Using Includes in Job Objects

When a job is processed, Includes are read and used to generate the executable job for the target system. Depending on the job definition, activation data is retrieved, variable settings evaluated, the attribute dialog displayed, messages for the target system prepared, the log on/off in the target system facilitated, the job report requested, etc.

Client 0 comes with platform-specific Includes. Within header and trailer includes, user Includes are called using the "NOFOUND=IGNORE" parameter in order to avoid errors if these Includes do not exist.

In doing so individual Includes can be created, which are responsible for special tasks during the various stages of job execution. These tasks are then included in Automation Engine processing.

For running jobs, you require the necessary rights to run job includes. Note when you use job includes (access method "X" for JOBI objects).

Job	Header Include	Trailer Include	User Includes
BS2000	HEADER.BS2000	TRAILER.BS2000	HEADER.BS2000.USER.PRE HEADER.BS2000.USER.HEAD HEADER.BS2000.USER.START TRAILER.BS2000.USER.END TRAILER.BS2000.USER.ABEND
JMX	HEADER.JMX	TRAILER.JMX	HEADER.JMX.USER.PRE HEADER.JMX.USER.HEAD HEADER.JMX.USER.START TRAILER.JMX.USER.END
NSK	HEADER.NSK	TRAILER.NSK	HEADER.NSK.USER.PRE HEADER.NSK.USER.HEAD HEADER.NSK.USER.START TRAILER.NSK.USER.END
z/OS	HEADER.MVS	TRAILER.MVS	HEADER.MVS.USER.PRE HEADER.MVS.USER.HEAD HEADER.MVS.USER.START TRAILER.MVS.USER.END
OS/400	HEADER.OS400	TRAILER.OS400	HEADER.OS400.USER.PRE HEADER.OS400.USER.HEAD TRAILER.OS400.USER.END
PeopleSoft	HEADER.PS	TRAILER.PS	HEADER.PS.USER.PRE HEADER.PS.USER.HEAD HEADER.PS.USER.START TRAILER.PS.USER.END
RA	HEADER.CIT	TRAILER.CIT	HEADER.CIT.USER.PRE HEADER.CIT.USER.HEAD HEADER.CIT.USER.START TRAILER.CIT.USER.END
SAP	HEADER.SAP	TRAILER.SAP	HEADER.SAP.USER.PRE HEADER.SAP.USER.HEAD HEADER.SAP.USER.START TRAILER.SAP.USER.END
SAP BW	HEADER.SAPBW	TRAILER.SAPBW	HEADER.SAPBW.USER.PRE HEADER.SAPBW.USER.HEAD HEADER.SAPBW.USER.START TRAILER.SAPBW.USER.END
Siebel	HEADER.SIEBEL	TRAILER.SIEBEL	HEADER.SIEBEL.USER.PRE HEADER.SIEBEL.USER.HEAD HEADER.SIEBEL.USER.START TRAILER.SIEBEL.USER.END
SQL	HEADER.SQL	TRAILER.SQL	HEADER.SQL.USER.PRE HEADER.SQL.USER.HEAD HEADER.SQL.USER.START TRAILER.SQL.USER.END
UNIX	HEADER.UNIX	TRAILER.UNIX	HEADER.UNIX.USER.PRE HEADER.UNIX.USER.HEAD HEADER.UNIX.USER.START TRAILER.UNIX.USER.END
VMS	HEADER.VMS	TRAILER.VMS	HEADER.VMS.USER.PRE HEADER.VMS.USER.HEAD TRAILER.VMS.USER.END
Windows	HEADER.WINDOWS	TRAILER.WINDOWS	HEADER.WINDOWS.USER.PRE HEADER.WINDOWS.USER.HEAD HEADER.WINDOWS.USER.START TRAILER.WINDOWS.USER.END TRAILER.WINDOWS.USER.ABEND

Due to the program logic, the Include object of the own client is used even if an object of the same name is available in client 0000.

Automic recommends using user includes for special tasks. You can also modify the supplied header and trailer includes in client 0000 and store them in your own client. This only increases maintenance work if the supplied includes are changed with an updated version due to programming reasons.

Important Considerations

There are dependencies between the individual includes. Keep this in mind when modifying Include objects.

Resources attached to the Storage object may be transferred using external interpreters, where the script is entered in the Process page of a Job object (JOBS). Jobs containing external interpreter scripts use the header/trailer of existing Include objects. The existing Includes should not be changed.

If you do not intend to work with user-defined Include objects in general or on particular platforms, the administrator can deactivate this function in the UC_SYSTEM_SETTINGS AE variable using the "DISABLE_USER_HEADER" key. In this case, Include objects are not called and this increases performance.