How to set up custom synchronization with UCMDB

Download and install the On-Premise Bridge Agent.

Create an agent.

Specify the credentials.

Create a UCMDB endpoint:

1. From the main menu, select Administration > Utilities > Integration > Endpoints.

2. Click Add.

3. Enter the endpoint details.

   Field	Description
   Endpoint type	Select the relevant UCMDB version.
   Endpoint name	Type a name for the endpoint. Use only alphanumeric characters and spaces.
   Running on agent	Select the agent (installed in step 1 of the task) from the drop-down list.

4. Click Add.

Configure the endpoint:

1. Click Configure. The Endpoint Configuration dialog box opens.

2. Enter the endpoint details.

   Field	Description
   Endpoint name	The name of the endpoint. Note This field is read-only.
   Protocol	Select the protocol to be used for connecting to the on-premise UCMDB installation. Valid values are HTTP or HTTPS.
   Host name	Type the name or IP address of the on-premise UCMDB server.
   Port	Type the number of the port listened to by the UCMDB API. The default is 8080.
   Root context	Type the root context value of the on-premise UCMDB installation. If no root context has been defined, leave this field with its default value.
   Credentials	Choose the credentials to be used to connect to the UCMDB installation from the drop-down list. The full credentials are those defined as part of the agent to which the endpoint is connected.
   Probe name	Type the name of the UCMDB probe on which to run the synchronization. The default is Integration Service.
   Probe domain	The domain of the probe as defined in UCMDB.
   Sync content	Select whether to synchronize only infrastructure records, or infrastructure and business records.
   Customer name	Type the customer name.
   Remote machine state	Select the state with which you want to connect when integrating with multi-state UCMDBs. Valid values are Actual State or Authorized State. The default is Actual.
   Custom sync	Check this check box to run in custom synchronization mode. Automatic synchronization mode is the default mode.
   Additional field customization	You can define additional fields to synchronize. Click Add to add a row for each additional set of fields. Select the Service Management record type and field from the drop-down lists on the left and enter the UCMDB CI type attribute name (not the display label) on the right. Note The Addtional field customization works for automatic synchronization only. To customize field mappings for manual synchronization, see How to tailor custom synchronization.

3. Click Save.

Download the UCMDB Push Adapter package (.zip file) from the Service Management On-Premise Bridge download center to your local drive. For more information, see On-Premise Bridge download center.

Deploy the adapter package in the UCMDB instance:

1. Log into the UCMDB instance and select Administration >Package Manager.
2. Click the Deploy packages to server (from local disk) button.
3. In the window displayed, click .
4. Select the downloaded UCMDB Push Adapter package from your local drive.
5. Click Deploy to install the package.

A message is displayed when the package is successfully deployed. You can then find the package in Package Manager.

To view the adapter information, go to Data Flow Management > Adapter Management > manualPushAdapter_<tenant ID>.

You can customize the mapping files under the Configuration Files folder as needed. For more information, see How to tailor custom synchronization.

Create an integration point in UCMDB:

1. Go to Data Flow Management > Integration Studio.

2. Click the New button and enter the following information in the window displayed:

   Field	Description
   Integration Name	Enter a name of the integration point. Note Make sure it is the same as the UCMDB endpoint name in Service Management.
   Integration Description	Enter a description that captures the integration details.
   Adapter	Select the UCMDB Push Adapter that was installed in step 2 under HPE software products. The adapter name should be in the following format: MANUAL_<tenant_ID>_SACM Push adapter.
   Is Integration Activated	Check the check box to activate the integration point.
   Protocol	Select HTTP.
   Hostname/IP	Enter the IP address of the UCMDB instance.
   Port	Enter the port number of the UCMDB instance.
   Credentials ID	Click to create a credential ID. For more information, see Create a credential ID. You should enter credentials of a user with UCMDB-Admin permission.
   Client Name	Enter a name for the client.
   Data Context	Enter the data context. Note Make sure it is the same as the Integration Name field for this integration point.
   Data Flow Probe	Select IntegrationService.
   Additional Probes	Enter any additional data flow probes.

   Create a credential ID

   1. Click New to start to create a credential ID.
   2. Enter a user label in the General section.
   3. Enter a user name and password in the Generic section.
   4. Click OK.
3. Click Test connection to see if the connection was successfully created.
4. Click OK.

The new integration point is successfully created.

Create an integration job for the integration point:

1. Go to Data Flow Management > Integration Studio.
2. From the left pane, select the integration point that you created in step 3.
3. From the right pane, click New to start creating a new job.

4. In the New Integration Job window, enter the following and click OK:

   Field	Description
   Name	Enter a name for the integration job.
   Job Definition	Defines the job of the integration. Select the TQL queries that you want to run. Click Add and navigate to Root > Integration > Service Management > SACM. Select the TQL queries that you want to run in the subfolders. Press Ctrl to select multiple queries. Note All TQLs generated by a manual push follow this naming pattern: MANUAL_<tenant_ID>_<TQL_query>. If there are TQL queries for both manual and automatic pushes, make sure you select only those started with the MANUAL. Click OK. For more information on mapping customization, see How to tailor custom synchronization.
   Scheduler Definition	Defines the schedule of the integration job for both incremental and full synchronization. Define a schedule for delta synchronization. Click the Delta Synchronization tab. Select the Scheduler enabled option. Select the scheduling options you want to use. Click the Full Synchronization tab and select the scheduling options you want to use. Click OK. Note If the schedule is not defined, the custom synchronization will be triggered only when you click the Sync now button on Service Management.

5. Click to save the changes to the new integration point.

For more information on UCMDB configuration, refer to the UCMDB documentation.

Go back to Service Management and click Request full sync on the Endpoints tab.

Data is synchronized to the staging area. This is equivalent to running the integration job within UCMDB.

If you refresh the UCMDB UI, you can find the status is changed to Running.

After the integration job status in UCMDB is changed to Complete successfully, go back to Service Management and click the Sync now button on the Endpoints tab to synchronize data to Service Management.

When the synchronization is completed, the job status is updated to Success on the Endpoints tab.

View broken relationships.

A broken relationship occurs when the relationship was synchronized before data about one or both of its ends was available. The relationship is automatically synchronized to Service Management, once the missing data arrives.

To view the broken relationships from your synchronization, follow these steps:

1. On the Endpoints tab, select the endpoint used in your synchronization.
2. Click More > View broken relationships. The table displays the broken relationships.
3. If you do not expect a relationship to be synchronized, you can dismiss it. Select the relationships to dismiss and click Dismiss from list.
4. To view details about a broken relationship, click the Show details link in the Details column.