8.8 Adding a Driver Heartbeat

The driver heartbeat is a feature of the Identity Manager drivers that ship with Identity Manager 2 and later. Its use is optional. The driver heartbeat is configured by using a driver parameter with a time interval specified. If a heartbeat parameter exists and has an interval value other than 0, the driver sends a heartbeat document to the Metadirectory engine if no communication occurs on the Publisher channel for the specified interval of time.

The intent of the driver heartbeat is to give you a trigger to allow you to initiate an action at regular intervals, if the driver does not communicate on the Publisher channel as often as you want the action to occur. To take advantage of the heartbeat, you must customize your driver configuration or other tools. The Metadirectory engine accepts the heartbeat document but does not take any action because of it.

For most drivers, a driver parameter for heartbeat is not used in the sample configurations, but you can add it.

A custom driver that is not provided with Identity Manager can also provide a heartbeat document, if the driver developer has written the driver to support it.

To configure the heartbeat:

  1. In iManager, click Identity Manager > Identity Manager Overview.

  2. Browse to and select your driver set object, then click Search.

  3. In the Identity Manager Overview, click the upper right corner of the driver icon, then click Edit properties.

  4. On the Identity Manager tab, click Driver Configuration, scroll to Publisher Settings, then locate Heartbeat interval (in minutes).

    If a driver parameter already exists for heartbeat, you can change the interval and save the changes. Configuration is then complete.

    The value of the interval cannot be less than 1. A value of 0 means that the feature is turned off.

  5. (Conditional) If a driver parameter does not exist for heartbeat, click Edit XML.

  6. (Condtional) Add a driver parameter entry similar to the following example, as a child of <publisher-options>.

    <pub-heartbeat-interval display-name="Heart Beat">10</pub-heartbeat-interval>

    HINT:If the driver does not produce a heartbeat document after being restarted, check the placement of the driver parameter in the XML.

  7. Save the changes, then make sure the driver is stopped and restarted.

After you add the driver parameter, you can edit the time interval by using the graphical view. Another option is to create a reference to a global configuration value (GCV) for the time interval. Like other global configuration values, the driver heartbeat can be set at the driver set level instead of on each individual Driver object. If a driver does not have a particular GCV, and the Driver Set object does have it, the driver inherits the value from the Driver Set object.