How to tailor custom synchronization

This topic shows you how to add a new attribute to the integration, including the TQL query, and Push Adapter Mapping. It enables the integration to push the attribute to Service Management.

• Step 1: Add the new attribute to an existing Service Management TQL query layout.

  In this step you add the attribute of a specific CI to the integration TQL query, so that you can use the attribute and value in the mapping.

  1. In the UCMDB instance, navigate to Modeling > Modeling Studio> Resources > Root > Integration > Service Management > SACM.

  2. Select the TQL query containing the CI to which you want to add a new attribute, and double-click. The query is displayed in the main pane.

     For more information about the Service Management CIs and their TQL queries, see Synchronized configuration items (CIs).

     Note TQLs with the <tenant ID>_MANUAL_ prefix are TQLs for custom synchronization. Do not change any TQLs without this prefix.

     For example, if you are adding a new attribute data_note to the Actual Service CI, double-click the <tenant ID>_MANUAL_SACM Service Push query.

  3. Select the specific CI for which you want to add an attribute, right-click and select Query Node Properties. The Query Node Properties window is displayed.

  4. Go to the Element Layout tab.

  5. Move the new attribute to the Specific Attributes box and click OK.

  6. Save the query.

 

• Step 2: Add the new attribute to the corresponding push adapter mapping.

  In this step, you take the value from the TQL result, and remodel it to the Service Management data model.

  1. Go to Data Flow Management > Adapter Management > Packages > manualPushAdapter_<tentant ID>>Configuration Files, and select the XML file corresponding to the CI to which you have added a new attribute.

     For example, if you are adding a new attribute data_note to the Actual Service CI, select the pushMappingMaasService.xml file.

  2. Go to the source_ci_type XML tag for the element that matches the name of the element in the TQL you edited.

     Continuing the previous example, you go to:

     <source_ci_type query-element-name="ActualService">

  3. Add the target mapping to hold the value of the new attribute.

     Continuing the previous example:

     <target_mapping datatype="STRING" name="data_note" value="Root['data_note']"/>

     For more information about the default CI attribute mappings, see Synchronized configuration items (CIs).

  4. Click Save.

 

• Step 3: Create a job with the updated TQL query

  1. Go to Data Flow Management > Integration Studio.
  2. Create an Integration Point with Service Management.
  3. In the Integration Jobs tab, click New Integration Job.
  4. Insert a job name in the Name field.

  5. Click Add Query, and choose the updated query.

  6. Click OK.

  For more information on creating a job, see How to set up custom synchronization with UCMDB.

  Note Even if a job has been created for the TQL query, you need to remove the existing job and re-create it after the TQL query is updated. This is to ensure that the changes are reflected in the job.

 

• Step 4: Run the job

  1. Click on the job created.

  2. Click Full Synchronization or Request full sync in Service Management.

  3. Wait for the job to complete; click Refresh multiple times as needed until the job is completed.

  4. Make sure that the status is Succeeded and click Sync now on Service Management.

  For more information, see How to set up custom synchronization with UCMDB.

 

• Step 5: View the results

  1. Go to Service Management.

  2. Validate that the new attribute, pushed in the previous steps, is displayed.

For more information, see How to view synchronization results.

This topic shows how to add a new TQL query and push-mapping to the integration for a CIT called Example. It consists of the following steps:

• Step 1: Create a TQL query

  1. Go to Modeling > Modeling Studio > New > Query.

  2. From the CI Types tab, add Example CIT to the query.

  3. Right-click the Example Query Node and select Query Node Properties.
  4. Go to the Element Layout tab.
  5. Select Select attributes for layout.
  6. In the Attributes condition drop down, select Specific Attributes, and add the new attributes that you want to map and push to Service Management.

  7. Click OK.

  8. Save the query to Modeling > Modeling Studio> Resources > Root > Integration > Service Management > SACM.

 

