Dataphin:Configure text message channel

Usage instructions

• Message sending channels can be configured globally at the instance level or for each tenant. Configure them according to your organization's needs.

• If the message channel is disabled, configured alert messages will not be sent. To ensure the smooth delivery of alert messages, please activate the text message channel.

Permission instructions

• Metadata warehouse tenant super administrators and system administrators at the instance level have the authority to modify message channels.

• At the tenant level, super administrators and system administrators can edit message channels, while other users may only view them.

Configure Short Message Service

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

2. In the left menu bar, select System Settings > Message Channel.

3. On the Message Channel Settings page, click the Text Message tab.

4. After selecting Channel Settings and choosing Tenant Custom, select Voice Service. Different voice services require different parameters, as detailed in the table below.

   Alibaba cloud Short Message Service

   1. Configure Parameters

      Parameter	Description
      Region	Select a region.
      AccessKey ID	Enter the AccessKey ID. To create a new one, click Create Accesskey.
      AccessKey Secret	Enter the AccessKey Secret. Click Test Connection: If successful, a message indicating connectivity test passed will be displayed. If failed, the connectivity test failed. Please check whether the entered AccessKey ID and AccessKey Secret are correct.
      Sign	Select a sign from the dropdown box. To create one, click the Create Sign button.
      Configure Template	To quickly create a template, click the One-click Create button. Note After creation, the template name and ID will automatically backfill into the following template selection input boxes. If a template with the same name already exists when creating a template, the same name template will not be created. You can select the template or manually create a template.
      Dataservice Studio,Data Quality,Real-time Task Alert,Offline Task Alert,Task Instance Not Generated,Baseline Task Error,Baseline Task Slowdown,Baseline Warning,Baseline Break	Select a template from the dropdown box. Click the Create Template button. Note After creation, the created template will automatically backfill into the template input box. If a template with the same name already exists when creating a template, the same name template will not be created. You can select the template or manually create a template.

   2. Send Test Message

      Click Send Test Message to verify if the Alibaba Cloud Short Message Service is configured correctly.

      Parameter	Description
      Receiving Phone Number	Enter the phone number. Only numbers are supported.
      Dataservice Studio,Data Quality,Real-time Task Alert,Offline Task Alert,Task Instance Not Generated,Baseline Task Error,Baseline Task Slowdown,Baseline Warning,Baseline Break	The text box contains fixed message content and cannot be edited. Important The message content is for demonstration only. If the content of the configured message template changes, only variable replacement is performed, and it is still sent according to the configured template. At least one message must be selected. Each test message sends one text message.

   Custom Short Message Service

   Note

   When using a custom Short Message Service, you can enable text message notifications in Notification Settings.

   If you switch from a custom Short Message Service to Alibaba Cloud Short Message Service after enabling notifications, internal notifications will cease to be sent through the text message channel.

   1. Send Information Configuration

      Parameter	Description
      Information Sending URL	The URL address for sending information.
      Request Method	The system supports selecting POST or GET. Note When selecting POST, request parameter configuration supports Headers, Parameters, and Body. When selecting GET, request parameter configuration supports Headers and Parameters.
      Request Parameter Configuration	Headers: Click the + New button to configure Headers parameters. key: Custom key value. The key value cannot be duplicated, and the parameter name is unique among all parameters. value: Supports custom input, including constants and built-in parameters. For details, see Metadata Supported by Custom Message Channels. Type: The dropdown box allows you to select String, Double, Long, or Boolean. Parameter Encryption: Disabled by default. When encryption is enabled, the parameter value is displayed as ******. Important Parameter encryption can be configured for constant parameter values in Headers and Body. Variable parameter values cannot be encrypted. Encryption is only for desensitization during Dataphin editing and encryption during storage. During channel integration, it is still transmitted in plaintext. If encrypted transmission is required, the encrypted text must be used during configuration, and decryption must be performed during channel application processing. Parameters: Click the + New button to configure Parameters parameters. key: Custom key value. The key value cannot be duplicated, and the parameter name is unique among all parameters. value: Select the value. Supports custom input, including constants and built-in parameters. For details, see Metadata Supported by Custom Message Channels. Actions: To edit the Parameters parameter, click the icon under the Actions column . To delete the Parameters parameter, click the icon under the Actions column . Body: Click the + New button to configure Body parameters. key: Custom key value. The key value cannot be duplicated, and the parameter name is unique among all parameters. value: Supports custom input, including constants and built-in parameters. For details, see Metadata Supported by Custom Message Channels. Type: The dropdown box allows you to select String, Double, Long, Boolean, or JSON. Parameter Encryption: Disabled by default. When encryption is enabled, the parameter value is displayed as ******. Actions: To edit the Body parameter, click the icon under the Actions column . To delete the Body parameter, click the icon under the Actions column . Test: Click Test. In the Test Request Sending dialog box, configure the test parameters and then click Start Test. The request text box displays the request details. You can click the icon to copy the request details. The request body appears only in the Post request method. The response text box displays the response details. You can click the icon to copy the response details. Note If Headers carry parameters themselves, you need to enter the configuration values of the parameters during testing.
      Send Result Analysis	The system supports Based On HTTP Status Code or Based On HTTP Status Code And Response Result. According To The HTTP Status Code: When the status code is 2xx, it is considered that the send is successful. Based On HTTP Status Code And Response Result: Custom configuration of sending conditions.
      Query Result Analysis	key: You can select a key value from the dropdown box or customize the key value. value: Custom value. Note If the status code is 2xx and the sending success conditions are met, it is recognized as successful. If the status code is not 2xx, it is recognized as failed. If the status code is 2xx and the sending failure conditions are met, it is recognized as failed. Under other conditions, it is recognized as sending in progress and will continue polling until a success or failure is obtained. You can obtain the key value in the response by entering ${response.key}.

   2. Result Query Configuration

      Parameter	Description
      Result Query	Default is Disabled. You can choose to Enable it. Disabled: When disabled, once sending is complete, the task is considered successful. Enabled: When enabled, once sending is complete, the result needs to be polled and displayed in the alert center.
      Result Query URL	The URL address for result query.
      Request Method	The system supports selecting POST or GET. Note When selecting POST, request parameter configuration supports Headers, Parameters, and Body. When selecting GET, request parameter configuration supports Headers and Parameters.
      Request Parameter Configuration	Headers: Click the + New button to configure Headers parameters. key: Custom key value. The key value cannot be duplicated, and the parameter name is unique among all parameters. value: Supports custom input, including constants and built-in parameters. For details, see Metadata Supported by Custom Message Channels. Type: The dropdown box allows you to select String, Double, Long, or Boolean. Parameter Encryption: Disabled by default. When encryption is enabled, the parameter value is displayed as ******. Parameters: Click the + New button to configure Parameters parameters. key: Custom key value. The key value cannot be duplicated, and the parameter name is unique among all parameters. value: Select the value. Supports custom input, including constants and built-in parameters. For details, see Metadata Supported by Custom Message Channels. Actions: To edit the Parameters parameter, click the icon under the Actions column . To delete the Parameters parameter, click the icon under the Actions column . Body: Click the + New button to configure Body parameters. key: Custom key value. The key value cannot be duplicated, and the parameter name is unique among all parameters. value: Supports custom input, including constants and built-in parameters. For details, see Metadata Supported by Custom Message Channels. Type: The dropdown box allows you to select String, Double, Long, Boolean, or JSON. Parameter Encryption: Disabled by default. When encryption is enabled, the parameter value is displayed as ******. Actions: To edit the Body parameter, click the icon under the Actions column . To delete the Body parameter, click the icon under the Actions column . Test: Click Test. In the Test Request Sending dialog box, configure the test parameters and then click Start Test. The request text box displays the request details. You can click the icon to copy the request details. The request body appears only in the Post request method. The response text box displays the response details. You can click the icon to copy the response details. Note If Headers carry parameters themselves, you need to enter the configuration values of the parameters during testing.
      Query Result Analysis	key: You can select a key value from the dropdown box or customize the key value. value: Custom value. Note If the status code is 2xx and the sending success conditions are met, it is recognized as successful. If the status code is not 2xx, it is recognized as failed. If the status code is 2xx and the sending failure conditions are met, it is recognized as failed. Under other conditions, it is recognized as sending in progress and will continue polling until a success or failure is obtained. You can obtain the key value in the response by entering ${response.key}.

   3. Send Test Message

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

      Parameter	Description
      Recipient	Select the recipient.
      Voice Messaging	Default fill is This Is A Test Message From Dataphin. You can customize the edit, not exceeding 128 characters.

5. Click Save to finalize the configuration of the Alibaba Cloud Short Message Service or custom text message channel.