Messaging and Communication Jobs

The following topics describe job attributes that work with messaging and communication platforms and services:

Communication Suite Job

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

To create a Communication Suite job, see Creating a Job. For more information about this plug-in, see Control-M Communication Suite.

The following table describes the Communication Suite job type attributes.

Attribute

Description

Connection Profile

Determines the authorization credentials that are used to connect Control-M to Communication Suite, as described in Communication Suite Connection Profile Parameters.

Rules:

  • Characters: 1−30

  • Case Sensitive: Yes

  • Invalid Characters: Blank spaces.

Application Name

Determines one of the following communications platforms to use:

  • Microsoft Teams: An instant-messaging, media sharing, file storage, application integration, and voice and video call service that runs on a computer or phone and does not require a phone number.

  • Slack: An instant-messaging, media sharing, and voice and video call service that runs on a computer or phone and does not require a phone number.

  • Telegram: An instant-messaging, end-to-end encrypted chat, and voice-over-IP (VoIP) voice and video call service that requires a mobile telephone number.

  • WhatsApp: An instant-messaging and voice-over-IP (VoIP) voice and video call service that requires a mobile telephone number.

Teams Parameters

Defines the parameters, in JSON format, that instruct Teams to perform multiple actions.

This sends the message, "Hello, World."

Copy 
{"text": "Hello World"}

Slack Parameters

Defines the parameters, in JSON format, that instruct Slack to perform multiple actions.

This sends the message, "This is a plain text section block."

Copy 
{
   "blocks": [
   {
      "type": "section",
      "text": 
      {
         "type": "plain_text",
         "text": "This is a plain text section block."
      }
   } ]
}

Telegram Parameters

Defines the parameters, in simple text format, that instruct Telegram to perform multiple actions.

Rule: 1–4096 characters.

You can add Control-M variables to the text.

The job finished successfully. The Order ID number is: %%ORDERID.

Silent Message

Determines whether to send your Telegram message without a notification, which is useful for after-hours or non-urgent messages.

Protect Content

Determines whether to prevent your Telegram message from being saved or forwarded.

WhatsApp Parameters

Defines the parameters, in JSON format, that instruct WhatsApp to perform multiple actions.

This creates a text message template, which enables you to send notifications or reminders to subscribers.

Copy 
{
   "messaging_product": "whatsapp",
   "to": "{{phone number you want to send to}}",
   "type": "template",
   "template": 
   {
      "name": "hello_world",
      "language": 
      {
         "code": "en_US"
      }
   }
}

PagerDuty Job

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

To create a PagerDuty job, see Creating a Job. For more information about this plug-in, see Control-M PagerDuty.

The following table describes the PagerDuty job type attributes.

Attribute

Action

Description

Connection profile

All actions

Determines the authorization credentials that are used to connect Control-M to PagerDuty, as described in PagerDuty Connection Profile Parameters.

Rules:

  • Characters: 1−30

  • Case Sensitive: Yes

  • Invalid Characters: Blank spaces.

Action

NA

Determines one of the following actions to perform on PagerDuty:

  • Create an Incident

  • Create an Incident - Detailed

  • Update an Incident

  • Snooze an Incident

  • Incident Details

Incident ID

  • Snooze an Incident

  • Update an Incident

  • Incident Details

Defines a unique identifier assigned to each incident, which allows you to reference, track, and manage the incident.
Email Address

  • Create an Incident

  • Create an Incident - Detailed

  • Update an Incident

  • Snooze an Incident

Defines an email address for a valid user in your PagerDuty platform.

Parameters

  • Create an Incident

  • Update an Incident

Defines specific parameters, in JSON format, to pass when the job executes:

The following example shows the parameters to create an incident template:

Copy 
{
  "incident": {
    "type": "incident",
    "title": "The server disk is getting full on this machine",
    "service": {
      "id": "P9VABOD",
      "type": "service_reference"
    },
    "priority": null,
    "urgency": "high",
    "incident_key": "baf7cf21b1da41b4b0221008339ff123",
    "body": {
      "type": "incident_body",
      "details": "A disk is getting full on this machine."
    }
  }
}

Title

Create an Incident - Detailed

Defines the title that describes the incident.

Service ID

Create an Incident - Detailed

Defines the identifier of the service.

Urgency

Create an Incident - Detailed

Determines the current urgency of the incident.

Incident Key

Create an Incident - Detailed

Defines the de-duplication key of the incident.

Incident Body

Create an Incident - Detailed

Describes details of the incident.