Collaborative Authoring connects Vault to Office 365 to allow multiple users to edit a document at the same time using the Office desktop software, Office Online, the Office mobile apps, or in a browser. Only users with edit and download permissions can edit a document with Collaborative Authoring. Collaborative Authoring can be used with Microsoft Word (*.docx), Excel (*.xlsx), and PowerPoint (*.pptx) documents.
Collaborative Authoring is not enabled in your Vault by default. Follow the steps below to make this feature available to users.
Prerequisites
The following prerequisites must be met before you can use Collaborative Authoring with Microsoft Office:
- Have an Office 365 tenant.
- Request Technical Setup User role from Veeva Support for the Vault user doing the set up.
- Register your Vault in Azure AD.
- Create a Vault Collaboration user in Azure AD with a license that includes SharePoint Online.
- Create a dedicated shared document library for collaboration.
- Authorize your Vault to connect to your Office 365 tenant.
- Set up automatic invitations for external users.
- Enable external collaboration in SharePoint.
Confirming Technical Setup User Role
Confirm that the Vault user performing the Collaborative Authoring setup has the Technical Setup User role in your Vault.
Complete the following steps to confirm that a user has the Techinical Setup user role:
- Log in to your Vault.
- Navigate to Admin > Settings.
- If you don’t have the Settings section, reach out to Veeva Support to request a Technical Setup User role for the user performing the setup in Vault.
Registering Your Vault in Azure AD
Your Office 365 business subscription includes Azure Active Directory (Azure AD). To use Collaborative Authoring, you must register your Vault as an application in Azure AD. Vault needs certain permissions to access your Office 365 account.
Complete the following steps to register your Vault in Azure AD:
- Navigate to Home > App Registrations.
- Click New Registration.
- In the Name field, enter Veeva Vault Collaborative Authoring.
- For the Supported account types field, select Accounts in this organization directory only - ( Single Tenant).
- In the Redirect URIs section, select Web from the Select a platform drop-down.
- Enter your Vault’s Redirect URI as follows:
https://{Your Vault DNS}/ui/clientTiles/office365/oauth2
For example, enterhttps://sb-yourdomain-clinical.veevavault.com/ui/clientTiles/office365/oauth2
- Click Register.
- In the Essentials section of the Overview Page, copy and store the values for Application (client) ID and Directory (tenant) ID, as they will be used later in the setup process and in provisioning additional Vaults.
- In the Manage section of the left navigation menu, click on API Permissions.
- In the Configured permissions section, click + Add a permission.
- Click Microsoft Graph > Delegated permissions.
- Navigate to Permission > Openid permissions, and add the following delegated permissions:
- offline_access
- openid
- Profile
Note: In the User section, User.Read should be selected by default. Scroll down to the User section to confirm.
- In the search bar, search for and add Files.ReadWrite.All.
- Optional: For external user access, add a Microsoft Graph permission with the following delegated permissions:
- User.Invite.All
- User.ReadWrite.All
- Directory.ReadWrite.All
- Click Add permissions.
- In the Manage section of the left navigation menu, click on Certificates & secrets.
- Click + New client secret.
- In the Description field, enter Veeva Vault Collaboration.
- In the Expires field, select 730 days (24 months) from the drop-down.
- Click Add.
Important: Copy and store the Value and the Secret ID of the new Client Secret before navigating to another page, as you will use them later in the setup process and when provisioning additional Vaults. When you navigate to a different page, the Value and Secret ID values will be hidden.
Creating a Vault Collaboration User
The Vault Collaboration user is the Office 365 user that is authorized to access your Vault.
Complete the following steps to create a Vault Collaboration user:
- Using the search bar at the top, search for Microsoft Entra ID.
- In the Manage section of the left menu, click on Users.
- Click + New user > Create new user and enter the information below. Make note of the Username and Password, as these will be used later in the setup process and when provisioning additional Vaults.
- User Principal Name:
vaultcollaboration@{yourdomain.com}
- Display Name: Vault Collaboration
- Password: Enter a secure password
- User Principal Name:
- Click Review + create, then click Create on the following screen.
- In the Microsoft 365 Admin Center, assign an Office 365 license with SharePoint online access to the Vault Collaboration User you created.
Creating a SharePoint Document Library for Collaboration
The shared document library is a SharePoint team site where your Vault documents are temporarily stored while they’re being edited. SharePoint permissions should not allow users to access or share Vault documents directly through Office 365.
Complete the following steps to create a SharePoint document library for collaboration:
- Create a new team site in the SharePoint Admin Center. Review details about site naming restrictions.
- In the left menu, navigate to Sites > Active Sites > + Create > Team site.
- In the From Microsoft tab, use the Standard Team template.
- Click Use Template.
- On the Give your site a name page, enter the following information:
- Site name: Veeva Vault
- Group email address: VeevaVault
- Site address: will be automatically populated
- Group Owner:
vaultcollaboration@{yourdomain.com}
- Click Next.
- On Set language and other options page, enter the following information:
- Set the privacy settings for the team site to Private.
- Leave the defaults as-is for Select a language and Time zone.
- Click Create site.
- On the Add site owners and members page, leave the field blank, or add members as needed.
- Log in to the vaultcollaboration SharePoint site in an incognito window in your browser; this will ensure you can log in via vaultcollaboration as the owner of the site. Increase the security of the site using the following options:
- URL: Typically
{clientdomain}.sharepoint.com/site/VeevaVault
but may be another URL depending on your configuration. - MFA: Enable MFA for Collaboration User, which is used when authenticating the Collaboration User in your Vault during initial setup only. Alternatively, consider using exception configuration in Azure AD if you do not want to use MFA for this user.
- URL: Typically
- After you log in, click the gear icon in the top right. The icon may take a few moments to show up if you are logging into the site for the first time.
- Click the Site permissions > Change how members can share link, and share the following options:
- Sharing Permissions: Only the site owner can share files, folders, and site.
- Allow access requests: Toggle this setting to Off.
- Click Save.
- Click Advanced permission settings.
- In the PERMISSIONS tab, click Permission Levels.
- Click Contribute.
- In the List Permissions section, clear the Delete Items - Delete items from a list and documents from a document library checkbox.
- Click Submit.
- In the left navigation pane, click Documents.
- Click the gear icon in the top right.
- In Permissions and Management, navigate to Library settings > More library settings > Permissions for this document library.
- In the PERMISSIONS tab, click Stop Inheriting Permissions, then click OK in the dialog box.
- Select the checkboxes for {Site Name} Members and {Site Name} Visitors.
- In the PERMISSIONS tab, click Remove User Permissions, then click OK in the dialog box.
- In the left navigation pane, click Documents.
- Copy and store the SharePoint URL from the browser address bar, as it will be used later in the setup process and when provisioning additional vaults.
Connecting Your Vault to Your Office 365 Account
After you configure Office 365 to work with Vault, you need to connect your Vault to your Office 365 account.
Complete the following steps to connect your Vault to your Office 365 account:
- Log in to your Vault.
- Navigate to Admin > Settings > Checkout Settings and click Edit in the Collaborative Authoring with Microsoft Office section.
- Populate the Collaborative Authoring with Microsoft Office fields using the table in the Connecting Your Vault to Your Microsoft Office 365 Account section.
- In your web browser, sign out of anything related to Microsoft Azure, such as Microsoft Office.
- Click Authorize.
- When prompted, log in with the Vault Collaboration username and password. If you are not prompted to log in, you may still be logged into Office 365 as yourself. Log out and try to authorize again, or retry in a private browser session.
- When the Permissions requested prompt is displayed, click Accept.
- Navigate back to the window where you are logged into Vault.
- When the settings are correctly authorized, the Integration Status is displayed as Verified. Click Save.
Important: After you connect Office 365 to Vault and use Collaborative Authoring, changing these settings could cause permissions errors. If you must change these settings, make sure the Vault Collaboration user has Owner access to previous SharePoint drives.
Enabling Additional Vaults
Complete the following steps to enable Collaborative Authoring in additional Vaults:
- Log in to Azure Active Directory as an Admin.
- Navigate to Home > App Registrations.
- In the App Registration section, select Veeva Vault Collaborative Authoring.
- On the Veeva Vault Collaborative Authoring page, click Authentication.
- Click Add a platform.
- Select Web as the Application Type.
- Enter your Vault’s Redirect URI as follows:
https://{Your Vault DNS}/ui/clientTiles/office365/oauth2
For example,enter https://yourdomain-clinical.veevavault.com/ui/clientTiles/office365/oauth2
. - Click Configure to save the changes.
- Follow the instructions in the Connecting Your Vault to Your Microsoft Office 365 Account section to complete additional Vault setup tasks.
Removing Collaborative Authoring with Microsoft Office Settings
If you want to turn off Collaborative Authoring, you can remove the Checkout Settings. This option is only available if there are no documents currently being edited in Microsoft Office.
Complete the following steps to remove Collaborative Authoring settings:
- Log in to your Vault.
- Navigate to Admin > Settings > Checkout Settings and click Edit.
- Click Remove Settings.
- Click OK to confirm that you want to remove these settings.
- Click Save.
Note: Removed settings are not saved. If you remove the Collaborative Authoring Checkout Settings and later decide you want to turn Collaborative Authoring back on, you must re-enter the settings.