IBM Cognos Job

The following table describes the IBM Cognos job type attributes:

Attribute

Description

Connection Profile

Defines the connection profile for the job.

Rules:

  • Characters: 1−30

  • Case sensitive: Yes

  • Invalid characters: Spaces

Jobs/Reports

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

Rules:

  • 1-4096 characters
  • Case sensitive

Variable Name: %%JOBNAME

Location

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

Rules:

  • 1-4096 characters
  • Case sensitive

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, Email Recipients Attributes.

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

Email Recipients Attributes

The following table describes the Email Recipients attributes:

Attribute

Description

Enabled

 

Email to

Defines the destination email address of the report.

Rule: 1-4096 characters.

Variable Name: %%COGNOS-DEST-EMAIL-TO

Email CC

Defines an additional destination email address of the report.

Rule: 1-4096 characters.

Variable Name: %%COGNOS-DEST-EMAIL-CC

Email BCC

Defines an additional destination email address of the report that are not viewable to other recipients.

Rule: 1-4096 characters.

Variable Name: %%COGNOS-DEST-EMAIL-CC

Email subject

Defines the subject of the email for the report. This field can contain variables, which must contain a space or a period at the end.

Rule: 1-4096 characters.

Variable Name: %%COGNOS-DEST-EMAIL-SUBJECT

Email message

Defines the message of the email. This field can contain variables, which must contain a space or a period at the end.

Rule: 1-4096 characters.

Variable Name: %%COGNOS-DEST-EMAIL-MSG

Include a link to the report

Determines whether a link to the report is included in the email.

Variable Name: %%COGNOS-DEST-EMAIL-LINK

Attach the report

Determines if the report is attached to the report.

Variable Name: %%COGNOS-DEST-EMAIL-ATTACH