Defining and Managing End-of-Job (EOJ) Checking and Actions

Defining End-of-Job checking and actions means instructing Entire Operations what actions to trigger after a job has terminated. The triggered action is referred to as an End-of-Job action.

End-of-Job checking and actions consists of two steps:

1. Analysis of job results (determination of End-of-Job status);

2. Triggering of appropriate system actions.

The End-of-Job action depends on the status of the whole job or any other event which can be checked by Entire Operations on termination. The status of the job on termination is determined by the occurrence of certain events during job execution which Entire Operations can check.

Before Entire Operations can check for an event, it must be defined to the system, together with instructions as to the action to be triggered. If no events are specified, Entire Operations performs End-of-Job checking automatically using system defaults.

This document describes the End-of-Job (EOJ) checking functions used to check the job status on job completion and take appropriate action, if required.

• Events

• Event Check Method

• Possible End-of-Job Actions

• Displaying End-of-Job Events and Actions

• Adding and Modifying an Event Definition

• Deleting an Event Definition

• Operating System Dependent Defaults for Event Checking

• Creating and Viewing Online Documentation for Events

• Examples of Event Definitions

• Handling End-of-Job Actions

• End-of-Job Actions after Execution as a Temporary Dummy Job

• Defining Output Condition Actions

• Defining Actions for Symbol Value Modification

• Defining Actions for Modifying Job Variable Values

• Defining Action User Exits

• Defining Other Actions: Deactivate Job Automatically

• Defining Network and Job Activation Actions

• Defining Recovery Actions

• Defining SYSOUT Actions

• Defining Notification Messages

• Defining Release Actions for Kept Resources

Related Topics:

• Passing Files to Entire Output Management.

• For conceptual information, see Events and Actions: End-of-Job Checking in the Concepts and Facilities documentation.

Events

In the terminology of Entire Operations, an event is the occurrence of a defined situation which is recognized during the End-of-Job analysis. Entire Operations automatically triggers system action, depending on the occurrence of events during job processing.

If you do not specify any event, Entire Operations provides a default event expressed as job OK or job not OK, depending on whether a received condition code is greater or less than a default condition code, or, for BS2000, whether certain system messages are received.

Some examples of possible defined events are:

• Exit code of a UNIX job equals 2;

• STEP2 of JOB1 ends with a condition code greater than 8;

• No job step ends with a condition code greater than 0;

• A defined message appears in the job SYSOUT;

• A database or file contains or does not contain certain expected data;

• The result of a user exit (expressed by its return code).

• A job variable contains certain expected data (BS2000).

Event Check Method

Events are checked on a check OK/not OK basis. End-of-Job actions can be triggered by:

• the result of a single event check (for example, a job step checking in z/OS);

• the result of all End-of-Job checks (including the default checks), which always causes either the event job OK (All Checks ok) or job not OK (Any Check not ok) to occur.

Both of these event definitions are always predefined for every job.

In the latter case, you can define two sets of actions:

• one set is performed if all checks finished OK (All Checks ok, i.e., job OK);

• the other is performed if at least one check finished not OK (Any Check not ok, i.e., job not OK).

All Checks ok and Any Check not ok are mutually exclusive parameters to be checked.

All events can be combined as required. You can specify up to 30 different event checks for a job.

This section covers the following topics:

• End-of-Job Checks for Operating Systems and Job Types

• Job SYSOUT Check

• Retrying End-of-Job Checking

End-of-Job Checks for Operating Systems and Job Types

The following table provides an overview of the availability of End-of-Job checks for the supported operating systems and job types:

An asterisk (*) indicates that the End-of-Job check is available for the operating system or job type. These checks are described later in this section.

Job SYSOUT Check

• On z/OS: The job result check will be retried by the Monitor up to 10 times, when the message Job disappeared from Spool Queue appears.

  The wait interval between SYSOUT read attempts is constantly at least 30 seconds (not to be confused with the Monitor wait time, because it may be very short).

• On BS2000: Entire Operations can only check job SYSOUT if it is assigned to a file. JCL of jobs that are to run under Entire Operations control must therefore not contain SYSOUT assignments to *dummy, primary or to a temporary file, otherwise no End-of-Job checking is possible.

See also Defining SYSOUT Actions.

Retrying End-of-Job Checking

For the operating system z/OS the following applies:

• In case of incomplete SYSOUT, the SYSOUT reading will be retried 10 times, with intervals not shorter than 30 seconds. Interval can be longer if the monitor task wait time is longer.

Possible End-of-Job Actions

End-of-Job actions refer to all actions performed after termination of a job. These actions can be performed automatically by Entire Operations or manually by the user.

All End-of-Job actions can be defined for an event (job step) or at the job level.

For each of the user-specified or default events, you can define how Entire Operations is to act.

Possible End-of-Job actions are:

• Set/reset output conditions to continue the job flow.

  See Defining Output Condition Actions.

• Set/modify symbol values.

  See Defining Actions for Symbol Value Modification.

• Release resources held by a job.

  See Defining Release Actions for Kept Resources.

• Set/reset/modify job variables (BS2000 only).

  See Defining Actions for Modifying Job Variable Values.

• Execute End-of-Job action user exits.

  See Defining Action User Exits.

• Deactivate job.

  See Defining Other Actions: Deactivate Job Automatically.

• Activate other job networks or single jobs.

  See Defining Network and Job Activation Actions.

• Start job recovery.

  See Defining Recovery Actions.

• Handle job SYSOUT data.

  See Defining SYSOUT Actions.

