Skip to main content

         This documentation site is for previous versions. Visit our new documentation site for current releases.      

Configuring the Cisco ICM Application Gateway

Updated on October 12, 2021
  1. Log in to the Pega Platform as a user with access to the Pega-CTI ruleset.
  2. In the header of Dev Studio, click ConfigureChannel ServicesPega CallAdministration & Configuration.
  3. On the Pega Call landing page, click the Application Gateways tab.
  4. Choose Add to add an application gateway.
  5. On the New Rule tab, enter a name and short description for the application gateway and click Create.
    Result: The rule form for configuring an application gateway appears.
  6. Enter the configuration:
    Cisco application gateway configuration
    Cisco application gateway configuration
    Enter a TCP port number that the application gateway will listen on. Make sure that your environment is set up to allow Pega Call to open a server socket on the configured TCP port on the chosen Pega node. On your ICM, configure an application gateway to initiate a TCP connection to this port on the Pega node.
    Select this option after you have configured. Pega Call will only start an application gateway if it is enabled.
    Auto Start
    Indicates whether to start the application gateway when the Pega node starts up. Select this check box for gateways used in production to prevent delayed responses.
    Select the Pega node that this application gateway will run on. If no node is entered, the gateway will start on all nodes in the Pega cluster.
    Key Conversion
    The application gateway uses a Pega value group to represent the ICM’s extended call context (ECC) variables. ECC variable names are mapped to property names. Since Pega property names do not include periods (.), Pega maps all periods in ECC variable names received from ICM to underscore (_) characters in Pega property names. The key conversion setting determines how underscores in the Pega property names map to ECC variable names when Pega Call sends variables back to ICM. It can be set to All, First or None.
    • If set to All, all underscore characters in the property name maps to periods in the ECC variable name.
    • If set to First, only the first underscore in the property name is maps to a period.
    • If set to None, the property name is used as the ECC variable name with no mapping of underscore characters.
    Setup Time Out
    This is the time (in milliseconds) that the application gateway waits for the socket server thread to set up, to confirm that the application gateway started up properly. The socket server listens for a TCP connection from the Cisco ICM Router and it does so on a separate thread.
    Socket Retry Time
    This is time (in milliseconds) that the application gateway will wait before trying to re-establish the socket server that waits for TCP connections from the Cisco Router. This is only used if the socket server becomes unresponsive. The Gateway attempts to re-establish the socket server after this interval of time. The setting defaults to 2000 (two seconds).

Have a question? Get answers now.

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

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best. is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us