IBM® watsonx Assistant™
IBM watsonx Assistant is a chat bot that can appear in the UI. It can offer 24-hour support to the common questions that users have within OpenPages. It can provide interactive text answers, natural language search, and direct links to specific pages in OpenPages. For example, to a Creation View where a user can enter an Issue or Loss Event. A subscription to the IBM watsonx Assistant service is required.
Using contextual information sent to IBM watsonx Assistant
Through the integration with IBM watsonx Assistant, OpenPages can share contextual information about the OpenPages user session. With this information, IBM watsonx Assistant knows the type of user that is logged on and where they are in the OpenPages UI. IBM watsonx Assistant can then use the contextual information to query the OpenPages API to get more information, or perform actions on behalf of the user. For example, IBM watsonx Assistant can use generative AI to create an Action item for an issue in OpenPages.
Use the following variables in IBM watsonx Assistant to reference contextual data from OpenPages:
| Variable | Description | When the data is sent to IBM watsonx Assistant |
|---|---|---|
| op_user_profile_name | User Profile Name | When the chat is first initiated within a new profile session. |
| op_user_profile_id | User Profile ID | When the chat is first initiated within a new profile session. |
| op_user_locale | User locale | When the chat is first initiated within a new profile session. |
| op_base_url | URL of the OpenPages instance | When the chat is first initiated within an OpenPages session. |
| op_view_type_name | View Type, such as Grid, Creation, Task, or Admin view | Once per chat interaction. Sends the View Type, such as Grid, Creation, Task, or Admin View, for the currently active object. |
| op_object_type_name | Object Type | Once per chat interaction. Sends the type of the currently active object. |
| op_object_id | Object ID, which allows the API to retrieve information that is related to the object | Once per chat interaction. Sends the ID of the currently active object. |
| op_object_title | Object Title | Once per chat interaction. Sends the title of the currently active object. |
| op_workflow_action_name | Workflow actions | Once per chat interaction. Sends the workflow actions that are available for the currently active object if the object is in a workflow. |
Configuration overview
Complete the following steps to configure IBM Watson® Assistant:
- Configure an assistant. For more information, see Configuring a web chat assistant by using IBM watsonx Assistant.
- Integrate the assistant with OpenPages. For more information, see Configuring the integration between an assistant and OpenPages.
When an assistant is configured, the 
icon is displayed on all pages in the UI. It is displayed only
to users with the application permission that allows them to access it.
Example of integrating OpenPages as a Service with IBM watsonx Assistant
In this example, you use the OpenPages integration with IBM watsonx Assistant to output a summary that describes an object.
- Set up a dialog in IBM watsonx Assistant to make the
following calls:
- A call to the OpenPages API that passes the object ID and requests all fields for an object.
- A call to the watsonx.ai™ API that passes the object's field data and requests a summary from the model.
- Configure a web chat assistant by following the steps in Configuring a web chat assistant by using IBM watsonx Assistant.
- Configure the integration between the assistant and OpenPages by following the steps in Configuring the integration between an assistant and OpenPages.
When a user enters a request in the chat, OpenPages sends the contextual information, including the ID of the current object, to the assistant. The assistant outputs a summary of the issue.
Show me how
For an overview of using IBM watsonx Assistant, see the following video.