CI relations formatter
Summarize
Summary of CI relations formatter
The CI relations formatter is a default feature on the Configuration Item (CI) form in ServiceNow's Zurich release. It enables you to view and analyze the relationships between a CI and its related CIs through various configurable views. You can also launch the CI relationship editor directly from the formatter to create or modify CI relationships.
Show less
When domain separation is enabled, the formatter only displays relationships where the logged-in user has permission to view both CIs involved. The formatter excludes certain complex or chained relationships to simplify the view and improve clarity.
In environments that don’t meet browser requirements for the latest formatter, a legacy CI relations formatter is provided instead.
Key Features
- Relationship Views: Offers flat and tree layouts to display related CIs, grouped by relationship types or hierarchically.
- Toolbar Controls: Includes controls to add CI relationships, launch Dependency Views maps for visualizing CI dependencies, and search/filter related CIs.
- Relationship Filtering: Allows filtering by maximum hierarchy levels, relationship types, and CMDB views to tailor the displayed data.
- Icons for Related Issues: Visual indicators show the presence of changes, outages, problems, and incidents associated with related CIs.
- Performance Management: Properties like maximum relation levels and max related CIs limit data volume for faster form loading.
- Domain Separation Support: Ensures users see only authorized relationships according to domain-based data segregation.
Practical Usage and Controls
- Add CI Relationship: Opens the CI relationship editor for manual relationship creation (requires appropriate roles).
- Show Dependency Views: Opens a visual map centered on the CI, showing upstream and downstream dependencies with task and incident indicators.
- Search for CI: Filters displayed CIs to quickly find specific relationships within the formatter.
- View Settings: Configure flat versus tree layout, split versus merged upstream/downstream relationship lists, and filter by relationship types and levels.
Limitations and Special Notes
- CIs not extended from the base Configuration Item [cmdbci] table do not appear in the formatter or Dependency Views maps.
- The Applicative Flow To::Application Flow From relationship type, used only for Service Mapping endpoints, is excluded from this formatter.
- Endpoints acting as both parent and child in chained relationships are hidden to avoid clutter.
Configuration and Customization
You can create custom relationship filters to control which CI relationships appear in the formatter and exclude specific relationships if needed. Properties are available to tune performance and display behavior.
Summary for ServiceNow Customers
The CI relations formatter provides a comprehensive and configurable interface to explore CI relationships, contributing to better understanding and management of your configuration items. It enhances visibility into dependencies and related issues while respecting domain security constraints. Using its controls and filters, you can tailor the view to your operational needs, manage performance for large networks, and seamlessly create or edit relationships to keep your CMDB accurate and up to date.
The default CI form includes a CI relations formatter from which you can examine a CI and its relationships in various views. From the CI relations formatter, you can also launch the CI relationship editor for the CI.
If the domain separation plugin is activated, then only relationships in which the logged on user is authorized to view both CIs, are displayed.
The CI relations formatter contains a list of related CIs and a toolbar with controls for viewing the relationships between the current CI and related CIs. You can configure the controls in this formatter to modify varying aspects of the view. For more information about formatters, see Create a formatter and add it to the form.
- If an endpoint is a child in one relationship and the same endpoint is a parent in another relationship, then that endpoint is hidden and does not appear in the relations formatter view. Similarly, relationship qualifier
chains are also hidden and do not appear in the relationship formatter view.
- Example: CI1 > endpoint > CI2
In this example, CI1 is related to CI2 through relationships with endpoint. A single relationship appears in the relations formatter:
CI1 > CI2 (These relationships appear as a direct relationship without endpoint, because endpoint is a parent in one relationship and a child in another relationship).
- Example: CI1 > endpoint1 > CI2 > endpoint2
Two relationships appear in the relations formatter:
CI1 > CI2 (endpoint1 is hidden because it is a parent in one relationship and a child in another relationship).
CI1 > CI2 > endpoint2 (appears as level 2 relationship – endpoint1 is hidden and endpoint2 appears as it a child and not a parent in any other relationship).
- Example: CI1 > endpoint > CI2
- On instances that do not meet the internet browser requirements for the CI relations formatter, the default CI form includes the legacy CI relations formatter instead. For more information, see Legacy CI relations formatter.
- CIs not extended from the Configuration Item [cmdb_ci] table, are not displayed in Dependency Views maps and in CI relation formatters.
- The Applicative Flow To::Application Flow From relationship is a special relationship type used only between Service Mapping endpoints. This relationship type is not intended for use in the CMDB as a relationship between CIs and therefore it is not displayed in the relations formatter.
| Control | Definition |
|---|---|
|
Add CI relationship |
Starts the relationship editor to manually create CI relationships. For more information (including about roles required for the '+' control to appear), see Create or edit a CI relationship. |
|
Show dependency views |
Launches a Dependency Views map in another window or tab. The CI is the central node in the map, with a configurable number of levels above and below that node in the hierarchy. Map indicators next to the nodes indicate the number of tasks, incidents, problems, changes, or outages related to that node. Right-click to expand collapsed nodes or display a list of related tasks or problems. For more information, see Dependency Views map. |
| Search for CI | Filters the CIs included in the display. |
Select the Settings icon to configure additional view settings that filter the data displayed. Settings are preserved through logging out and logging back in.
| Setting | Description |
|---|---|
| Show Relations in Flat/Tree Layout |
To view a flat list of related CIs that are grouped by relationship type in alphabetical order, click Flat (default value). To view groups of related CIs in a hierarchical tree, clickTree. If you select the tree view, you cannot configure any other settings for viewing related CIs. A single list of upstream and downstream relationships is displayed. |
| Show Relations in Split/Merge Layout |
To view a single list that includes both upstream and downstream relationships, click Merge (default value). Relationships are grouped by relationship type. To view separate lists for upstream and downstream relationships, click Split. |
| Filter Relations by Max Level |
Select the number of downstream and upstream levels in the hierarchy to include when displaying CIs in a flat view. Default value is 3. |
| Filter Relations by Relationship Type |
Select the types of relationships to view. Default value is 'All Relationship Types'. |
| Filter Relations by CMDB View | Filter by tables specified in CMDB views, if any relationship filters exist. |
| Icon |
|---|
| Recently closed changes |
| Planned changes |
| Currently open changes |
| Recently closed outages |
| Problems |
| Incidents |
| Planned outages |
| Currently open outages |
In large networks, a list of related CIs might be excessively long, which can slow performance when a CI form is rendered. You can configure these properties to control the amount of data that is displayed. To find a property, enter sys_properties.list in the left navigation filter and search for the property.
| Property | Description |
|---|---|
| glide.ecmdb.find_relationship_issues | Hides or displays an icon in the CI relations formatter that links to open issues for the CI. This property defaults to true (displays the icon). |
| glide.ui.max_relation_levels | Specifies the maximum level for displaying CIs in flat view before reaching the maximum relations limit. The default value is 5. |
| glide.ui.max_relations |
Specifies the maximum number of related CIs to display. When exceeded:
|