Skip to main content

Veeva Vault Integration

Connect Knak to Veeva Vault to sync email content for Medical, Legal, and Regulatory (MLR) review or Veeva Customer Relationship Management (CRM) use.

Demo Video


Before You Begin

Create a dedicated Veeva Vault user for Knak. Using a dedicated user helps manage permissions. It also prevents issues if an individual user account changes.

Your Veeva Vault user must have permission to:

  • Retrieve document metadata

  • Create document locks

  • Create single document versions

  • Annotate documents. (Optional)

    • This is needed to download annotations.


Set Up the Veeva Vault Integration

  1. Go to Admin.

  2. Click Integrations > Platforms.

    Integrations > Platforms navigation in the admin side of Knak.
  3. Locate the Veeva integration tile.

  4. Click Connect.

    Connect button visible on the Veeva integration tile.
  5. Enter a name for the integration.

  6. Enter your Veeva Vault username.

  7. Enter your Veeva Vault password.

  8. Enter your Veeva Environment URL.

    Veeva integration settings.

The environment URL is the portion of your Veeva Vault URL between https:// and .veevavault.com.

Full URL

Environment URL

https://companyname.veevavault.com

companyname

Optional: Default Country Value

You can specify a default country for CRM sync.

Enter the Veeva ID for the country you want to use.

Veeva Country ID input field in the Veeva settings modal.

This setting is optional. It is only required for certain CRM sync configurations.


Manage Your Integration

After setup, view your integration in the My Platform Connection list on the Integrations page.

From here, you can:

  • View the configuration

  • Edit the integration

  • Delete the integration

My Platform Connections section.

To connect a new integration or re-add a deleted one:

  1. Scroll to All Platforms.

  2. Find the Veeva tile.

  3. Click Connect or Add Another Connection.

    Add another connection button visible on the Veeva tile.

Sync Content to Veeva Vault

Knak supports two sync methods:

Sync Type

Purpose

Document Created

Submission Sync

Send content for MLR review

Any supported Veeva Vault document type

CRM Sync

Prepare content for Veeva CRM

Email Template document


Submission Sync

Use Submission Sync when you need to update an existing Veeva Vault document for review.

Prepare a Target Document

Before syncing:

  1. Create a document in Veeva Vault.

    • You can create a document placeholder if the document does not yet contain content.

      Create a document placeholder in Veeva Vault.
  2. Share the document with the Knak integration user.

Knak requires access to edit the document.

Sync the Document

  1. Open your email in Knak.

  2. Start a Submission Sync.

  3. Search for the existing Veeva Vault document.

  4. Select the document.

  5. Complete the sync.

During the first sync:

  • Knak creates a new version of the selected document.

  • Knak uploads a PDF that contains desktop and mobile previews.

Each additional sync creates another minor document version with the latest content.


CRM Sync

Use CRM Sync when you want to create an email template for Veeva CRM.

During the first sync:

  • Knak creates a new Email Template document in Veeva Vault.

  • Knak uploads the generated HTML as the document source.

Each additional sync creates a new version of the Email Template with the latest HTML.

Veeva CRM HTML Character Limit

Downloaded Email Template HTML files must not exceed 131,072 characters.

If the HTML exceeds this limit, Veeva CRM truncates the email after it is manually uploaded.

Keep your email HTML below 131,072 characters whenever possible.


Download Annotations from Veeva in Knak

Annotations are the comments and markups that reviewers add to your email in Veeva Vault. You can download them from Knak as a Portable Document Format (PDF) file. This lets you see reviewer feedback without leaving Knak.

Note: Knak does not create or change these annotations. Knak gets them directly from your Veeva Vault and saves them to your computer.

Before You Begin

The Download Annotations button only shows when:

  • Your asset is an email. The button does not show on other asset types.

  • Your company has a Veeva Vault integration connected.

  • The Veeva Vault document number is saved in your email’s CUID Code field.

Note: Knak needs to set up the CUID Code field on your account. If your company uses Veeva Vault and you do not see this field, contact your Knak Customer Success Manager (CSM) or Knak Support. They can add it for you.

Add the Document Number

  1. Find the document number for your email in Veeva Vault.

  2. Open your email in Knak.

  3. Open the Info tab and find the CUID Code field.

  4. Paste the document number into the field.

Download Annotations

  1. Open your email in the editor.

  2. Open the Info tab.

  3. Go to the Reviews section.

  4. Find Veeva Vault Status.

  5. Click Download Annotations under it.

    Reviews section of the info sidebar, with Download Annotations highlighted under Veeva Vault Status.

The PDF saves to your computer. The file name is your email name followed by “-annotations.pdf”.

Troubleshooting

If the download does not work, you will see this message: “Download failed. Check the document ID and try again.”

Here are common causes:

  • The document number is wrong. Check that the number in the CUID Code field matches the document number in Veeva Vault.

  • The integration is not connected. Ask your Knak admin to check that Veeva Vault is connected.

  • Knak does not have access to the document. The Veeva Vault user linked to the integration must be able to view this document. Ask your Veeva Vault admin to check its permissions.

  • The Knak integration user does not have the Annotate permission. Knak can find the document, but Veeva Vault blocks the download. Ask your Veeva Vault admin to give the Knak integration user the Annotate permission. They need to add it in each lifecycle state your emails use, such as Draft and Approved for Use. A lifecycle state is the stage a document is in during review. Your admin can add the permission in the lifecycle state’s security settings. They can also update the sharing settings on each document. You do not need to change anything in Knak.


Need more help? Contact support via live chat within Knak using the chat bubble in the bottom right corner or email support@knak.com.

Did this answer your question?