Data Integration Connection Profiles

The following topics describe connection profiles for data integration platforms and services:

ConnectionProfile:AirbyteLink copied to clipboard

Airbyte is an open-source extract, transform, and load (ETL) service that enables you to build data pipelines and load data to a data warehouse, data lake, database, or analytics tool of your choice.

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

The following example shows how to define an Airbyte connection profile:

CopyCopied to clipboard 
"Airbyte": 
{
   "Type": "ConnectionProfile:Airbyte",
   "Airbyte URL": "https://api.airbyte.com",
   "API Key": "your_api_key_here",
   "Connection Timeout": "10",
   "Description": "",
   "Centralized": true
}

Parameter

Description

Airbyte URL

Defines the Airbyte authentication endpoint.

Default: https://api.airbyte.com

API Key

Defines the Airbyte account access key, which is available on the Airbyte Developer Portal.

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: 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:AWS AppFlowLink copied to clipboard

AWS AppFlow is a managed data integration service that enables you to transfer data between cloud applications (SaaS) and AWS services.

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

The following example shows how to define an AWS AppFlow connection profile that uses AWS IAM Role authentication:

CopyCopied to clipboard 

"AWSAPPFLOW": 
   {
   "Type": "ConnectionProfile:AWS AppFlow",
   "AWS Appflow URL": "https://appflow.Region.amazonaws.com",
   "AWS Region": "us-east-1",
   "Authentication": "NOSECRET",
   "IAM Role": "NOC_ROLE",
   "Connection Timeout": "60",
   "Description": "",
   "Centralized": true
   }

The following example shows how to define an AWS AppFlow connection profile that uses AWS Key and Secret authentication:

CopyCopied to clipboard 

"AWSAPPFLOW": 
   {
   "Type": "ConnectionProfile:AWS AppFlow",
   "AWS Appflow URL": "https://appflow.Region.amazonaws.com",
   "AWS Region": "us-east-1",
   "Authentication": "SECRET",
   "AWS Secret": "wsefwer234wefw3242",
   "AWS Access key ID": "AKIARY7B2LKR2I6FR233",
   "Connection Timeout": "60",
   "Description": "",
   "Centralized": true
   }

The following example shows how to define an AWS AppFlow connection profile that uses AWS Assume Role authentication:

CopyCopied to clipboard 

"AWSAPPFLOW": 
   {
   "Type": "ConnectionProfile:AWS AppFlow",
   "AWS Appflow URL": "https://appflow.Region.amazonaws.com",
   "AWS Region": "us-east-1",
   "Authentication": "ASSUME",
   "Assume Role ARN": arn:aws:iam::123456789012:role/MyRoleName",
   "Assume Role Session":"aws sts assume-role --role-arn arn:aws:iam::123456789012:role/MyRoleName --role-session-name MySession",
   "Connection Timeout": "60",
   "Description": "",
   "Centralized": true
   }

The following table describes Control-M for AWS AppFlow connection profile parameters.

Parameter

Description

AWS AppFlow URL

Defines the AWS AppFlow endpoint.

AppFlow.us-east-2.amazonaws.com

AWS Region

Determines the AWS region where the job is located.

us-east-2

Authentication

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.

  • ASSUME: Authenticates with an AWS IAM role from another AWS account that has access to the service.

IAM Role

Defines the Identity and Access Management (IAM) role name for the AWS service connection.

Assume Role ARN

(AWS IAM Assume Role) Defines the Amazon Resource Name of the role for the Destination account when you utilize AWS IAM Assume Role authentication in the following format:arn:aws:iam::<account-id>:role/<role-name>

 

Assume Role Session

(AWS IAM Assume Role) Defines the session name when you utilize AWS IAM Assume Role authentication.accountlogistics

AWS Access Key ID

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. 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: 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:AWS GlueLink copied to clipboard

Amazon Web Services (AWS) Glue, a serverless data integration service, enables you to define data-driven workflows that automate the movement and transformation of data.

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

The following examples show how to define an AWS Glue connection profile:

  • This JSON-based connection profile authenticates with an AWS access key and secret.

    CopyCopied to clipboard 
    "GLUECONNECTION": 
    {
       "Type": "ConnectionProfile:AWS Glue",
       "AWS Access key ID": "MYAWSACCESSKEY1234",
       "AWS Secret": "myAwsSecret12345",
       "Authentication": "SECRET",
       "AWS Region": "eu-west-2",
       "Glue url": "glue.eu-west-2.amazonaws.com",
       "Connection Timeout": "40",
       "Description": "",
       "Centralized": true
    }

  • This JSON-based connection profile authenticates with an AWS IAM role from inside an EC2 instance.

    CopyCopied to clipboard 
    "GLUECONNECTIONIAM": 
    {
       "Type": "ConnectionProfile:AWS Glue",
       "IAM Role": "GLUEEC2IAMROLE",
       "Authentication": "NOSECRET",
       "AWS Region": "eu-west-2",
       "Glue url": "glue.eu-west-2.amazonaws.com",
       "Connection Timeout": "40",
       "Description": "",
       "Centralized": true
    }

The following table describes the AWS Glue connection profile parameters.

Parameter

Description

Authentication

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 ID

(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

Glue url

Defines the URL of an AWS Glue service regional endpoint.

For more information about regional endpoints available for the AWS Glue 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: 40

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:AWS Glue DataBrewLink copied to clipboard

Amazon Web Services (AWS) Glue DataBrew, a cloud-based ETL service, enables you to visualize your data and publish it to the Amazon S3 Data Lake.

For more information about this plug-in, see Control-M for AWS Glue DataBrew.

The following examples show how to define an AWS Glue DataBrew connection profile:

  • This JSON-based connection profile authenticates with an AWS access key and secret.

    CopyCopied to clipboard 
    "AWSDATABREW":
    {
       "Type": "ConnectionProfile:AWS Glue DataBrew",
       "Authentication": "SECRET", 
       "AWS Access Key": "MYAWSACCESSKEY1234",
       "AWS Secret": "myAwsSecret12345",
       "AWS Region": "us-east-1",
       "AWS Logs URL": "https://logs.{{AWSRegion}}.amazonaws.com",
       "AWS API Base URL": "https://databrew.{{AWSRegion}}.amazonaws.com",
       "Connection Timeout": "30",
       "Description": "",
       "Centralized": true
    }

  • This JSON-based connection profile authenticates with an AWS IAM role from inside an EC2 instance.

    CopyCopied to clipboard 
    "AWSDATABREW": 
    {
       "Type": "ConnectionProfile:AWS Glue DataBrew",
       "Authentication": "NOSECRET", 
       "IAM Role": "IAMROLE", 
       "AWS Region": "us-east-1",
       "AWS API Base URL": "https://databrew.{{AWSRegion}}.amazonaws.com",
       "AWS Logs URL": "https://logs.{{AWSRegion}}.amazonaws.com",
       "Connection Timeout": "30",
       "Description": "",
       "Centralized": true
    }

The following table describes the AWS Glue DataBrew connection profile parameters.

Parameter

Description

Authentication

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 API Base URL

Defines the REST API URL for the AWS Glue DataBrew regional endpoint, as follows:

https://databrew.<AWSRegion>.amazonaws.com

For more information about regional endpoints available for the AWS Glue DataBrew service, refer to the AWS documentation.

AWS Logs URL

Defines the AWS Logs URL, as follows:

https://logs.<AWSRegion>.amazonaws.com

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:ADF (Azure Data Factory)Link copied to clipboard

Azure Data Factory (ADF), a cloud-based ETL and data integration service, allows you to create data-driven workflows to automate the movement and transformation of data.

For more information about this plug-in, see Control-M for Azure Data Factory.

The following examples show how to define an ADF connection profile:

  • This JSON-based connection profile authenticates with an Azure service principal.

    CopyCopied to clipboard 
    "ADF_SERVPRINC":
    {
       "Type": "ConnectionProfile:ADF",
       "Tenant ID": "tenantId",
       "Identity Type": "PRINCIPAL",
       "Client Secret": "*****",
       "Application ID": "applicationId",
       "Subscription ID": "subscriptionId",
       "Connection Timeout": "40",
       "Description": "",
       "Centralized": true
    }

  • This JSON-based connection profile authenticates with a managed identity.

    CopyCopied to clipboard 
    "ADF_MANID":
    {
       "Type": "ConnectionProfile:ADF",
       "Identity Type": "MANAGEDID",
       "Specify Managed Identity Client ID": "&client_id=",
       "Managed Identity Client ID": "72d448f0-ac32-45ea-9158-f8653e4ee16",  
       "Subscription ID": "subscriptionId",
       "Connection Timeout": "40",
       "Description": "",
       "Centralized": true
    }

The following table describes the ADF connection profile parameters.

Parameter

Description

Identity Type

Determines one of the following authentication methods:

  • PRINCIPAL: Access protected Azure services and resources based on roles assigned to the Service Principal by the Azure administrator. The Service Principal is also known as an App Registration. Use this method if the Control-M/Agent is installed on-premises or with another (non-Azure) cloud vendor.

  • MANAGEDID: Access protected Azure services and resources using a key created and managed by the Azure platform, without login credentials. Use this method if the Control-M/Agent is installed on an Azure virtual machine that has a Managed Identity with the required permissions.

Specify Managed Identity Client ID

(Managed identity authentication) Determines whether the managed identity is specified by the Managed Identity Client ID parameter.

This parameter must be included when you use the Managed Identity authentication method and there are multiple managed identities defined on your Azure VM.

Valid Values:

  • "&client_id=": The Managed Identity Client ID parameter contains the managed identity used for authentication. You must specify this value when your Azure VM has multiple managed identities.

  • "": The Managed Identity Client ID parameter does not contain a managed identity value. The managed identity is automatically retrieved from the Azure VM.

Managed Identity Client ID

(Managed identity authentication) Defines the client ID of the managed identity used for access.

This parameter requires a value only if there are multiple managed identities defined on your Azure VM and you included the Specify Managed Identity Client ID parameter.

If there is only one managed identity, it is detected automatically.

Tenant ID

(Service principal) Defines the Azure tenant ID for your organization.

Client Secret

(Service principal ) Defines the password associated with the Service Principal/registered application.

You can use Secrets in Code to hide this value in the code.

Application ID

(Service principal ) Defines the Registered App for the Azure service in your Microsoft Entra/Azure AD tenant. The corresponding Service Principal must be assigned the Owner or Contributor role for the Azure service.

Subscription ID

Defines the Azure account ID of your organization.

You can retrieve the subscription ID from the Subscription menu in the Azure portal.

Connection Timeout

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

Default: 40

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:BoomiLink copied to clipboard

Boomi AtomSphere enables the integration of Boomi processes with your existing Control-M workflows.

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

The following example shows how to define a Boomi connection profile:

CopyCopied to clipboard 
"BOOMICCP": 
{
   "Type": "ConnectionProfile:Boomi",
   "AccountId": "*****",
   "API Token": "*****",
   "End Point": "https://api.boomi.com",
   "API Username": "BOOMI_TOKEN.BoomiUsername",
   "Description": "",
   "Centralized": true
}

The following table describes the Boomi connection profile parameters.

Parameter

Description

AccountId

Defines a unique Boomi AtomSphere account ID.

API Token

Defines a Boomi AtomSphere API Token of a Boomi user for connection to the Boomi endpoint.

You can use Secrets in Code to hide this value in the code.

End Point

Defines the Boomi API endpoint, as follows:

https://api.boomi.com

API Username

Defines the Boomi username in email format, as follows:

BOOMI_TOKEN.<Boomi_username>@<email_suffix>

BOOMI_TOKEN.user@example.com

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:GCPDF (GCP Data Fusion)Link copied to clipboard

GCPDF (GCP Data Fusion) enables you to load data from multiple sources, visualize it, and publish it to the cloud.

For more information about this plug-in, see Control-M for GCP Data Fusion.

The following example shows how to define a GCPDF connection profile. In the following example, authentication is based on a service account:

CopyCopied to clipboard 
"GCP Cloud Data Fusion":
{
   "Type": "ConnectionProfile:GCPDF",
   "Identity Type": "service_account",
   "GCP Data Fusion URL": "https://datafusion.googleapis.com",
   "Service Account Key": "*****",
   "Connection Timeout": "20",
   "Description": "",
   "Centralized": true
}

The following table describes the GCPDF connection profile parameters.

Parameter

Description

Identity Type

Determines one of the following authentication types with GCP Access Control:

  • service_account: Authenticates with an application ID (service account) and client secret.

  • os_user: Authenticates based on a detected IAM role, which removes the need to provide additional credentials.

GCP API URL

(Service account) Defines the Google Cloud Platform (GCP) authentication endpoint for GCP Data Fusion, as follows:

https://datafusion.googleapis.com

Service Account Key

(Service Account) Defines a service account that is associated with an RSA key pair.

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: 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:GCP DataplexLink copied to clipboard

GCP Dataplex is an extract, transform, and load (ETL) service that enables you to visualize and manage data in GCP BigQuery and the cloud.

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

The following examples show how to define a GCP Dataplex connection profile:

  • This JSON defines a connection profile based on a Service Account.

    CopyCopied to clipboard 
    "GCP_DATAPLEX_SERVICE_ACCOUNT": 
    {
       "Type": "ConnectionProfile:GCP Dataplex",
       "Identity Type": "service_account",
       "GCP Dataplex URL": "https://dataplex.googleapis.com ",
       "Service Account Key": "*****",
       "Connection Timeout": "30",
       "Description": "",
       "Centralized": true
    }

  • This JSON defines a connection profile based on IAM.

    CopyCopied to clipboard 
    "GCP_DATAPLEX_IAM": 
    {
       "Type": "ConnectionProfile:GCP Dataplex",
       "Identity Type": "os_user",
       "GCP Dataplex URL": "https://dataplex.googleapis.com",
       "Connection Timeout": "30",
       "Description": "",
       "Centralized": true
    }

The following table describes the GCP Dataplex connection profile parameters.

Parameter

Description

Identity Type

Determines one of the following authentication types with GCP Access Control:

  • service_account: Authenticates with an application ID (service account) and client secret.

  • os_user: Authenticates based on a detected IAM role, which removes the need to provide additional credentials.

GCP Dataplex URL

Defines the Google Cloud Platform (GCP) authentication endpoint for GCP Dataplex.

https://dataplex.googleapis.com

Service Account Key

(Service Account) Defines a service account that is associated with an RSA key pair.

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: 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:GCP DataprepLink copied to clipboard

GCP Dataprep enables you to visualize, format, and prepare your data for analysis.

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

The following example shows how to define a GCP Dataprep connection profile:

CopyCopied to clipboard 
"GCP_DATAPREP":
{
   "Type": "ConnectionProfile:GCP Dataprep",
   "GCP Dataprep URL": "https://api.clouddataprep.com",
   "User Access Token": "*****",
   "Connection Timeout": "30",
   "Description": "",
   "Centralized": true
}

The following table describes GCP Dataprep connection profile parameters.

Parameter

Description

GCP Dataprep URL

Defines the GCP Dataprep API authentication endpoint for Dataprep, as follows:

https://api.clouddataprep.com

User Access Token

Defines a token that enables you to authenticate Control-M and connect to your GCP Dataprep account.

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: 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:IBM DataStageLink copied to clipboard

IBM DataStage jobs let you use Agents on Linux and Windows machines to create and monitor DataStage jobs.

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

The following example shows how to define an IBM DataStage connection profile for Agents on Windows that uses the Local User authentication method:

CopyCopied to clipboard 
"LOCAL-USER": {
    "Type": "ConnectionProfile:IBM DataStage Windows",
    "Authentication Method": "{{Empty}}",
    "DSJOB Path": "c:\\IBM\\InformationServer\\Clients\\Classic\\dsjob.exe",
    "Description": "",
    "Centralized": true
  }

The following example shows how to define an IBM DataStage connection profile for Agents on Linux that uses the Server Login authentication method:

CopyCopied to clipboard 
"FACTORY_DATASTAGE": 
{
    "Type": "ConnectionProfile:IBM DataStage Linux",
    "Authentication Method": "-domain {{DomainName}} -user {{UserName}} -password {{Password}} -server {{ServerName}}",
    "Domain": "domain=[2002:920:c000:217:9:32:217:32]:9080"
    "Server Name": "myserver.bmc.com ",
    "User Name": "isadmin",
    "Password": "*****",
    "DSJOB Path": "/opt/IBM/InformationServer/Server/DSEngine/bin/dsjob",
    "Description": "",
    "Centralized": true
  }

The following example shows how to define an IBM DataStage connection profile for Agents on Windows that uses the Authentication File authentication method:

CopyCopied to clipboard 
"AUTHENTICATION_FILE": {
    "Type": "ConnectionProfile:IBM DataStage Windows",
    "Authentication Method": "-authfile {{AuthFile}}",
    "Authentication File": "c:\\auth.txt",
    "DSJOB Path": "c:\\IBM\\InformationServer\\Clients\\Classic\\dsjob.exe",
    "Description": "",
    "Centralized": true
    }

The following table describes the IBM DataStage integration connection profile parameters.

Parameter

Authentication Method

Description

Authentication Method

All

Determines one of the following ways to access the IBM DataStage server:

  • Local User: Logs in as the locally defined Control-M/Agent user. The Agent must be installed on the same machine as the IBM DataStage server. The value of the Authentication Method parameter is {{Empty}}. See the code example above.

  • Authentication File: Retrieves the IBM DataStage server name and login credentials from the file defined in the Authentication File parameter. The value of the Authentication Method parameter is a reference to the Authentication File parameter. See the code example above.

  • Server Login: Submits the values defined in the User Name and Password parameters to the server defined in the Server Name/Domain Name parameters. The value of the Authentication Method parameter is a set of references to the User Name, Password, Server Name, and Domain Name parameters. See the code example above.

The Authentication File and Server Login methods let you submit jobs to a remote IBM DataStage server. If the Agent is not installed on the same machine as the IBM DataStage server, the IBM DataStage Client must be installed on the Agent to run dsjob commands.

Server Name

Server Login

Defines the name of the IBM DataStage engine.

Domain Name

Server Login

(Optional) Defines the domain of the IBM DataStage engine.

User Name

Server Login

Defines the username for the IBM DataStage server.

Password

Server Login

Defines the password for the IBM DataStage server.

Authentication File

Authentication File

Defines the full path including filename on the Agent machine that contains domain/server and user credentials, in the following format:

user=username

password=pwd_string

server=hostname_or_IP
domain=dns.domain.string

DSJob Path

All

Defines the full path of the dsjob executable file on the Control-M/Agent.

This path is for all jobs that use this connection profile.

Centralized

 All

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:InformaticaLink copied to clipboard

Informatica enables you to automate tasks or workflows based on the parameters that you define.

The following example shows how to define an Informatica connection profile:

CopyCopied to clipboard 
"INFORMATICA_CONNECTION": 
{
   "Type": "ConnectionProfile:Informatica",
   "Host": "InformaticaHost",
   "Port": "7333",
   "User": "UserName",
   "Password": "Password",
   "PowerCenterDomain": "DomainName",
   "Repository": "RepositoryName",
   "IntegrationService": "ServiceName",
   "SecurityDomain": "Native",
   "ConnectionType": "HTTP",
   "MaxConcurrentConnections": "100",
   "Centralized": true
}

The following table describes the Informatica connection profile parameters.

Parameter

Description

Host

Defines the name of the Informatica web services server.

Port

(Optional) Defines the port number of the Informatica web services server.

Valid Values: 1–65,535

Default: 7,333

User

Defines the name of a user to log into the Repository.

Password

Defines a password to log into the Repository.

You can use Secrets in Code to hide this value in the code.

PowerCenterDomain

Defines the name of the Informatica server that contains the Repository service.

Repository

Determines the name of the repository where the Repository folders and workflows are located.

IntegrationService

Defines the name of the integration service to use to run the workflows.

SecurityDomain

Defines a collection of user accounts and groups in a Power Center Domain.

If the user name belongs to the native security domain, this parameter is optional, and the default is an empty value.

If the user name belongs to an LDAP security domain, this parameter is required.

ConnectionType

(Optional) Determines the protocol for the connection to the Informatica server.

Valid Values:

  • HTTP

  • HTTPS

MaxConcurrentConnections

(Optional) Determines the maximum number of allowed concurrent workflows in the connection profile

Valid Values: 1–512

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:Informatica CSLink copied to clipboard

Informatica Cloud Services (CS) enables you to automate your Informatica workflows for multi-cloud and on-premises data integration through the Control-M environment.

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

The following example shows how to define an Informatica CS connection profile:

CopyCopied to clipboard 
"INFORMATICA_CS_CONNECTION": 
{
   "Type": "ConnectionProfile:Informatica CS",
   "Login URL": "https://dm-us.informaticacloud.com",
   "Base URL": "https://usw5.dm-us.informaticacloud.com", 
   "Username": "UserName",  
   "Password": "Password", 
   "Request Timeout": "3", 
   "Description": "", 
   "Centralized": true 
}

The following table describes the Informatica CS connection profile parameters.

Parameter

Description

Login URL

Defines the URL to connect to Informatica Cloud Services.

Base URL

Defines the instance name of the Informatica Cloud Services server.

Username

Defines a username for the account to connect to Informatica Cloud Services.

Password

Defines a password for the login to Informatica Cloud Services.

You can use Secrets in Code to hide this value in the code.

Request Timeout

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

Default: 3

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:MatillionLink copied to clipboard

Matillion is a data integration service that enables data transfer and ETL processing.

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

The following example shows how to define a Matillion connection profile that connects to the Matillion Data Productivity Cloud:

CopyCopied to clipboard 

"MATILLION": {
   "Type": "ConnectionProfile:Matillion",
   "Matillion Base URL": " https://\{{Region}}.api.matillion.com",
   "Client Id": "47f88ab9-131a-4b99-b072-d3fsdf9a8011f",
   "Client Secret": "*****",
   "Environment": "DataProductivityCloud",
   "Region": "us1",
   "Connection Timeout": "20",
   "Description": "",
   "Centralized": true
   }

The following example shows how to define a Matillion connection profile that connects to a local instance of Matillion ETL:

CopyCopied to clipboard 

"ETLMAT": {
   "Type": "ConnectionProfile:Matillion",
   "Matillion ETL Instance URL": "http://172.166.59.666",
   "Environment": "MatillionETL",
   "Region": "us1",
   "Username": "a-user",
   "Password": "*****",
   "Description": "",
   "Connection Timeout": "20",
   "Centralized": true
   }

The following table describes the Matillion connection profile parameters.

Parameter

Environment

Description
Environment

  • Matillion Data Productivity Cloud

  • Matillion ETL

Determines one of the following Matillion services to access:

  • DataProductivityCloud: Accesses the Matillion cloud service.

  • MatillionETL: Accesses the Matillion service on a virtual machine in your environment.

Matillion ETL instance URL

Matillion ETL

Defines the base URL of the virtual machine that hosts the Matillion ETL service.
Matillion Base URL

Matillion Data Productivity Cloud

Defines the target URL in the Matillion Data Productivity Cloud, in the following format:
https://<region>.api.matillion.com

where

<region> is the value defined in the Region parameter.
Region

Matillion Data Productivity Cloud

Defines the virtual region of the account, which is defined in the Client ID parameter.
Client Id

Matillion Data Productivity Cloud

Defines a user account in the Matillion Data Productivity Cloud.

Client Secret

Matillion Data Productivity Cloud

Defines the password for the account, which is defined in the Client ID parameter.
Username

Matillion ETL

Defines a user on the Matillion ETL virtual machine.

Password

Matillion ETL

Defines the password of the Matillion ETL user, which is defined in the Username parameter. You can use Secrets in Code to hide this value in the code.

Connection Timeout

  • Matillion Data Productivity Cloud

  • Matillion ETL

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

Default: 20

Centralized

  • Matillion Data Productivity Cloud

  • Matillion ETL

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.

Connection Profile:OCI Data IntegrationLink copied to clipboard

OCI Data Integration is an Oracle Cloud Infrastructure (OCI) platform, that enables data extraction, transformation, and loading (ETL) processes across various sources and targets within the Oracle Cloud.

For more information about this plug-in, see Control-M for OCI Data Integration.

The following example shows how to define an OCI Data Integration connection profile, that authenticates with DefineParameters:

CopyCopied to clipboard 
"ODI": 
{
   "Type": "ConnectionProfile:OCI Data Integration",
   "OCI Data Integration URL": "https://dataintegration.us-phoenix-1.oci.oraclecloud.com",
   "OCI Region": "us-phoenix-1",
   "Authentication": "DefineParameters",
   "User OCID": "ocid1.user.oc1..aaafdgfgaat56ecah7yw7ebl6pffgh678758kdsfsdf44787zp2dzsa4k2qyxn45wtaa",
   "Tenancy OCID": "ocid1.tenancy.oc1..aaadfghgaaak445azt6b2346uvi2afhgghfghhhtryradsaasdasd",
   "Fingerprint": "67:45:eb:c6:16:h3:67:s6:fd:ac:gf:a6:7q:ad:bb:2f",
   "Private Key": "*****",
   "Description": "",
   "Connection Timeout": "30",
   "Centralized": true
}

The following table describes OCI Data Integration connection profile parameters.

Parameter

Authentication Method

Description

OCI Data Integration URL

All methods

Defines the OCI Data Integrations URL in the following format:

https://dataintegration.<region>.oci.oraclecloud.com

OCI Region

All methods

Determines the region where the OCI Data Integration is located.

Authentication

All methods

Determines one of the following authentication methods:

  • DefineParameters: Defines authentication parameters in the connection profile.

  • ConfigurationFile: Uses a configuration file that contains authentication information and is stored on the Control-M/Agent.

    The following example of a configuration file defines the DEFAULT profile for Linux and the PROFILE2 profile for Windows.

    CopyCopied to clipboard 
    [DEFAULT] 
    user=ocid1.user.oc1..aaaaaaaa4vcihdfhrdtyry457245636cqqcljd6yrcukszg7gzoymoyvkyupivpjfnq
    tenancy=ocid1.tenancy.oc1..aaa456y4e3yrtyue9f8djfihhwp2cu4e6t2b7lttna7rcgnhrdi4qzika
    fingerprint=9f:af:df:f5:5g:95:92:7c:34:ab:46:d3:b4:30:e6:9e
    region=us-phoenix-1
    key_file=/home/dbauser/key.pem 

    [PROFILE2] 
    user=ocid1.user.oc1..aaaaaaaa4v768679dfhrd8989JHGJG36cqqcljd6yrcukszg7gzoymoyvkyupivpjfnq
    tenancy=ocid1.tenancy.oc1..aaa456y4e3yrtyue987erum,gfwp2cu4e6t2b7lttna7rcgnhrdi4qzika
    fingerprint=9f:af:c0:f5:7b:95:92:7c:03:a5:46:g3:b4:38:e6:9e
    region=us-phoenix-1
    key_file=C:\\Users\\dbauser\\key.pem

User OCID

All methods

Defines an individual user within the OCI environment.

Tenancy OCID

DefineParameters

Defines the OCI Tenacy ID in the OCI Data Integration, which is a global unique identifier for this account within the OCI environment.

Fingerprint

DefineParameters

Defines a fingerprint which uniquely identifies and verifies the integrity of the associated certificate or key.

Private Key

DefineParameters

Defines the private key within a set of API signing keys that are used for authentication and secure access to OCI resources.

You can use Secrets in Code to hide this value in the code.

Config File Path

ConfigurationFile

Defines the path to the configuration file that contains authentication information.

This file is stored on the Control-M/Agent.

UNIX: home/user/config/pem.pem

Windows: C:\Users\user1\config\\pem.pem

Profile

ConfigurationFile

Defines the name of a specific section in the configuration file, such as DEFAULT and PROFILE2 in the Configuration File code sample.

Connection Timeout

All methods

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

Default: 20

Centralized

All methods

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:Talend Data ManagementLink copied to clipboard

Talend Data Management is an automation service that enables you to integrate applications, and extract, transform, load, and check the quality of large amounts of data.

For more information about this plug-in, see Control-M for Talend Data Management.

The following example shows how to define a Talend connection profile:

CopyCopied to clipboard 
"TALENDDATA":
{
   "Type": "ConnectionProfile:Talend Data Management",
   "API URL": "https://api.eu.cloud.talend.com/tmc/v2.6",
   "Personal access token authorization": "*****",
   "Description": "Talend Data Management",
   "Centralized": true
}

The following table describes the Talend connection profile parameters.

Parameter

Description

API URL

Defines the authentication endpoint base URL for the Talend Cloud Management Console, as follows:

https://api.<Region>.cloud.talend.com/tmc/v2.6

where <Region> is one of the following values:

  • us: Eastern United States

  • eu: Europe

  • us-west: Western United States

  • au: Australia

  • ap: Asia

https://api.eu.cloud.talend.com/tmc/v2.6

Personal access token authentication

Defines a Talend token to authenticate connections to Talend.

You generate this token through your Talend profile.

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.

Connection Profile:Talend OAuth Link copied to clipboard

Talend OAuth (Open Authorization) enables you to use OAuth authentication within the Talend suite of data integration and management tools. It allows third-party applications to access resources on behalf of a user without sharing sensitive credentials.

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

The following example shows how to define a Talend OAuth connection profile:

CopyCopied to clipboard 
"TALEND":
{
   "Type": "ConnectionProfile:Talend OAuth",
   "Talend API URL": "https://api.eu.cloud.talend.com",
   "Region": "eu",
   "Client ID": "D4leqpN21SrsebBqbBBTKHUnccsizUdebrdbaasfwfw",
   "Client Secret": "*****",
   "Connection Timeout": "30",
   "Description": "",
   "Centralized": true
}

The following table describes the Talend OAuth connection profile parameters.

Parameter

Description
Talend API URL

Defines the authentication endpoint base URL for the Talend Cloud Management Console, as follows.

https://api.<region>.cloud.talend.com

Region

Determines one of the following regions where the Talend jobs are located:

  • eu: Europe

  • us: Eastern United States

  • us-west: Western United States

  • au: Australia

  • ap: Asia

Default: eu

Client ID

Defines the Client ID that is used to get an OAuth2 JWT access token through the Client ID Grant flow.

Client Secret

Defines the Client Secret (password) that is used to get an OAuth2 JWT access token through the Client Secret Grant flow.

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: 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:TRIFACTALink copied to clipboard

Alteryx Trifacta is a data-wrangling platform that allows you to discover, organize, edit, add to, and publish data in different formats and to multiple clouds, including AWS, Azure, Google, Snowflake, and Databricks.

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

The following example shows how to define an Alteryx Trifacta connection profile:

CopyCopied to clipboard 
"TRIFACTA":
{
   "Type": "ConnectionProfile:TRIFACTA",
   "Trifacta URL": "https://cloud.trifacta.com",
   "User Name": "User Name",
   "Password": "Password",
   "Connection Timeout": "10",
   "Description": " ",
   "Centralized": true
}

The following table describes the Alteryx Trifacta connection profile parameters.

Parameter

Description

Trifacta URL

Defines the Alteryx Trifacta authentication endpoint, as follows:

https://cloud.trifacta.com

User Name

Defines the registered user name or email address for your Alteryx Trifacta account.

Password

Defines the password for the Alteryx Trifacta user.

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.