Job and SMART Folder XML parameters

The following table describes the job and SMART_folder XML parameters:

Parameter

Description

active_from

Indicates the start of a period of time during which the job or SMART Folder can be ordered.

active_till

Indicates the end of a period of time during which the job or SMART Folder can be ordered.

adjust_condition

Determines whether to ignore prerequisite conditions normally set by predecessor jobs if the relevant predecessor jobs are not scheduled.This parameter is relevant only for jobs in a SMART Folder. Optional.

and_or

Indicates the relationship between specified Days parameter values and Week days parameter values.

application

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 external Application panel of the Control‑M 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.

arch_max_days

(Control-M for z/OS only) Defines the maximum number of days to retain the SYSDATA archive data set for jobs that ended NOTOK.

arch_max_runs

(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.

auto_archive

(Control-M for z/OS only)Determines whether SYSDATA (job output) must be archived.

captures

Indicates the parameters for job capture. See XML parameters for CAPTURES.

command

(Optional) Defines the command string supplied when the job Task Type (the task_type element) is Command.

confirm_flag

Specifies whether user confirmation is required before the job is submitted for execution.

control_resources

(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.

count_cyclic_from

Indicates whether the interval between runs of a cyclic job or until the start of a rerun job is measured from the start or the end of the previous job run.

conf_cal

Indicates the name of a Control-M calendar that is used to validate scheduling dates. A shift value can be used to indicate how to handle jobs that are scheduled for a non-working day in the calendar.

created_by

Indicates the Control‑M/EM user who defined the job.

critical

Determines whether the job is a critical-path job in Control-M, which ensures resources allocation order.

ctld_category

(Control‑M for z/OS only) Defines the name of a Control‑D Report Decollating Mission category to be scheduled whenever the job is run.

cyclic

Indicates that the job must run at a designated time, interval of time.

cyclic_type

Indicates how the intervals for running the job are specified, if job is cyclic (cyclic equal yes). Valid values are:

  • interval: Job is run at fixed interval. See rerun_interval.
  • interval_sequence: Job is run according to a list of time periods. See interval_sequence.
  • specific_times: Job is run according to a list of specific times. See specific_times.

    Only for jobs running in Control-M/Server version 6.4.01 and above and Control-M for z/OS version 7.0.01 and above.

dates

Defines a sequence of date, which indicates a specific date (either mmdd or ddmm format, depending on the site standard), on which the job should be scheduled.

Control‑M for z/OS: A maximum of 12 date elements can be specified.

days_cal

Indicates the name of a user-defined calendar containing a list of days of the month, used with Month Days, to determine a set of working days.

days_due_out_offset

Defines the number of days that job execution can be extended after the ODAT.

Only for jobs running in Control‑M for z/OS version 6.2.00 and above.

dayskeepinnotok

Enables you to specify a minimum period to keep the SMART folder (and jobs) in the Active Jobs database after the folder is set to NOT OK.

 

description

Defines the text description of the job.

doc_lib

Defines the name of the directory/library containing the job documentation file.

doc_member

Defines the name of the file containing job documentation.

in_conditions

(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.

instream_jcl

Defines a script exactly as it would be specified in a terminal for the specific computer and is part of the job definition.

interval_sequence

Defines a sequence of interval_item.

This parameter is relevant only for jobs running in Control-M/Server version 6.4.01 and above and Control-M for z/OS version 7.0.01 and above.

job_name

Defines the name of the job.

job_rule_based_cals

Defines a sequence of job_rule_based_cal, which refers to the name of the rule based calendar.

keep_active

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.

file_path

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.

file_name

Defines the name of the folder. In the Properties pane this parameter indicates the folder where the job belongs.

min_pds_tracks

Minimum number of free partitioned data set tracks required by the library specified for the Partition Data Set parameter.

month_days

Indicates the days of the month on which the job should be scheduled for processing.

multiagent

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.

host_id

Defines the Host ID of the host on which the job was recently run. Not for Control‑M for z/OS jobs.

on_do_statements

Defines a sequence of on_do_statements, which consist of the following:

out_conditions

(From Forecast only) Specifies prerequisite conditions to be added or deleted after the job completes with a completion status of OK.

override_path

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.

pds

(Control-M for z/OS only) Defines the name of a partitioned data set to check for free space. If the Partition Data Set has fewer than the minimum number of required free tracks (as specified for the Minimum number of tracks parameter), the job is executed.

prevent_nct2

(Control-M for z/OS only) Performs data set cleanup before the original job run.

priority

Determines the order of job processing by Control-M in the Active Jobs database. String.

quantitative_resources

(From Forecast only) Indicates the name and quantity of Quantitative resources required by the job.

removeatonce

Indicates that all jobs in the folder are not removed automatically from the Active Jobs database. Instead jobs wait for the folder to complete and are removed at the same time as the folder.

request_nje

(Control-M for z/OS only) Defines the node in the JES network where the job executes.

rerun_interval

Specifies the length of time to wait between reruns of a job or between cyclic runs of a job.

rerun_max

Determines the maximum number of reruns that can be performed for the job.

rerun_member

(Control-M for z/OS only) Defines the name of the JCL member to use when the job automatically reruns.

reten_days

(Control-M for z/OS, only) Determines the number of days to retain the job in the History Jobs file. For z/OS jobs only. String.

reten_gen

(Control-M for z/OS, only) Maximum number of generations of the job to keep in the History Jobs file. For z/OS jobs, only.Defines the maximum number of generations of the job to keep in the History Jobs file. String.

retro

Indicates if the job should be scheduled for possible execution after its original scheduling date has passed.

run_as

Identifies the user name with the authorization to execute the job. This parameter is used by the Control-M security mechanism.

SAC

(Control‑M for z/OS only) Determines whether to adjust the logical date for a job converted from a scheduling product other than Control‑M.

schedule_environment

Indicates the JES2 workload management scheduling environment that is to be associated with the job.

smart_folder_rule_based_cals

Defines a sequence of rule_based_cal XML parameters

shift

Enables you to schedule the job if the date is not confirmed. (Option) Valid values are:

  • ignore_job: Do not shift the job to a different date. The job is not scheduled.
  • next_day: Shift to the next working date.
  • prev_day: Shift to the previous working date.
  • no_confcal:. Tentatively schedule the job for the current day (even if not a working day). Additional shifting may or may not be performed, depending on the value indicated in the shift_num parameter.

shift_num

Defines the number of working days that a job can be shifted. Values from -62 to 62 can be entered. This function is also called Extended Shift.

shouts

Defines a sequence of shout.

specific_times

Defines a sequence of specific_time.

Only for jobs running in Control‑M/Server version 6.4.01 and above and Control-M for z/OS version 7.0.01 and above.

statistic_calendar

Name of the Control-M periodic calendar within which statistics relating to the job are collected.Defines the name of the Control‑M periodic calendar within which statistics relating to the job are collected.

Only for jobs running in Control‑M for z/OS version 6.2.00 and above.

step_ranges

Defines a sequence of step_range.

sub_application

Defines the name of the sub application to which the job belongs. Used as a descriptive name for related groups of jobs.

sys_db

(Control-M for 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:

  • yes: Single data set created for the SYSDATA of each job run.
  • no: Separate data set created for the SYSDATA of each job run.

output_from_class

(Control-M for z/OS only) Limits the output handling operation to only outputs from the specified class.

output_option

Enables output handling options.

Optional.

Valid values (non-Control-M for z/OS):

  • copy
  • delete
  • move
  • release

Valid values (Control-M for z/OS):

  • copy
  • delete
  • move
  • release
  • change_class

output_parameter

Defines output_option values, which require you to supply the following additional information (such as Copy, NewDest):

  • If the output_option element is change_class, the output_parameter value corresponds to the new class name.
  • If the output_option element is copy, the output_parameter value corresponds to the destination file name.
  • If the output_option element is move, the output_parameter value corresponds to the new destination for the file.

rule_based_cal_relationship

Indicates the relationship (AND/OR) between Rule Based Calendar criteria and basic scheduling criteria in the job processing definition (that is, whether either set of criteria, or both sets of criteria, must be satisfied).

system_affinity

(Control-M for z/OS jobs only) Indicates the identity of the system in which the job must be initiated and executed (in JES2).

Indicates the identity of the processor on which the job must execute (in JES3).

rule_based_cal_relationship

Indicates the relationship (AND/OR) between Rule Based Calendar criteria and basic scheduling criteria in the job processing definition (that is, whether either set of criteria, or both sets of criteria, must be satisfied).

task_type

Defines the type of the job (task) to be performed by Control‑M. Valid values

Microsoft Windows and UNIX

  • job
  • command
  • dummy
  • detached
  • external

Control‑M for z/OS

  • job
  • task
  • cyclic_job
  • emergency_job
  • emergency_cyclic_job
  • cyclic_task
  • emergency_task
  • emergency_cyclic_task

time_due_out

Defines the time that the job is expected to finish.

time_from

Indicates the earliest time for submitting the job.

time_from_days_offset

Defines the number of days after the original scheduling date of the job during which execution of the job can begin.

Only for jobs running in Control‑M for z/OS version 6.2.00 and above.

time_until

Indicates the latest time for submitting the job.

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.

NOTE: Only for jobs running in Control‑M for z/OS version 6.2.00 and later

time_zone

Indicates the global time zone used to calculate the interval for time-related conditions.

tolerance

Defines the maximum delay in minutes permitted for late submission when selecting a specific time.

NOTE: 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

Defines a sequence of variable_assignment XML parameters.

weeks_cal

Defines a name of a user-defined, week-based calendar used together with parameter Week Days to specify a set of working days.

week_days

Indicates the days of the week on which the job should be scheduled for processing.

JAN

Indicates whether to run the job in the relevant month. Valid values are:

  • yes
  • no

FEB

MAR

APR

MAY

JUN

JUL

AUG

SEP

OCT

NOV

DEC

Parent Topic

Create folder definitions