Add Rule

The Action Manager is a stand-alone Java program that allows you to monitor AssemblyLine execution using rules. It also allows you to define alternate actions to be performed upon detection of certain events and scenarios. The Action Manager (AM) replaces Fail-over Service functionality.

The Action Manager must be started. See the IBM Tivoli Directory 6.1.1 Administration Guide for information on how to start the Action Manager.

This window allows you to select the Config View containing the AssemblyLine you want to monitor, and add, delete and edit Action Manager rules.

Configured monitoring rules are displayed in a table. See "Using tables" for instructions on how to use the paging, sorting, filtering and find utilities associated with IBM Tivoli Directory Integrator Administration and Monitoring Console (AMC) tables.

You can find more detailed help on the following elements of this window:

This window allows you to add a trigger to your current configuration and associate actions to each trigger. Depending on what is appropriate for the trigger you are configuring, you can associate actions to a particular trigger.

Name

Description

Trigger type

AssemblyLine

Not run since

Unit

Attribute (On query AL result)

Condition (On query AL result)

Value (On query AL result)

Event type (On received event)

Source (On received event)

Data (On received event)

Property name

Condition (On property)

Value (On property)

Configured Actions

OK

Cancel

Help



Name

Enter an optional description of the rule. Enter the name you want to give to this rule.



Description

Enter an optional description of the rule.



Trigger type

The trigger type defines the conditions under which a rule is invoked.

Select a trigger type:

No trigger
Rule has no triggering condition.

On AL termination
Rule is triggered when the selected AssemblyLine is terminated.

Time since last execution
Rule is triggered when the selected AssemblyLine has not run for the determined period of time.

On query AL result
Rule is triggered when the last work entry of the selected AssemblyLine contains an attribute matching a given condition and value.

On server API failure
Rule is triggered when the Action Manager is unable to connect to the remote server using the Server API. This rule is triggered only once. The rule resets when it detects that it can reconnect to the server using the Server API.

On received event
Rule is triggered when the Action Manager receives an event that meets the criteria specified in the Event type, Event source and Event data fields.

On property
Rule is triggered when the property meets the determined Property name, Condition and Value specifications.

The default trigger is NO Trigger.



AssemblyLine

Select the AssemblyLine you want to monitor.



Not run since

Enter a numeric value specifying how many seconds, minutes, hours or days can elapse before triggering the rule.

This field is specific to the Time since last execution trigger type, which is triggered when the selected AssemblyLine has not run for the specified period of time. If the selected AssemblyLine does not run for the time period you specify in this field, the rule will be triggered.



Unit

Specify whether the period of time in the Not run since field will be measured in seconds, minutes, hours or days. For trigger: Time since last execution.



Attribute (On query AL result)

Enter the name of attribute you want to compare. For trigger: On query AL result.



Condition (On query AL result)

Select the condition you want to use to compare the attribute and value. For trigger: On query AL result. Possible options are:



Value (On query AL result)

Enter the value you want to compare. For trigger: On query AL result.



Event type (On received event)

Enter the event type you want to monitor.



Source (On received event)

Enter the source you want to compare.



Data (On received event)

Enter the data name you want to compare.



Property name (On property)

Select the property name you want to compare.



Condition (On property)

Select the condition you want to use to compare the property and value. Possible options are:



Value (On property)

Enter the value you want to compare.



Configured Actions table

The Configured Actions table contains a list of actions associated with the rule. From this window you can add, edit and delete actions. You can also move actions up and down in the table.

Configured actions are displayed in a table. See "Using tables" for instructions on how to use the paging, sorting, filtering and find utilities associated with IBM Tivoli Directory Integrator Administration and Monitoring Console tables.

Configured actions table

The following sections contain information about the Configured actions table columns and how to perform operations on configured actions.

Columns

The Configured rules table contains the following columns:

Select
Select the action on which you want to perform an operation.

Action
Displays the name of the action.

Performing configured rules operations

From this table you can add, delete and edit actions. You can also move actions up and down in the table. You can choose the operations you want to perform from the tool bar at the top of the table or using the Select action menu, such as:

Add - To add an action, select the action you want to add and perform one of the following actions:

Delete - To delete an action, select the action you want to delete and perform one of the following actions:

Edit - To edit an action, select the action you want to modify and perform one of the following actions:

Move up - To move an action up one position in the table, select the action you want to move and perform one of the following actions:

