OS/400 Full Job

OS/400 Full jobs enable you to define any type of IBM i (AS/400) job: Program, Command, Multiple commands, Subsystem, External job, External subsystem, Virtual Terminal or Restricted state. When a job is submitted, it enables you to monitor the job, view and change operating system attributes, control the job execution, and respond to OS events related to the job.

The following table describes the OS/400 Full Job attributes:

Attribute	Description
Script File	Enables the job to execute the Script file specified in Script file that resides in Library or Path in the Special environment. CTMCL (the Control-M Script interpreter) processes the commands in the script. To view the script file parameters, see Script File.
Subsystem	Enables the job to start a subsystem specified in Subsystem that resides in Library and monitors the active subsystem until the subsystem ends. Subsystem ending code is always OK, regardless of the method used to end it. To view the subsystem parameters, see Subsystem.
Job Description	Enables the job to start a Job description specified in Job Description that resides in Library and monitors the job until the job ends. This action is similar to Autostart Job Entry (AJE) in a subsystem description. To view the job description, see Job Description
Restricted state action	Enables you to execute the job while setting the system into restricted state.
Special Environment	Defines the environment where the job runs as follows: Native: Enables the job to run on the native OS/400 environment. QShell: Enables the job to run on the QShell environment. S/38: Enables the job to run on the System/38 environment.
Library	Defines the library name where the program resides. Characters: Max 10 Characters: Max 8 S/38 Environment
Program	Defines the program name to be executed in the specified special environment.
Overriding Library	Defines the name of an alternate library or directory for the program specified in the program parameter.
Program's Parameters	Defines a Program, Script file or VT script file, which may expect to receive parameters as input for the execution. Each parameter must match its type as expected by the Program, Script file or VT script. The following types are available: String: Defines any string up to 4000 characters. Decimal: Defines a decimal number with or without decimal point. The value is passed to the program as packed decimal with a length of (15 5), where the value is 15 digits long, of which 5 digits are decimal positions. Hex: Defines any even number of hexadecimal characters (0-9, a-f, A-F). The value is passed to the program as X'<value>'. The String is the only valid type to be passed to Script file or VT script file and also to a QShell program. A maximum of 99 parameters can be set per job. If you need to include single quote character ('), it must be 2 single quotes (''). A value of *BLANKn will be resolved to n blanks.
Resolve Special values	Indicates whether special values, such as PGM, DTAARA, and FILE, defined in the program's parameters value will be resolved by the script interpreter or prior to submitting a program. Default value*: Selected (Yes)
Submission Attributes	Enables you to define the submission attribute parameters for an OS/Job type.
Job description	Defines the name of the OS/400 Job description (*JOBD) used to submit the job. You can select a job description name from the generated list.
Library	Defines the name of the library where the job description resides. You can select a library name from the generated list.
Job queue	Defines the name of the Job queue to submit the job to. You can select a job queue name from the generated list.
Job queue priority	Specifies the Job queue scheduling priority. Highest priority 1, lowest priority 9. When System default is set, the job is submitted with the system default JOBPTY value.
Hold on job queue	Determines whether this job is held at the time defined in the job queue. When System default is set, the job is submitted with the system default HOLD value.
Run priority	Specifies the run priority for the job. Highest priority 1, lowest priority 9. The Agent only attempts to set the Run priority after the job is submitted. If a job is not available or ends before the priority is set, the job is not updated and no error message is sent. If the OS/400 configuration parameter CHGRUNPTY is set to N, the RUNPTY of the job is not set.
Submit with ASAP option	Enables you to submit the Job to a NOMAX Job queue. If selected, Job Queue, Library, Job queue priority and Hold on Job queue are disabled.
Bypass job	The job does not run and the following message is generated in the job output: Job was bypassed
Skip validity checks for this job	Enables you to skip validity checks for all fields.

Script File

The following table describes the Script File attributes:

Attribute	Description
Script file location	Indicates where the following script file is located: Native (QSYS file system): The script file belongs to a physical file that resides in a QSYS library. IFS (Integrated file system): The file resides in the integrated file system. The file path must start with one of the following characters: /, \, ~ or . Embedded script: The script content is embedded in the Control-M Job definition, which is in the "Script" text box. The "Script file name" becomes informational only and does not have to exist on the target system.
Library	(Script file location Native only) Defines the library name. Up to 10 characters, valid OS/400 Object name, or one of the special values from the drop-down list.
Script	(Embedded script only) Enables you to type the embedded script.
Script File	Specifies the name of the script file which is executed. When the Script file location is Native (QSYS file system), the value of this field must be specified in one of the following formats: <File>/<Member> <File>/ /<Member> Where File and Member are valid OS/400 object names.
Path	(Script file location IFS only) Defines the path in which the script file resides in. The path name must start with ~, /, \ or period (.).
Overriding path	(Script file location IFS only) Defines the name of an alternate path or directory for the file specified with the Script file parameter.
Overriding library	(Native only) Defines the name of an alternate library or directory for the file specified with the Script file parameter.

