Business Intelligence and Analytics Connection Profiles

The following topics describe connection profiles for business intelligence and analytics platforms and services:

ConnectionProfile:AWS QuickSight
ConnectionProfile:Microsoft Power BI
ConnectionProfile:Microsoft Power BI SP
ConnectionProfile:Qlik Cloud
ConnectionProfile:Tableau

ConnectionProfile:AWS QuickSightLink copied to clipboard

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

For more information about this plug-in, see Control-M for Amazon QuickSight.

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 authentication methods: SECRET: Authenticates with an AWS access key and secret, which are used by services outside the AWS infrastructure. NOSECRET: Authenticates with an AWS IAM role from within the AWS infrastructure, which removes the need to provide additional credentials.
AWS Access Key	(SECRET Authentication) Defines the access key assigned to the account with the relevant permissions to the AWS service.
AWS Secret	(SECRET Authentication) Defines the secret access key assigned to the account with the relevant permissions to the AWS service. 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 name for the AWS service connection.
AWS Region	Determines the AWS region where the job is located. us-east-2
AWS Account ID	Determines the AWS account ID, which can be retrieved from the top right 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 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 BILink copied to clipboard

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

For more information about this plug-in, see Control-M for Microsoft Power BI.

The following example shows how to define a connection profile for a Microsoft Power BI job:

Copy

{ 
   "POWERBI": 
   { 
      "Type": "ConnectionProfile:Microsoft Power BI", 
      "Application ID": "77538c66-d7fp-4ca4-8cwa-120ed404fe8c",  
      "Client Secret": "*****", 
      "User Name": "user1@Elearningace.onmicrosoft.com", 
      "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 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 to log in 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 with your application: https://analysis.windows.net/powerbi/api
API URL	Defines the Azure AD authentication endpoint base URL for Power BI: https://api.powerbi.com/v1.0/myorg/
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 SPLink copied to clipboard

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.

For more information about this plug-in, see Control-M for Microsoft Power BI SP.

The following example shows how to define a connection profile for a Microsoft Power BI SP job that authenticates with a username and password:

Copy

{
   "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": "user1@Elearningace.onmicrosoft.com",
      "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:

Copy

{
"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 with 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: Client Password Default: Password
Username	Defines the name of a user to log in to the Power BI platform, typically 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 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 CloudLink copied to clipboard

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.

For more information about this plug-in, see Control-M for Qlik Cloud.

The following example shows how to define a connection profile for a Qlik Cloud job:

Copy

{
   "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 holds users, apps, and spaces.
Qlik API URL	Defines the REST API authentication endpoint base URL for Qlik Cloud. 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 after Control-M initiates a connection request before a timeout occurs. 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:TableauLink copied to clipboard

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

For more information about this plug-in, see Control-M for Tableau.

The following example shows how to define a connection profile for a Tableau job:

Copy

{
   "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 runs.
API Version	Determines which version of Tableau REST APIs the job runs. Most recent version: 3.19
Connection Timeout	Determines the number of seconds to wait after Control-M initiates a connection request 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.