CI References | OTRS Academy

Table of Contents

With this feature it is possible to enhance the configuration items in the configuration management database (CMDB) through additional fields and to create links and references between these or other data in OTRS. This can be useful for linking configuration items with each other when there is a dependency relationship between them or to store information regarding linked services and agents directly in the configuration item, as well as find this information with a quicker autocomplete search.

The following input fields with autocomplete search can be added:

ReferenceCI field: a further configuration item.
ReferenceService field: a further service.
ReferenceUser field: a further agent.

In the administrator interface, it is possible to create new reference fields under Configuration Items. Then, it is necessary to add the visualization configuration as code for the desired configuration item class. If, for example, a new configuration item is being created in the said class, then the newly added reference field will appear in the form to be filled out. A search for the referenced configuration items using autocomplete can then be carried out, and these can be added. If the new configuration item is updated, an automatic linking to the referenced configuration item is carried out.

Additional Configuration Item Fields

It is possible to add additional reference fields to refer to different data like to other configuration items, services and agents.

To add the fields for configuration items:

Go to the Configuration Items screen.
Select a configuration item class and click on the Change class definition button.
Add the new fields to the class definition.

The following sections describe the possible input fields.

`ReferenceCI` Field

This field adds an input field with auto-completion feature to search for other configuration items in the configuration item dialog. The following example configuration is needed to insert this kind of field:

- Key: testci
  Name: Test CI
  Searchable: 1
  Input:
    Type: ReferenceCI
    Required: 0
    Reference:
      Name: Computer
      LinkType: AlternativeTo
      LinkDirection: Source
      ImportExportKey: Name

The following settings are available when adding or editing this resource. The fields marked with an asterisk are mandatory.

Key *

Must be unique and only accept alphabetic and numeric characters. If this is changed, data will not be readable from old definitions.

Name *

The label of the field in the form. Any type of characters can be entered to this field including uppercase letters and spaces.

Note

It is recommended to always use English words for names.

`ReferenceService` Field

This field adds an input field with auto-completion feature to search for services in the configuration item dialog. The following example configuration is needed to insert this kind of field:

- Key: testservice
  Name: Test Service
  Searchable: 1
  Input:
    Type: ReferenceService
    Required: 0
    Reference:
      LinkType: AlternativeTo
      LinkDirection: Source

The following settings are available when adding or editing this resource. The fields marked with an asterisk are mandatory.

Key *

Must be unique and only accept alphabetic and numeric characters. If this is changed, data will not be readable from old definitions.

Name *

The label of the field in the form. Any type of characters can be entered to this field including uppercase letters and spaces.

Note

It is recommended to always use English words for names.

`ReferenceUser` Field

This field adds an input field with auto-completion feature to search for agents in the configuration item dialog. The following example configuration is needed to insert this kind of field:

- Key: testuser
  Name: Test User
  Searchable: 1
  Input:
    Type: ReferenceUser
    Required: 0

The following settings are available when adding or editing this resource. The fields marked with an asterisk are mandatory.

Key *

Must be unique and only accept alphabetic and numeric characters. If this is changed, data will not be readable from old definitions.

Name *

The label of the field in the form. Any type of characters can be entered to this field including uppercase letters and spaces.

Note

It is recommended to always use English words for names.

CI References on Agent Interface

Use the Add Configuration Item menu item in the main menu to add new configuration items to the configuration management database.

To add a configuration item:

Select a class from the list of classes.
Fill in the required fields.
Search for a different configuration item, service or agent to set the value for it.
Click on the Save button.

Now the value is automatically linked to the created configuration item.

Note

The fields in the Create Configuration Item screen can be very different on each classes.

Facebook X LinkedIn

Additional Configuration Item Fields

ReferenceCI Field

ReferenceService Field

ReferenceUser Field

CI References on Agent Interface

`ReferenceCI` Field

`ReferenceService` Field

`ReferenceUser` Field