Business Intelligence and Analytics Connection Profiles
The following topics describe connection profiles for business intelligence and analytics platforms and services:
ConnectionProfile:AWS QuickSight
AWS QuickSight is a cloud-based data analytics platform that enables you to visualize, analyze, and share large workloads of data.
The following examples show how to define an AWS QuickSight connection profile.
-
This JSON defines a job based on authentication using an AWS access key and secret:
Copy{
"AWS_QUICKSIGHT":
{
"Type": "ConnectionProfile:AWS QuickSight",
"Authentication Method": "SECRET",
"AWS Access Key": "MYAWSACCESSKEY1234",
"AWS Secret": "myAwsSecret12345",
"AWS Region": "us-east-1",
"AWS Account ID": "12345678",
"AWS QuickSight URL": "https://quicksight.us-east-1.amazonaws.com",
"Connection Timeout": "30",
"Description": "",
"Centralized": true
}
} -
This JSON defines a job based on authentication using an AWS IAM role from inside an EC2 instance:
Copy{
"AWS_QUICKSIGHT":
{
"Type": "ConnectionProfile:AWS QuickSight",
"Authentication Method": "NOSECRET",
"IAM Role": "QUICKSIGHTIAMROLE",
"AWS Region": "us-east-1",
"AWS Account ID": "12345678",
"AWS QuickSight URL": "https://quicksight.us-east-1.amazonaws.com",
"Connection Timeout": "30",
"Description": "",
"Centralized": true
}
}
The following table describes the AWS QuickSight job connection profile parameters.
Parameter |
Description |
---|---|
Authentication Method |
Determines one of the following types of authentication for the connection with AWS QuickSight:
|
AWS Access Key |
(SECRET Authentication) Defines the access key assigned to the account in the AWS QuickSight integration setup. |
AWS Secret |
(SECRET Authentication) Defines the secret access key assigned to the account in the AWS QuickSight integration setup. You can use Secrets in Code to hide this value in the code. |
IAM Role |
(NOSECRET Authentication) Defines the Identity and Access Management (IAM) role for connection to AWS QuickSight. |
AWS Region |
Determines the region where the AWS QuickSight jobs are located. |
AWS Account ID |
Determines the AWS account ID, which can be retrieved from the top right-hand corner of the AWS console. |
AWS QuickSight URL |
Determines the authentication endpoint for AWS QuickSight, based on the following format: https://quicksight.{{region}}.amazonaws.com For more information about regional endpoints available for the AWS QuickSight service, refer to the AWS documentation. |
Connection Timeout |
Determines the number of seconds to wait after Control-M initiates a connection request to AWS QuickSight before a timeout occurs. Default: 20 |
Centralized |
Determines whether to create a centralized connection profile, which is stored in the Control-M/EM database and is available to all Agents. You must set this parameter to true. |
ConnectionProfile:Microsoft Power BI
The Microsoft Power BI job enables you to integrate Power BI workflows with your existing Control-M workflows.
The following example shows how to define a connection profile for a Microsoft Power BI job:
{
"POWERBI":
{
"Type": "ConnectionProfile:Microsoft Power BI",
"Application ID": "77538c66-d7fp-4ca4-8cwa-120ed404fe8c",
"Client Secret": "*****",
"User Name": "[email protected]",
"Password": "*****",
"Resource Group": "https://analysis.windows.net/powerbi/api",
"API URL": "https://api.powerbi.com/v1.0/myorg/",
"Description": "Power BI connection profile",
"Centralized": true
}
}
The following table describes the Microsoft Power BI job connection profile parameters.
Parameter |
Description |
---|---|
Application ID |
Defines the application ID of the registered application. |
Client Secret |
Defines the client secret (password) associated with the user and the application. You can use Secrets in Code to hide this value in the code. |
User Name |
Defines the name of a user for logging on to the Power BI platform, typically an email address. |
Password |
Defines the password for the specified Power BI user. |
Resource Group |
Defines the URL of the resource group that holds your application: |
API URL |
Defines the Azure AD authentication endpoint base URL for Power BI: |
Centralized |
Determines whether to create a centralized connection profile, which is stored in the Control-M/EM database and is available to all Agents. You must set this parameter to true. |
ConnectionProfile:Microsoft Power BI SP
The Microsoft Power BI job enables you to include service principal authentication to integrate Power BI workflows with your existing Control-M workflows. Service principal authentication utilizes Azure Active Directory to allow applications to access resources without exposing sensitive credentials.
The following example shows how to define a connection profile for a Microsoft Power BI SP job that authenticates with a username and password:
{
"POWERBI":
{
"Type": "ConnectionProfile:Microsoft Power BI SP",
"Description": "",
"Power BI URL": "https://api.powerbi.com/v1.0/myorg/",
"Resource Group": "https://analysis.windows.net/powerbi/api",
"Client ID": "0ab4cdc9-e94c-494d-ace8-4873cde12345",
"Client Secret": "*****",
"Authentication": "Password",
"Username": "[email protected]",
"Password": "*****",
"Connection Timeout": "50",
"Centralized": true
}
}
The following example shows how to define a connection profile for a Microsoft Power BI SP job that authenticates with a service principal:
{
"POWERBI": {
"Type": "ConnectionProfile:Microsoft Power BI SP",
"Description": "",
"Power BI URL": "https://api.powerbi.com/v1.0/myorg/",
"Resource Group": "https://analysis.windows.net/powerbi/api",
"Client ID": "0ab4cdc9-e94c-494d-ace8-4873cde12345",
"Client Secret": "*****",
"Authentication": "Client",
"Tenant ID": "04dc5587-63a8-4c64-ae55-ab0694f12345",
"Connection Timeout": "50",
"Centralized": true
}
}
The following table describes the Microsoft Power BI SP job connection profile parameters.
Parameter |
Description |
---|---|
Power BI URL |
Defines the Azure AD authentication endpoint base URL for Power BI: https://api.powerbi.com/v1.0/myorg/ |
Resource Group |
Defines the URL of the resource group that holds your application: https://analysis.windows.net/powerbi/api |
Client ID | Defines the application ID of the registered application. |
Client Secret | Defines the secret (password) associated with the user and the application. |
Authentication |
Determines the authentication method. Valid Values:
Default: Password |
Username |
Defines the name of a user to log in to the Power BI platform, such as an email address. |
Password | Defines the password for the specified Power BI user. |
Tenant ID |
Defines a unique identifier associated with an Azure Active Directory (Azure AD) tenant. |
Connection Timeout |
Determines the number of seconds to wait after Control-M initiates a connection request to Power BI before a timeout occurs. Default: 30 |
Centralized |
Determines whether to create a centralized connection profile, which is stored in the Control-M/EM database and is available to all Agents. You must set this parameter to true. |
ConnectionProfile:Qlik Cloud
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.
The following example shows how to define a connection profile for a Qlik Cloud job:
{
"QLIK_connection":
{
"Type": "ConnectionProfile:Qlik Cloud",
"Tenant ID": "******",
"Qlik API URL": "qlikcloud.com/api/v1",
"Region": "sg",
"API Key": "******",
"Connection Timeout": "10",
"Description": "Qlik Cloud connection profile",
"Centralized": true
}
}
The following table describes the Qlik Cloud job connection profile parameters.
Parameter |
Description |
---|---|
Tenant ID | Defines the tenant ID, which is a unit in Qlik Sense that can hold users, apps, and spaces. |
Qlik API URL |
Defines the REST API authentication endpoint base URL for Qlik Cloud. Example: qlikcloud.com/api/v1 |
Region | Determines the region where the Qlik tenant is located, such as sg for Singapore. |
API Key |
Defines a Qlik Cloud API key that authenticates connections to Qlik Cloud, which is generated through the Qlik Cloud profile.You can use Secrets in Code to hide this value in the code. |
Connection Timeout |
Determines the number of seconds to wait before a timeout occurs after Control-M initiates a request to Qlik Cloud. Default: 10 |
Centralized |
Determines whether to create a centralized connection profile, which is stored in the Control-M/EM database and is available to all Agents. You must set this parameter to true. |
ConnectionProfile:Tableau
Tableau is a cloud-based data analytics platform that enables you to visualize, analyze, and share large workloads of data.
The following example shows how to define a connection profile for a Tableau job:
{
"TABLEAU_CP":
{
"Type": "ConnectionProfile:Tableau",
"Tableau URL": "https://prod-useast-b.online.tableau.com",
"Token Name": "myToken",
"Token Secret": "*****",
"Site Name": "bmctest",
"API Version": "3.19",
"Connection timeout": "50",
"Description": "",
"Centralized": true
}
}
The following table describes the Tableau job connection profile parameters.
Parameter |
Description |
---|---|
Tableau URL |
Defines the REST API authentication endpoint base URL for Tableau. |
Token Name |
Defines the Tableau account access key. |
Token Secret |
Defines the Tableau account secret access key.You can use Secrets in Code to hide this value in the code. |
Site Name |
Defines the name of the Tableau site where the job executes. |
API Version |
Determines which version of Tableau REST APIs the job executes. Most Recent Version: 3.19 |
Connection Timeout |
Determines the number of seconds to wait after Control-M initiates a connection request to Tableau before a timeout occurs. Default:: 50 |
Centralized |
Determines whether to create a centralized connection profile, which is stored in the Control-M/EM database and is available to all Agents. You must set this parameter to true. |