The Administration and Monitoring Console 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 replaces Fail-over Service (FOS) functionality.
See the following links for information on Action Manager configurable actions and attributes.
You must start the Action Manager. See the IBM Tivoli Directory 7.1.1 Administration Guide for information on how to start the Action Manager.
Use this window to select the Solution View for which you want to Add, Modify, or Delete Action Manager actions.
Configured rules are displayed in a table. See Using tables for instructions on how to use the paging, sorting, filtering, exporting, and find utilities associated with IBM Tivoli Directory Integrator Administration and Monitoring Console tables.
You can find more detailed help on the following elements of this window:
Use this window 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. The trigger and associated actions that you configure for the trigger make up a rule.
AssemblyLine (On Start and On Stop AssemblyLine)
Interval (Time since last execution)
Unit (Time since last execution)
Inspect Error Object (Inspect AssemblyLine exit code)
Attribute (Inspect AssemblyLine exit code)
Condition (Inspect AssemblyLine exit code)
Value (Inspect AssemblyLine exit code)
Event type (On received event)
Polling Interval (On property)
Polling Interval (On Server API Failure)
Unit Config to load Config to unload On AssemblyLine start On local variable Local variable value Configured Actions
The On Local Variable rule is triggered when the specified variables meets the specified condition. The Action Manager checks for this property from time to time.
NOTE: This rule gets triggered only once, and gets reset back to ready state only when the Action Manager detects that this variable does not meet the specified criteria any longer. One time triggering is used so that the rule does not repeatedly get triggered for a single occurrence of the triggering condition.
Type the variable value for the Local Variable.
Use this field to specify the number for the units of time that the Action Manager allows to elapse between polling actions.
Use this field to specify the type of measurement you want to use for the polling interval. Possible units of measure include:
Use this menu to select the configuration file to load on the server. Loading the config allows users to add Action Manager rules to the Config.
Use this menu to select the configuration file to unload from the server. Unloading the Config means that you cannot make changes to the Config using the Action Manager until you reload it.
Use this trigger type to begin an action when the selected AssemblyLine starts.
Type the name you want to give to this rule.
Type an optional description of the rule.
Use a trigger type to define the conditions under which a rule is invoked.
The Action Manager executes according to defined rules. A rule consists of a trigger and associated actions. Use the Add rule window to specify the:
To configure the trigger completely, you must supply values for certain other parameters that are dependent on the selected trigger type. Each trigger type requires values for parameters that are unique to it.
For example, if you have selected On AssemblyLine Termination as the trigger for the rule you are adding or editing, you must specify which AssemblyLine and when it terminates to trigger the rule.
You can select from the following triggers. Each trigger is accompanied by a definition:
Select a trigger type:
NOTE: This rule gets triggered only once, and gets reset to ready state only when the Action Manager detects that this variable does not meet the specified criteria any longer. One time triggering is used so that the rule does not repeatedly get triggered for a single occurrence of the triggering condition.
The default trigger is NO Trigger.
Select the AssemblyLine you want to monitor.
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.
For Interval, type a numeric value specifying how many seconds, minutes, hours or days can elapse before triggering the rule.
For unit, select the time interval type from the list.
Select from the list whether the period of time in the Interval field is to be measured in seconds, minutes, hours or days. For trigger: Time since last execution.
If, however, the value field is empty, the Action Manager triggers the rule without searching the AssemblyLine result. The Action Manager triggers the rule for every abnormal termination of the AssemblyLine.
When Inspect Error Object is not checked, the Action Manager waits for the AssemblyLine to terminate and inspects the exit code for the Value you have entered in the Attribute field.
For trigger: Inspect AssemblyLine exit code
When your trigger is Inspect AssemblyLine exit code:
For trigger: Inspect AssemblyLine exit code.
When your trigger is Inspect AssemblyLine exit code:
Possible options for Condition are:
Allows the Action Manager to search the error object for a user-defined (string) for Value on the Inspect AssemblyLine exit code trigger.
The Inspect AssemblyLine exit code trigger works in two modes:
Enter the event type you want to monitor.
Enter the source you want to compare.
Type the data name you want to compare.
Select the property name you want to compare.
Select the condition you want to use to compare the property and value. Possible options are:
Type the value you want to compare.
For trigger: (On property).
This is the number for the units of time that the Action Manager allows to elapse between polling actions.
For trigger: (On property).
This unit qualifies the Polling Interval. Possible values are:
For trigger: (On server API failure).
This is the number for the units of time that the Action Manager allows to elapse between polling actions.
For trigger: (On server API failure).
Possible values are:
The Configured Actions table contains a list of actions associated with the rule. From this window you can Add, Modify, or Delete actions. Using Move Up and Move Down, you can 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, exporting, and finding utilities associated with Tivoli Directory Integrator Administration and Monitoring Console tables.
The following sections contain information about the Configured Actions table columns and how to perform operations on configured actions.
The Configured rules table contains the following columns:
When actions fail, Administration and Monitoring Console populates Action Manager local variables with error information. The Administration and Monitoring Console and Action Manager provide the means for making the action error available in the various actions. At any point in time, if an error occurs while executing any of the configured actions, this error becomes available to the users in the form of special reserved variables. You can then use these reserved variables in other actions you have configured. In any action being executed, such as
From this table you can Add, Modify, or Delete 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 use 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:
Modify - To modify an action, select the action you want to change 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:
Confirm the values you entered, and click OK to continue.
Closes the window. Values are not saved.
In the blue title bar of the window you are working with, on the right side of the title bar, there is a question mark ? symbol. When you click the question mark, context sensitive help appears. The help displays more details on the elements of the window.
When a rule is triggered, the Action Manager executes the actions associated with the rule. This window allows you to select 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 the action you want for the trigger you have added. Select from the following list.
Configure the settings of the action. The available settings depend on the selected action type.
Add the configured action to the current Action Manager rule.
Closes the window. Values are not saved.
Displays more details on the elements of the window.
When you click View Rules Summary, a table appears, listing the rules and some details for the selected Solution View. There are three columns in the table, Rule, Trigger, and Action.
This window shows the current Action Manager for the selected AssemblyLine. The table lists all the defined rules, triggers and actions associated with the Solution View.
Closes the window.
Displays more details on the elements of the window.
This window allows you to select the Config for which you want to Add, Modify, or Delete rules. 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 the Solution View. Rules associated with the selected Config display.
When you click View Rules Summary, a new window opens, showing a table that lists rules, triggers and actions that have been configured for the selected AssemblyLine.
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.
The Configured rules table contains the following columns:
Closes the window.
Displays more details on the elements of the window.
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:
Select from remote config folder
Select the server where the Config and AssemblyLine(s) are stored. The server you select runs the AssemblyLine you specify.
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 the api.config.folder property in the global.properties file.
Select the Config name from the list.
Type the name of the Config. This edit box is only available when the Select from remote Config folder is not checked.
Type the password for the Config. This field is only applicable if the Config is password protected.
Type the name of the AssemblyLine you want to run.
When you select Configure AssemblyLine operation, the select Operation window opens, providing a list of operations from which you can select. The Configure AssemblyLine operation link allows you to specify the AssemblyLine operation with which to start the chosen AssemblyLine.
Shows the chosen AssemblyLine Operation for starting the AssemblyLine. The chosen AssemblyLine Operation can be modified by clicking the Configure AssemblyLine Operation link. The label is only shown if configured on the server and is not applicable on Tivoli Directory Integrator version 6.0.
Confirm the values you entered, and click OK to continue.
Closes the window. Values are not saved.
Displays more details on the elements of the window.
This window allows you to stop an AssemblyLine by selecting an action on the Select Action Window. To add this action to the rule, select Stop AssemblyLine. If you select this action, you must specify the name of the 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
Select the server from the menu. The server you select will stop the AssemblyLine you specify.
If you want to select your Config from a remote folder, choose the config you want from the list. When you select the box, a list of Configs appears. The list displays the Config files present in the folder whose path is given for the api.config.folder property in the global.properties file.
Type the Config you want from the list.
Type the name of the Config that contains the AssemblyLine you want to stop.
Type the name of the AssemblyLine that you want to stop.
Confirm the values you entered, and click OK to continue.
Closes the window. Values are not saved.
Displays more details on the elements of the window.
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:
Select the source property from which you want to copy values.
Select the destination property to which you want to copy values.
Confirm the values you entered, and click OK to continue.
Closes the window. Values are not saved.
Displays more details on the elements of the window.
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 the Administration and Monitoring Console, and can be seen in the Solution View Details window. 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 Solution View Details window.
You can find more detailed help on the following elements of this window:
Select the severity condition under which a message will be written to the log. The available severity types are: Severe, Info, Warning, Fine.
Type the content for the message that you want to write to the log.
Type a description for the log condition.
Confirm the values you entered, and click OK to continue.
Closes the window. Values are not saved.
Displays more details on the elements of the window.
Add/Edit 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 Solution 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:
Type an event type. This field is required.
Type a source for the event type.
Type data for the event type.
Confirm the values you entered, and click OK to continue.
Closes the window. Values are not saved.
Displays more details on the elements of the window.
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:
Select the property you want to modify.
Select the operation you want to use to modify a property. Possible options are:
Type the desired value. This is a required field.
Confirm the values you entered, and click OK to continue.
Closes the window. Values are not saved.
Displays more details on the elements of the window.
Select Enable/Disable Rule from the list of actions to enable or disable an Action Manager rule. This window allows you to select a pair made up of a rule name and a Solution View name. The pair that comprises the rule combined with the Solution View becomes a new action. Once you have selected the rule paired with a Solution View, the Action Manager can carry out the new action.
You can find more detailed help on the following elements of this window:
Select the rule -- Solution View pair that you want the Enable/Disable rule action to execute.
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 rule selections.
Confirm the values you entered, and click OK to continue.
Closes the window. Values are not saved.
Displays more details on the elements of the window.
This window allows you to select a pair made up of a rule name and a Solution View name. The pair that comprises the rule combined with the Solution View becomes a new action. Once you have selected the rule paired with a Solution View, the Action Manager can carry out the new action.
You can find more detailed help on the following elements of this window:
Associate Solution View with Rule when creating Execute rule action. Select the rule -- Solution View pair that you want the Execute rule action to execute.
Confirm the values you entered, and click OK to continue.
Closes the window. Values are not saved.
Displays more details on the elements of the window.
Action Manager triggers and actions provide support for "local" variables that can be set or incremented using rules and actions. Local variables can also be used as triggering conditions for other rules. Select a Solution View and click Local Variables to launch the Local Variables window. In the Local Variables window, select a Local Variable to manage, and then click Add, Modify, or Delete
.You can find more detailed help on the following elements of this window:
Displays the name for the Local variable. This is a read-only field.
Specify the operation that is to be performed on the value you have assigned to the variable. Available operations that you can perform on a variable value include set, increment and decrement.
Type the initial value for the Local Variable.
Confirm the values you entered, and click OK to continue.
Closes the window. Values are not saved.
Displays more details on the elements of the window.
Use this window to configure an action to send email when a certain trigger occurs.
You can find more detailed help on the following elements of this window:
Type the email address of the person who is to receive the email.
Type your email address (the address of the sender).
Type the topic that is to make up the subject line of the email. Any event data specified by %Event_Data% or error data specified by %Action_Error% is also inserted into the subject line.
Select this option if you want to attach the Action Manager logs to this email.
Type your message. Sets the content of the mail. Along with the content, other details about execution of the action are appended by the Action Manager before sending the mail. You can specify the variable %EVENT_DATA% value in this textbox. Specifying %EventData% in the content inserts the actual value of the Eventdata variable when the mail is sent. %Action_Error% can similarly be substituted here.
Confirm the values you entered, and click OK to continue.
Closes the window. Values are not saved.
Displays more details on the elements of the window.
The Execute Command action can execute the command entered in the Command field on the target computer specified under Target computer Name. The command can be any generic command or a Tivoli Directory Integrator specific command. The Execute Command can be used when a user configures a rule to execute commands that are specific to the target computer or to execute Tivoli Directory Integrator commands that are not exposed by the Administration and Monitoring Console. For example, in the Administration and Monitoring Console we do not have actions that can restart a server or load a config. The user has to perform the restart or reload commands using either the Tivoli Directory Integrator Servers or Load/reload windows. If any error occurs while executing the command, it is captured in the %ACTION_ERROR% variable, which can be further used by the Action Manager.
You can find more detailed help on the following elements of this window:
Name or IP address of the target computer. Action Manager connects to the computer specified in this field. If neither a computer hostname nor an IP address is specified, the command executes on the computer where the Action Manager is running.
Port specifies the channel over which the Action Manager can connect to the target computer where the command is to be executed.
The user name is verified for authentication and authorization when establishing a connection with the target computer.
The password is verified for authentication and authorization when establishing a connection with the target computer.
Keystore path is entered and used in case certificate authentication is required when connecting to the target computer.
Keystore password is required when certificate authentication is mandatory for connection to the target computer.
The protocol that is to be used for establishing a connection with the remote machine. Protocol can have the following values, WINDOWS, RSH, SSH OR REXEC (Windows, remote shell, secure shell, or remote execution protocols).
Command that is to be executed.
Confirm the values you entered, and click OK to continue.
Closes the window. Values are not saved.
Displays more details on the elements of the window.