Configuring Custom Tabs


Custom tabs allow you to organize and expand the primary navigation bar, providing users with quick access to object records or external sites. 

About Tab Types

There are different types of custom tabs:

  • Object tabs display records for standard or custom Vault objects, for example, Products, Studies, Submissions, Manufacturers, Vendors.
  • Object Type tabs display available records for a specific object type. Filters and views only include object fields that apply to that object type. When users click Create within an object type tab, Vault automatically creates the new record using that type.
  • Web tabs display external websites or integrate with external systems. You can configure the target URL to pass vault, session, and user parameters to an external service.
  • Menus are parent tabs under which you can create additional tabs, allowing you to group custom tabs, for example, a Study Info menu tab with object type sub-tabs for the Study, Study Country, and Study Site objects.

Accessing Custom Tab Configuration

Configuration options for both standard and custom tabs are located in Admin > Configuration > Tabs. To view or configure, you must have a security profile that grants the correct Admin: Tabs permissions.

Tab Configuration Area

How to Create Custom Tabs

To create a new custom tab:

  1. From the Tabs page, click Create.
  2. Under Tab Details, enter a Label to appear as the tab name in the navigation bar.
  3. The Name field auto-fills based on the label value, but is editable. This value is only visible via the API.
  4. Select a Tab Type and enter additional details specific to the type. For object tabs, select the object. For object type tabs, select the object followed by the object type. For web tabs, enter the target URL.
  5. Click Save.

Vault allows a maximum of ten (10) tabs in the navigation bar, including the standard tabs. You can create up to two levels of sub-tabs, for example, Study Info > Organizations > Studies, with each menu tab holding up to ten (10) sub-tabs.

Defining Web Tabs

When defining web tabs, you must:

  • Select or clear the Post Session credentials via Post Message checkbox. When this setting is enabled, Vault sends the user’s session ID using a technology called “postmessage” rather than as a URL parameter. Postmessage is a more secure way to send this information.
  • Enter the target URL. If needed, you can use tokens (variables representing a value from the vault) in the URL field. Click the token icon to search for and insert tokens. 

Note that the website must allow embedding in iFrames to appear in a web tab.

How to Edit Custom Tabs

To edit a custom tab:

  1. From the Tabs page, click on the tab name in the list. If needed, click Expand all to see sub-tabs.
  2. In the Tab Details panel, click Edit, make necessary changes and click Save.

How to Delete Custom Tabs

To delete a custom tab:

  1. From the Tabs page, click on the tab name. Click Expand all to display sub-tabs.
  2. Select Delete from the Actions menu.
  3. Click Continue in the confirmation dialog.

Note that Vault prevents the deletion of standard tabs: Home, Library, Reports, Dashboards.

How to Change Tab Order

In addition to creating custom tabs, you can also change the order of existing (custom and standard) tabs within the navigation bar. To reorder tabs:

  1. From the Tabs page, click Reorder. Click Expand all to display sub-tabs.
  2. Select a tab and drag it to its new position.
  3. Click Save.

Tab Ordering Rules

The following rules dictate how you can reorder tabs and where you can create new tabs:

  • You can only add a sub-tab beneath a tab with the Menu type.
  • Moving a tab with sub-tabs moves both the menu tab and all sub-tabs.
  • You can move a sub-tab from beneath one tab to another as long as the new menu tab has the Menu type.
  • You can promote a sub-tab to a top-level tab.
  • You can demote a tab to a sub-tab as long as the target menu tab has the Menu type.

Controlling Access to Tabs

When you create a custom object tab, you give non-Admin users access to view object data records. Without a custom tab, these are only accessible through Admin > Business Admin. There are several ways that you can control view access to object data records:

  • Permission Sets - Objects: You can add or remove the Read permission for all objects or for individual objects. Users who do not have this permission for the custom tab’s object cannot see the tab. For example, you can create a Studies tab and configure a set of users without read access for the Study object: those users cannot see the Studies tab.
  • Permissions Sets - Tabs: Users can only view tabs if they have the View permission for that tab. Only users with the View permission on All Tabs will see newly created tabs by default. Add tabs to permission sets in Admin > Users & Groups > Permission Sets.
  • Custom Sharing Rules: If the object uses this feature, you can restrict view access to individual object data records. When users open the custom object tab, they only see the records on which they have a role. Users who cannot see any individual records can still view the custom tab.

Standard Tabs

Vault CDMS includes standard tabs, which cannot be removed.

Standard Vault EDC Tabs

The Casebooks, Studio, Legacy Reports, ReportsDashboards, Loader, and Tools > EDC Tools tabs are standard and cannot be removed. However, you can reorder, rename, or control access these as needed.

Standard Vault Coder Tabs

The Coder, ReportsDashboards, Loader, and Tools > Coder Tools tabs are standard and cannot be removed. However, you can reorder, rename, or control access these as needed.

Overflow Tabs

The top-level of the primary navigation bar can include up to ten (10) tabs. The width of each tab depends on the length of the tab name. When all of the tabs cannot fit in the primary navigation bar, Vault automatically moves them to a menu represented by a chevron (down arrows) icon.

Localization for Custom Tabs

If your vault uses multiple languages, you can provide translations for the custom tab labels through the bulk translation tool.


Last Updated: