The following table describes active_job XML Parameters:
Parameter |
Description |
---|---|
Determines whether to ignore prerequisite conditions normally set by predecessor jobs if the relevant predecessor jobs are not scheduled. (SMART folders only) Optional. |
|
Provides a logical name for sorting groups of jobs. This parameter is used to supply a common descriptive name to a set of related job groups. The jobs do not necessarily have to run at the same time. |
|
application_cm_version |
Indicates the version of external application Control Module (such as SAP), which is installed in the Control‑M installation. This is specified together with application_form, application_type, and application_version elements. |
application_form |
Specifies a predefined set of external application parameters that display in the External Application panel of the Control‑M Workload Automation Properties pane. |
application_type |
Indicates the type of external application (such as SAP) on which the external application job runs. |
application_version |
Indicates the version of the external application (such as SAP) on which the external application job runs. |
(Control-M for z/OS only) Defines the maximum number of days to retain the SYSDATA archive data set for jobs that ended NOTOK. |
|
(Control-M for z/OS only) Defines the maximum number of job runs to retain the SYSDATA archive data set for jobs that ended NOTOK. |
|
(Control-M for z/OS only) Determines whether SYSDATA (job output) must be archived. |
|
(Optional) Indicates an operating system command line entry to be submitted as a job. Use this parameter to specify an operating system command to execute by Control-M. The command must be specified exactly as it would be specified in a terminal for the specific computer. |
|
Specifies whether user confirmation is required before the job is submitted for execution. |
|
(From Forecast only) Indicates the resources required by the job during execution and the type of control (shared or exclusive) the job requires over each resource. The Control Resources parameter is used to control parallel execution of jobs. A sequence of control_resources XML parameters. |
|
Indicates whether the interval between successive runs of a cyclic job is calculated from the start or the end of the previous job run. |
|
Determines whether the job is a critical-path job in Control-M, which ensures resources allocation order. |
|
Adds Control‑M/Analyzer steps as the first and/or last step of the job’s execution. A sequence of ctb_step XML parameters. |
|
Indicates that the job must run at a designated time, interval of time. |
|
cyclic_type |
Determines the type of cyclic job:
|
days_due_out_offset |
Defines the number of days that job execution can be extended after the ODAT |
Text description of the job. |
|
For a z/OS job, Doc Library defines the name of the library where the Documentation (description) is saved. For a non-z/OS job, Doc Path defines the name of the file path where the Documentation is saved.. |
|
For a z/OS job, defines the name of the member where the job Documentation (description) is saved. For a non-z/OS job, the Doc File is the name of the file where the job Documentation is saved. |
|
folder_id |
Defines the Order ID of the parent SMART Folder preceded by a leading zero. Control-M for Z/Os: The folder consists of RBA of the existing SMART folder. After the SMART Folder has been created, note the value of the order_id parameter, which must be supplied to the folder_id job parameters. |
(From Forecast only) Specifies prerequisite conditions that must be satisfied before the job is submitted for execution. The In Conditions parameter makes the submission of the job dependent on the existence of one or more prerequisite conditions. See in_condition XML parameters |
|
interval_sequence |
A sequence of interval_item. See: interval_sequence XML parameters. This parameter is relevant only for jobs running in Control‑M/Server version 6.4.01 and later and Control-M for z/OS version 7.0.01 and later. |
Defines the name of the job |
|
Determines the number of extra days (beyond the original scheduling date) that the job is allowed to remain in the Active Jobs database while awaiting execution. If the job still has not run after the specified number of days, the job is removed from the Active Jobs database. Integer. |
|
For non-z/OS jobs, File Path indicates the location of the file that contains the script. For z/OS jobs, Member Library indicates the location of the Member that contains the JCL, started task procedure, or Warning message. String. |
|
Indicates the name of the file that contains the job script, or for z/OS jobs, the name of a member that contains one of the following in relation to the job to be executed:
|
|
Specifies that job submission details be broadcast to all agents within a defined Host Group. All available agents in the Host Group run an identical job, and each such job has a unique Order ID. |
|
Defines the name of a Control-M/Agent computer, remote host computer, or host group where the job is submitted. Not for z/OS. |
|
Original scheduling date of a job. |
|
on_do_statements |
A sequence of on_do_statements, which consist of the following:
|
order_folder |
Default or dummy folder to which you indicate the job belongs A folder is not necessary because jobs that are created with Control‑M/EM API are inserted directly into Active Jobs. However, you may want to include a value for this parameter so that the job can be tracked during statistical analysis that uses Folder as a criterion. |
order_library |
Default or dummy folder library in which folder documentation is stored. A folder (and a folder library) are not necessary because jobs that are created with Control‑M/EM API are entered directly into Active Jobs. However, you may want to include a value for this parameter so that the job can be tracked during statistical analysis that uses Folder or Folder Library as criteria. This parameter is specified only for z/OS jobs for which the order_folder element was also specified. |
(From Forecast only) Specifies prerequisite conditions to be added or deleted after the job completes with a completion status of OK. A sequence of out_condition XML parameters |
|
Identifies the user name with the authorization to execute the job. This parameter is used by the Control-M security mechanism. |
|
Specifies a temporarily-modified job script file without changing the original script file in the File Path/Member library and without changing the scheduling order of a folder. |
|
pipes |
Runs the job regardless of whether other jobs using the same Pipe as that specified in the definition of this job, are ready to run. See pipe XML parameters |
(Z/OS only)Performs data set cleanup before the original job run. |
|
Determines the order of job processing by Control-M in the Active Jobs database. String. |
|
(From Forecast only) Indicates the name and quantity of Quantitative resources required by the job. See quantitative_resource XML parameters. |
|
(z/OS only) Defines the node in the JES network where the job executes. String. |
|
Specifies the length of time to wait between reruns of a job or between cyclic runs of a job. |
|
Determines the maximum number of reruns that can be performed for the job. Integer. |
|
rerun_member |
(z/OS only)Defines the name of the JCL member to use when the job automatically reruns. String. Optional. |
Determines the number of days to retain the job in the History Jobs file. For z/OS jobs only. |
|
Maximum number of generations of the job to keep in the History Jobs file. For z/OS jobs, only. |
|
(z/OS only)Indicates the JES2 workload management scheduling environment that is to be associated with the job. String. |
|
Indicates a notification of a job's status. Seeshouts XML parameters |
|
specific_times |
Specific time for a cyclic job to run, such as 7:00 or 11:00. Limited to 4000 for all fields. This parameter is relevant only for jobs running in Control-M/Server version 6.4.01 and later and Control-M for z/OS version 7.0.01 and later. |
Specifies a range of steps in the steps of an On PGMST statement. See step_range XML parameters |
|
(z/OS only) Indicates that a single data set is used for archiving the SYSDATA of all jobs until it is full, when another data set is started. Valid values:
|
|
(z/OS only) Limits the output handling operation to only outputs from the specified class. |
|
Output Handling options. Optional. |
|
Certain output_option values require that you supply additional information (such as Copy, NewDest):
|
|
(z/Os jobs only) Indicates the identity of the system in which the job must be initiated and executed (in JES2). Also indicates the identity of the processor on which the job must execute (in JES3). |
|
task_class |
Control‑D mission. Mandatory for Control‑D jobs. Valid values:
|
Defines one or more parameters which determines what the job runs. Microsoft Windows and UNIX:
Control‑M for z/OS:
|
|
time_due_out |
Time that the job is expected to finish. |
Indicates the earliest time for submitting the job. |
|
time_reference |
Valid values:
|
Enables the job to run the next day without time limitations. |
|
time_until_days_offset |
Defines the number of days after the original scheduling date of the job during which execution of the job can end. This parameter is relevant only for jobs running in Control‑M for z/OS version 6.2.00 and later. |
Indicates the time zone according to which the job should be scheduled. |
|
Maximum delay in minutes permitted for a late submission when selecting a specific time (e.g. 5 minutes).Maximum delay in minutes permitted for late submission when selecting a specific time. This parameter is relevant only for jobs running in Control‑M/Server version 6.4.01 and later and Control-M for z/OS version 7.0.01 and later. |
|
variable_assignments |
All variables are identified by the %% prefix. If %% is included in the value for a job processing parameter, Control‑M assumes that it is referring to a variable or function. Variable_assignments include the following XML parameters:
|
Parent Topic |