How to set up automatic synchronization with UCMDB

In automatic synchronization mode, you need to create an endpoint in Service Management and start the synchronization process, and then the agent pulls data from UCMDB to Service Management automatically. In this mode, you have little control of the synchronization process and schedule.

The following steps describe how to set up automatic synchronization with UCMDB.

Note  

  • For more information about downloading, installing, and creating the On-Premise Bridge Agent, search the Help Center for: How to use On-Premise Bridge agents to synchronize data.

  • For information about how to synchronize using the HTTPS protocol, search the Help Center for: How to communicate with UCMDB using HTTPS.

  1. Download and install the On-Premise Bridge Agent.

  2. Create an agent.

  3. Specify the credentials. For more information on this, search the Help Center for the following topics:

    • How to specify credentials using the Endpoint Credentials Manager

    • How to specify credentials using a command line tool

  4. Create a UCMDB endpoint:

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

    2. Click Add iconAdd.

    3. Enter the endpoint details.

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

  5. Configure the endpoint:

    1. Click Configure iconConfigure. 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 entities, or infrastructure and business entities.
      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. For information about field mappings for manual synchronization, search the Help Center for: How to set up custom synchronization with UCMDB.

    1. Click Save.

  6. Click Sync Now.

    The push job runs immediately. In addition, the push job runs according to the scheduler in UCMDB, the default for which is set at every hour.

    In UCMDB, the push adapter that is deployed and the integration point that is created include the tenant ID as a prefix. For example, 100000001_SACMPushAdapter and 100000001_test_endpoint, where 100000001 is the tenant ID.

    Note When performing a synchronization with a Discovery probe (not an Integration Service) in UCMDB 10.20, proceed as follows:

    1. Click the Sync Now button and wait until it fails.

    2. Shut down the Discovery probe service.

    3. In the UCMDB Discovery Probe file system, go to the following folder: DataFlowProbe\runtime\probeManager\discoveryResources\SACMPushAdapter and delete the following files:

      • api-integration.jar

      • api-interfaces.jar

    4. Start the Discovery probe service. Wait a few minutes for the probe to start.

    5. In Service Management, go to Integration > Endpoints and click Sync Now.

    For subsequent, on-demand, synchronizations:

    • Click Sync Now if you want the agent to synchronize only the delta.

    • Click Request Full Sync if you want a full synchronization. This is equivalent to running the integration job within UCMDB.

    You can see a record of the data pushed in the fcmdb.push.all.log file in the <DataFlowProbe>\runtime\log folder.

  7. 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.