Business Intelligence and Analytics Connection Profiles

The following topics describe the connection profile parameters for business intelligence and analytics platforms and services:

Amazon QuickSight Connection Profile Parameters

Before you can define a job, you must create a connection profile in the Configuration domain. A connection profile contains authorization credentials—such as the username, password, and other plug-in-specific parameters—and enables you to connect to the application server with only the connection profile name. To create a connection profile, see Creating a Centralized Connection Profile.

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

The following table describes the Amazon QuickSight connection profile parameters.

Parameter

Description

AWS QuickSight URL

Defines the authentication endpoint for Amazon QuickSight, based on the following format:

https://quicksight.<region name>.amazonaws.com

https://quicksight.us-east-1.amazonaws.com

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.

Authentication Method

Determines one of the following authentication methods:

  • AWS Key & Secret: Authenticates with an AWS access key and secret, which are used by services outside the AWS infrastructure.

  • AWS IAM Role: Authenticates with an AWS IAM role from within the AWS infrastructure, which removes the need to provide additional credentials.

AWS Access Key

Defines the access key assigned to the account with the relevant permissions to the AWS service.

AWS Secret

Defines the secret access key assigned to the account with the relevant permissions to the AWS service.

IAM Role

Defines the Identity and Access Management (IAM) role name of the AWS service connection in the following format:<role-name> The IAM role must be attached to the EC2 agent that runs the job.

Use External Vault

Determines whether to retrieve secret parameter values from an external vault, as described in CyberArk Secret Parameters in Connection Profiles.Determines whether to retrieve secret parameter values from an external vault as described in CyberArk Secret Parameters or HashiCorp Secret Parameters.

Connection Timeout

Determines the number of seconds to wait after Control-M initiates a connection request before a timeout occurs.

Default: 30

Microsoft Power BI Connection Profile Parameters

Before you can define a job, you must create a connection profile in the Configuration domain. A connection profile contains authorization credentials—such as the username, password, and other plug-in-specific parameters—and enables you to connect to the application server with only the connection profile name. To create a connection profile, see Creating a Centralized Connection Profile.

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

The following table describes Microsoft Power BI 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.

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/

Use External Vault

Determines whether to retrieve secret parameter values from an external vault, as described in CyberArk Secret Parameters in Connection Profiles.Determines whether to retrieve secret parameter values from an external vault as described in CyberArk Secret Parameters or HashiCorp Secret Parameters.

Microsoft Power BI SP Connection Profile Parameters

Before you can define a job, you must create a connection profile in the Configuration domain. A connection profile contains authorization credentials—such as the username, password, and other plug-in-specific parameters—and enables you to connect to the application server with only the connection profile name. To create a connection profile, see Creating a Centralized Connection Profile.

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

The following table describes Microsoft Power BI SP 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:

  • Username & Password

  • Service Principal

Default: Username & 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.

Use External Vault

Determines whether to retrieve secret parameter values from an external vault, as described in CyberArk Secret Parameters in Connection Profiles.Determines whether to retrieve secret parameter values from an external vault as described in CyberArk Secret Parameters or HashiCorp Secret Parameters.

Tenant ID

Defines a unique identifier associated with an Azure Active Directory (Azure AD) tenant.

HTTP Codes

Defines the HTTP codes that trigger a rerun of a job step if detected in the response.

Multiple HTTP codes must be separated with a space.

You cannot rerun a step with HTTP codes when you perform manual execution, such as rerun from point of failure.

Default: 429 503 408 500

Attempt Reruns

Determines the number of attempts to rerun a job step.

Default: 3

Rerun Interval

Determines the number of seconds to wait before Control-M reruns the job step.

Default: 10

Connection Timeout

Determines the number of seconds to wait after Control-M initiates a connection request before a timeout occurs.

Default: 50

Qlik Cloud Connection Profile Parameters

Before you can define a job, you must create a connection profile in the Configuration domain. A connection profile contains authorization credentials—such as the username, password, and other plug-in-specific parameters—and enables you to connect to the application server with only the connection profile name. To create a connection profile, see Creating a Centralized Connection Profile.

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

The following table describes the Qlik Cloud connection profile parameters.

Parameter

Description

Qlik API URL

Defines the REST API authentication endpoint base URL for Qlik Cloud.

qlikcloud.com/api/v1

Tenant ID

Defines the tenant ID, which is a unit in Qlik Sense that holds users, apps, and spaces.

Region

Determines the region where the Qlik tenant is located, such as Singapore.

API Key

Defines a Qlik Cloud API key that authenticates connections to Qlik Cloud, which is generated through the Qlik Cloud profile.

Use External Vault

Determines whether to retrieve secret parameter values from an external vault, as described in CyberArk Secret Parameters in Connection Profiles.Determines whether to retrieve secret parameter values from an external vault as described in CyberArk Secret Parameters or HashiCorp Secret Parameters.

Connection Timeout

Determines the number of seconds to wait after Control-M initiates a connection request before a timeout occurs.

Default: 10

Tableau Connection Profile Parameters

Before you can define a job, you must create a connection profile in the Configuration domain. A connection profile contains authorization credentials—such as the username, password, and other plug-in-specific parameters—and enables you to connect to the application server with only the connection profile name. To create a connection profile, see Creating a Centralized Connection Profile.

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

The following table describes the Tableau connection profile parameters.

Parameter

Description

Tableau URL

Defines the REST API authentication endpoint base URL for Tableau.

https://prod-useast-b.online.tableau.com

Token Name

Defines the Tableau account access key.

Token Secret

Defines the Tableau account secret access key.

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

Use External Vault

Determines whether to retrieve secret parameter values from an external vault, as described in CyberArk Secret Parameters in Connection Profiles.Determines whether to retrieve secret parameter values from an external vault as described in CyberArk Secret Parameters or HashiCorp Secret Parameters.

Connection Timeout

Determines the number of seconds to wait after Control-M initiates a connection request before a timeout occurs.

Default: 50