• Pass output files to Entire Output Management.

  See Passing Files to Entire Output Management.

• Send message to user or console with information about any abnormal event or pending condition.

  See Defining Notification Messages.

Only one action of the same type can be defined for an event (except in the case of output conditions). If you need several actions of the same type for the event job OK or job not OK, you can define these by adding an Add. Job-ok, Job-not-ok event.

Displaying End-of-Job Events and Actions

To view End-of-Job events and actions defined for a job

• In the Job Master window, open the tabbed page EOJ Checking as shown in the following example:

  

  The page lists all End-of-Job actions and events defined for the selected job.

  The columns and functions available on the page are described in the relevant sections.

This section covers the following topics:

• Columns and Rows: End-of-Job (EOJ) Checking and Actions

• Action Indicators: EOJ Checking Page

• Functions: EOJ Checking Page

Columns and Rows: End-of-Job (EOJ) Checking and Actions

The tabbed page EOJ Checking provides the following columns:

Action Indicators: EOJ Checking Page

The character(s) shown in the Action column of the EOJ Checking page indicate the action(s) that have been defined for the event. For example: PSU indicates that a description (P), a SYSOUT action (S) and a notification message (U) have been defined for the event.

Functions: EOJ Checking Page

The following functions are available for a table item selected on the EOJ Checking page:

Adding and Modifying an Event Definition

To add or modify an End-of-Job (EOJ) check and action definition

1. In the Job Master window, open the tabbed page EOJ Checking.

2. Choose Add or Modify depending on whether a definition already exists.

   An EOJ checking window similar to the example below opens:

   

   The input fields and tabs provided in the EOJ checking window depend on the operating system (here: BS2000) of the execution node and the Event type (here: String) specified for the job. All fields and tabs that can be available in the window are explained in Fields: EOJ Checking Window.

3. Make your definitions and choose OK to save your entries.

This section covers the following topics:

• Fields: EOJ Checking Window

Fields: EOJ Checking Window

This section describes the fields and tabs contained in the EOJ checking window.

The fields in the Event type, Means and Event type specific settings group boxes are used to define the job event.

The fields on the tabbed pages in the lower window section are used to define the action to be taken if the event occurs. The following table indicates when a field in a group box has a corresponding field on a tabbed page.

'    leading blanks'

Fields: Job Variable Definitions (BS2000 only)

The fields available to define a job variable event in the header section of the EOJ checking window and a job variable action on the tabbed page Job Variable are explained in the following table:

Field	Description
Job variable	Name of a valid BS2000 job variable. If the job variable is specified without an explicit user ID, the job default BS2000 user ID is used as a prefix. Symbol replacement is performed in the name if the name contains the activation escape character at least once. Symbol replacement is possible. The submission escape character is to be used.
Position	Position of the substring of the job variable value to be checked. Possible values: 1 to 253.
Length	Length of the substring of the job variable value to be checked. Possible values: 1 to 253.
Format	Format in which the substring of the job variable value is to be checked against the comparison-string. Possible selection options:
	A		alphanumeric
	N		numeric
is	Logical operator to be used for comparison of the defined BS2000 substring of the job variable value against the comparison-string.
compared to comparison-string	Enter the string or field to be compared with the substring of the job variable value. The strings are compared in the defined format. The content of this field is compared with the substring of the job variable value, or it is inserted into the substring of the job variable value. The comparison is made in the defined format. Symbol replacement is possible. The submission escape character is to be used.
Password	(Optional field) If the job variable is read password-protected, specify the password here.
Execute if temporary dummy	See End-of-Job Actions after Execution as a Temporary Dummy Job.

See also Example of a Job Variable Event (Event Type V).

Valid Comparison Operators

You can use one of the following comparison (relational) operators to compare two character strings and return either the value true or false:

Operator	Explanation
=	Equal to the specified value.
EQ
>=	Greater than or equal to the specified value.
GE
>	Greater than the specified value.
GT
<=	Less than or equal to the specified value.
LE
<	Less than the specified value.
LT
<>	Not equal to the specified value.
NE

Deleting an Event Definition

To delete an event definition

1. On the tabbed page EOJ Checking, select the required event and choose Delete.

   A window prompts you to confirm the deletion.

2. Choose Yes to confirm the deletion.

   (No cancels the action.)

   The page closes and the event definition is removed.

Operating System Dependent Defaults for Event Checking

This section covers the following topics:

• Common Defaults for Event Checking

• z/OS and z/VSE Defaults for Event Checking

• BS2000 Defaults for Event Checking

• UNIX and Windows Defaults for Event Checking

Common Defaults for Event Checking

• Symbol replacement error during job submission:

  If a symbol replacement error occurs at submission time, the event Job not run JCL error is set to occurred.

  If the event Job not run JCL error is not defined, it is added to the active job.

• If a string defined in the Global Message Code Table (see the Administration documentation) is found anywhere in the SYSOUT, its severity equivalent is compared with the highest condition code value accepted as OK. The job is not OK if the severity equivalent is higher than this default.

z/OS and z/VSE Defaults for Event Checking

If no events are defined for a job, Entire Operations provides a default check of the return code type (for termination codes):

• If a system code that is not equal to 0 (zero) has occurred at any job step, the job is evaluated as not OK if this event is not explicitly defined. This also applies if an event has occurred which has been defined using ANYSTEP. The occurrence of such an event has the priority over definitions, which apply for any steps.

• For z/VSE only:

  No system codes are available in the z/VSE operating system.

• For z/VSE only:

  The following messages lead to a not OK status of the z/VSE job:

  • PROGRAM ABEND

  • ENDED ABNORMALLY

  • OPERATOR CANCEL

