Vault Connect
Last updated
Last updated
This document provides complete information about the new feature Vault Connect, which will enhance the user’s capability to better utilize Vault in viewing archived Salesforce data from an external data source.
OData protocol is an open and platform-independent protocol that can be integrated with the system of the user’s choice (along with Salesforce) as it exposes REST APIs for consuming and querying data from the underlying archives.
External objects support most of the capabilities that standard and custom objects have in Salesforce.
No need to install any managed packages or write custom scripts in Salesforce.
Log in to the Vault application.
Navigate to the setup module of the Vault application. Click on the required Org.
Click on the Connect (Beta) module of the Vault application.
On landing on the Connect (Beta) tab of the Vault setup, the user will see the following message on the screen:
Once the customer reaches out to AutoRABIT support team as specified on the above screen, our technical team will perform due diligence to enable Vault Connect for the customer(s).
When Vault Connect is enabled on the application, the user will see the following screen on the Connect (Beta) tab of the Vault Setup module.
Click on the Add Connect Config button on the application.
A pop-up will be displayed with the following information:
How/where to config the external data source;
OData URL for configuring the external data source; and
What to select when creating Auth. Providers.
Copy the URL from the pop-up shown.
Note: The same URL can be copied from the pop-up and opened by clicking on the information icon available beside the Add Connect Config button.
Select the required config from the Archive Config section and click on the Next button.
On clicking Next, you will be redirected to the Jobs section.
Select the required Job and click on Next.
On clicking Next, you will be redirected to the Objects section.
The following operations can be performed:
Include/exclude the required objects from the list of objects available.
Include/exclude the fields as required from the list of Fields available. Click on the File icon from the Fields column.
The following pop-up will be displayed, where the user can exclude the fields as required and click on Apply field.
On clicking Save, you will be prompted to enter the Name and Description for the config being created.
On entering the required details, click on Save.
On clicking Save, you will be shown a pop-up that says, “Config has been created/updated successfully,” and you will be redirected to the Connect Config Summary.
On the Connect Config Summary, you can view all the configurations created.
Log in to the Salesforce org for which you want to view the data.
Create Auth. Providers
Go to → Auth. Providers under setup.
Click on the Auth. Providers under setup.
Click on New.
4. Select the Provider Type – Salesforce.
Provide Name and URL Suffix and click on Save.
Note: Do not change the remaining settings on the layout.
On completing the required selections, click on the Save button.
Connected Apps allow external applications to securely integrate with Salesforce, enabling seamless data sharing and advanced functionality. Proper configuration is critical to ensure secure and efficient integration. The following guide outlines the steps to configure a Connected App and set up authentication providers.
Go to App Manager from Quick Find and click on "New Connected App" → "Create a Connected App."
Provide a Connected App Name, set the API Name to default, and provide the User's email in the "Contact Email" field.
Under "API (Enable OAuth Settings)," enable the following two options:
Enable OAuth Settings
Enable for Device Flow
Let the "Callback URL" be the default value at this stage.
From the "Available OAuth Scopes", select:
Full access (full)
Perform requests at any time (refresh_token, offline_access).
Ensure the following four checkboxes are checked:
Require Proof Key for Code Exchange (PKCE) Extension for Supported Authorization Flows
Require Secret for Web Server Flow
Require Secret for Refresh Token Flow
Enable Client Credentials Flow
Please find the following screenshot for reference
Click Save.
Go to "Auth. Providers" from Quick Find and click New.
Select the "Provider Type" as "Salesforce".
Provide a "Name" and set the "URL Suffix" to default.
Provide the “Consumer Key” & “Consumer Secret”
To get the "Consumer Key" and "Consumer Secret", navigate to the connected app and select "Manage Consumer Details" (refer to the following screenshot for guidance).
Click the “Copy” button to copy the respective “Consumer Key” & “Consumer Secret.”
Under "Default Scopes", enter "refresh_token full" and click Save.
After saving, you will see the "Callback URL."
Copy the Callback URL, edit the Connected App, paste it in the "Callback URL" field, and click Save.
Go to "External Data Sources" from Quick Find, select the external data source created, and click "Validate and Sync."
Go to → External Data Sources under setup.
Click on New External Data Sources.
Provide External Data Source.
Provide Name.
Type → Salesforce Data: OData 4.0
Identity type → Named Principal
Authentication Protocol → OAuth 2.0
Authentication Provider → On clicking the LookUp glass, you can select the “Auth. Provider” created earlier.
Select the Authentication Provider.
Click on Save on the External Data Sources screen.
On Save, click the Validate and Sync.
You will be shown all the objects selected as part of the config creation.
On selecting the required objects, the Sync button on Salesforce will be enabled.
Select all the objects you want to sync or select which objects’ data you want to view in Salesforce.
Click on the Sync button.
On completion, you can see all the objects selected.
Create Tabs: Customers can view the archived data under these tabs.
Go to → Tabs under setup.
Click on the New button.
Under Objects, you can see the objects that are part of the Config created with the naming convention “Object__X”.
To streamline the process and enhance functionality, the Vault Connect integration has been updated to support viewing of rich text fields (unsupported by external objects) through Visualforce pages in Salesforce, enabling the seamless viewing of images and other HTML content in rich text fields.
Steps to Implement the Fix:
Create a Visualforce Page:
In Salesforce Setup, create a Visualforce page for the object where the rich text data needs to be displayed.
Example: To display emailmessage body field in the emailMessage_x object layout, follow these steps:
Open the Developer Console by going to: Setup → Developer Console
After Landing on the developer console, create a new Visualforce page and save it to continue with the script creation.
Enter the script and save it.
Example script:<apex:page standardController="CustomX_c_x__x" >
<apex:outputText style="text-align:left" value="{!CustomX_c_x__x.RicheRich_c__c}" escape="false" />
</apex:page>
Add the Visualforce page to the object layout and continue to view the email messages in external objects:
Go to the external object through: Setup → External Objects
Select any external object as required. Here, email message is considered for illustration.
Add the Visualforce page to the object layout
Go to the ‘Page Layout’ in the external object and observe the Visualforce page.