Quickstart

This quickstart walks you through installing the Vault Toolbox Visual Studio Code Extension, connecting to a Vault environment, and running your first VQL query.

Prerequisites

Section link for Prerequisites

To follow this quickstart, you need:

• Visual Studio Code version 1.95 or later
• A Veeva Vault user account

Installing Vault Toolbox

Section link for Installing Vault Toolbox

To install the Vault Toolbox extension, download the latest version from the Visual Studio Marketplace. Alternatively, you can install it from within Visual Studio by navigating to the Extensions tab, searching for "Vault Toolbox", and clicking Install.

Once installed, the Vault Toolbox extension appears under your Installed extensions and its icon appears in the lefthand panel.

Adding and Connecting to an Environment

Section link for Adding and Connecting to an Environment

Before using the Vault Toolbox extension, you must add an environment, which connects the extension to your preferred Vault.

To add and connect an environment:

1. Select the Vault Toolbox icon in the lefthand panel.
2. Select the Environments () tab.
3. Click Add Environment.
4. Enter a Vault DNS, provide an optional Label, select an Authentication Method (Basic, Session ID, or API Access Token), and provide the corresponding credentials.
   
5. Click Add. A card for the new environment appears under the list of All Environments.
6. Click () on the new environment's card to connect.

See Managing Environments for the available authentication methods and how to work with multiple environments.

Running Your First Query

Section link for Running Your First Query

Now that you've added and connected a Vault environment, you can run your first VQL query using the Vault Toolbox extension's VQL Editor tool.

To run a VQL query:

1. Select the VQL Editor () tab.
2. From the VQL Editor, expand the Query Builder and select Documents as the query Target.
3. Within Fields, select the Id and Name fields.
4. Click Build Query in Editor. The editor should display the following query:

   Copy to clipboard

   SELECT
       id,
       name__v
   FROM documents

5. Click Run VQL.
   

Results display in a table below the editor. See Using the VQL Editor to learn about saving queries, query history, and building queries visually.