• You can set the default for how to treat the message IEF201I job terminated if it occurs. The appropriate option in the Operating System Specials (see the Administration documentation) determines whether to treat this message as not OK. If treated as not OK, a log is written and the job is set to the status Job interrupted. If treated as OK, the occurrence of IEF201I in SYSOUT has no consequences and the job continues.

• If the message IEF287I data set not cataloged is received, it is written to the log and the job is treated as not OK.

• If a condition code or user code, which is not explicitly defined, is received at any job step, it is compared with the highest value accepted as OK. The job is not OK if the code is higher than this default. The job is also not OK if no explicit check has returned an OK. For more information, see the Operating System Specials option.

• Events like JCL error, Job not run and Job interrupted cause the status not OK by default. Dedicated event definitions can override this.

• In all other cases, the job is accepted as OK.

• Precedence of event checks:

  • If a MAXCC or ANYSTEP check has been defined and this event occurs, no check is done on the highest value accepted as still OK.

  • MAXCC precedes ANYSTEP.

• For z/VSE only:

  Date formats in z/VSE SYSOUT:

  In z/VSE SYSOUT, the following date formats are recognized and handled:

  American Format	MM/DD/YY, MM/DD/YYYY
  European Format	DD/MM/YY, DD/MM/YYYY

  If a date contains a 2-digit year specification in the SYSOUT, Entire Operations adds the century for further processing. In this case, a sliding window of + / - 50 years is applied (see also Date Display and Input Options).

BS2000 Defaults for Event Checking

Entire Operations either uses a defined Monitor job variable for a job or creates its own job variable if job variables are available.

• If the Monitor job variable displays an abnormal end, the job is not OK.

• By default, if defined message keys appear, the job is regarded as faulty and is set to not OK. These message codes (see BS2000 Default Message Codes in den Administration documentation) are default settings which are in effect after the installation of Entire Operations. However, they can be freely adapted. It is possible to completely delete this table.

  Note:
  Each time this table is modified, possibly faulty jobs may no longer be set to not OK.

• If messages like program dump appear in the SYSOUT, the job is not OK.

• In all other cases, the job is accepted as OK.

UNIX and Windows Defaults for Event Checking

Entire Operations inserts start and end messages (EOR0301, EOR0302) in the SYSOUT.

• If the end message EOR0302 is missing, the job is treated like an interrupted job. Because it is possible that the SYSOUT of an asynchronous child process is written behind the end message, the message EOR0302 is searched in the whole SYSOUT file. If the End-of-Job checking detects that there is unexpected SYSOUT behind the end message, you cannot obtain the process times for accounting. A note is written to the log:

  Process times for accounting not found ... SYSOUT of background processes may exist.

• If no special event checking was defined for a job (UNIX and Windows), then the event is compared to a system-wide default value for UNIX or Windows. Depending on this check, the job result can be set to not OK.

• In all other cases, the job is accepted as OK.

Creating and Viewing Online Documentation for Events

You can browse text description of active event and write or modify the text description of a master event.

To add, view or change an event description

1. On the EOJ Checking page select the event for which you want to add a description or whose description you want to view or change and choose Modify.

   The letter P in the Action column indicates whether a description already exists for the event.

   The EOJ Checking window opens.

2. Open the tabbed page Description.

   The page contains either descriptive text for the event or an URL address as shown in the example below:

   

   If an URL address is displayed, you can choose Open URL to open the page associated with the URL.

3. Write new or replace existing text as required.

   Choose Clear if you want to remove the whole text contained in the editor area.

4. Choose OK when you are finished.

Examples of Event Definitions

This section contains examples of event definitions:

• Example of an Additional Job OK/not OK Event (Event Type A)

• Example of a Termination Code Event (Event Type C)

• Example of a Job Special Event (Event Type J)

• Example of a User Exit Event (Event Type R)

• Example of a String Event (Event Type S)

• Example of a User Switch Event (Event Type U)

• Example of a Job Variable Event (Event Type V)

• Example of an Exit Code Event (Event Type X)

Example of an Additional Job OK/not OK Event (Event Type A)

Explanation:

This example defines an additional Job OK event to execute another End-of-Job action of the same type.

Example of a Termination Code Event (Event Type C)

Explanation:

If Condition Code 3 is received at any step (ANYSTEP) during job execution, the event result is not OK.

Example of a Job Special Event (Event Type J)

Explanation:

This event occurs if an operating system abend or hardware failure occurs during job execution.

Example of a User Exit Event (Event Type R)

Explanation:

User exit E01-J01 checks the job SYSOUT at job completion. This user exit resides in the Natural library SYSEORU.

Example of a String Event (Event Type S)

Example for z/OS:

Example for BS2000:

Explanation:

• Example for z/OS: If the string EXCEEDS is found in any system message (SM *), the event result is not OK.

• Example for BS2000: If the string ITEM531 is found in the BS2000 file DEPOT-INVENTORY-MAY, the event result is OK.

Example of a User Switch Event (Event Type U)

Explanation:

The event is OK if user switch 11 of the BS2000 user ID DC1 is on at job termination time.

Example of a Job Variable Event (Event Type V)

Explanation:

The event is OK if the job variable $DC1.JV.DEMO contains Result is 100 at the position 10, in the length 20, in alphanumeric (A) format.

Example of an Exit Code Event (Event Type X)

Explanation:

The event is OK if an exit code greater than 0 (zero) occurs.

Handling End-of-Job Actions

