Event Procedures

Adding Jobs and Job Groups to Job Events

You can link any number of jobs or job groups to a job event.

To add a job/job group to a job event:

  1. Click one of the defined job events in the Job Events pane.

  1. Double-click the job event to edit from the Job Events pane, or right-click the job event and click Edit Event from the context menu, or select the job event and click Edit on the TA toolbar to display the Job Event Definition dialog.

  1. Click the Associated Job(s) tab.

  1. The drop-down arrow button lists all the jobs you own and that are owned by workgroup to which you belong.

  1. Click the job(s) and job group(s) you want to associate to this job event and click Add.

Associating Actions to Events

You can associate any number of actions to an event. However, if you are using a job control action type (Job events only), then only one job control can be associated (or combined with the other action types) at any time. When the event trigger occurs, all the actions that are associated with the event will occur.

To associate actions to events:

  1. Click Definitions > Events on the Navigation pane to display the Events pane.

  1. Double-click the event or right-click the event and click Edit Event from the context menu, or select the event and click Edit on the TA toolbar to display the Event Definition dialog.

  2. Click the Associated Action(s) tab.

  1. Click the Available Action(s) field, and then choose the action(s) to associate with the event.

Note: You can choose the actions and then use left arrow(<). To choose more than one action at the same time, hold down the Shift key or the Ctrl key on your keyboard while clicking your selections, then click left arrow.

Job control actions are displayed in the Available Actions field if you are working on a Job event.

Note: It is possible to create an infinite loop that continually submits jobs if you assign a new job action that inserts a job that is also listed in the Associated job(s) tab.

Changing the Ownership of Events

To change the ownership of an event:

  1. Click Definitions > Events on the Navigation pane to display the Events pane.

  1. Double-click the event to edit from the Events pane or right-click the event and click Edit Event from the context menu, or select the event and click Edit on the TA toolbar to display its Event Definition dialog.

  1. Click the drop-down menu in the Owner field, and then choose a new owner of the event.

Creating a Job Event

You can create a job event that connects an event trigger to one or more actions. You can link jobs or job groups to job events at any time either from the Job Event Definition dialog or the Job Definition or Job Group Definition dialogs. Actions are associated with a job event only from the Job Event Definition dialog.

To create a job event:

  1. Click Definitions > Events > Job Events on the Navigation pane to display the Job Events pane.

  1. Click Add or right-click and select Add Event from the context menu to display the Job Event Definition dialog.

  1. Type a name for the job event (up to 30 characters) in the Event Name field.

    • If you do not want to own this job event, select another user or workgroup from the drop-down menu in the Owner field.

    • If you want this job event to be associated with all jobs, select the Apply this event to all jobs option; otherwise, you must click the Associated Jobs tab to select a job(s) to associated with the event.

    • If you want the event to be public, select the Public option. Note that if an event is public, all users of TA with the appropriate security policy have access to that job event.

    • If you want to define the event now, but you are not ready to have it triggered, clear the Enabled option

Defining an Email Monitor

To define an email monitor:

  1. Click Definitions > Events > Email Events on the Navigation pane to display the Email Events pane.

  1. Click the Email Events pane, right-click and choose the Add Event option from the context menu, to display the Email Event Definition dialog.

  2. Enter a name for the email event in the Event Name field.

    Note: By default, the user defining the event is the owner but you can select one of the other listed users from the drop-down menu as the owner.

  1. Choose a connection to an Exchange server in the Email Connection field. The connection must be already defined before it will appear in the drop-down list.

  2. Click the Folder field, and then enter the name of the mail account to be monitored.

  1. Click the Conditions section, designate what text is to be considered an event when it is detected.

  1. Click Insert to add a line to the Conditions section.

    1. In the Scan for Text column, enter a text string that the monitor will scan for in the email going to the designated mail account.

    2. In the In column, select from the drop-down list where in the email that the monitor should look for the text.

    3. In the Case Sensitive column, designate whether the text match is dependent upon case.

    4. In the Disposition section, choose what will occur once the monitor detects the specified text. From the drop-down list in the Operation field, choose an option. If you select the Move message to folder option, in the Target field, enter the pathname to the folder where you want the message stored.

    5. If you want to access the message text from within TA, select the Return message body to Scheduler option.

Defining a Variable Monitor

To define a variable monitor:

  1. Click Definitions > Events > Email Events on the Navigation pane to display the Email Events pane.

  1. Click the Email Events pane, right-click and choose the Add Event option from the context menu, to display the Email Event Definition dialog.

  2. Enter a name for the email event in the Event Name field.

    Note: By default, the user defining the event is the Owner but you can select one of the other listed users from the drop-down menu as the owner.

  1. Choose the Master that owns the variable in the Master field.

  1. Choose the variable to be monitored in the Variable Name field.

  1. Click the Operator field, choose the operator to be used with the specified value.

  1. Click the Value field, specify the value that the variable needs.

    If defining an interMaster variable so that the monitor will watch for a variable published from another Master, select the Variable option and specify the Master and the Variable Name.

