Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Section
titleProperties


Transclusion
documentNote Box referencing common Document Properties
idsBox


Section
titleIdentifier

The unique identifier of the configuration item defined by the owning organization.


Section
titleSuperordinate 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.


Section
titleType

Specify the type of the configuration item to organize them.

Use the Configuration Item Type to define types of configuration items.


Section
titleLifecycle Phase

Specify the lifecycle phase this configuration item is currently in.


Section
titleIT System

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.


Section
titleDocumentation

List documentation assets provided for this configuration item.


Section
titleSoftware

List software assets this configuration item depends on.


Section
titleAssets

List assets this configuration item depends on.


Section
titleIT Services

Add links to services this configuration item depends on. Services will be rendered within a document section.


Section

...

titleIT Systems

Add links to systems this configuration item depends on. Systems will be rendered within a document section.


Section
titleConfiguration Items

List configuration items this configuration item depends on to be operational.


Section
titleStatus

Select the status of the configuration item.

Use Configuration Item Status to document statuses.


Section
titleVersion

Specify the version of the configuration item.


Section
titleURI

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.


Section
titleLogical Location

Provide the logical location for the configuration item.


Section
titleLocation

Provide the physical location for the configuration item.


Section
titleVendor Organization

Reference the organization that sells the configuration item.


Section
titleVendor Contact

Reference the contact person of the vendor organization to access more information on the configuration item or related information.


Section
titleAdministration Organization

Reference the organization that runs the configuration item.


Section
titleAdministrator

Reference the contact person of the administration in case of technical problems.


Section
titleRemote Repositories

List of remote information repositories related to the configuration item.



Section
titleSections


Section
titleDescription

Describe the configuration item.


Section
titleDependencies

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.


Section
titleInterfaces

List and describe the interfaces provided by this configuration item.


Section
titleInstallation

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.


Section
titleConfiguration

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.


Section
titleBest Practices

An automatic list of work instructions relevant for running or working with this configuration item.


Section
titleDeployments

List of deployments conducted for this configuration item. Typically configuration items are not deployed separately, but there is no hard rule that they cannot.


Section
titleAccess Information

If there is a document of type Access Information, this information is automatically rendered in this section by transclusion.


Transclusion
documentDocument Sections
idsstandard-sections-bottom



Section
titleDetails


Section
indextrue
titleRelated Doctypes

...