Source: https://vaultcrmhelp.veeva.com/doc/Content/CRM_topics/X_Pages/CreateX_Pages/Prompt_Overlay.htm

## Using the Prompt Overlay Entry Point

Customers can use the X-Pages Prompt Overlay entry point to replace the standard Vault AI Chat with custom AI chatbots to provide a tailored experience directly within their Vault CRM workflow. By integrating a custom AI chatbot, users benefit from a cohesive user experience that maintains the familiar Vault CRM interface while leveraging proprietary business logic and AI training, for example, surfacing a recommended action or AI-assisted call preparation.

**Who can use this feature?**

* Business Admin Users - Browser
* [Managing Prompt Overlay Pages](#Managing)
* Content Developers - Browser
* [Using the Prompt Overlay Entry Point](#Using)
* End Users - iPad
* [Using Custom Chat Prompts](#Using2)
* Users do not require an additional license

### Configuring the Prompt Overlay Entry Point for

[![Closed](../../../../Skins/Default/Stylesheets/Images/transparent.gif)Business Admin Users](#)

To configure this feature:

1. Ensure [X-Pages](../X_PagesConfig.htm) is configured.
2. Navigate to **Admin > Users & Groups > Permission Sets**.
3. Select the appropriate permission set.
4. Select **Objects**.
5. Grant the following permissions:

   | Object | Object Permission | Object Types | Fields | Field Permission |
   | --- | --- | --- | --- | --- |
   | html\_report\_\_v | CRE | prompt\_overlay\_\_v | * name\_\_v * object\_type\_\_v * platform\_\_v * prompt\_context\_\_v * logo\_\_v | Edit |
6. Navigate to **Admin > Configuration > Objects**.
7. Select **html\_report\_\_v**.
8. Select the **Layouts** tab.
9. Create a layout for the **prompt\_overlay\_\_v** object type.

[![Closed](../../../../Skins/Default/Stylesheets/Images/transparent.gif)Content Developers](#)

To configure this feature:

1. Ensure [X-Pages](../X_PagesConfig.htm) is configured.
2. Navigate to **Admin > Users & Groups > Permission Sets**.
3. Select the appropriate permission set.
4. Select **Objects**.
5. Grant the following permissions:

   | Object | Object Permission | Object Types | Fields | Field Permission |
   | --- | --- | --- | --- | --- |
   | html\_report\_\_v | CRED | prompt\_overlay\_\_v | * name\_\_v * object\_type\_\_v * platform\_\_v * prompt\_context\_\_v * logo\_\_v | Edit |

[![Closed](../../../../Skins/Default/Stylesheets/Images/transparent.gif)End Users](#)

To configure this feature:

1. Ensure [X-Pages](../X_PagesConfig.htm) is configured.
2. Navigate to **Admin > Users & Groups > Permission Sets**.
3. Select the appropriate permission set.
4. Select **Objects**.
5. Grant the following permissions:

   | Object | Object Permission | Object Types | Fields | Field Permission |
   | --- | --- | --- | --- | --- |
   | html\_report\_\_v | R | prompt\_overlay\_\_v | * name\_\_v * object\_type\_\_v * platform\_\_v * prompt\_context\_\_v * logo\_\_v | Read |

### Using the Prompt Overlay Entry Point as

[![Closed](../../../../Skins/Default/Stylesheets/Images/transparent.gif)Content Developers](#)

Content developers can develop chatbot interfaces using standard web technologies and the X-Pages library using the [getOverlayContext() method](https://developer.veevacrm.com/doc/Content/CRM_topics/Vault/x-pages-library.htm#getOverlayContext) to retrieve details about the current Vault CRM context, for example, the active record ID or the current page, and implement custom navigation using deep linking to close the Prompt Overlay UI automatically.

### Managing Prompt Overlay Pages as

[![Closed](../../../../Skins/Default/Stylesheets/Images/transparent.gif)Business Admin Users](#)

Business admin users can manage which CRM contexts trigger the custom AI interface by creating prompt overlay pages, depending on their requirements. Each page can have one or multiple prompt\_context\_\_v selected. For example, a customer might create the following records:

* A Home page for home\_\_v , top\_level\_xpage\_1\_\_v , and top\_level\_xpage\_2\_\_v
* A specialized page for top\_level\_xpage\_3\_\_v
* An Account page for account\_\_v and account\_plan\_\_v

To configure a prompt overlay page:

1. Navigate **Business Admin > Objects > HTML Reports**.
2. Select **Create**.
3. Select the **Prompt Overlay** object type.
4. Select **Continue**.
5. Select the **Prompt Context**. This is the page from which the overlay should display. The following options are available:

* Home
* Account
* Call
* Account Plan
* Top Level X-Page 1
* Top Level X-Page 2
* Top Level X-Page 3

  See [Using the X-Pages Top Level Entry Point](Top_Level.htm) to enable this feature.

6. Select **Mobile\_Device** for the Platform.
7. Upload a JPEG or PNG file to the **Logo** field to display a custom brand image in the overlay header. For best results, use an image 22px tall and up to 250px wide. This step is optional.
8. Select **Save**.
9. Select **Upload** in the Attachments section.
10. Select the appropriate content zip file.

    Each record should only have one zip file attached. Attachments must be zip files and must contain the index.html file directly in the zip. The attachment limit is 32 MB. Delete previous files if more room is required.
11. Navigate to **Business Admin > Objects > VMobile Object Configurations**.
12. Ensure a VMOC is enabled for the **html\_report\_\_v** object for the appropriate mobile device.

### Using Custom Overlay Prompts as

[![Closed](../../../../Skins/Default/Stylesheets/Images/transparent.gif)End Users](#)

Users can access company-specific AI guidance directly within their standard Vault CRM workflow by navigating to a supported Vault CRM context, for example, an Account page or the Home screen, and selecting the prompt overlay action, which is visually identical to the standard AI Chat icon. Depending on the organization’s configuration, this can include custom AI chatbots or other customized experiences.

Users can only view one prompt overlay X-Page at a time. If multiple records are configured, the first record by name displays.

If a prompt overlay X-Page is available for the current entry point, for example, the Account page, and the user selects the prompt overlay action, the prompt overlay displays. Otherwise, the standard Vault AI Chat displays if available and enabled.

Persistence of data such as conversation history is the responsibility of the external system. X-Page content does not persist when a user closes the chat window or when a user navigates to another window. The chat window reloads the next time the button is selected.

### Related Topics

[Using AI Chat](../../VeevaAI/UsingChatUI.htm)

[X-Pages Overview](../X_PagesOverview.htm)

[Creating X-Pages Content](CreateRecord.htm)