Configuring the integration between an agent and OpenPages

Add integration information for a IBM watsonx Orchestrate agent so that it is embedded in the OpenPages® user interface.

Before you begin

Add the SOX > Administration > Watson Assistant application permission to role templates that are allowed to access IBM watsonx Orchestrate Chat.

Configure an agent in IBM watsonx Orchestrate. For more information, see Configuring an agent in IBM watsonx Orchestrate.

About this task

When an agent is configured and deployed in IBM watsonx Orchestrate, a configuration snippet is available in the Channels section under Embedded agent. You can import this configuration into OpenPages to enable the chat interface.

The integration requires configuring security using public and private keys to ensure that only authorized applications can interact with the agent.

Procedure

  1. In the IBM watsonx Orchestrate console, navigate to Channels > Embedded Agent and copy the configuration snippet.
  2. In OpenPages, open the Administration > Integrations > AI Chat Agent page.
  3. Under Chat type, select watsonx Orchestrate.
  4. Under Web chat options, click Import Configuration.
  5. In the Import web chat configuration dialog, paste the configuration snippet into the Configuration string field, and then click Import.
    The name-value pairs are populated in the interface, one in each row.
  6. In the Assistant profiles field, select the profiles that are allowed to access the chat agent.
    Leave the field blank to make the chat available to all profiles for logged-in users.
  7. In the Private key field, provide the key to secure the embedded web chat.
    1. Generate public and private keys from the terminal using the commands provided in the IBM watsonx Orchestrate documentation. The generated keys are stored locally on your machine.

      For more information about generating keys, see Configuring embedded chat security in the IBM watsonx Orchestrate documentation.

    2. In the IBM watsonx Orchestrate console, navigate to Profile > Settings > Embed Security.
      Important: Security is enabled by default in IBM watsonx Orchestrate to ensure that only authorized applications can interact with the agent. Disabling security is not recommended.
    3. Copy the public key and paste it into the Public key field in the IBM watsonx Orchestrate console, and then click Save.
    4. Copy the private key and paste it into the Private key field on the Administration > Integrations > AI Chat Agent page, and then click Save.
    IBM watsonx Orchestrate Chat is now embedded within OpenPages.

What to do next

Test the chat agent within OpenPages to ensure it is working correctly. Users with the appropriate permissions can now access the chat interface from any page in OpenPages.

Tip: If the configuration of your agent changes in IBM watsonx Orchestrate, you can re-import the configuration snippet to update the integration settings in OpenPages.