Using the Prompt Overlay Entry Point
Customers can use the X-Pages Prompt Overlay entry point to replace the standard Veeva 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.
Who can use this feature?
- Business Admin Users - Browser
- Managing Prompt Overlay Pages
- Content Developers - Browser
- Using the Prompt Overlay Entry Point
- End Users - iPad
- Using Custom Chat Prompts
- Users do not require an additional license
Configuring the Prompt Overlay Entry Point for
To configure this feature:
- Ensure X-Pages is configured.
- Navigate to Admin > Users & Groups > Permission Sets.
- Select the appropriate permission set.
- Select Objects.
- 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
- Navigate to Admin > Configuration > Objects.
- Select html_report__v.
- Select the Layouts tab.
- Create a layout for the prompt_overlay__v object type.
To configure this feature:
- Ensure X-Pages is configured.
- Navigate to Admin > Users & Groups > Permission Sets.
- Select the appropriate permission set.
- Select Objects.
- 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
To configure this feature:
- Ensure X-Pages is configured.
- Navigate to Admin > Users & Groups > Permission Sets.
- Select the appropriate permission set.
- Select Objects.
- 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
Content developers can develop chatbot interfaces using standard web technologies and the X-Pages library using the getOverlayContext() method 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
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:
- Navigate Business Admin > Objects > HTML Reports.
- Select Create.
- Select the Prompt Overlay object type.
- Select Continue.
- 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 to enable this feature.
- Select Mobile_Device for the Platform.
- 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.
- Select Save.
- Select Upload in the Attachments section.
- 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.
- Navigate to Business Admin > Objects > VMobile Object Configurations.
- Ensure a VMOC is enabled for the html_report__v object for the appropriate mobile device.
Using Custom Chat Prompts as
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.
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 Veeva 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.

