Configuring Custom Pages

To access your Custom Page in Vault, you must create a Page component and configure access to it.

You can also configure navigation to your Custom Page using tabs and page links in the Vault UI.

Creating a Page

The Page component type links the client code and the server code for your Custom Page.

You can configure a Custom Page using MDL or the Vault Admin UI. Learn more about using the Vault UI to configure Custom Pages in Vault Help.

When using MDL to create a Page component, use the following attributes:

Attribute	Description	Format
`client_distribution`	The name of your Custom Page Distribution in the `distribution-manifest.json` file	`Clientdistribution.{distribution_file_name}`
`page_client_code`	The name of your page in the `distribution-manifest.json` file	`Pageclientcode.{page_name}`
`page_controller`	The fully qualified name of your `PageController`	`Pagecontroller.{path.to.PageController}`
`url_path_name`	A unique URL-safe path to use to access your `Page`	`{url_path}`

For example, the following MDL creates a Page component named hello_world__c:

RECREATE Page hello_world__c (
   label('Hello World!'),
   active(true),
   client_distribution('Clientdistribution.hello_world__c'),
   page_client_code('Pageclientcode.hello_world__c'),
   page_controller('Pagecontroller.com.veeva.vault.custom.pages.HelloWorld'),
   url_path_name('hello-world')
);

You can access the example Custom Page from the following URL: https://$HOST/ui/#custom/page/hello-world.

Configuring Page Access

Manage access to your Custom Page using permission sets.

You can configure a tab to display your Custom Page or create a page link that navigates the user to your Custom Page when interacting with an object record.

Managing Page Permissions

A user's security profile must grant them permission to view a Page component.

To secure your Custom Page:

Go to Admin > Users & Groups > Permission Sets
Create or select a permission set
Navigate to the Pages tab
Click Edit
Enable View permission for your page
Save changes

Creating a Tab

You can create a Tab component to link to your Custom Page from your Vault's navigation bar.

Configure a tab using MDL or the Vault Admin UI. Learn more about Custom Page tabs in Vault Help.

To access a Custom Page from a tab in the Vault UI, users must have the View permission for both the tab and the Custom Page.

The url must begin with https://${Vault.domain}/ui/#custom/page/${Page.url_path_name}. This includes URL tokens to retrieve the Vault domain and the path to the Custom Page. You can provide URL parameters to your Page component by appending them to the url value.

The following example uses MDL to create a Tab that references the Page configuration for a Custom Page:

RECREATE Tab hello_world__c (
   active(true),
   label('Hello World!'),
   order(100),
   page('Page.hello_world__c'),
   url('https://${Vault.domain}/ui/#custom/page/${Page.url_path_name}')
);

Creating a Page Link

You can create a Pagelink component to navigate users to your Custom Page when they perform one of the following actions on an object record in the Vault UI:

View
Edit
Copy
Create

Configure a page link using MDL or the Vault Admin UI. Learn more about page links in Vault Help.

The Page component must be provided as a reference to a Custom Page with a name ending in __c, such as Page.country_page__c. The url must begin with https://${Vault.domain}/ui/#custom/page/${Page.url_path_name}. This includes URL tokens to retrieve the Vault domain and the path to the Custom Page. You can provide URL parameters by appending them to the url value.

The following example uses MDL to create a Pagelink component that navigates to the specified Custom Page when a user views a Country record:

RECREATE Pagelink custom_pagelink__c (
   label('Custom Page Link'),
   mode('View'),
   object('Object.country__v'),
   page_type('Object'),
   page('Page.country_page__c),
   url('https://{{Vault.domain}}/ui/#custom/page/{{Page.url_path_name}}')
);