3.7 Configuring Drivers

1. Click Add, then browse to and select the ECMAScript object from another driver.

2. Click OK.

3. Click Apply to save the change.

1. Click Add, then browse to and select the Global Configuration object.

2. Click Apply to save the change.

1. In the Modeler or Outline view, right-click the driver, then select Properties.

2. In the left-side navigation, select Health.

   

3. Select New Driver Health Configuration.

   Designer creates a basic health configuration with sample conditions for the green and yellow states (none for red).

   

4. Continue with Modifying the Health State Conditions.

To modify the conditions for a state:

1. In the Modeler or Outline view, right-click the driver where you want to modify the health check configuration, then select Properties.

2. In the left-side navigation, select Health.

3. Click the state tab (Green or Yellow) that you want to modify.

   

   The tab displays the current conditions for the health state. Conditions are organized into groups, with logical operators (either AND or OR), to link each condition and condition group.

   Table 3-16 describes the conditions that the Driver Health job can evaluate.

   Table 3-16 Driver Health Check Conditions

   Condition	Description
   Driver State	Running, stopped, starting, not running, or shutting down. For example, one of the default conditions for the green health state is a Driver State that indicates the driver is running.
   Driver in Cache Overflow	The state of the cache used for holding driver transactions. If the driver is in cache overflow, all available cache has been used. For example, the default condition for the green health state is Driver in Cache Overflow is false and the default for the yellow health state is Driver in Cache Overflow is true.
   Newest	The age of the newest transaction in the cache.
   Oldest	The age of the oldest transaction in the cache.
   Total Size	The size of the cache in bytes.
   Unprocessed Size	The size of all unprocessed transactions in the cache.
   Unprocessed Transactions	The number of unprocessed transactions in the cache. You can specify all transactions types or specific transaction types (such as adds, removes, or renames).
   Transaction History	The number of transactions processed at various points in the Subscriber or Publisher channel over a given period of time. This condition uses multiple elements in the following format: <transaction type> <transaction location and time period > <relational operator> <transaction number>. <transaction type>: Specifies the type of transaction being evaluated. For example, adds, removes, renames, and so forth. <transaction location and time period>: Specifies the point in the Subscriber or Publisher channel and the time period being evaluated. For example, you might evaluate the total number of transactions processed as Publisher events over the last 48 hours. The time period cannot exceed the Transaction Data Duration setting, which is configurable in the Driver Health job. For more information, see Modifying the Driver Health Job Settings. <relational operator>: Specifies the relationship between the identified transactions and the <transaction number> (equal to, less than, greater than, and so forth.) <transaction number>: Specifies the number of transactions being used in the evaluation. For example: <number of adds> <as publisher commands> <over the last 10 minutes> <is less than> <1000>
   Available History	The amount of transaction history data that is available for evaluation. This condition helps ensure that a Transactions History condition does not cause the current state to fail because it does not have enough transaction history data collected for the time period being evaluated. For example, assume that you want to use the Transactions History condition to evaluate the number of “Add as Publisher” commands over the last 48 hours. However, you don't want the condition to fail if there is less than 48 hours of data. You could create condition groups similar to the following: Group1 Available History <is less than> <48 hours> or Group2 Available History <is greater than or equal to> <48 hours> and Transactions History <number of adds> <as publisher commands> <over the last 48 hours> <is less than> <1000> The state evaluates to true if either condition group is true. The state evaluates to false if both conditions evaluate to false.

4. Modify the condition criteria as desired.

   • To add a new group, select the Conditions tab, then click Append Condition Group .

   • To add a condition, select an existing condition group, then click Append Condition .

   • To reorder condition groups or individual conditions, select the condition group or condition, then click Move Up or Move Down . You can also use these buttons to move a condition from one group to another.

   • Cut, copy, and paste a condition group or condition to the clipboard by right-clicking the item, then selecting the appropriate clipboard action.

5. Click Apply to save your changes without closing the Properties page, or click OK to save the changes and close the Properties page.

6. If you want to change the actions associated with the conditions you set, continue with Modifying the Health State Actions.

1. In the Modeler or Outline view, right-click the driver, then select Properties.

2. In the left-side navigation, select Health.

3. Click Driver Health Job to open the Job dialog box. Select the appropriate job, then click OK.

   Follow the prompts to import the configuration file for the Driver Health job. Refer to the following information for details:

   • Where to place the driver: Place the job in the same driver set as the driver. The correct driver set is selected by default. You can only have one Driver Health job per driver set.

   • Import a configuration: Import the configuration from the server. In the Show field, select Identity Manager 4.7 configurations, then select the Driver Health job in the Configurations field.

   • Email server: Select the e-mail server that you want used for any actions that initiate e-mail. If you have not defined additional e-mail servers, select the Default Notification Collection server.

   • Servers: If the driver set is associated with only one server, that server is selected and cannot be changed. If the driver set is associated with multiple servers, select the server where you want to run the job.

1. In the Modeler or Outline view, right-click the driver where you want to modify the health check configuration, then select Properties.

2. In the left-side navigation, select Health.

3. Select the state tab (Green or Yellow) that you want to modify.

   

   The tab displays the current actions for the health state. If no action is assigned, the Driver Health Configuration displays Define new action here in the Actions tab.

4. Select the Actions tab, then click Append Action to add an action to the health state.

5. Select an action from the drop-down list.The table below describes the actions that the Driver Health job can perform.

   Some actions require additional information before they will execute.

   Action	Description
   Clear Driver Cache	Removes all transactions, including unprocessed transactions, from the cache.
   Execute ECMAScript	Executes an existing ECMAScript. Specify the DirXML-Resource object that contains the ECMAScript.
   Generate Event	Generates an event that can be used by NetIQ Sentinel and the Identity Reporting Module.
   On Error	If an action fails, this action tells Designer what to do with the remaining actions, the current health state, and the Driver Health job.
   Restart Driver	Restarts the driver (stop, then start)
   Send Email	Sends an e-mail to one or more recipients. The template you want used in the e-mail message body must already exist.
   Start Driver	Starts the driver.
   Start Workflow	Starts a provisioning workflow. For more information about the Start Workflow action, see Start Workflow in the NetIQ Identity Manager - Using Designer to Create Policies Guide.
   Stop Driver	Stops the driver.
   Write Trace Message	Writes a message to the Driver Health job's log file or the driver set's log file if the trace file is not configured on the Driver Health job.

6. Click Apply to save your changes without closing the Properties page., or click OK to save the changes and close the Properties page.

1. In the Modeler or Outline view, right-click the driver where you want to create a custom state, then select Properties.

2. In the left-side navigation, select Health.

3. Select the drop-down menu , then select New Custom State.

   

4. Define the conditions and actions for the custom state, then click Apply to save the changes without closing the Properties page, or click OK to save the changes and close the Properties page.

   For information about defining state conditions, see Modifying the Health State Conditions. For information about defining state actions, see Modifying the Health State Actions.

1. In the Modeler or Outline view, open the driver set object where the driver health job is stored.

2. Right-click the appropriate job object, then select Edit.

3. Change the desired settings on the following tabs, then click OK to save your changes:

   Tab	Description
   Schedule	The Driver Health job is a continuously running job, meaning that it does not stop unless a health state action shuts it down or you shut it down manually. The job must run continuously to be able to support transaction data collection for use in Transactions History conditions. If the job does stop, it is restarted based on the schedule. The default schedule checks every minute to see if the job is running. If the job is not running, it is started.
   Scope	By default, the job applies to all drivers in the driver set. This means that you only need one Driver Health job per driver set. However, you can create multiple Driver Health jobs for different drivers within the same driver set. For example, you might have some drivers whose health you want updated more frequently than other drivers, in which case you would need at least two Driver Health jobs.
   Parameters	You can change any of the following job parameters: Login ID: This defaults to the login ID that was used when creating the driver job. You should only change this if you want the driver to authenticate using different credentials. Login password: This is the password required for the login ID that you supplied in the Login ID field. Polling interval: Determines how often the job evaluates the conditions for the health states, assigns the driver the appropriate state, executes any actions associated with the assigned state, and stores the driver’s transaction data. The default polling interval is one minute. Polling interval units: Specifies the time unit (minutes, hours, days, weeks) for the number specified in the Polling interval setting. Duration transaction data is kept: Specifies how long a driver’s transaction data is kept. The default retains a transaction for two weeks before being deleted. Longer transaction durations require more memory. For example, to store transaction data for one driver every minute (Polling interval) for two weeks requires approximately 15 MB of memory. Duration units: Specifies the time unit (minutes, hours, days, weeks) for the number specified in the Duration transaction data is kept setting.

1. On the Reciprocal Attributes page, click New Attribute .

2. In the new attribute entry, select the desired attribute from the drop-down list, then click OK.

   

3. Specify the details of the reciprocal mapping, then click OK.

   

   Source Class	Specifies the class name to which the attribute in the mapping list is associated. For example, if you placed the Group Membership attribute in the reciprocal mapping list, the associated Source Class is User.
   Destination Class	Specifies the class name associated with the attribute to which you want to create a reciprocal mapping.
   Reciprocal Attribute	Specifies the attribute name to which you want to create a reciprocal mapping.

1. In the reciprocal mapping list, select the reciprocal mapping you want to remove.

   When the mapping is selected, the attribute name in the Attribute tab is highlighted.

   

2. Click Delete .

1. Select the attribute you want to remove by selecting it in the reciprocal mapping list.

   When selected, the attribute name in the Attribute tab is highlighted.

   

2. Click Delete .

   To remove all attributes from the reciprocal attribute mapping list, click Clear All Attribute Mappings .