Move down - To move an action down one position in the table, select the action you want to move and perform one of the following actions:



OK

Confirm the values you entered, and click OK to continue.



Cancel

Closes the window. Values are not saved.



Help

Displays more details on the elements of the window.



Select Action

Add/Edit Action

When a rule is triggered, the Action Manager executes the actions associated with the rule. This window allows you to specify the actions you want Action Manager to take when the rule is triggered.

You can find more detailed help on the following elements of this window:

Select action type

Next >>

Cancel

Help



Select action type

Select the action you want for the trigger you have added. Select from the following list and click Next >>.

  • Start AssemblyLine
  • Stop AssemblyLine
  • Enable/Disable AM Rule
  • Execute AM rule
  • Notify event
  • Modify TDI property
  • Copy TDI property value
  • Write to log


  • Next >>

    Takes you to the next screen required by the response you have entered.



    Cancel

    Closes the window. Values are not saved.



    Help

    Displays more details on the elements of the window.



    Rule table

    This window shows the current Action Manager configuration for the selected AssemblyLine. The table lists all the defined rules, triggers and actions associated with the Config View.



    Close

    Closes the window.



    Help

    Displays more details on the elements of the window.



    AM Configuration

    This window allows you to select the Config for which you want to Add, Delete, or Edit a rule. You can also select to view details about the current configuration.

    You can find more detailed help on the following elements of this window:

    Select config views

    View current configuration

    Configured rules

    Close

    Help



    Select config views

    Select the Config View. Rules associated with the selected Config will display.



    View current configuration

    When you click View current configuration, a new window opens, showing a table that lists rules, triggers and actions that have been configured for the selected AssemblyLine.



    Configured rules

    The Configured rules table displays the existing Action Manager rules for the selected Config and AssemblyLine. The following sections contain information about the Configured rules table columns and how to perform operations on configured rules.

    Columns

    The Configured rules table contains the following columns:

    Select
    Select the rule on which you want to perform an action.

    Rule
    Displays the name of the rule. Rule names are created by the administrator on the "Add..." and "Edit..." windows.

    Status
    Displays whether the rule is enabled or disabled.

    Last triggered
    Displays the time the rule was last invoked.



    Close

    Closes the window.



    Help

    Displays more details on the elements of the window.



    Add Action - Start AssemblyLine

    This window allows you to provide details about the Config from which you will run the AssemblyLine.

    You can find more detailed help on the following elements of this window:

    Server

    Select from remote config folder

    Config name (Select)

    Config name (Enter)

    Config password

    AssemblyLine

    Configure AL operation

    ChosenOperationLabel

    OK

    Cancel

    Help



    Server

    Select the server. The server you select will run the AssemblyLine you specify.



    Select from remote config folder

    If you want to select a Config from the remote config folder, select the Config you want from the list. The list displays the Config files present in the folder whose path is given for api.config.folder property in global.properties file.



    Config name (Select)

    Select the Config name from the list.


    Config name (Enter)

    Enter the name of the Config. This edit box is only available when the Select from remote Config folder is not checked.



    Config password

    Enter the password for the Config.This field is only applicable if the Config is password protected.



    AssemblyLine

    Enter the name of the AssemblyLine you want to run.



    Configure AL operation

    When you select Configure AL operation, Select Operation window opens, providing a list of operations from which you can select. The Configure AL operation link allows you to specify the AL operation with which to start the chosen AssemblyLine.



    ChosenOperationLabel

    Shows the chosen AL Operation for starting the AssemblyLine. The chosen AL Operation can be modified by clicking the Configure AL Operation link. The label is only shown if configured on the server and is not applicable on TDI 6.0.



    OK

    Confirm the values you entered, and click OK to continue.



    Cancel

    Closes the window. Values are not saved.



    Help

    Displays more details on the elements of the window.



    Add Action - Stop AssemblyLine

    This window allows you to stop an AssemblyLine. To add this action to the rule, select Stop AssemblyLine. If you select this action, you must specify the name of AssemblyLine you want to stop and its associated Config.

    You can find more detailed help on the following elements of this window:

    Select config from remote folder

    Server

    Config name (Select)

    Config name (Enter)

    AssemblyLine

    OK

    Cancel

    Help



    Server

    Select the server from the menu. The server you select will stop the AssemblyLine you specify.



    Select config from remote folder

    If you want to select your Config from a remote folder, choose the config you want from the list. When you check the box, a list of Configs appears. The list displays the Config files present in the folder whose path is given for api.config.folder property in global.properties file.



    Config name (Select)

    Select the Config you want from the list.



    Config name (Enter)

    Enter the name of the Config that contains the AssemblyLine you want to stop.



    AssemblyLine

    Enter the name of the AssemblyLine that you want to stop.



    OK

    Confirm the values you entered, and click OK to continue.



    Cancel

    Closes the window. Values are not saved.



    Help

    Displays more details on the elements of the window.



    Add Action - Copy TDI Property Value

    This window allows you to copy the value of the "From" property to the value of the "To" property.

    You can find more detailed help on the following elements of this window:

    From property

    To property

    OK

    Cancel

    Help



    From property

    Select the source property from which you want to copy values.



    To property

    Select the destination property to which you want to copy values.



    OK

    Confirm the values you entered, and click OK to continue.



    Cancel

    Closes the window. Values are not saved.



    Help

    Displays more details on the elements of the window.



    Add Action - Write To Log

    This windows allows you to configure a log message that is written to the log after the trigger condition for your rule is satisfied. These logs are also written to AMC, and can be seen in the Config View Details window in AMC. It is recommended to specify at least one Write To Log action for each rule, so that the rule details can be seen in the Config View Details window.

    You can find more detailed help on the following elements of this window:

    Severity

    Message

    Description

    OK

    Cancel

    Help



    Severity

    Select the severity condition under which a message will be written to the log. The available severity types are: Severe, Info, Warning, Fine.



    Message

    Enter the content for the message that you want to write to the log.



    Description

    Enter a description for the log condition.



    OK

    Confirm the values you entered, and click OK to continue.



    Cancel

    Closes the window. Values are not saved.



    Help

    Displays more details on the elements of the window.



    Add Action - Notify Event

    Add Action - Notify Event causes the Action Manager to send an event with its details to the IBM Tivoli Directory Integrator server associated with the current Config View. To add this action to the rule, select Notify event. If you select this action, you must also select an event type from Notify event.

    You can find more detailed help on the following elements of this window:

    Event type

    Source

    Data

    OK

    Cancel

    Help



    Event type

    Enter an event type. This field is required.



    Source

    Enter a source for the event type.



    Data

    Enter data for the event type.



    OK

    Confirm the values you entered, and click OK to continue.



    Cancel

    Closes the window. Values are not saved.



    Help

    Displays more details on the elements of the window.



    Add Action - Modify TDI Property

    This window allows you to use the Action Manager to modify a property based on a specific operation and value. To add this action to the rule, select Modify property. If you select this action, you must also choose a value.

    You can find more detailed help on the following elements of this window:

    Property name

    Operation

    Value

    OK

    Cancel

    Help



    Property name

    Select the property you want to modify.



    Operation

    Select the operation you want to use to modify a property. Possible options are:



    Value

    Enter the desired value. This is a required field.



    OK

    Confirm the values you entered, and click OK to continue.



    Cancel

    Closes the window. Values are not saved.



    Help

    Displays more details on the elements of the window.



    Add Action - Enable/Disable AM Rule

    Select Enable/Disable AM Rule from the list of actions to enable or disable an Action Manager rule.

    You can find more detailed help on the following elements of this window:

    Rule name

    State

    OK

    Cancel

    Help



    Rule name

    Select the name of the rule you want to enable or disable.



    State

    Select the state you want. If you want to enable the rule in the Rule name field, select Enable. If you want to disable the rule, then select Disable. Click the arrow to the right of the rule name to expose the Enable/Disable AM Rule selections.



    OK

    Confirm the values you entered, and click OK to continue.



    Cancel

    Closes the window. Values are not saved.



    Help

    Displays more details on the elements of the window.



    Add Action - Execute AM rule

    This window allows you to select actions that you associate with a rule. Action Manager then executes the actions associated with the selected rule. To add this action to the rule, select Execute AM rule from the list of actions.

    You can find more detailed help on the following elements of this window:

    Rule name

    OK

    Cancel

    Help



    Rule name

    Select the rule you want Execute AM rule to execute.



    OK

    Confirm the values you entered, and click OK to continue.



    Cancel

    Closes the window. Values are not saved.



    Help

    Displays more details on the elements of the window.