Business Intelligence and Analytics Jobs

The following topics describe job attributes that work with business intelligence and analytics platforms and services:

AWS QuickSight Job

AWS QuickSight is a cloud-based data analytics platform that enables you to visualize, analyze, and share large workloads of data.

To create an AWS QuickSight job, see Creating a Job. For more information about this plug-in, see Control-M for AWS QuickSight.

The following table describes the AWS QuickSight job type attributes.

Attribute

Description

Connection Profile

Determines the authorization credentials that are used to connect Control-M to AWS QuickSight, as described in AWS QuickSight Connection Profile Parameters.

Rules:

  • Characters: 1−30

  • Case Sensitive: Yes

  • Invalid Characters: Blank spaces.

AWS Dataset ID

Determines the ID of the AWS QuickSight job that is created in an AWS QuickSight workspace.

Refresh Type

Determines which of the following refresh functions to perform:

  • Full Refresh: Updates the entire data set, which refreshes all the rows in the table.

  • Incremental Refresh: Adds the rows that have not been imported to the table.

Status Polling Frequency

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

Default: 30

Failure Tolerance

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

Default: 2

IBM Cognos Job

To create an IBM Cognos job, see Creating a Job. For more information about this plug-in, see Control-M for IBM Cognos.

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, as described in IBM Cognos Connection Profile Parameters.

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

Rules:

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

Variable Name: %%JOBNAME

Location

Defines the path and name of the job that you want to execute 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 executed 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, Business Intelligence and Analytics 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

Power BI Job

The Microsoft Power BI job enables you to integrate Power BI workflows with your existing Control-M workflows.

To create a Power BI job, see Creating a Job. For more information about this plug-in, see Control-M for Power BI.

The following table describes Microsoft Power BI job attributes.

Attribute

Description

Connection profile

Determines the authorization credentials that are used to connect Control-M to Microsoft Power BI, as described in Power BI Connection Profile Parameters.

Dataset Refresh/

Pipeline Deployment

Determines one of the following options for execution in Power BI:

  • Dataset Refresh

  • Pipeline Deployment

Workspace Name

(Dataset) Defines a Power BI workspace where you want to refresh data.

Workspace ID

(Dataset) Defines the ID for the specified Power BI workspace (defined in Group Name).

Dataset ID

Defines a Power BI data set that you want to refresh under the specified workspace.

Parameters

(Dataset) Defines specific parameters, in JSON format, to pass when the job executes.

For more information about available parameters, see Datasets - Refresh Dataset in the Microsoft Power BI documentation.

To specify parameters, the dataset must be in the Premium group.

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

Copy
{
  "type":"Defragment",
  "commitMode":"transactional",
  "maxParallelism":20,
  "retryCount":2,
  "objects":[
      {"table":"Contributions"},
      {"table":"Traffic_Popular"}
    ]
}

For no parameters, type {}.

Connection Timeout

(Optional) Determines the maximum number of seconds to wait for REST API requests to respond, before disconnecting.

Default: 10

Status Polling Frequency

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

Default: 10

Pipeline ID

Defines the ID of a Power BI pipeline that you want to deploy to test and then to production.

Qlik Cloud Job

Qlik Cloud supports a cloud-based extract, transform, load (ETL) service, called Qlik Cloud Data Services, and enables you to visualize your data using Qlik Sense.

To create a Qlik Cloud job, see Creating a Job. For more information about this plug-in, see Control-M for Qlik Cloud.

The following table describes the Qlik Cloud job attributes.

Field Description

Connection Profile

Determines the authorization credentials that are used to connect Control-M to Qlik Cloud, as described in Qlik Cloud Connection Profile Parameters.

Rules:

  • Characters: 1−30

  • Case Sensitive: Yes

  • Invalid Characters: Blank spaces.

Reload Type

Determines one of the following options to load data into the environment:

  • Full: Deletes all the tables in the current environment and reloads the data from the data sources.

  • Partial: Keeps the tables in the current environment and executes the Load and Select statements, preceded by an Add, Merge, or Replace prefix.

App Name

Defines the Qlik Sense app name, which contains one or more workspaces, called sheets.

Print Log to Output

Determines whether the job logs are included in the Control-M output.

Status Polling Frequency

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

Default: 10

Tolerance

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

Default: 2

Tableau Job

Tableau is a cloud-based data analytics platform that enables you to visualize, analyze, and share large workloads of data.

To create a Tableau job, see Creating a Job. For more information about this plug-in, see Control-M for Tableau.

The following table describes the Tableau job attributes.

Attribute

Description

Connection Profile

Determines the authorization credentials that are used to connect Control-M to Tableau, as described in Tableau Connection Profile Parameters.

Rules:

  • Characters: 1−30

  • Case Sensitive: Yes

  • Invalid Characters: Blank spaces.

Action

Determines one of the following Tableau actions to perform:

  • Refresh Data Source: Updates the Tableau workflow with the most recent version of a data source.

  • Run Flow: Executes the Tableau workflow.

Data Source Name

Defines the name of the data source that is refreshed.

Tableau can connect to the following types of data sources:

  • Files, such as CSV, Excel, and PDF.

  • Databases, such as Oracle, SQL Server, and DB2.

  • Cloud storage, such as Azure, GCP, and AWS.

Status Polling Frequency

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

Default: 30

Failure Tolerance

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

Default: 1