How to Add an Attribute of a Supported CI Type for Federation

Out-of-the-box, the integration supports federation for three external CI types in UCMDB: Incident, Problem, and RequestForChange.

For each of the supported CI types, there is a list of attributes in UCMDB that you can map to Service Manager web service objects for federation. The following figure shows the out-of-the-box UCMDB CI attributes available for the Incident CI type.

Incident CI attributes supported for federation are illustrated in the following screenshot:

For example, to add an SM Incident attribute for federation, you need to expose the field in the SM UcmdbIncident web service object and then map it to an appropriate UCMDB attribute (if one does not already exist, you need to create it in UCMDB first).

The following figure shows the fields that are exposed in the UcmdbIncident web service object in Service Manager:

You can expose more fields so that more Incident attributes can be federated to UCMDB. As an example, the following describes how to add the “action” field in the Service Manager probsummary (Incident) file for federation, by mapping it to a new UCMDB attribute named “details”.

To add an attribute of a supported CI type for federation:

1. Add the SM attribute to its web service object.

   The following example describes how to expose the SM “action” field of Incident in UCMDBIncident web service object.

   1. Log in to Service Manager as a system administrator.
   2. Navigate to Tailoring > Web Services > WSDL Configuration.
   3. Enter the following field values, and then click Search.
      • Service Name: ucmdbIntegration
      • Name: probsummary

      UCMDBIncident web service object is displayed.

   4. On the Fields tab, add the following row:
      • Field: action.
      • Caption: Description

      

   5. Save the web service object.
2. Map the SM attribute to a UCMDB attribute.

   The following example describes how to map the SM “action” attribute to a new UCMDB attribute named “details”.

   1. Log in to UCMDB as an administrator.
   2. Navigate to Modeling > CI Type Manager.
   3. Browse to ItProcessRecord > Incident, and open its properties pane.
   4. Click the Add button to add a new attribute named “details” to the Incident CI type.

      

      • name: details
      • Display Name: Details
      • Description: Incident details
      • Attribute Type: Primitive > List of strings (this is because the “action” field in SM is an array)
   5. Save the Incident CI type record.
   6. Navigate to Data Flow Management > Adapter Management > ServiceManagerAdapter9.41 > Configuration Files.
   7. Click the ServiceDeskConfiguration.xml file.
   8. Add a mapping entry for the “details” attribute in the Incident attributeMappings section, as shown in the following.

      <ucmdbClassConfiguration ucmdbClassName="incident">

          <attributeMappings>

              <attributeMapping ucmdbAttributeName="reference_number" 
      serviceDeskAttributeName="IncidentID"/>

              <attributeMapping ucmdbAttributeName="name" 
      serviceDeskAttributeName="BriefDescription"/>

               ...

              <attributeMapping ucmdbAttributeName="incident_status"
      serviceDeskAttributeName="IMTicketStatus"
      converterClassName="com.mercury.topaz.fcmdb.adapters.
      serviceDeskAdapter.converter.PropertyValueConverterFirstLetter
      ToUpperAndReplaceUnderscoreWithSpace"
      reversedConverterClassName="com.mercury.topaz.fcmdb.adapters.
      serviceDeskAdapter.converter.PropertyValueConverterFirstLetter
      ToLowerAndReplaceSpaceWithUnderscore"/>

               ...        

             <attributeMapping ucmdbAttributeName="urgency" serviceDeskAttributeName="Urgency"/>

      <attributeMapping ucmdbAttributeName="details" serviceDeskAttributeName="Description"/>

          </attributeMappings>

      Tip The attribute mapping entry uses the following format:

      <attributeMapping ucmdbAttributeName="details" serviceDeskAttributeName="Description"/>

      Where:

      ucmdbAttributeName is the UCMDB attribute name in the Incident CI type definition to which you want to map the SM attribute;

      serviceDeskAttributeName is the field caption you defined in the SM web service object.

      For an SM attribute (for example, problem.status) that is a drop-down list, the attribute mapping uses the following format (you only need to change the attribute names):

      <attributeMapping ucmdbAttributeName="incident_status" 
      serviceDeskAttributeName="IMTicketStatus" 
      converterClassName="com.mercury.topaz.fcmdb.adapters.
      serviceDeskAdapter.converter.PropertyValueConverterFirstLetter
      ToUpperAndReplaceUnderscoreWithSpace" 
      reversedConverterClassName="com.mercury.topaz.fcmdb.adapters.
      serviceDeskAdapter.converter.PropertyValueConverterFirstLetter
      ToLowerAndReplaceSpaceWithUnderscore"/>

   9. Click OK to save the file.

   Now the Description (field name: action) attribute of SM Incident has been added to the integration for federation. You can run an Incident federation query in the UCMDB Modeling Studio to see if the SM Description data is properly federated. For details, see Examples of Using Federation.

   The following figure shows an example where the Description of an SM incident ticket has been federated to UCMDB as Details: