Messaging and Communication Connection Profiles

The following topics describe connection profiles for messaging and communication platforms and services:

ConnectionProfile:Atlassian Jira

Atlassian Jira is an issue and project tracking platform to manage software development, IT operations, and business workflows.

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

  • The following example shows how to define an Atlassian Jira connection profile with the Jira Data Center platform:

    Copy 
    {
       "JIRADATACENTER": 
       {
          "Type": "ConnectionProfile:Atlassian Jira",
          "Jira Platform": "JiraDataCenter",
          "Jira Data Center URL": "http://10.10.10.10:8080",
          "Jira Data Center Token": "*****",
          "Connection Timeout": "60",
          "Description": "",
          "Centralized": true
       }
    }

  • The following example shows how to define a Atlassian Jira connection profile with the Jira Cloud platform:

    Copy 
    {
       "JIRAClOUD": 
       {
          "Type": "ConnectionProfile:Atlassian Jira",
          "Jira Platform": "JiraCloudPlatform",
          "Jira URL": "https://1234.atlassian.net/",
          "Atlassian Email": "[email protected]",
          "Atlassian Token": "*****",
          "Connection Timeout": "60",
          "Description": "",
          "Centralized": true
       }
    }

The following table describes the Atlassian Jira connection profile parameters.

Parameter

Description

Jira Platform

Determines one of the following Jira platforms:

  • JiraDataCenter

  • JiraCloudPlatform

Jira Data Center URL

Defines the authentication endpoint for the Jira Data Center in the following format:

https://(hostname):(port)

Jira URL

Defines the authentication endpoint for Jira Cloud Platform in the following format:

https://<Tenant Name>.atlassian.net/

Atlassian Email

Defines the Atlassian account email associated with your Jira Cloud account.

Jira Data Center Token

Defines the Personal Access Token (PAT) used to authenticate and authorize requests to Jira Data Center.

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

Atlassian Token

Defines the Personal Access Token (PAT) generated in Atlassian Jira Cloud.

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: 60

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:Communication Suite

Communication Suite enables you to automate business messaging and communication over Microsoft Teams, Slack, Telegram, and WhatsApp.

For more information about this plug-in, see Control-M Communication Suite.

The following example shows how to define a Communication Suite connection profile:

The following table describes the Communication Suite connection profile parameters.

Parameter

Description

Microsoft Teams Webhook URL

Defines an incoming Microsoft Workflow, which enables Control-M to communicate over Microsoft Teams channels.

You must create this Microsoft Workflow in Teams, before you can add it to the connection profile.

Slack Webhook URL

Defines an incoming webhook, which enables Control-M to communicate over Slack channels.

You must create this webhook in Slack before you can add it to the connection profile.

Telegram URL

Determines the authentication endpoint for Telegram, which enables Control-M to connect to a Telegram bot.

Default: https://api.telegram.org/bot

Telegram Bot Token

Defines a password that is used to authenticate Control-M, which enables you to access and communicate with a Telegram bot.

You must create this bot in Telegram before you can add it to the connection profile.

Telegram Chat ID

Defines a unique identifier that is assigned to a specific chat conversation in Telegram, which enables you to communicate through a bot in this chat conversation.

WhatsApp URL

Determines the authentication endpoint for WhatsApp, which enables Control-M to connect to WhatsApp.

Format: https://graph.facebook.com/<Version>/<PhoneNumberId>/messages

WhatsApp Business ID

Defines the unique ID that is associated with your WhatsApp business account.

This enables Control-M to communicate over WhatsApp with customers who are connected to this account.

You must create a WhatsApp business account before you can add it to the connection profile.

Phone Number ID

Defines a unique ID that is associated with the WhatsApp user.

Recipient Phone Number

Defines the country code and phone number of the WhatsApp user.

User Access Token

Defines a password that is used to authenticate Control-M, which enables you to access your WhatsApp Business API and perform actions with this account.

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

Version

Defines the WhatsApp API version number.

Default: v15.0

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:Datadog

Datadog enables you to gain end-to-end visibility into the health and performance of applications, infrastructure, and network systems across cloud and hybrid environments.

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

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

Copy 
{
   "DATADOG": 
   {
      "Type": "ConnectionProfile:DATADOG",
      "Datadog URL": "https://api.us5.datadoghq.com",
      "API Key": "0a4bf2c4d93336e8b39186db53a62d6c",
      "Application Key": "7b4eb943075b97c02a1d69c8d8b50891015d9c4c",
      "HTTP Codes": "429 404",
      "Attempt Reruns": "3",
      "Rerun Interval": "10",
      "Connection Timeout": "50",
      "Description": "",
      "Centralized": true
   }
}

The following table describes the Datadog connection profile parameters.

Parameter

Description

Datadog URL

Defines the base API URL for the selected site.

https://api.us3.datadoghq.com

API Key

Defines the organization-level key to authenticate API requests.

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

Application Key

Defines the user-level key that grants access to create, modify, or delete resources.

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

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 404

Rerun Interval

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

Default: 10

Attempts Rerun

Determines the number of attempts to rerun a job step.

Default: 3

Connection Timeout

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

Default: 60

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:PagerDuty

PagerDuty enables you to perform incident management and response in automated workflows and job scheduling.

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

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

Copy 
{
   "PAGERDUTY": 
   {
      "Type": "ConnectionProfile:PagerDuty",
      "Pager Duty URL": "https://api.pagerduty.com",
      "API Key": "*****",
      "Connection Timeout": "50",
      "Description": "",
      "Centralized": true
   }
}

The following table describes the PagerDuty connection profile parameters.

Parameter

Description

PagerDuty URL

Defines the following URL for the PageDuty API:

https://api.pagerduty.com

Connection Timeout

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

Default: 50

API Key

Defines the API key to generate in PagerDuty for the API authentication.

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.