Skip to main content
LinkedIn
Copied!

Table of Contents

Configuring on-premises or internal access only environments for Digital Messaging access

Version:

Only available versions of this content are shown in the dropdown

If your Pega Platform environment is set up on the premises or for internal access only, perform additional configuration so that your application can communicate with the Digital Messaging service. As a result, you can later create a Unified Messaging channel so that users interact with your chatbot and application on messaging platforms like Apple Business Chat, Facebook Messenger, and WhatsApp.

For the region-specific settings described below, Pega Support will specify your region when they provision your Unified Messaging Manager ID and Manager Key. Ensure that you use the correct region configuration for your Manager ID. For more information, go to Pega Support.

  1. Allow inbound message delivery by opening the firewall for the following endpoints:

    • https://{publicURL}/prweb/PRRestService/botAgent/v1/messaging
    • https://{publicURL}/prweb/PRRestService/botAgentListener/v1/accounts
    Performing this firewall configuration step ensures that your application can receive messages from the Unified Messaging service (HTTPS/443). The system rejects calls to these endpoints if you did not properly configure the Manager ID and Manager Key for your instance.
    Replace the {publicURL} string in the above endpoints with the configured public link URL for your instance.
    If required, also add to the list of trusted sites the dedicated Pega IP addresses that the Digital Messaging service uses when sending messages to your Pega Platform instance. Pega will specify these IP addresses when we provide your Digital Messaging service credentials.
  2. Allow outbound communication and message delivery by opening the firewall for the following endpoints for your region:

    Region Endpoints
    United States (US)
    • https://api.artemis.pega.digital
    • https://outgoing.artemis.pega.digital
    • https://accounts.artemis.pega.digital
    • https://cdn.artemis.pega.digital
    Canada (CA)
    • https://api.ca.um.pega.digital
    • https://outgoing.ca.um.pega.digital
    • https://accounts.ca.um.pega.digital
    • https://cdn.ca.um.pega.digital
    Europe (EU)
    • https://api.euw1.um.pega.digital
    • https://outgoing.euw1.um.pega.digital
    • https://accounts.euw1.um.pega.digital
    • https://cdn.euw1.um.pega.digital

    Performing this firewall configuration step ensures that your application can communicate with the Digital Messaging service and send messages.

    If Pega Support provisioned your Digital Messaging credentials for the EU region, open the firewall for the four endpoints specified in the Europe (EU) row in the table.
  3. If you set up your Pega Platform environment behind a proxy or an API Gateway, use the proxy or gateway URL as the publicly accessible URL for your instance, and also ensure that you use a secure connection (HTTPS) for the URL.

    Your proxy or API Gateway will be responsible for receiving messages and forwarding them externally to the application.
  4. If Pega provisioned your Digital Messaging credentials for a region other than the United States, update the URL API settings in data transform rules for the Data-Channel-Configuration-BotAgent class:

    1. In the navigation pane of Dev Studio, click App, and then search for the Data-Channel-Configuration-BotAgent class.

    2. Expand the Data Model Data Transform section for the Data-Channel-Configuration-BotAgent class, and then click pyDefault.

    3. In the data transform rule, in the row for the .pyManagementAPIUrl target, in the field in the Source column, update the URL API endpoint for your region with the value in the first row in the table in step 2.

      Enter the value in the field in the Source column in double quotation marks.
      The following figure shows the correct updated value in the Source column for Europe (EU) region configuration, "https://api.euw1.um.pega.digital":
      Updated settings for the pyDefault data transform rule for the Europe region.
      Updated settings for the pyDefault
                                        data transform rule for an environment in the Europe
                                        region.
    4. Save the rule to a ruleset by clicking Save as.

    5. In the navigation pane of Dev Studio, click App, and then search for the Data-Channel-Configuration-BotAgent class.

    6. Expand the Data Model Data Transform section for the Data-Channel-Configuration-BotAgent class, and then click pySetBaseURL.

    7. In the data transform rule, in the row for the .pyManagementAPIUrl target, in the field in the Source column, update the URL API endpoint for your region with the value in the first row in the table in step 2.

      Enter the value in the field in the Source column in double quotation marks.
      The following figure shows the correct updated value in the Source column for the Europe (EU) region configuration, "https://api.euw1.um.pega.digital":
      Updated settings for the pySetBaseURL data transform rule for the Europe region.
      Updated settings for the pySetBaseURL
                                        data transform rule for an environment in the Europe
                                        region.
    8. Save the rule to a ruleset by clicking Save as.

Did you find this content helpful?

Have a question? Get answers now.

Visit the Collaboration Center to ask questions, engage in discussions, share ideas, and help others.

Ready to crush complexity?

Experience the benefits of Pega Community when you log in.

We'd prefer it if you saw us at our best.

Pega Community has detected you are using a browser which may prevent you from experiencing the site as intended. To improve your experience, please update your browser.

Close Deprecation Notice
Contact us