...
This section talks about the two properties “Associated Configuration Item Type” and “Associated Configuration Item Type From Template” and . Both mean the properties on the configuration concept type of new configuration that gets created when using a template. Not on the configuration concept type of the template itself
...
The image below illustrates the different scenarios:
...
...
Manually Set the Template Protocol
1. Define Template Properties
Mark Concept Types as Templates:
Set
IsTemplate
totrue
during Concept Type creation.Example: A Unit or Configuration Concept Type becomes a template when
IsTemplate = true
.
Define Associated Configuration Types:
Assign an
Associated Configuration Item Type from Template
to ensure correct Concept Type alignment during configuration creation.
2. Create a New Configuration from a Template
Select a Template:
From the Configuration Area's
associatedTemplates
, choose a valid template (state =TEMPLATE_VALID
).If only one template is available, it is auto-selected.
Choose Protocol Usage:
With Protocol:
Users can exclude specific Configuration Items from the new instance.
Reasons for exclusions must be documented in the protocol.
Without Protocol:
All items in the template are included in the new configuration.
Copy Properties and Items:
Copy shared properties between the new configuration and the selected template.
Include only Configuration Items aligned with the selected Concept Types.
Record Template Protocol:
Link the new configuration to the source template.
Document usage, exclusions, and tailoring steps.
3. Update a Configuration Using a Template
Match Configuration Items:
Use CI titles or types to match existing items with the template.
Update or Add Items:
For matched items:
Update read-only properties based on the template.
For unmatched items:
Add new items or update Concept Types as necessary.
Tailor Configuration Items:
If using the template protocol, select items to exclude and provide reasons.
Create a record of the update process in the template protocol.
4. Maintain the Template Protocol
...
Template Usage Protocol Properties:
sourceTemplateId
: Reference to the template used.targetConfigurationId
: The new or updated configuration.omittedConfigurations
: List of excluded items and their reasons.Protocol is inherited during configuration branching or baselining.
Customization:
...
External templates can be linked with additional metadata (e.g., source name, link, and protocol details).
...
The template use protocol displayed in the “Template protocol” tab in the configuration is usually automatically created when a configuration is created by using a template or when a configuration was updated by applying a template. But because it is possible to create configurations directly by calling the cdcm API (see https://smartfacts.atlassian.net/wiki/spaces/CDCM/pages/174424065/Architecture#CDCM-Rest-backend) it is possible to manage information about how configurations should look like outside of cdcm (so called “external templates”). It is then possible when creating a configuration via the api to manually set the template protocol.
In that case the following three values when creating a configuration are relevant:
externalTemplateTitle
- The title of the template that will be displayed in the “template use” tab on the configurationexternalTemplateLink
- A link that leads to information about the used templateexternalProtocolHtml
- HTML for the content of the “template use” tab