Defining a File Monitor

To define a file monitor:

  1. Click Definitions > Events > File Events on the Navigation pane to display the File Events pane.

  1. Click Add from the File Events pane to display the File Event Definition dialog.

  1. Enter a name for the email event in the Event Name field.

    Note: By default, the user defining the event is the Owner. You can also select any other user from the dropdown list as the owner.

  1. Click the Agent Name field, enter or select the name of the agent that processes the file.

  1. Click the Directory field, enter the path to the directory to be monitored for the file.

  1. Click the File Mask field, enter a file mask using wild card characters.

    Note: If needed, you can configure the monitor to delay its response or to only respond after the designated file is stable for a stated interval of time or reaches a certain size.

  1. Specify in the Disposition section what should be done with the file when it meets the monitor’s criteria.

  1. Click the Operation field, either delete the file or move it to another directory that is designated in the Target field.

    Note: If needed, select the Return file contents as output option to include the file’s contents as part of the job output.

Configuring the Schedule Tab on an Event Monitor

Whenever an event monitor is defined, it must be configured to watch for the defined event criteria at the crucial times. This is done by scheduling when the monitor should be active.

To configure the Schedule tab:

  1. Click the Schedule tab in the event being defined.

  1. Choose and configure a calendar as needed in the Calendar section, .

  1. If you want to restrict how often events can be triggered:

    Select the Trigger Constraints option and configure how often the event can be triggered within a designated interval:

    • Set the maximum number of occurrences using Trigger maximum of.

    • Set the number of minutes as the maximum threshold in occurrences in minutes.

    • Optionally, select the Ignore occurrences that exceed the limit option to ignore occurrences that exceed the specified maximum.

    Note: The trigger constraints apply to all time periods.

  1. If you want the event monitor to operate only during certain periods of the day, select the Time window option and specify the time periods as described below. Otherwise, the event monitor operates all of the time.

  2. Click Insert to create a row in the Time window field.

    • Enter a starting time in the From Time column and an ending time in the Until Time column.

    • Create as many time windows as needed.

Deleting an Event

You can delete an event that is no longer in use. When you delete an event, the job event is removed from the jobs and job groups associated with it.

To delete an event:

  1. Click Definitions > Events > Job Events on the Navigation pane to display the Job Events pane.

  1. Click the job event to delete and press the DELETE key on your keyboard or click Delete on the TA toolbar or right-click the job event and select Delete Event from the context menu.

  2. Click OK in the confirmation dialog to delete the job event.

Removing Actions from Events

To remove an action from an event:

  1. Click an event in the Events pane.

  1. Open the event definition by double-clicking the event or right-click the event and select Edit Event from the context menu, or select the event and click Edit on the TA toolbar to display the its Event Definition dialog.

  1. Click the Associated Action(s) tab.

  1. Click the Selected Actions(s) field, select the action(s) to remove from the job event, and click right arrow ( > ).

Removing Jobs/Job Groups from Job Events

To remove a job or job group from a job event:

  1. Click Definitions > Events > Job Events on the Navigation pane to display the Job Events pane.

  1. Double-click the job event to edit from the Job Events pane or right-click the job event and click Edit Event from the context menu, or click the job event and click Edit on the TA toolbar to display the Job Event Definition dialog.

  2. Click the Associated Job(s) tab.

  1. Click the Associate Job(s) field.

  2. Click the job(s)/job group(s) to disassociate from the job event.

  3. Click Remove.

Viewing Events

You can view all the events available to you according to your security policy and all public events in the Events pane. You can also view the job events for a job from the Job Events tab of the Job Definition and Job Group Definition dialogs.

Click Definitions > Events > Job Events on the Navigation pane to display the Job Events pane.

Viewing Jobs and Groups Associated With a Job Event

To view a job or job group associated with a job event:

  1. Click Definitions > Events > Job Events on the Navigation pane to display the Job Events pane.

  1. Double-click the desired job event from the Job Events pane, or click Edit on the TA toolbar to display the Job Event Definition dialog.

  2. Click the Associated Job(s) tab to display the jobs and job groups associated with the job event.

Viewing Job Events Associated With a Job or Job Group

To view a job event associated with a job or job group:

  1. Click Definitions > Jobs on the Navigation pane to display the Jobs pane.

  1. Double-click the desired job or job group or right-click and select Edit Job/Group from the context menu to display its Job Definition (or Job Group Definition) dialog.

  1. Click the Job Events tab to display all job events associated with the job or job group.