An End-of-Job action can be performed for a check event defined at the job step level and/or the default check event All Checks ok or Any Check not ok defined at the job level.

The default check events are always provided in the last two table rows of the EOJ Checking page.

All checks ok can be used to define actions to perform if no error occurred during job execution.

Any Check not ok can be used to define actions to perform if at least one error occurred during job execution.

This section covers the following topics:

• Defining Actions

• Changing Execute if Temporary Dummy Settings for Multiple Jobs

• Removing Actions

Defining Actions

To define an action

1. On the EOJ Checking page, select an event at the job step level for which you want to define an action, or select the default event check All Checks ok or Any Check not ok

2. Choose Add or Modify depending on whether you want to add or change an action, and proceed as described in the action-specific instructions in the remainder of this chapter.

   The example below demonstrates how the same action can be defined for several purposes:

   

   In the example above, a notification message (U) is sent after job termination if

   • No error occurred during job execution (Additional Actions for Job-ok),

   • Condition Code 4 occurred during job execution, and

   • Any error occurred during job execution (Any Check not ok).

Changing Execute if Temporary Dummy Settings for Multiple Jobs

You can modify the setting of Execute if temporary dummy for all relevant End-of-Job actions defined for a selected set of job masters.

Prerequisite: Read and write permissions must be checked in the EOJ Checking + Action option of your user profile (see Network Maintenance Functions described in the Administration documentation).

To update "Execute if temporary dummy" for multiple jobs

1. From the table in the Job Master List window, select the jobs whose Execute if temporary dummy settings you want to change and choose Mass update from the context menu.

   Or:
   Open the diagram of the network master containing the jobs to be updated, select the job masters whose Execute if temporary dummy settings you want to change and choose Mass update from the context menu (see also Maintenance Functions for Diagrams).

   A Mass update Job Master (or Diagram Job Master, respectively) dialog similar to the following opens:

   

   The Job field indicates the number of job masters selected for the update operation.

2. If you want to perform the execute operation, select the Update check box (not selected by default) and choose Yes from the drop-down list box to check the Execute if temporary dummy option for all End-of-Job actions of the selected jobs.

   Or:
   If you do not want to perform the execute operation, select the Update check box and choose No (default) from the drop-down list box to uncheck the Execute if temporary dummy option for all End-of-Job actions of the selected jobs.

3. Choose OK.

   The setting of the Execute if temporary dummy option is changed for the following End-of-Job actions:

   • Activation

   • Action User Exits

   • Job Variable

   • Symbol

   • Release Kept Resource

   • Message and Message Recipients

Removing Actions

Related Topic:

• Deleting an Output Condition

To remove an action

1. On the EOJ Checking page select the event for which you want to remove an action and choose Modify.

   The EOJ checking window opens.

2. Open the page that contains the action you want to remove.

3. On the appropriate action page, choose Clear.

   The entries in the window are removed.

   Choose OK.

   Or:
   On the appropriate action page, choose Delete (if available).

   A confirmation window opens.

   Choose Yes.

   (No cancels the action.)

   The page closes and the action is removed.

To remove an event with a single action

• If a single action is defined for an event, you may want to remove the entire event by selecting the required event on the EOJ Checking page and choosing Delete.

End-of-Job Actions after Execution as a Temporary Dummy Job

For temporary dummy jobs, End-of-Job actions are partially carried out as if the jobs were running in normal mode.

Several End-of-Job action definitions contain a field Execute if temporary dummy which can be used to execute the End-of-Job action according to this definition if the job was executed as a temporary dummy job.

Possible check-box settings:

This section covers the following topics:

• Default End-of-Job Actions for Temporary Dummy Jobs

• SYSOUT Actions

• End-of-Job Action User Exit

Default End-of-Job Actions for Temporary Dummy Jobs

If the Execute if temporary dummy option is not selected in an event action definition, the following defaults apply:

SYSOUT Actions

Actions that refer to the SYSOUT file cannot be executed if no SYSOUT file exists. This case applies if the job is executed as a temporary dummy job.

End-of-Job Action User Exit

End-of-Job action user exits are not performed for temporary dummy jobs.

Defining Output Condition Actions

You can set or reset output conditions as End-of-Job actions for any job events.

You can define up to 50 output conditions for any event at the job step level or at the job level according to All checks ok and Any check not ok.

• Adding and Modifying an Output Condition

• Deleting an Output Condition

Adding and Modifying an Output Condition

To add, view or change an output condition

1. On the EOJ Checking page, select the event for which you want to create a condition and choose Add.

   Or:
   On the EOJ Checking page, select the event whose output condition you want to view or change and choose Modify.

   The letter C in the Action column indicates whether an output condition exists for the defined event.

   The EOJ checking window opens.

2. Open the tabbed page Output Conditions show in the following example:

   

   If output conditions already exist, they are listed in the table. In the example above two conditions are set for a selected Termination code event.

   The column headings are explained in Columns and Fields: Output Conditions. The commands are explained in Commands: Output Conditions.

3. Choose Add to define a new condition.

   Or:
   Select an existing output condition (here: OUT1-CC-JOB-EOJ) and choose Modify.

   An Output Condition window similar to the example below opens:

   

4. Enter the required values.

   The fields and valid input values are explained in Columns and Fields: Output Conditions.

5. Choose OK when you are finished.

   The Output Condition window closes.

6. On the Output Conditions page, choose OK.

7. On the EOJ Checking page, choose OK.

   The definition of the new or modified output condition is saved.

Columns and Fields: Output Conditions

