3Understanding Delivery Channels

Delivery Channels Screen

The Delivery Channels screen lets you configure all external system connectivity parameters on a single screen. To open the screen, click the Channels button on the Message Scenarios screen.

The Deliver Channels list uses color coding to indicate the number and status of message scenarios using each delivery channel. The following color codes are used:
  • Green—No warnings and delivery channel is active.

  • Gray—No warnings and delivery channel is inactive.

  • Red—Warnings exist or the count is greater than zero and the channel is inactive.

The Advanced Settings section of the Delivery Channels screen is hidden if the Connection field is set to Not encrypted. Otherwise it is shown. The advanced settings include the following:
  • x509 Trust File

  • x509 CRL File

  • Client Certificate

  • Client Private Key

The format of the files in the Advanced Settings is PEM. You do not have to complete all fields. However, the Client Certificate and Client Private Key fields must both be either empty or completed.

    Add a Delivery Channel

    Add delivery channels for message scenarios on the Delivery Channels screen.

    1. Click Configuration.

    2. Click Message Scenarios under Subsystems and Integrations.

      The Message Scenarios screen opens.

    3. Click the Channels button in the upper right corner of the screen.

      The Delivery Channels screen opens, and any existing delivery channels appear in the left column.
    4. Click the plus sign at the top of the left column.

      The right side of the screen displays fields for entering general delivery channel information and end-point information.
    5. Type the name of the delivery channel in the Name fields.

    6. Select the required option from the Status drop-down list.

      Note: For example, you can block a channel using the Inactive option in Test instances to disallow test messages to reach real customers. Messages that are not delivered due to inactivated delivery channel get the status 'obsolete' with the description, EXTERNAL_NOTIFICATION_ARE_DISABLED. Note that the 'set property' messages do not have a delivery channel and cannot be handled this way.
    7. Type a value between 1 and 10,000 in the Bulk Size field to define the maximum number of messages per request.

      Note: The default value is 10, which is also the recommended value.
    8. Type a host field in the Host/Port field using the example.com format.

    9. Type a port number in the section of the Host/Port field that appears after the colon.

    10. Type a URL in the URL Path field.

    11. Type a user name in the User field.

    12. Type the user’s password in the Password field.

    13. Re-type the user’s password in the Confirm Password field.

    14. Select the Allow basic access authentication check box if you want to implement HTTP basic authentication while integrating with external systems.

      When you select the check box, the outbound methods (such as send_message, drop_message, get_message_status methods) send the standard HTTP header "Authorization" with base64-encoded user credentials (standard basic access authentication). Also, the <user> SOAP structure is sent in the body of the request. The client application can either use the standard HTTP header "Authorization" or the <user> SOAP structure to send user credentials in the request.
      Note: When the check box is not selected, the standard HTTP header is not used in the request and the client application can use the <user> SOAP structure for authentication. For more information, see the Integrating with Outbound API Guide.
      Note: From the 19C release onwards, the Disable Weak Password option is removed for delivery channels and all Outbound API integrations shall use the SHA256 algorithm for secured authentication. The delivery channels of the clients which used Weak Password Hashing (MD5) algorithm for Outbound API integrations, shall use the SHA256 algorithm for secured authentication.
    15. Click the Connection drop-down menu and select an encryption method for the connection. The options include:

      • Not encrypted
      • Default encryption
      • SSL 3
      • TLS 1.0
      • TLS 1.1
      • TLS 1.2
    16. If you selected any option except Not encrypted, the Advanced settings section opens to let you enter certificates and a client private key. Complete some or all of the following fields:

      • x509 Trust File
      • x509 CRL File
      • Client Certificate
      • Client Private Key
      The format of the files in the Advanced Settings is PEM. You do not have to complete all fields. However, the Client Certificate and Client Private Key fields must both be either empty or completed.
    17. Click the Save button.

      The newly created delivery channel appears in the left column.

      Edit a Delivery Channel

      You can edit any of the fields on an existing delivery channel.

      1. Click Configuration.

      2. Click Message Scenarios under Subsystems and Integrations.

        The Message Scenarios screen opens.

      3. Click the Channels button in the upper right corner of the screen.

        The Delivery Channels screen opens, and existing delivery channels appear in the left column.
      4. Select the delivery channel you want to edit.

        The right side of the screen displays information for the delivery channel.
      5. Edit any of the fields for the delivery channel using the field descriptions found in Add a Delivery Channel.

      6. Click the Save button.

        Delete a Delivery Channel

        You can delete delivery channels that your organization no longer uses.

        1. Click Configuration.

        2. Click Message Scenarios under Subsystems and Integrations.

          The Message Scenarios screen opens.

        3. Click the Channels button in the upper right corner of the screen.

          The Delivery Channels screen opens, and existing delivery channels appear in the left column.
        4. Select the delivery channel you want to delete.

          A dialog opens, asking you to confirm the deletion.
        5. Click OK in the Confirm dialog.

          The delivery channel no longer appears in the left column.

          Delivery Channels Error Messages

          If a delivery channel is configured improperly, an error message will appear when you try to save it.

          The following error messages appear when fields are incomplete or wrong or when another error occurs:
          • Unable to load Delivery Channel settings

          • Unable to create a new Delivery Channel

          • Unable to update Delivery Channel

          • Unable to delete Delivery Channel

          • Delivery Channel does not exist (Try to change or delete the channel.)

          • Requested Delivery Channel is used by Message Scenarios and cannot be deleted

          • Name of delivery channel already exists

          • Bulk Size field must be in numeric symbols ranging from 1 to 10000

          • Host field must have a corresponding format (http(s)://example.com)

          • Port field must be in numeric symbols ranging from 1 to 65535

          • User field is empty

          • Password field is empty

          • Confirm Password field is empty

          • Password and Confirm Password do not match

          • Client Certificate is empty

          • Client Private Key is empty

          • Mandatory field is empty

          • {Field name} is wrong