Subsystem

The following table describes the Subsystem attributes:

Attribute	Description
Library	Defines the library name. Up to 10 characters, valid OS/400 Object name, or one of the special values from the drop-down list.
Subsystem	Specifies the name of a subsystem description that defines the operational environment (subsystem) being started.
Overriding library	Defines the name of an alternate library for the specified subsystem.
Bypass Job	The job does not run and the following message is generated in the job output: Job was bypassed
Skip validity check for this Job	Enables you to skip validity checks for all fields.

Job Description

The following table describes the Job Description attributes:

Attribute	Description
Library	Defines the library name. Up to 10 characters, valid OS/400 Object name, or one of the special values from the drop-down list.
Job Description	Defines the name of the OS/400 Job description used to submit the job. You can select a job description name from the generated list.
Overriding library	Defines the name of an alternate library for the file specified with the file name parameter.
Bypass Job	Enables the job not to run. The following message is generated: Job was bypassed
Skip validity checks for this Job	Enables you to skip validity checks for all fields.

Library List Attributes

The following table describes the Library List attributes in the More Options area for an OS/400 job type:

Attribute	Description
Name space	Defines the Name space or ASP group.
System library list	Determines the system portion of the library list to use.
Current library	Defines the current library for the job.
Library list option	Determines which library name to include in the job's library list. If a special value is specified, it must be the only entry in the list. Special values: CURRENT JOBD SYSVAL NONE

Environment Attributes

The following table describes the Environment attributes in the More Options area for an OS/400 job type:

Attribute	Description
Accounting code	Determines the accounting code used by the submitted job when logging the system resources usage. 15-character string (use any characters) or a special value from the drop-down list. If a value contains spaces or non-alphanumeric characters, enclose the value with single quotation marks (‘).
Routing data	Defines the routing data used to start the next routing step in the job. 80-character string (any characters) or one of the special values from the drop-down list. If a value contains spaces or non-alphanumeric characters, enclose the value with single quotation marks (‘).
Request data	Determines the request data that is placed as the last entry in the Job's message queue. 3000-character string (any characters) or one of the special values from the drop-down list.
Submitted for	Defines the parent job name for the job. A qualified Job name in <number>/<user>/<name> format, or the special value from the drop-down list.
Scheduling date	Determines the date when the job is submitted to the job queue and is eligible to run. Specify a date in the job's date format, with or without the date separator, or one of the special values from the drop-down list.
Scheduling time	Defines the time on the scheduled date when the Job becomes eligible to run. Time in hhmmss format, or special value from the drop-down list.
Job date	Determines the date that is assigned to the job when it starts. (Job date format). Type the date or a special value from the drop-down list.
Job switches	Determines the first settings for a group of 8 Job switches used with the job. Any combination of 0s and 1s to form an 8-digit string, or the special value from the drop-down list.
Allow multiple threads	Defines whether or not the job is allowed to run with multiple user threads. One of the special values from the drop-down list: System default Job Description Yes No
Allow display by WRKSBMJOB	Specifies whether the Job being submitted is allowed to be shown on the Work with Submitted Jobs panel. Default: Selected (Yes)
Copy environment variables	Specifies whether the environment variables from the submitting job are copied to the new job. When this property is set to clear (No), LDA is not set for the job and environment variables are not passed Default: Selected (Yes).
LDA	Defines the local data area. You can add, delete, modify, copy or move up or down by selecting the icon in the LDA field. The LDA field contains the following: Start: Defines the starting location of the LDA (1 to 1024 inclusive with a default of 1). Length: Defines the length of the string in the LDA (default = actual length). [Decimal]: Defines the precision (number of digits after the decimal point). Value: Defines the value of the LDA. When [Decimal] is specified, the value must be a numeric value with or without decimal point (examples: 167, 1997.15). For all formats, <start> + <length> -1 must not exceed 1024. %%LDA accepts Hex or Binary values and enables special values (PGM, DTAARA, FILE, ...). Usage notes: To set the hex value to LDA, use the following format in the Value: HEX(<hex value>). Example: HEX(a1b2C3D4) The <hex value> must have an even number of characters. If not, the value is not set. If the Length is specified, only the "Length" number of bytes is written to the LDA. For example, if Length=3 and <hex value>=a1b2c3d4, only a1b2c3 will be written to LDA. <hex value> must have a valid hex value (only 0-9,a-f,A-F). If not, the value is not set. When applying a special value to LDA (PGM, FILE, DTAARA, HEX, ...) the "Resolve special values" checkbox must be checked. If the Length was specified and the resolved length of the value is longer than the specified Length, only <Length> characters are written to the LDA. If the Length was not specified, the resolved length of the value, and all resolved value's characters are written to the *LDA.

