Skip to main content

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

Adding application gateways

Updated on March 31, 2022

Add and configure a Cisco ICM application gateway to use Pega Platform rules for augmented call routing.

Before you begin: Ensure that your environment is set up so that Pega Call can open a server socket on the appropriate TCP port on the chosen Pega Platform node. On your ICM, configure an application gateway to initiate a TCP connection to this port on the Pega Platform node.
  1. In the header of Dev Studio, click ConfigureChannel ServicesPega CallAdministration and Configuration.
  2. On the Application Gateways tab, click Add Application Gateway.
  3. On the New rule tab, enter a name and description for the application gateway, and then click Create and Open.
  4. On the General tab, specify the application gateway properties:
    • In the Port field, enter the TCP port number that the application gateway listens on.
    • To enable an application gateway that is already configured, select the Enabled checkbox.
      Note: Pega Call autostarts only the application gateways that are enabled.
    • To automatically start the application gateway when the Pega Platform node starts up, select the Auto Start checkbox. Select this checkbox for application gateways that are used in production to prevent delayed responses.
    • In the Node field, select the Pega Platform node on which this application gateway runs.
      Note: If you do not select a node, the gateway starts on all nodes in the Pega Platform cluster.
    • In the Key conversions list, select how underscores in the Pega Platform property names map to ECC variable names when Pega Call sends variables back to ICM:
      • To map all underscore characters in the property name to periods in the ECC variable name, select All.
      • To map only the first underscore in the property name maps to a period in the ECC variable name, select First.
      • To directly use the property name as the ECC variable name, with no mapping of underscore characters, select None.
    • In the Setup timeout field, enter the time (in milliseconds) that the application gateway waits for the socket server thread to set up, to confirm that the application gateway starts properly.
      Note: The socket server listens for a TCP connection from the Cisco ICM router on a separate thread.
    • In the Socket retry time field, enter the time (in milliseconds) that the application gateway waits before trying to reestablish the socket server that manages TCP connections from the Cisco router.
      Note: This setting is only used if the socket server becomes unresponsive. The gateway attempts to re-establish the socket server after this time. The default setting is 2000 (two seconds).
  5. Optional: To provide more details about the application gateway, on the History tab, enter a description and usage information.
  6. Click Save.

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