Configuration items (CIs) may be (sub-)systems or components. Whatever may change and needs to be tracked may be documented as a CI.
The document type configuration-item provides the following properties:
Please note that only information about specific properties is provided here. Common document property used by all document types are documented by Document Properties.
The unique identifier of the configuration item defined by the owning organization.
Unlike the URI the unique identifier may not be published or may identify a specific configuration item that is accessible via a shared URI.
Superordinate Configuration Item
Configuration items may be nested. This is the reference to the superordinate configuration item.
This value is automatically generated from the parent if it has the same doctype.
Specify the type of the configuration item to organize them.
Use the Configuration Item Type to define types of configuration items.
Specify the lifecycle phase this configuration item is currently in.
A link to the system this configuration item is part of.
This value is automatically generated if there is a an ancestor of the IT System doctype.
Select the status of the configuration item.
Use Configuration Item Status to document statuses.
Specify the version of the configuration item.
Specify the uniform resource identifier (URI) to the configuration item. Relevant if the the configuration item can be addressed individually.
This information may be used by the Access Information doctype.
Provide the logical location for the configuration item.
Provide the physical location for the configuration item.
List documentation assets provided for this configuration item.
List software assets this configuration item depends on.
List assets this configuration item depends on.
Add links to services this configuration item depends on. Services will be rendered within a document section.
Add links to systems this configuration item depends on. Systems will be rendered within a document section.
List configuration items this configuration item depends on to be operational.
Reference the organization that sells the configuration item.
Reference the contact person of the vendor organization to access more information on the configuration item or related information.
Reference the organization that runs the configuration item.
Reference the contact person of the administration in case of technical problems.
List of remote information repositories related to the configuration item.
Describe the configuration item.
This section provides subsections to list information on dependencies.
The tables are automatically populated with references provided as values to properties. So typically this section is not edited manually. New dependencies are added as a value to the respective property.
List and describe the interfaces provided by this configuration item.
Describe the installation procedure of the configuration item. Use a subsection for each step. This way you can add screen shots or console output to make things very easy. Adding this information is hard on lists. If the installation process is long and complicated, add a checklist or topic as a child document and refer to it from here. In case the installation is automated, just help the user to launch the installation process.
Describe the typical or recommended configuration of the configuration item. Again, use subsections for the individual steps. If the configuration process is long and complicated, add a checklist or topic as a child document and refer to it from here.
An automatic list of work instructions relevant for running or working with this configuration item.
List of deployments conducted for this configuration item. Typically configuration items are not deployed separately, but there is no hard rule that they cannot.
If there is a document of type Access Information, this information is automatically rendered in this section by transclusion.