Pre/Post Commands

The following table describes the pre submit and pre/post commands in the More Options area for an OS/400 job type:

Pre submit commands	Description
Pre submit commands	(Program, Script File, and Command only) Enables you to define a command before you submit the job. A job can have any number of pre submit commands but the total number of variables for a job is limited. All Pre-submit commands are executed before the job is submitted to the OS/400. Pre-submit commands are processed in the order they are displayed in the OS/400 Pre/Post Commands dialog box. Pre-submit commands are executed "as is." There is no need for special ‘single quote’ handling. If a Pre-submit command fails, the failure is ignored, logged in the Agent log file, and the next Pre-submit command is processed. When there are no more Pre-submit commands to process, the Job is submitted. You can add, delete, edit copy, or move up or down any pre-submit command.
Pre Commands Post Commands	(Program, Script File, and Command only) Determines the command line instruction to be executed before or after the specified command line. The following rules apply to Pre and Post commands: A maximum of 19 Pre and Post commands can be defined for a single Job. If a Pre or Post command is defined for a job, the job is processed as a Script file object type, regardless of its defined object type. If the defined Object type is CMDLINE, the Command line (in the OS400 tab) cannot exceed 256 characters. The job processes all the Pre commands in the order they are displayed in the OS/400 Pre/Post Commands dialog box, then the command line or the program (depending on "What to run"), and then all the Post commands in the order they are displayed in the OS/400 Pre/Post Commands dialog box. If a Pre command, or the command line or program, or a Post command fails, the job will fail, unless the next command to be processed is MONMSG. As the job is treated as a “Script file”, a Pre or Post command can be any valid “Script file” extended feature. PGM PARM(&name), RETURN, GOTO, MONMSG, continuation line, or remarks. Default values for "Ignore Errors" (IGNERR keyword) and "Log informational messages" (LOGINFMSG keyword) of the "Script file" interpreter are used. Single quote marks (') must be doubled ('') in Pre or Post commands. EXAMPLE: SNDMSG MSG('I am using Control-M') TOUSR(SYSOPR) should be entered as SNDMSG MSG(''I am using Control-M'') TOUSR(SYSOPR).
Pre statistics	(Program, Script File, and Command only) The following rules apply to pre statistics programs: A job can only have one pre statistics program The parameter pre statistics program must refer to a qualified OS/400 program name in one of the following formats: -<Program> -<Library>/<Program> The Pre-statistics field contains the following: Pre statistics program: Specifies the name of a program to process the Jobs statistic information. Library: Defines the name of the library. 10 characters valid OS/400 object name.

Pre submit commands

Description

Pre submit commands

(Program, Script File, and Command only) Enables you to define a command before you submit the job. A job can have any number of pre submit commands but the total number of variables for a job is limited. All Pre-submit commands are executed before the job is submitted to the OS/400.

Pre-submit commands are processed in the order they are displayed in the OS/400 Pre/Post Commands dialog box.

Pre-submit commands are executed "as is." There is no need for special ‘single quote’ handling.

If a Pre-submit command fails, the failure is ignored, logged in the Agent log file, and the next Pre-submit command is processed. When there are no more Pre-submit commands to process, the Job is submitted. You can add, delete, edit copy, or move up or down any pre-submit command.

Pre Commands

Post Commands

(Program, Script File, and Command only) Determines the command line instruction to be executed before or after the specified command line. The following rules apply to Pre and Post commands:

A maximum of 19 Pre and Post commands can be defined for a single Job. If a Pre or Post command is defined for a job, the job is processed as a Script file object type, regardless of its defined object type.
If the defined Object type is CMDLINE, the Command line (in the OS400 tab) cannot exceed 256 characters.
The job processes all the Pre commands in the order they are displayed in the OS/400 Pre/Post Commands dialog box, then the command line or the program (depending on "What to run"), and then all the Post commands in the order they are displayed in the OS/400 Pre/Post Commands dialog box.
If a Pre command, or the command line or program, or a Post command fails, the job will fail, unless the next command to be processed is MONMSG.
As the job is treated as a “Script file”, a Pre or Post command can be any valid “Script file” extended feature.

PGM PARM(&name), RETURN, GOTO, MONMSG, continuation line, or remarks.

Default values for "Ignore Errors" (IGNERR keyword) and "Log informational messages" (LOGINFMSG keyword) of the "Script file" interpreter are used.
Single quote marks (') must be doubled ('') in Pre or Post commands.

EXAMPLE: SNDMSG MSG('I am using Control-M') TOUSR(*SYSOPR) should be entered as

SNDMSG MSG(''I am using Control-M'') TOUSR(*SYSOPR).

Pre statistics

(Program, Script File, and Command only) The following rules apply to pre statistics programs:

A job can only have one pre statistics program
The parameter pre statistics program must refer to a qualified OS/400 program name in one of the following formats:

-<Program>
-<Library>/<Program>

The Pre-statistics field contains the following:

Pre statistics program: Specifies the name of a program to process the Jobs statistic information.
Library: Defines the name of the library. 10 characters valid OS/400 object name.

International Attributes

The following table describes the International attributes in the More Options area for an OS/400 job type:

Attribute	Description
Sort sequence	Determines the sort sequence that is used for the job. Value: Characters max 10. OS/400 object name, or a special value from the drop-down list.
Library	Determines the library name. Value: Characters max 10. Valid OS/400 object name, or a special value from the drop down list.
Language ID	Determines the language identifier to be associated with the Job. Value: Characters 3 ID. Valid OS/400 language ID, or a special value from the drop-down list.
Country ID	Determines the country or region identifier (ID) used by the job. Value: Characters 2 country or region ID, or a special value from the drop-down list.
Coded character set ID	Determines the coded character set identifier (CCSID) used for the submitted job. Up to 5 digits coded character set ID in the range of 1-65535 or one of the following special values from the drop-down list.

Messaging Attributes

The following table describes the Messaging attributes in the More Options area for an OS/400 job type:

Attribute	Description
Level	Defines the messaging logging level used for the job's messages. Value: Characters: 0-4, or a special value from the drop-down list.
Severity	Defines the message severity used to determine which error messages are logged in the job log. If the string contains spaces or non-alphanumeric characters, enclose it with single quote marks (‘) Value: Characters: 0-99, or a special value from the drop-down list.
Text	Determines the messaging logging text. Value: System Default, or a special value from the drop-down list.
Log CL program commands	Determines whether the commands, which run in a CL program, are logged into the job log through the CL program's message queue. Value: System Default, or a special value from the drop-down list.
Inquiry message reply	Determines how predefined messages are answered, which are sent when running the job. Value: System Default, or a special value from the drop-down list.
Job message queue maximum	Determines the maximum size of the job message queue (02-64) or one of the special values from the drop-down list.
Job message queue full action	Determines the action that needs to be taken when the job message queue is full. Value: System Default, or a special value from the drop-down list.
MSGW auto reply profile	Defines the name of the MSGW auto reply profile file that is processed when the job's status is set to MSGW.
Message queue	Defines where the completion message is sent when the submitted job has completed running. Value: Characters: Max 10. OS/400 name, or a special value from the drop-down list. BMC recommends that you do not change this value. Otherwise, when the job ends, it is not detected until the next Tracker loop. If the OS400 configuration parameter OVRMSGQ is not set to Y, this value is ignored.
Library	Determines the name of the library. Value: Characters: Max 10. OS/400 name, or a special value from the drop-down list

Output Attributes

The following table describes the Output attributes in the More Options area for an OS/400 job type:

Attribute	Description
Output queue	Defines the default queue for the job's spooled files. Value: Characters max 10. OS/400 name, or a special value from the drop-down list.
Library	Defines the library name. Value: Characters max 10. OS/400 name, or a special value from the drop-down list.
Print device	Defines the default printer name for the Job. Value: Characters max 10. OS/400 name, or a special value from the drop-down list.
Output priority	Defines the output priority for spooled output files that are produced by the Job. Value: System default, or a special value from the drop-down list. Highest priority 1, lowest priority 9
Spooled file action	Decides whether the spooled files are accessed through the Job interfaces after the job ends. Value: System default or a special value from the drop-down list.
Print text	Defines the printed text at the end of each page or on separate pages. String or special value. Maximum length: 30 characters. If the string contains spaces or non-alphanumeric characters, enclose it with single quote marks (‘).
Spooled files handling	Defines the spooled file handling profile name supplied when the job ends. Must be the name of an existing spooled files handling profile that is located in the Agent Data directory. When no value is set for this parameter, the default Spooled files handling profile value from the Agent configuration is used. The following special values can be used: ALLTOOUTPUT: All spooled files of the job are appended to the job's output. NONE: No spooled file action is taken.