Vault Toolbox is a Chrome Extension designed to make the everyday life of Vault Admins and Developers easier. It has a built-in set of "Tools" that leverage the power of the Vault REST API through a clean and responsive User Interface.
Vault Toolbox is available for installation via the Chrome Web Store.
For information on the technical architecture and instructions for extending or self-hosting this project, please refer to the project wiki.
Vault Toolbox requires you to authenticate into a Vault. You can do this using the Vault DNS
(yourvaultname.veevavault.com) and either the combination of your Username and Password or you can
supply an active Session ID.
SSO Authentication is possible by obtaining the Session ID via the Vault REST API using OAuth 2.0 / OpenID Connect (see Vault Help for more information).
The Login Form will automatically copy the Vault DNS into the Login Form for you if you open the plugin from a tab where you are logged into a Vault. It also lets you save up to 100 environments' Vault DNS and Username, including setting one of them as the default.
Users can can switch between Light and Dark mode using a button. Toolbox will remember your settings when opening the next time.
API Info section will display:
- The Name and Link to the Vault you are currently logged in to; when clicked, opens Vault in new tab
- Status, Time, and Size of the last API Call made
- The API Version used to make the API Calls
Users can change the API Version used by the tools by clicking the version link, and then selecting an available version from the popup.
The Component Editor lets you get the MDL of Vault Components by searching for them using the Componenttype.Componentname format and clicking the Get button.
If you are in a non-production environment, the Component Editor also allows you to Send MDL Commands to Vault. This enables you to Get a component, make quick modifications, and then Send it back to Vault, allowing for faster configuration changes.
Vault Toolbox will get all MDL-based components from the system and load them into the right-hand-side Component Directory.
The Component Directory will be organized by Component Types and once a Component Type is expanded, the list will reveal the Component Records. When clicked, the Component Record MDL will be retrieved and loaded into the Monaco Editor.
Vault Toolbox uses the open-source Monaco Editor (used by VS Code) which has been customized with Syntax Highlighting for MDL and Sticky Scroll enabled.
You can Zoom In/Out to set the desired display size by Ctrl/Command + Mouse Scroll or the Pinch Zoom on touchpads. You can access the Monaco Editor Command Palette by pressing the F1 key while focused on the editor.
The VQL Editor lets you send VQL Queries to Vault and retrieve the data, which you can view in Table or JSON format. The Download CSV button will generate a CSV file of the entire query result, including all pages. Subquery Pagination (Object or Document) is not supported in the current version, so results will be limited to the first page of subquery results.
The VQL results are retrieved according to the default PAGESIZE which can be reduced by adding the PAGESIZE parameter to the query.
If there are more results than the PAGESIZE, you can use the Next Page and Previous Page buttons to perform the pagination, which will utilize the recommended next_page and previous_page values from the query result JSON.
The cloud version of the open-source Vault Data Tools allows developers to initiate Count Object and Count Document jobs, for all or specific Objects or Document Types.
On non-production environments, the tool will also allow developers to initiate Delete Object and Delete Document jobs. Delete operations cannot be reversed.
Once a job is completed, a summary of the results will be posted on the Vault's File Staging Server and displayed in the results window.
Vault Toolbox uses the published and validated API endpoints, and does not provide any overrides to documented functionalities.
In order to use Developer Toolbox, users must have the following permissions:
- Application > API > Access API is required to be able to access Vault Toolbox and use the VQL Editor
- Application > API > Metadata API is required to be able to use the Component Editor
- Application > File Staging > Access is required for Data Tools to be able to put the results of the jobs into the File Staging Server
Access to Objects and Documents is subject to the relevant permissions and potential Lifecycle Role restrictions, or to simply put, users will only see data using Vault Toolbox, which they would be able to access via the Vault UI.
Support for Vault Toolbox is handled exclusively through the Vault for Developers community on Veeva Connect.