Skip to content
Vault Logo
Vault Developer Portal Developer
Advanced Search

    Release Notes

    Development Setup

    In this step, you will:

    • Set up an IntelliJ® project with the vSDK Hello World project
    • Understand how to update your POM file to connect your project to your Vault

    Now that you’ve set up your Vault and executed a record trigger in the Vault UI, you can move on to writing your own custom code. To do this, let’s start with setting up your development environment.

    Import the Maven Project to IntelliJ®

    Section link for Import the Maven Project to IntelliJ®
    1. From IntelliJ®, select File > Open.
    2. Navigate to your downloaded or cloned project directory and locate the pom.xml file.
    3. Click Open.
    4. In the Open Project dialog, click Open as Project. If prompted, choose Trust Project. IntelliJ® imports the project and automatically downloads the Vault Java SDK dependencies.
      The 'Open Project' dialog in IntelliJ.The 'Open Project' dialog in IntelliJ.
    5. Verify that the Maven: com.veeva.vault.sdk.api:vault-sdk-api library is present in the External Libraries section. If this file is not present or the External Libraries section is empty, make sure you have access to the Internet and your browser can load repo.veevavault.com. You should also make sure your POM file is set up with the correct Vault SDK version.
      Viewing that the Vault Java SDK External Libraries properly loaded into your IDE.Viewing that the Vault Java SDK External Libraries properly loaded into your IDE.

    IntelliJ® Setup

    Section link for IntelliJ® Setup

    The Java SDK version in IntelliJ® must match the version you installed during the Prerequisites setup.

    To set the Java SDK version in IntelliJ® to the required version:

    1. Navigate to File > Project Structure > Project Settings > Project.
    2. In the SDK field, select the JDK 17 that you installed.
    3. Click Apply and then OK.

    POM Setup

    Section link for POM Setup

    The Java SDK library version must match the Vault version. You can update the version by editing the <vault.sdk.version> attribute in your POM file.

    1. Verify the version of your Vault. You can find your Vault version in Admin > About > Vault Information.

      Vault version information in the Admin UI.Vault version information in the Admin UI.

    2. In IntelliJ®, navigate to your pom.xml file.

    3. Update the <vault.sdk.version> to your Vault version, using only periods (.) and not the letter R. For example, a Vault on version 24R3.3 should look like this:

      <properties> <vault.sdk.version>[24.3.3-release0, 24.3.3-release1000000]</vault.sdk.version> </properties>

    4. If prompted, select Import Changes. You can also Enable Auto-Import to instruct Maven to automatically import any future changes.

      Importing changes in Maven.Importing changes in Maven.
      In newer versions of IntelliJ®, you may need to import changes manually by right-clicking the pom.xml file and selecting Maven > Reload project.

    5. In the External Libraries section of IntelliJ®, verify the Maven: com.veeva.vault.sdk.api:vault-sdk-api library shows your Vault version. If it does, your development setup is complete!