• Step 2: Create a push-mapping

  1. Go to Data Flow Management > Adapter Management >manualPushAdapter_<tentant ID>.

  2. Click Create new resource and select New Configuration File.

  3. Type the a name for the file.

  4. Select the manualPushAdapter_<tentant ID> package.

  5. Click OK.

  6. Copy the following into the newly created XML file, replacing ExampleCI with the name of the relevant CI:

     <integration xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
     								xsi:noNamespaceSchemaLocation="../generic-push-adapter.xsd">
     								<info>
     								<source name="UCMDB" vendor="HPE" versions="10.0"/><target name="SACM" vendor="HPE" versions="1.0"/>
     								</info>
     								<import>
     								<scriptFile path="mappings.scripts.MaasPushFunctions"/>
     								</import>
     								<targetcis>  
     								<source_instance_type query-name=""ExampleCI*" root-element-name="Root">
     								<target_ci_type name="ExampleCI*">  
     								<variable name="externalId" datatype="STRING" value="ExampleCI['external_id_obj']"/>
     								<variable name="serviceName" datatype="STRING"value="'CMDB_UDM_1_6'"/>
     								<variable name="attributesHierarchy" datatype="STRING value="'model.instance'"/>
     								<variable name="keysHierarchy" datatype="STRING" value="'model'"/>
     								<variable name="keyTag" datatype="STRING" value="'ID'"/>
     								<variable name="keyVal" datatype="STRING" value="ExampleCI['cmdb_id']"/>
     								<variable name="retrieveRequestName" datatype="STRING" value="'RetrieveExampleCI'"/> 
     								<variable name="createRequestName" datatype="STRING" value="'CreateExampleCI'"/>
     								<variable name="deleteRequestName" datatype="STRING" value="'DeleteExampleCI'"/>
     								<variable name="updateRequestName" datatype="STRING" value="'UpdateExampleCI'"/>
     								<target_mapping name="Name" datatype="STRING" value="ExampleCI.attributeExists('name') ?
     								((ExampleCI['name']==null) ?ExampleCI['display_label']:ExampleCI['name']) :'MISSING'"/>  
     								<target_mapping name="Description" datatype="STRING" 
     								value="ExampleCI.attributeExists('description')? ExampleCI['description'] : 'MISSING'"/>
     								<target_mapping name="DisplayLabel" datatype="STRING" value="ExampleCI.attributeExists('display_label')
     								? ExampleCI['display_label'] : 'MISSING'"/>   
     								<target_mapping name="GlobalId" datatype="STRING" value="ExampleCI.attributeExists('global_id')
     								? ExampleCI['global_id'] : 'MISSING'"/></target_ci_type>
     								</source_instance_type> 
     								</targetcis>
     							</integration> 

  7. Click OK.

     Note To advance push-mapping configurations, update the MaasPushFunctions.groovy file. For information on the groovy function, see the Universal CMDB Developer Reference Guide.

 

• Step 3: Create a job with the new TQL query

  1. Go to Data Flow Management > Integration Studio.
  2. Create an Integration Point with Service Management.
  3. In the Integration Jobs tab, click New Integration Job.
  4. Insert a job name in the Name field.

  5. Click Add Query, and choose the newly created query.

  6. Click OK.

  For more information on creating a job, see How to set up custom synchronization with UCMDB.

 

• Step 4: Run the job

  1. Click on the job created.

  2. Click Full Synchronization or Request full sync in Service Management.

  3. Wait for the job to complete; click Refresh multiple times as needed until the job is completed.

  4. Make sure that the status is Succeeded and click Sync now on Service Management.

  For more information, see How to set up custom synchronization with UCMDB.

• Step 5: View the results

  1. Go to Service Management.

  2. Validate that the new CI, pushed in the previous steps, is displayed.

  For more information, see How to view synchronization results.

For more information on customization push adapters, see Developing Push Adapters in the Universal CMDB Developer Reference Guide.