The columns available on the Output Conditions page and the corresponding fields in the Output Condition window are explained in the following table.

Column/Field	Description
State | Set/Reset	Determines whether the defined output condition must be true (Set) or false (Reset) if the associated event occurs. Possible values: Set Condition is true (default). Reset Condition is false (ignored).
Condition Name | Condition	User-defined name for the condition. Use this name if you wish to define this output condition as an input condition for another job. Symbol replacement is possible. The submission escape character is to be used. If you want to add or modify a global condition that can be used across networks, consider the rules and restrictions for global conditions described in the section Global Conditions.
Reference	An output condition can be set with different references (usually the current network run number). The reference is evaluated and set when the active condition is created by the Monitor according to the End-of-Job definition. Possible values: ABS Absolute condition. Exists only once, because it is independent of run numbers. RCM Sets an active condition with owner, network, run number of the calling network and appends multiple suffixes. RCM can be used to determine that the conditions defined for a predecessor job apply to all jobs that reference this predecessor in multiple activated subnetworks. In this case, the input condition of the corresponding successor job must be referenced with RCA: see RCA in the section Possible References for Input Conditions. RUN or blank Current run number of the job network is assigned (default).
Run	Run number of the job to which this condition applies when modifying the condition for an active job. If left blank, the current run number is assumed by default.

Commands: Output Conditions

The commands available on the Output Conditions page are explained in the following table.

Function	Description
Add	Create a new output condition. See Adding, Displaying and Modifying an Output Condition.
Delete	Delete the condition as an output condition for the job. See Deleting an Output Condition.
Modify	Modify the output condition definition. See Adding, Displaying and Modifying Output Condition.
Where used	Open a Where used Condition window with a list of jobs for which this condition is defined as an input or output condition. For more information, see the corresponding function for input conditions described in Listing Jobs Linked to an Input Condition.

Deleting an Output Condition

To delete an output condition

1. On the Output Conditions page, select the output condition you want to delete and choose Delete.

   A confirmation window opens.

2. Choose Yes.

   (No cancels the action.)

   The confirmation window closes and the selected output condition is removed.

Defining Actions for Symbol Value Modification

You can define a value to be assigned to a symbol or the substring of a symbol value (analogous to a BS2000 job variable) as End-of-Job action depending on the occurrence of an event. The value assignment can be performed in the master or active symbol table, or in both tables. It is possible to modify symbol tables different from the ones specified for the job or the network.

To add, view or change a symbol value setting

1. On the EOJ Checking page, select the event for which you want to set a symbol value and choose Add.

   Or:
   On the EOJ Checking page, select the event whose symbol setting you want to view or change and choose Modify.

   The letter Y in the Action column indicates whether a symbol value has already been set for the event.

   The EOJ checking window opens.

2. Open the tabbed page Symbol similar to the example below:

   

   In the example above, the string -USER-ID replaces or sets the value for the symbol UID in the EXA-SYMBOL master table of the owner EXAMPLE:

   • Assuming the old value is NOP, the new value in the master table will be NOP-USER-ID.

   • Assuming the old value is VVVVVVVVVVVVVVVVVVVV, the new value in the master table will be VVV-USER-IDVVVVVVVVV.

   • Assuming an old value does not exist (empty value), the value in the master table will be set to

        -USER-ID

     (with three leading blanks).

3. In the input fields, enter the required values. They are described in Fields: Symbol Modification

   You can remove all current entries from the window by choosing Clear.

4. Choose OK when you are finished.

   The symbol value setting is saved and the Symbol page closes.

To remove a symbol value setting

• Proceed as described in Removing Actions.

This section covers the following topics:

• Fields: Symbol Modification

Fields: Symbol Modification

The fields available on the Symbol page are explained in the following table.

Defining Actions for Modifying Job Variable Values

(Applies to BS2000 only)

You can define a value to be assigned to a job variable (analogous to a symbol) as End-of-Job action depending on the occurrence of an event.

To add, view or change a job variable setting

1. On the EOJ Checking page, select the event for which you want to define a job variable setting and choose Add.

   Or:
   On the EOJ Checking page, select the event whose job variable setting you want to view or change and choose Modify.

   The letter J in the Action column indicates whether a variable setting has already been defined for the event.

   The EOJ checking window opens.

2. Open the tabbed page Job Variable similar to the example below:

   

   In the example above, the string -USER-ID replaces or sets the value for the job variable HUGO:

   • Assuming the old value is NOP, the new value will be NOP-USER-ID.

   • Assuming the old value is VVVVVVVVVVVVVVVVVVVV, the new value will be VVV-USER-IDVVVVVVVVV.

   • Assuming an old value does not exist (empty value), the value will be

         -USER-ID

     (with three leading blanks).

   If no job variable has been defined, the fields in this window are empty; you can set a job variable, by entering the values here.

3. In the input fields, enter the required values. They are described in Fields: Job Variable Modification.

   You can remove all current entries from the window by choosing Clear.

4. Choose OK when you are finished.

   The job variable setting is saved and the Symbol page closes.

To remove a job variable setting

• Proceed as described in Removing Actions.

Fields: Job Variable

Defining Action User Exits

You can define user exits for End-of-Job checking and End-of-Job actions.

For information on defining user exits, see User Exits for End-of-Job Checking and Actions in the section User Exits

This section describes how to specify an action user exit for a particular event. Depending on your permissions, you can also add or edit an action user exit.

Related Topics:

• User Exits for End-of-Job Checking and Actions in the section User Exits

To add, view or change an action user exit definition

