Configure a custom message channel

Usage notes

• You can configure message channels at the tenant level to meet your organization's requirements.

• If a message channel is disabled, alert messages cannot be sent. Enable the custom message channel to ensure alert delivery.

Permissions

Super administrators and system administrators can edit message channels. Other users can only view them.

Create a custom message channel

1. On the top menu bar of the Dataphin home page, choose Management Center > System Settings.

2. In the navigation pane on the left, choose Tenant Settings > Message Channel.

3. On the Message Channel Settings (Tenant) page, click the Custom Channel tab.

4. On the Custom Channel tab, click Add Custom Message Channel. On the Add Custom Message Channel page, configure the parameters for sending messages and querying results.

   1. Configure message sending

      Parameter	Description
      Channel Name	The name of the custom message channel. The name must be unique within the current tenant and cannot start with a space. For example: WeChat message channel.
      Description	A description of the channel. Describe the business scenario for the channel. Maximum length: 128 characters. For example: Used to receive alert information from WeChat groups.
      Message Sending URL	The URL for sending messages.
      Request Method	Supported methods: POST and GET. If you select POST, you can configure Headers, Parameters, and Body. If you select GET, you can configure Headers and Parameters.
      Request Parameter Configuration	Headers: Click the +New button to configure Headers parameters. key: A custom key. The key must be unique among all parameters. value: Supports custom input, including constants and built-in parameters. For more information, see Metadata for custom message channels. Type: From the drop-down list, select String, Double, Long, or Boolean. Parameter Encryption: Default: Off. If you turn on this switch, the parameter value is displayed as ******. Important The values of constant parameters in Headers and Body can be encrypted. The values of variable parameters cannot be encrypted. Dataphin desensitizes data during editing and encrypts it in storage, but data is transmitted in plaintext when connecting to the channel. For encrypted transmission, use encrypted text in the configuration and decrypt it in the channel application. Parameters: Click the +New button to configure Parameters. key: A custom key. The key must be unique among all parameters. value: Select a value. Supports custom input, including constants and built-in parameters. For more information, see Metadata for custom message channels. Actions: To edit the Parameters, click the icon in the Actions column. To delete the Parameters parameter, click the icon in the Actions column. Body: Click the +New button to configure Body parameters. key: A custom key. The key must be unique among all parameters. value: Supports custom input, including constants and built-in parameters. For more information, see Metadata for custom message channels. Type: From the drop-down list, select String, Double, Long, Boolean, or JSON. Parameter Encryption: Default: Off. If you turn on this switch, the parameter value is displayed as ******. Actions: To edit the Body parameter, click the icon in the Actions column. To delete the Body parameter, click the icon in the Actions column. Test: Click Test. In the Test Request Sending dialog box, configure test parameters and click Start Test. The Request text box displays the request details. Click the icon to copy the request details. The request body appears only for POST requests. The Response text box displays the response details. Click the icon to copy the response details. Note If the headers contain parameters, you must enter the values for these parameters during the test.
      Sending Result Parsing	Supported parsing methods: By HTTP Status Code and By HTTP Status Code And Response. By HTTP Status Code: The message is considered sent successfully if the status code is 2xx. By HTTP Status Code And Response: Configure custom conditions for a successful delivery.
      Query Result Parsing	key: From the drop-down list, select a key or enter a custom key. value: Enter a custom value. Note If the status code is 2xx and the success conditions are met, the delivery is considered successful. If the status code is not 2xx, the delivery is considered failed. If the status code is 2xx but the failure conditions are met, the delivery is considered failed. In other cases, the status is considered in progress. The system continues polling until the delivery succeeds or fails. You can enter ${response.key} to get the key value from the response.

   2. Configure result query

      Parameter	Description
      Result Query	Default: Off. You can switch it to On. Off: The task is considered successful after the message is sent. On: The system polls for the result after the message is sent. The result is displayed in the Alerting Center.
      Result Query URL	The URL for querying results.
      Request Method	Supported methods: POST and GET. Note If you select POST, you can configure Headers, Parameters, and Body. If you select GET, you can configure Headers and Parameters.
      Request Parameter Configuration	Headers: Click the +New button to configure Headers parameters. key: A custom key. The key must be unique among all parameters. value: Supports custom input, including constants and built-in parameters. For more information, see Metadata for custom message channels. Type: From the drop-down list, select String, Double, Long, or Boolean. Parameter Encryption: Default: Off. If you turn on this switch, the parameter value is displayed as ******. Parameters: Click the +New button to configure Parameters. key: A custom key. The key must be unique among all parameters. value: Select a value. Supports custom input, including constants and built-in parameters. For more information, see Metadata for custom message channels. Actions: To edit the Parameters parameters, click the icon in the Actions column. To delete a Parameters parameter, in the Actions column, click the icon. Body: Click the +New button to configure Body parameters. key: A custom key. The key must be unique among all parameters. value: Supports custom input, including constants and built-in parameters. For more information, see Metadata for custom message channels. Type: From the drop-down list, select String, Double, Long, Boolean, or JSON. Parameter Encryption: Default: Off. If you turn on this switch, the parameter value is displayed as ******. Actions: To edit the Body parameter, click the icon in the Actions column. To delete the Body parameter, click the icon in the Actions column. Test: Click Test. In the Test Request Sending dialog box, configure test parameters and click Start Test. The Request text box displays the request details. Click the icon to copy the request details. The request body appears only for POST requests. The Response text box displays the response details. Click the icon to copy the response details. Note If the headers contain parameters, you must enter the values for these parameters during the test.
      Sending Result Parsing	You can select By HTTP Status Code or By HTTP Status Code And Response. By HTTP Status Code: The message is considered sent successfully if the status code is 2xx. By HTTP Status Code And Response: Configure custom conditions for a successful delivery.
      Query Result Parsing	key: From the drop-down list, select a key or enter a custom key. value: Enter a custom value. Note If the status code is 2xx and the success conditions are met, the delivery is considered successful. If the status code is not 2xx, the delivery is considered failed. If the status code is 2xx but the failure conditions are met, the delivery is considered failed. In other cases, the status is considered in progress. The system continues polling until the delivery succeeds or fails. You can enter ${response.key} to get the key value from the response.

5. Click Send Test Message to verify that the Custom Short Message Service is configured correctly.

   Parameter	Description
   Recipient	From the drop-down list, select a recipient.
   Voice Message	The default message is This Is A Test Message From Dataphin. You can edit the message. The message can be up to 128 characters long.

6. Click Save to complete the custom message channel configuration.

Manage custom message channels

1. The Custom Channel page lists all custom channels. The list includes the Channel Name, Description, Last Updated By, and Last Updated At.

2. (Optional) Enter a channel name keyword to search for a specific channel.

3. In the Actions column for the target channel, perform one of the following operations.

   Operation	Description
   View	Click the icon. On the View Custom Message Channel page, you can view the detailed channel configuration. You can also click Edit Configuration to edit the channel configuration.
   Clone	Click the icon to clone the channel. To modify the cloned channel, click the icon in its Actions column.
   Edit	Click the icon. On the Edit Custom Message Channel page, you can edit all configurations for the channel. For parameter descriptions, see the steps for creating a channel.
   Delete	Click the icon to delete the channel. Once deleted, the channel can no longer receive alert messages.