Control-M Report job parameters

The following table describes the General parameters for a Control-M Report job.

From Control-M version 9.0.18 and above you can no longer run a Control-M Report job. To run a new Control-M Report job you need to define a job in Automation API and then create an O/S job type using the command defined in Automation API. You also create a new job type or in Control-M Application Integrator.

For more information, see Control-M Reports job definition.

Parameter

Description

Job Type

Defines the type of job that determines which fields are exposed in a job definition. The value of the job type is usually based on the platform for the job run. Jobs defined as Dummy provide instructions for Control-M such as post-processing actions.

Value: Control-M Report

Job Name

Defines the name of the job processing definition and appears in the job definition and tracking displays, and enables you to identify the job, and order the job.

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.

Run as dummy

Enables you to run jobs of job types other than Dummy, as dummy jobs.

Control-M Report Attributes (Details)

Defines the following parameters:

  • Run as
  • User
  • Password
  • Password file
  • Sever Host
  • emreportcli Path
  • Template
  • Template path
  • Output to:

    Output to file (Output file type and Output file)

    Output to Sysout

  • Report Parameters (Parameter Name and Parameter Value)
  • Save

For more information about the emreportcli utility, see Control-M Reporting Facility.

Run as

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

User

Control-M/EM user that runs the report.

Password

Control-M/EM user password.

Password file

Flat file containing an unencrypted username and password in the following format: user=username password=password.

Server Host

Host name of the Control-M/EM Server.

emreportcli path

Specifies the path where Reporting Facility is installed on Control-M/EM.

Template

Specifies the name of the template.

Template path

Specifies the folder in which the template file is located.

Output to file

Sends the output to a specified file to:

  • Output file type
  • Output file

Output file type

Specifies the type of the output file, such as EXCEL, EXCEL_DO (for data only), PDF, DOC, HTML, TXT, or XML.

Output file

Specifies the full filename of the output file (which is overwritten if it exists already).

Output to Sysout

Defines where to send the job report.

Report Parameters

Defines an individual parameter, whose name and value is specified.

Parameter Name

Name of the parameter as defined in the report template filter panel.

Parameter Value

Value of the report parameter (wildcard characters can be used for text fields when the field operator in the filter panel is set to "LIKE" for the fields)

Save

Defines the Save button to save the Job specific settings.

Host (/Group)

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

Control-M/Server

Defines the name of the Control-M/Server (or Control-M for z/OS) that processes the job.

Parent Folder

Defines the name of the folder that contains the job or Sub Folder.

Names of folders and Sub Folders may be up to 64 characters, with the exception of Control-M for z/OS folders which may be up to 8 characters. Folder names cannot contain the character “/”. SMART Folders in Control-M for z/OS can only contain jobs (not Sub Folders). Read only

More

Defines an area of the Properties pane to click to define more parameters.

Run job on all hosts in group

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.

Variables

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.

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.

Sub Application

Indicates the name of the Sub Application where the job belongs logically. It is a sub-category of the Application parameter. For example, the Application is Finances, and the Sub Application is Payroll.

Created by

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

Documentation

Defines a description related to the job, and is saved in a defined location. The Documentation area in the Properties pane includes information about where to find the Documentation. In a z/OS job, the Documentation is in a Doc Member located in a Doc Library. In a non-z/OS job, the Documentation depends on whether the type is File or URL. For a file, the description is located in a file located in a file path. For a URL, the Documentation is located in a URL address.

Type

Defines whether the documentation for an OS job is in a file or URL. See the following:

  • URL: Defines the URL address where the documentation is located. The format starts with "http://", "ftp://", or "file://".
  • File: Specifies the file that contains the job script.

Doc Path

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.

Doc File

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.

Priority

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

Critical

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

Parent Topic

Job types