Valid name parameter values

The following table describes Valid name parameter values:

Parameter

Description

order_id

(Mandatory) Defines the Order ID of the job to be retrieved. String.

data_center

Defines the data center to which the job belongs

application

Defines the application name to which the job’s group belongs

appl_type

Defines the external application on which the job runs

sub_application

Defines the group name to which the job belongs

MEMNAME

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:

  • The JCL of the job
  • The started task procedure
  • Warning messages

job_name

Defines the job name

task_type

Defines one or more parameters which determines what the job runs. Valid values:

Microsoft Windows and UNIX:

  • Job
  • Command
  • Dummy
  • Detached
  • External
  • SMART Folder
  • Sub-folder

Control‑M for z/OS:

  • Job
  • Started Task
  • SMART Folder
  • Cyclic Job
  • Emergency Job
  • Emergency Cyclic Job
  • Cyclic Task
  • Emergency Task
  • Emergency Cyclic Task

critical

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

cyclic

Indicates that the job must run at a designated time, interval of time.If selected, indicates that the current job is cyclic (it should be rerun at specified

intervals).

emergency

Determines whether the z/OS job is an Emergency job.

part_of_BIM_service

Indicates if the job is included in a Business Service.

status

Indicates the job execution status.

ended

Indicates that the job ended. Valid values are:

  • True
  • False

ended_not_ok

Indicates that the job ended unsuccessfully. Valid values are:

  • True
  • False

ended_ok

Indicates that the job ended successfully. Valid values are:

  • True
  • False

late

Indicates that the job ended late. Valid values are:

  • True
  • False

held

Indicates that the job was held. Valid values are:

  • True
  • False

delete_flag

Indicates that the job was deleted. Valid values are:

  • True
  • False

requested

Indicates that the job was requested. Valid values are:

  • True
  • False

run_as

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

host_group

Defines the name of a Control-M/Agent computer, remote host computer, or host group where the job is submitted.

description

Provides a description of the job in free text. A well written description can help you determine why the job was defined and how it fits into your business workflow.

order_date

Defines the job order date

AVG_RUNTIME

Indicates the average runtime of the job

START_TIME

Refers to the start time of the job

END_TIME

Refers to the end time of the job

Incond Name

Defines the name of the in-condition

Incond Date

Defines the date of the in-condition

Outcond Name

Defines the name of the out-condition

Outcond Date

Defines the date of the out-condition

Quant Res

Defines the name of the quantitative resource

Control Res

Defines the name of the control resource

RBA

Defines the relative block address (RBA). String.

Parent Topic

Search_criterion XML parameter