1. On the EOJ Checking page, select the event for which you want to define an action user exit and choose Add.

   Or:
   On the EOJ Checking page, select the event whose user exit definition you want to view or change and choose Modify.

   The letter X in the Action column indicates whether an action user exit.

   The EOJ checking window opens.

2. Open the tabbed page Action Exit similar to the example below:

   

3. In the input fields, enter the required values. They are described in Fields: Action User Exit.

   If required, choose Clear to remove all current entries from the window.

   You can also specify the name of a user exit that does not yet exist. Entire Operations saves the definition assuming that you will create the user exit at a later time.

   For information on coding user exits, see User Exits for End-of-Job Checking and Actions (section User Exits) and Editing Master JCL and Natural Sources.

4. When you are finished, choose OK to save your entries.

To remove an action user exit definition

• Proceed as described in Removing Actions.

This section covers the following topics:

• Fields: Action User Exit

Fields: Action User Exit

The fields available on the Action Exit page correspond to the fields available for a checking user exit (event type User exit in the Event type specific settings section of the EOJ checking window.

Defining Other Actions: Deactivate Job Automatically

The tabbed page Other is used to deactivate a job automatically, even if it ended not OK.

Select Accept from the drop-down list box if you want to deactivate the active job after termination even when it terminates with not OK. If you select Do not accept, the job remains active until you have corrected or manually deactivated it.

Choose Clear if you want to reset the selection box to its default (blank) value Do not accept. See also Removing Actions.

Defining Network and Job Activation Actions

Related Topic:

• Removing End-of-Job Actions

The occurrence of a defined event during job execution can trigger the activation of a specified single job or a whole job network. You can define activation of a job or network for specific events or at the job level for All checks ok and Any check not ok.

Activation is only possible if the network belongs to the defining user or if the defining user is authorized to activate the network of another user. The user defining the network to be activated must at least have authorization to activate this network (see Authorizing Other Users or Owners to Access a Network (Granting Access) in the section Network Maintenance).

To add, view or change an activation definition

1. On the EOJ Checking page, select the event for which you want to define an activation action and choose Add.

   Or:
   On the EOJ Checking page, select the event whose activation definition you want to view or change and choose Modify.

   The letter A in the Action column indicates whether an activation action has already been defined for the event.

   The EOJ checking window opens.

2. Open the tabbed page Activation similar to the example below:

   

3. Enter the required values. The input fields and options are explained in Fields: Network and Job Activation.

   If required, choose Clear to remove all current entries.

4. Choose OK when you are finished.

   Your action definition is saved and the window closes.

This section covers the following topics:

• Fields: Network and Job Activation

Fields: Network and Job Activation

Defining Recovery Actions

You can define a recovery process to be started as the result of a defined event during job execution. You can also define recovery action at the job level according to Any check not ok.

Usually, recovery is used in case of job failure. For example, a recovery job can be a compression job started after the message Library full is received. The string Library full should be defined as a string event (event type S). Entire Operations starts the recovery job automatically when the event occurs.

The recovery process comprises the following tasks:

• Activation of a recovery network or a recovery job.

• Creation of an internal condition to provide a correct return to the calling network.

• Rescheduling of the job to be recovered.

  One recovery network can be used in multiple recovery definitions.

  It always returns to the calling network.

  It is possible to stop the calling network after the recovery.

The conventional way to trigger a recovery network would be to define an event which activates the recovery network. Recovery is then started only if the event occurs or if any check is not OK. The recovery network must be defined as a network master.

To add, view or change a recovery definition

1. On the EOJ Checking page, select the event for which you want to define a recovery definition and choose Add.

   Or:
   On the EOJ Checking page, select the event whose activation definition you want to view or change and choose Modify.

   The letter R in the Action column indicates whether an activation action has already been defined for the event.

   The EOJ checking window opens.

2. Open the tabbed page Recovery similar to the example below:

   

3. Specify the recovery network to be started. The input fields and valid values are explained in Fields: Network and Job Activation.

   If required, choose Clear to remove current entries.

4. Choose OK when you are finished.

   Your recovery definition is saved and the window closes.

To remove a recovery definition

• Proceed as described in Removing Actions.

This section covers the following topics:

• Fields: Recovery Definition

• System Symbols for Recovery Actions

Fields: Recovery Definition

The fields on the Recovery page are described in the following table:

System Symbols for Recovery Actions

When defining a recovery action, the following Entire Operations system symbols can be prefixed with the escape symbol for symbol prompting and used, for example, in a comment line in the JCL of the recovery job:

They are substituted at JCL load with their current values. In the SYSOUT of the recovery job, you can then find the substitution of the parameters:

*** Symbol  : P-C-OWNER
  ***   Value : GFR
  *** Symbol  : P-C-NETWORK
  ***   Value : NET-1
  *** Symbol  : P-C-JOB
  ***   Value : JOB-6
  *** Symbol  : P-C-RUN
  ***   Value : 208
  *** =====================================================
2 //STEP1    EXEC PGM=NOPCONTI
3 //STEPLIB  DD   DISP=SHR,DSN=NOP.DEV.LOAD
  *** CALLER OWNER   GFR
  *** CALLER NETWORK NET-1
  *** CALLER JOB     JOB-6
  *** CALLER RUN     208
  ***

In this way, you can find out the job making the call, that is, the job to be recovered by the recovery job.

Defining SYSOUT Actions

You can define SYSOUT actions to be performed at job completion if the associated event occurs.

You can define the job SYSOUT to be cancelled or printed as the result of a defined event or the End-of-Job status (All checks ok and Any check not ok).

End-of-Job user exits are available for more complex actions, for example for obtaining selected information from the job SYSOUT. See also User Exits for End-of-Job Checking and Actions in the section User Exits.

To add, view or change a SYSOUT action

1. On the EOJ Checking page, select the event for which you want to define a SYSOUT action and choose Add.

   Or:
   On the EOJ Checking page, select the event whose SYSOUT action you want to view or change and choose Modify.

   The letter S in the Action column indicates whether an activation action has already been defined for the event.

   The EOJ checking window opens.

2. Open the tabbed page SYSOUT.

   The fields and options available in the window are explained in Fields: Network and Job Activation.

3. Select the SYSOUT action that corresponds to the function you want to perform.

   If required, choose Clear to remove current entries.

4. Choose OK when you are finished.

   The specified SYSOUT action is saved and the window closes.

To remove a SYSOUT action

• Proceed as described in Removing Actions.

This section covers the following topics:

• Fields and Options: SYSOUT Actions

Fields and Options: SYSOUT Actions

Defining Notification Messages

You can define a notification message to be sent as the result of a defined event, or if the job terminated OK or not OK. This is especially useful to inform appropriate user of job failures.

A user-defined message comes along with job execution information generated by Entire Operations. This information is more comprehensive if e-mails are used for sending; mailboxes have less information because they are limited to a single line. For example:

Mailbox message:

This line is the user-defined text.
==> EXAMPLE / EXA-NET3 / 10 / EXA-JOB1

Corresponding e-mail message:

Owner EXAMPLE - Network EXA-NET3 - Run 10 - Job EXA-JOB1
... Execution Node 123 (DAEF-123)
Event: Additional Actions for Job-ok

Ended ok
This line is the user-defined text.

A message can be defined for any event or at the job level according to All checks ok and Any check not ok.

The Entire Operations Monitor continues to send a message until it has been successfully transmitted.

This section covers the following topics:

• Displaying, Modifying and Adding Notification Messages

• Deleting Notification Messages

• Fields and Columns: Message and Message Recipients

• Rules for Message Text

• Rules for E-Mail Attachments

• Available Functions: Message and Message Recipients

• E-Mails on z/OS and z/VSE

• E-Mails on BS2000

• E-Mails on UNIX and Windows

Related Topic:

• Global Messages for Events in the Administration documentation

Displaying, Modifying and Adding Notification Messages

To view or change a notification message

1. On the EOJ Checking page, select the event whose message you want to view or change and choose Modify.

   The letter U in the Action column indicates whether a message has already been defined for the event.

   The EOJ checking window opens.

2. Open the tabbed page Message and Message Recipients:

   

   The page shows the short message text and the recipient(s) defined for the message.

   All fields contained on the page are described in Fields and Columns: Message and Message Recipients.

   All functions provided on the page are described in Available Functions: Message and Message Recipients

3. Message texts

   If required, write new message text or replace the current text in the Text field.

   Or:

   Choose Text to open a Text dialog to write or display text that exceeds the length of the Text field.

   In the Text dialog, you can choose Clear to remove all current text entries.

   See also Rules for Message Text.

   Recipients

   If you want to add a recipient definition, choose Add.

   Or:

   If you want to change a recipient definition, in the To: section, select the table row that contains the required definition and choose Modify.

   A Recipient Table window similar to the following opens:

   

   Add or change the definition as required and choose OK.

   The input fields are described in Fields and Columns: Message and Message Recipients.

   Or:

   If you want to delete a recipient definition, in the To: section, select the table row that contains the required recipient and choose Delete.

   Caution: Use this function with care.

   E-mail attachments

   If you want to attach a file to the message, choose Attachments.

   An E-Mail Attachments dialog opens where you can enter one or more addresses of files to be attached to the message.

   See also Rules for E-Mail Attachments.

   You can choose Delete to remove all current entries.

4. Choose OK when you are finished.

   The specified notification message is saved and the window closes.

   Or:
   Choose Clear All if you want to remove all current text entries (message text and all recipient definitions).

To add a notification message

1. On the EOJ Checking page, select the event for which you want to define a message and choose Add.

   The EOJ checking window opens.

2. Open the tabbed page Message and Message Recipients, enter message text in the Text field and choose Add to define message recipients.

   All fields contained on the page are described in Fields and Columns: Message and Message Recipients.

   All functions provided on the page are described in Available Functions: Message and Message Recipients

3. Proceed as described in Steps 3 to 4 of To view or change a notification message.

Deleting Notification Messages

To remove a notification message

• Proceed as described in Removing Actions.

Fields and Columns: Message and Message Recipients

The fields and columns on the Message and Message Recipients page and in the Recipient Table window are described in the following table.

Rules for Message Text

The following rules apply when writing message text on the Message and Message Recipients page:

Message Text Field

• The Text field can contain up to 120 characters on a GUI client and 45 characters on a CUI client. Characters that exceed the CUI limit are truncated on the CUI screen.

• If the text contains an activation escape character, text replacement is performed from the active symbol table.

Message Text Window

• If the Text field contains text, the first input line of the Text window is filled with this text by default.

  If no text is entered in the Text field, the first input line of the Text window is copied into the Text field by default. Text that exceeds the 45-character limit of the Text field is truncated.

  Text can be entered on 10 input lines with a maximum of 120 characters per line on a GUI client and 76 characters on a CUI client. Characters that exceed the CUI limit are truncated on the CUI screen. Empty lines are removed from the text.

• If the text contains an activation escape character, text replacement is performed from the active symbol table.

• The text in the Text field is removed when the text in the Text dialog is deleted.

Rules for E-Mail Attachments

The following rules apply when attaching a file to an e-mail from the Message and Message Recipients page:

Send Limits

You can attach up to 5 files to a message for e-mails sent through UNIX or Windows execution nodes.

You can attach only one file to e-mails sent through mainframe nodes.

There is no limitation for the size of an attachment. However, consider that large attachments, for example, consume large database space and may need more time to send the message. This can have an impact on the Entire Operations Monitor task used for message sending.

Node Usage

Attachments are always taken from the execution node of the job, for which the message is sent.

For e-mails sent through UNIX nodes: Attachments from any execution node can be sent.

For e-mails sent through mainframe and Windows nodes: Attachments can be sent only if they are located on the e-mail sending node (recipient node).

If an attachment cannot be found, a notification is appended to the e-mail body, and a message is written to the Entire Operations log.

File Format

Attachments from z/OS can be sequential text files and PDS members only. They are sent with Content-Transfer-Encoding: 8bit.

Attachments from BS2000 can be sequential text files only. They are sent with Content-Transfer-Encoding: 8bit.

Attachments from UNIX and Windows can be files of any type. They are sent with Content-Transfer-Encoding: base64.

File Name

The file name can contain symbols.

Symbols preceded by the activation escape character are replaced at job activation time.

Symbols preceded by the submission escape character are replaced during message sending.

The SYSOUT file of a job can be attached by using the activation escape character defined for the job or containing network. Example:

^P-SYSOUT

(assuming ^ is the escape character)

File Address

The maximum file address is 120 characters on a GUI client and 76 characters on a CUI client. Characters that exceed the CUI limit are truncated on the CUI screen.

Each file name must begin on a new line.

Files must be specified with their full path name. Example:

/home/sag/work/NOP 551 Adabas Files.docx

A Windows path name can be specified with a slash (/) or a back slash (\).

For mainframes, the file address can be specified using the syntax file-name(member-name), where member-name is the name of a source file. Example:

PDS.SOURCE1(IEFBR12)

A mainframe file address is converted to upper case during job activation.

Available Functions: Message and Message Recipients

The following functions are provided on the Message and Message Recipients page:

E-Mails on z/OS and z/VSE

1. The sender name contains Entire Operations for all sending platforms.

2. An additional line with the Entire Operations event text is added to the mail.

Usage Notes:

• Before using a z/OS Entire System Server node for sending e-mails, you must invoke the node definition in Entire Operations and enter the line command O (Other) for that node.

  For further information, see Special Definitions for a Node (Mainframe) in the section Definition of Nodes in the Administration documentation.

• You must define at least the mail destination and the SYSOUT class for the node through which the e-mail is to be routed.

• The e-mail send routine for z/OS performs an Entire System Server logon, if necessary. The user ID for the logon is the submit user ID for the active job. If no submit user ID is defined for the job, the default user ID for the node is used.

• To use a z/OS Entire System Server for sending e-mails, make sure that all users who send e-mail are correctly defined in the security systems (if applicable). It might be necessary to define user IDs as USS users.

  For more information, see the appropriate Entire System Server documentation for your operating and security system.

E-Mails on BS2000

E-mails can be sent via BS2000 nodes if Entire System Server nodes are used.

• Before using a BS2000 Entire System Server node for sending e-mails, you must invoke the node definition in Entire Operations and enter the line command O (Other) for that node.

  For further information, see Special Definitions for a Node (Mainframe) in the section Definition of Nodes in the Administration documentation.

• The e-mail send routine for BS2000 performs an Entire System Server logon, if necessary. The user ID for the logon is the submit user ID for the active job. If no submit user ID is defined for the job, the default user ID for the node is used.

E-Mails on UNIX and Windows

• UNIX: To be able to send e-mails on UNIX machines from Entire System Server, the following mail programs must be available there:

  AIX, HP-UX, Linux, Sun Solaris:	sendmail
  Others:	rmail

• Windows: To be able to send e-mails on Windows machines from Entire System Server, you must define a message command. This is a (third-party) command line tool to be used for sending e-mails via Entire System Server/Windows.

• Before using a UNIX or Windows node for sending e-mails, you must invoke the node definition in Entire Operations and enter the line command O (Other) for that node.

  The return address of the e-mail is set to the same value as E-Mail Reply-To.

  For further information, see Special Definitions for a Node (UNIX and Windows) in the section Definition of Nodes in the Administration documentation.

Defining Release Actions for Kept Resources

You can define an End-of-job action to explicitly release the resource held by another job of this network. The quantity released for the resource is equal to the quantity defined in the prerequisite resource definition of the respective job (that is, the quantity that was allocated).

It is possible to release a resource held by any other job of this network with the Release Kept Resource option.

To add, view or change a resource release definition

1. On the EOJ Checking page, select the event for which you want to define a resource release action and choose Add.

   Or:
   On the EOJ Checking page, select the event whose resource release definition you want to view or change and choose Modify.

   The letter L in the Action column indicates whether a resource release definition already exists for a defined event.

   The EOJ checking window opens.

2. Open the tabbed page Release Kept Resource shown in the following example:

   

3. Enter the required values. The fields are explained in Fields: Release Kept Resource.

   If required, choose Clear to remove the current entries.

4. Choose OK when you are finished.

   The resource release definition is saved.

To remove a release kept resource definition

• Proceed as described in Removing Actions.

This section covers the following topics:

• Fields: Release Kept Resource

Fields: Release Kept Resource

The fields in the Release Kept Resource page are explained in the following table.