Application Workflow Jobs

The following topics describe job attributes that work with application workflow platforms and services.

AWS Step Functions Job

AWS Step Functions enables you to create visual workflows that can integrate other AWS services.

The following table describes the AWS Step Functions job attributes.

Attribute

Description

Connection Profile

Determines the authorization credentials that are used to connect Control-M to AWS Step Functions.

Rules:

  • Characters: 1−30

  • Case Sensitive: Yes

  • Invalid Characters: Blank spaces.

Execution Name

Defines the name of the Step Function execution.
An execution runs a state machine, which is a workflow.

State Machine ARN

Determines the Step Function state machine to use.

A state machine is a workflow, and an Amazon Resource Name (ARN) is a standardized AWS resource address.

arn:aws:states:us-east-1:155535555553:stateMachine:MyStateMachine

Parameters

Defines the parameters for the Step Function job, in JSON format, which enables you to control how the job runs.

Rule: You must type backslashes around the parameter name and value.

Copy
{\"parameter1\":\"value1\"}

Show Execution Logs

Determines whether to append the log to the outputClosedA tab in the job properties pane in the Monitoring domain that shows the output of a job, which indicates whether a job ended OK, and used, for example, with jobs that check file location.

Status Polling Frequency

Determines the number of seconds to wait before checking the job status.

Set to 120 seconds or longer for jobs that run for more than an hour.

Default: 20

Failure Tolerance

Determines the number of times to check the job status before ending Not OK.

Default: 2

Azure Logic Apps Job

Azure Logic Apps enable you to design and automate cloud-based workflows and integrations.

The following table describes the Azure Logic Apps job attributes.

Attribute

Description

Connection Profile

Determines the authorization credentials that are used to connect Control-M to Azure Logic Apps.

Rules:

  • Characters: 1−30

  • Case Sensitive: Yes

  • Invalid Characters: Blank spaces.

Workflow

Determines which of the Consumption logic app workflows to run from your predefined set of workflows.

This job does not run Standard logic app workflows.

Parameters

Defines parameters, in JSON format, that enable you to control the presentation of data.

Copy

  "param1":"value1",
  "param2":"value2"
}

Rules:

  • Characters: 2–4,000

  • For no parameters, type {}.

Get Logs

Determines whether to display the job output when the job ends.

Failure Tolerance

Determines the number of times to check the job status before ending Not OK.

Set to 120 seconds or longer for jobs that run for more than an hour.

Default: 2

Status Polling Frequency

Determines the number of seconds to wait before checking the job status.

Default: 20

IBM Cognos Job

The following table describes the IBM Cognos job type attributes.

Attribute

Description

Connection Profile

Determines the authorization credentials that are used to connect Control-M to IBM Cognos.

Rules:

  • Characters: 1−30

  • Case Sensitive: Yes

  • Invalid Characters: Blank spaces.

For more information about creating a local connection profile for this job, see Creating a connection profile.

Jobs/Reports

Defines the path and name of the job that you want to run.

Rules:

  • Characters: 1−4,096
  • Case sensitive: Yes

Variable Name: %%JOBNAME

Location

Defines the path and name of the job that you want to run in a readable format.

Rules:

  • Characters: 1−4,096
  • Case sensitive: Yes

Variable Name: %%COGNOS-LOCATION

Type

Defines the type of job, which can be job, report, or reportView.

Rule: Case sensitive

Variable Name: %%COGNOS-TYPE

Prompt Values

Determines the values of the IBM Cognos prompt in the selected report or reportView as follows:

  • Name: Indicates the name of the prompt

    Variable Name: %%COGNOS-REPORT_PARAMS-P001-PRM_NAME

  • Type: Indicates the type of prompt

    Variable Name: %%COGNOS-TYPE

  • Multi:

  • Required

  • Range

  • Value

  • Description

Burst the report

Defines if the report is run as a burst report.

Variable Name: %%COGNOS-BURST_REPORT

Output Handling

Defines what Control-M does with the IBM Cognos job output.

Format

Determines the report output format in one or more of the following options:

  • CSV
  • HTML
  • MHT
  • PDF
  • SingleXLS
  • spreadsheetML
  • XHTML
  • XLS
  • XLWA
  • XML

Delivery

Defines the Save Report Attributes, File System Attributes, Application Workflow Jobs.

Save Report Attributes

The following table describes the attributes that define where Control-M saves the IBM Cognos report.

Attribute

Description

Enabled

 

Save report to Cognos server

Determines whether the report is saved to the Cognos server or as a report view, as follows:

  • To Cognos Server: Saves the report at the default location on the Cognos server.

    Variable Name: %%COGNOS-DEST-SAVE_REPORT-SERVER

  • As Report View: Saves the report as a report view with the name and location that you define.

    Variable Name: %%COGNOS-DEST-SAVE_REPORT-VIEW

Name

Defines the report view name when As Report View is selected.

Rule: Case sensitive.

Variable Name: %%COGNOS-DEST-SAVE_REPORT-VIEW_NAME

Location

Defines the report view location when As Report View is selected.

Rule: Case sensitive.

Variable Name: %%COGNOS-DEST-SAVE_REPORT-VIEW_LOCATION

File System Attributes

The following table describes the File System attributes.

Attribute

Description

Enabled

 

Location

Defines the report archive system file location.

Variable Name: %%COGNOS-DEST-FILE-DIR

File Name

Determines the file name, with options as follows:

  • Use the report name

  • Specify a file name: Names the file as you define. If the file name is empty, the default report name is used.

    Variable Name: %%COGNOS-DEST-FILE-NAME

Conflict Resolution

Determines what Control-M does when there is a conflict, with options as follows:

  • Keep existing files: Determines that the existing file is not overwritten by a file with the same name.

    Variable Name: %%COGNOS-DEST-FILE-KEEP

  • Replace existing files: Determines that the existing file is overwritten by a file with the same name.

    Variable Name: %%COGNOS-DEST-FILE-REPLACING

  • Make the file names unique and append a timestamp: Defines a unique output filename that must be created in the destination directory with a time stamp appended to the filename.

    Variable Name: %%COGNOS-DEST-FILE-TIMESTAMP

  • Make the file names unique and append a sequence number: Defines a unique output filename that must be created in the destination directory with a sequence number appended to the filename.

    Variable Name: %%COGNOS-DEST-FILE-SEQUENCE