AutoRABIT Knowledge Base
  • 👋Welcome to the Knowledge Base
  • Fundamentals
    • ⚡AutoRABIT Solutions
    • LearningHub
    • ℹ️FAQs
      • General User Definitions
        • ARM User Definitions
      • ARM-FAQs
        • Connection & Authentication
        • Common Errors and Resolutions
        • Deployment
        • Data Loader
        • CI Jobs
        • Retention Policy
        • nCino
      • CodeScan-FAQs
        • General
          • CodeScan Static IP Ranges
          • Difference b/w CodeScan Self-Hosted and CodeScan Cloud
          • Single Sign-On (SSO)
          • What is a Subscription Code?
          • What is a CodeScan License Key?
          • Can I use CodeScan with a proxy?
          • Not receiving email notifications
          • CodeScan Blocks, Lines, and Field Inquiries
          • How are Metric Definitions Defined?
          • What Is Cyclomatic Complexity?
          • Can I export my test results?
          • CodeScan requests read and update permissions while connecting to Bitbucket
          • SSL Certificates
          • Does SonarQube support test execution reports for pull requests?
        • CodeScan Self-Hosted Issues
          • Self-Hosted Errors and Solutions
          • Self-Hosted FAQs
          • License Errors
          • License Issues (IDE)
          • Setting the System Environment Variable
          • Setting Up CodeScan for Use with a Proxy
        • CodeScan Cloud Issues
          • Cloud Errors and Solutions
        • Common Issues and Solutions
      • Vault-FAQs
        • Vault-FAQs
        • Common Error Messages
        • Limitations
        • Unsupported Metadata Types
  • Release Notes
    • 🔁Release Notes
      • ARM Release Notes
      • CodeScan Release Notes
        • Cloud Releases
          • Release Notes 25.1
          • Release Notes 25.0
          • Release Notes 24.0
          • Prior Versions
            • Release Notes 23
              • Release Notes 23.2
              • Release Notes 23.1
            • Release Notes 22
              • Release Notes 22.8
              • Release Notes 22.7
              • Release Notes 22.4
              • Release Notes 22.3
              • Release Notes 22.2
              • Release Notes 22.1
            • Release Notes 21
              • Release Notes 21.5
              • Release Notes 21.4
            • Release Notes 4
              • Release Notes 4.5
              • Release Notes 4.4
              • Release Notes 4.3
              • Release Notes 4.2
        • Self Hosted Releases
          • Eagle Edition
            • Release Notes 25.1.0 Eagle 3.0
            • Release Notes 24.1.1 Eagle 2.0
            • Release Notes 24.1.0 Eagle
          • Tiger Edition
            • Release Notes 25.0.1 Tiger 3.0
            • Release Notes 24.0.13 Tiger 2.0
            • Release Notes 24.0.9 Tiger
          • Prior Editions
            • Release Notes 24
              • Release Notes 24.0.8
              • Release Notes 24.0.5
              • Release Notes 24.0.4
              • Release Notes 24.0.1
            • Release Notes 23.1
        • CodeScan for Government
      • nCino Release Notes
        • Release Notes 25.2
        • Release Notes 25.1
        • Release Notes 24.4
        • Release Notes 24.3
        • Release Notes 24.2
        • Release Notes 24.1
        • Release Notes 23.1
        • Release Notes 22.3
      • Vault Release Notes
        • Release Notes 25.0
        • Release Notes 24.0
        • Release Notes 23.0
        • Release Notes 22.0
        • Release Notes 21.0
      • Guard Release Notes
        • Release Notes 25.1
  • Product Guides
    • ARM
      • Getting Started
        • Signing Up with ARM
          • User Profile
        • Understanding ARM
          • What is ARM?
          • What can I do with ARM?
          • Who can use ARM?
          • ARM Supported Metadata Types
        • Navigating ARM
      • ARM Administration
        • User Management
          • User Types
          • Predefined Roles
          • Users, Roles & Permissions
          • Adding New Users
          • Assigning User Roles
          • Removing or Suspending Users
          • Exporting User Details
          • Managing User Account Settings
          • Resetting Account Passwords
          • Profiles
          • Permissions
          • Credential Manager
          • Delegating Approvals to Another User
          • Enforcing Single Sign-On (SSO)
          • Salesforce API Version
          • Changing Super Admin in ARM
        • Registration
          • Version Control Repository
            • GIT Integration
              • GIT Tag
            • SVN
            • TFS
            • Bitbucket
          • Version Control Branch
            • GIT Branch Creation
            • Creation of a TFS Branch
            • Creation of SVN Branch
          • Salesforce Org
            • Salesforce Authentication using OAuth
            • Salesforce Org Re-Authentication
          • Static Code Analysis in CI-CD
        • Subscription Management
        • Workspaces
        • Search and Substitute
        • ALM Management
      • Getting Set Up
        • Version Control Repository
          • GIT Integration
            • GIT Tag
          • SVN
          • TFS
          • Bitbucket
        • Version Control Branch
          • GIT Branch Creation
          • Creation of a TFS Branch
          • Creation of SVN Branch
        • Salesforce Org
          • Salesforce Org Management
          • Salesforce Authentication using OAuth
          • Salesforce Org Reauthentication
        • Branching Baseline
        • Static Code Analysis in CI/CD
        • Browser Support
      • ARM Features
        • Dashboard & Pipelines
          • Dashboards & Widgets
          • Pipelines
        • Webhooks
          • Configure a Webhook in Bitbucket
          • Configure a Webhook in Bitbucket Enterprise
          • Configure a Webhook in GitHub
          • Configure a Webhook in GitHub Enterprise
          • Configure a Webhook in GitLab
          • Configure a Webhook in Microsoft Azure
          • Configure a Webhook in Slack
          • Configure a Webhook in Teams
          • Configure a Webhook in Visual Studio GIT
          • Configure a webhook in Visual Studio GIT Enterprise
        • Version Control
          • Introduction to Version Control
            • Version Control Repositories Summary
            • Version Control Branch Workflow
          • Version Control Repository
          • EZ-Commits
            • How Do I Commit?
            • Commits Summary
            • Committing Individual Forms from Form Manager (RBC Metadata)
          • EZ-Merge
            • Merge Conflicts
            • Merge Requests
            • Squash and Merge
            • Git Commit History and Merge Operations Basics
          • Change Labels
            • Commit Labels
            • Release Labels
              • Selective Deployments Using Pre-Prepared Artifacts
              • Artifact Preparation and Deployment Process
            • ALM Labels
          • External Pull Request
            • Azure Cloud Authentication
            • Pull Request Support for Azure Cloud
            • External Pull Request Summary Page
          • Commit Templates
          • GIT Revert
          • Understanding Duplicate File Change Commits in Git
          • Merge Approvals
        • Data Loader
          • Single Data Loader
            • Extract Salesforce Data
            • Insert Salesforce Data
            • Update Salesforce Data
            • Upsert Salesforce Data
            • Delete Salesforce Data
            • Using Data Loader with Lookups
          • Data Loader Pro
          • Data Loader Configuration
          • Test Environment Setup
          • Validation / Workflow Rules
          • Preparing the CSV file for ARM Data Loader
        • Automation and CI
          • Create a New CI Job
            • Build a Package from Salesforce
            • Backup your project to Version Control
            • Build a package from Version Control
            • Deploy a package from a Salesforce Org
            • Deploy from Salesforce with VC backup
            • Deploy from Version Control to a Salesforce Org
            • Deploy from SFDX branch to a Salesforce Org
            • Run Test Automation Scripts
            • Install an Unlocked Package from Version Control Branch
          • Triggering Builds for your CI Job
          • CI Job History
          • CI Job List
          • Configure Callout URL
          • CI Job Rollback
          • Parallel Processor
          • Enabling GitHub Checks
          • Automate Merge When CI Builds Pass
        • Deployment
          • Monitor Deployments
          • Apex Unit Tests
          • Connecting and Syncing Salesforce Orgs
          • Creating and Deploying Changes
          • Deploying Profile and Permission Sets
          • Deployment Rollback
          • Destructive Changes
        • nCino
          • Feature Migration
            • Create a Feature Migration Template
            • Create a Feature Migration Template with Predefined nCino Objects
            • Feature Migration Summary Page
          • Feature Deployment
            • Deployment Using Feature Migration Template
            • Deployment via Template using Salesforce Org
            • Deployment Using Version Control
            • Deployment via Version Control using Salesforce Org
            • Feature Deployment Summary
          • Feature Commits
          • Feature CI Jobs
            • Running a CI Job
              • Selecting a Range of Revisions
              • Specify Baseline Revision in Continuous Integration for Version Control
              • Post Deployment Activities
              • nCino RBC Deployment Rollback
              • Exclude the OwnerID from Automapping in nCino CI jobs
              • External Unique ID Validation
              • Select External Unique ID
            • CI Job Results
            • CI Job List screen
            • nCino Webhooks
          • nCino Developer APIs
            • nCino API References
          • nCino Compare
        • Salesforce DX
          • Salesforce DX Metadata Format
          • Registering a DevHub
          • Create a Scratch Org
          • Create a Module
          • Create an Unlocked/Managed Package
          • Import an Unlocked/Managed Package
        • Reports
          • Reports Overview
          • Code Coverage Reports
          • Deployment Reports
          • Static Code Analysis
          • Audit Report
        • Environment Provisioning
          • Migration Template
            • Enable History Tracking on Objects
            • Disable History Tracking on Objects
            • Enable History Tracking on Custom Fields
            • Disable History Tracking on Custom Fields
            • Run Destructive Changes
            • Execute Anonymous Apex
            • Enable Validation Rules
            • Disable Validation Rules
            • Enable Workflow Rules
            • Disable Workflow Rules
            • Enable Flows
            • Disable Flows
            • Enable Apex Triggers
            • Disable Apex Triggers
            • Migrate Custom Settings Data
          • Unsupported Metadata Templates
            • Account Teams
              • EnableAccountTeams
              • DeleteAccount
              • DisableAccountTeams
              • NewRoleAccount
              • Reorder
              • Replace
              • SortAlphabetically
            • AddTabsinAppManager
            • ActivityButtonOverrides
            • ApexExceptionEmail
            • ComplianceBCCEmail
            • AutoNumberFields
            • Campaign Influences
              • CampaignInfluencesEnable
              • CampaignInfluencesDisable
            • Case Contact Roles
              • NewContactRoles
              • DeleteContactRoles
              • ReorderContactRoles
              • ReplaceContactRoles
            • Contact Role Templates
              • EditTeamRole
              • NewTeamRole
              • ReplaceTeamRole
            • Console Layout Assignment
              • ConsoleLayoutsAssignments
              • DeleteConsoleLayout
              • NewConsoleLayouts
            • Create Lead Mapping Rules
              • LeadMapping
            • Create Organization-Wide Email Footers
              • DeleteEmailFooters
              • EditEmailFooters
              • EmailFooters
            • Case Feed Layout
            • Create Public Groups
              • Assign Roles and Profiles to Public Groups
              • PublicGroups
            • Web to Case
            • Data Category Visibility Settings
            • Delegated Administration
              • DelegatedAdministrationNew
              • DelegatedAdministrationEdit
            • Delete Outbound Messages
            • Delete Scheduled Jobs
            • Delete Time Based Workflow
            • Disable Scheduled Reports
            • Edit Queue
            • Email to Case Settings
              • Email to Case
              • Update Email to Case
            • File Upload and Download Security
            • Fiscal Year
            • Edit Lead
            • Email Admin Settings
            • Email Relay Activation
            • Manage Email Services
              • DeleteEmailServices
              • EditEmailServices
              • NewEmailServices
            • Manage Libraries
            • Page Layout Assignment
            • Manage User Records
            • Mobile Administration
              • Mobile Dashboard Settings
              • Mobile Notifications
              • Mobile Salesforce Settings
              • Salesforce Navigation
              • Salesforce Offline
            • Multiline Layout Fields For Contract Line Items
            • Multi Line Layout Fields for Opportunity Teams
            • Territory Model Options
              • New Territory Model
              • Edit Territory Model
              • Delete Territory Model
            • Offline Briefcase Configuration
              • Offline Briefcase Configuration New
              • Offline Briefcase Configuration Edit
              • Offline Briefcase Configuration Delete
            • Opportunity Deal Alerts
              • Edit Deal Alert
              • New Deal Alert
            • Opportunity Update Reminders
              • EditReminder
            • Organization Wide Email Addresses
              • Delete
              • Edit All
              • Organization All Profile
            • Predefined Case Teams
              • DelPredefined
              • NewPredefined
              • EditAdd
              • EditRemove
              • EditName
            • Product Schedule Settings
            • Public Calendar
              • Public Calendar Delete
              • Public Calendar Edit
              • Public Calendar New
            • Public Calendars and Resources Sharing
              • Public Calendar and Resources Sharing Add
              • Public Calender and Resources Sharing Edit
              • Public Calendar and Resources Sharing Delete
            • Publish Communities
            • Quote Templates
              • Active Quote
              • Deactive Quote
              • Delete Quote
              • New Quote
            • Report Dashboards Create Manage Folders
              • Create New Dashboard Folder
              • Create New Report Folder
              • Delete Folder
              • Share Settings
            • Resource Calendar
              • Resources Calendar Delete
              • Resources Calendar Edit
              • Resources Calendar New
            • Sandbox Refresh
            • Enable Salesforce to Salesforce
            • Schedule Apex Classes Monthly
            • Schedule Apex Classes Weekly
            • Search Settings
            • Self Service Public Solutions Edit
            • Site
            • Social Accounts Contacts and Lead Settings
            • SoftPhone Layouts
              • Softphone Layout New
              • SoftPhone Layout Edit
              • SoftPhone Layout Delete
            • Solution Categories
              • Solution Category Add
              • Solution Category Edit
            • Solution Settings Edit
            • Tag Settings
            • Territory View Rules
              • Delete Territory View Rules
              • Edit Territory View Rules
              • New Territory View Rules
            • User Interface Settings
            • Update Custom Label
            • Update Url for Remote Site Settings
            • Web to Lead
              • Edit Web Lead
              • Web To Lead
      • Integration and Plugins
        • SSO
          • SSO With Microsoft Entra ID
          • SSO for OKTA
          • SSO For PingFederate
          • SSO For ADFS
          • SAML SSO (Generic IdP)
        • Active Directory
        • JIRA
        • Azure DevOps
        • OmniStudio
          • Deploying OmniStudio Components
          • OmniStudio Configuration Settings
          • Committing OmniStudio Components to a Branch
        • AccelQ
        • HashiCorp Vault
        • Provar
        • SCA for Checkmarx
          • Checkmarx One Integration
        • Apex PMD
        • CodeScan Overview
        • SonarQube
        • Jenkins
        • Visual Code Extension
          • Installing VS Code Extension
          • Configuring VS Code Extension
          • Working with VS Code Extension
        • Integrate ServiceNow with ARM
        • URL Callout Integration with Tricentis
        • ARM for Salesforce Data Cloud
      • Security Information and Event Management
        • Common Event Format (CEF) Data
        • ARM Event Type
        • Retrieval APIs
      • Developer APIs
        • Authentication
        • API Access
        • Errors
        • API References
      • On-Premises / Dedicated Instances
        • Upgrade Guides
      • Troubleshooting
        • Best Practices
          • Salesforce Deployment Best Practices
          • Version Control Best Practices
          • CI Job Configurations
          • Vlocity
          • IP Whitelist
          • How to Include Network Settings in Commit or Deployment
          • Branching Strategy & CI/CD Pipeline
          • Metadata comparison between two Salesforce Orgs
          • Working with Translations in ARM
          • Revision Range & Release Label Deployment
          • Salesforce API Version Mismatch for the CI Build and Custom Deployment
          • Prerequisite while performing a commit using AutoRABIT
          • Flows in Salesforce
        • Known Issues / Limitations
          • ARM Known Issues
          • ARM Known Limitations
          • Salesforce Known Limitations
        • How-To's
          • Configure Merge Approval
          • Check Time Stamp for Commit/Merge
          • Enable SCA Apex PMD validation criteria.
          • Create API Token
          • Create Users' Credentials
          • Configure Record Types Picklist Values
          • Configure Multi-Proxy
          • Configure Mail Server Settings
          • Notifications (Mail Server Settings)
          • Enable Delta on PermissionSets
          • Default Apex Class Configuration
          • Enable Enhanced Domains
          • Provide branch access to users
        • FAQs
    • CodeScan
      • CodeScan Overview
      • System Requirements and Installation Self-Hosted
        • Installing CodeScan Self-Hosted
      • Getting Started
        • Users, Roles and Permissions
          • User Account
          • Reset the Password
          • Adding Users to a CodeScan Cloud Organization
            • Accepting invitations to add a user to a CodeScan Organization
          • Deleting User from a CodeScan Organization
          • Member Permissions
          • IDP Group Mapping
        • Setting up a CodeScan Cloud Organization
          • About CodeScan Cloud Organizations
          • Deleting Projects and Organizations
          • Generate a Security Token
          • Finding your Organization Key
          • Finding your Project Key
          • Setting up Payment
          • Understanding branches in CodeScan Cloud
          • Understanding branches for Salesforce project
          • Understanding the New Code Tab
        • Adding Projects to CodeScan
          • Add a project to CodeScan from Salesforce
          • Add a project to CodeScan from GitHub
          • Add a Project to CodeScan from Bitbucket
          • Add a Project to CodeScan from Git
          • Add a project to CodeScan from GitLab
      • Quality Profiles
        • Setting a Default Quality Profile
        • Customizing Quality Profiles
        • Exporting CodeScan Quality Profiles
      • Quality Gates
        • Understanding Quality Gates
        • Assigning Specific Quality Gates to a Project
        • Customizing Quality Gates
      • CodeScan Rules
        • CodeScan Rule List
        • Security-Related Rules
        • Creating Custom Rules with XPath
        • Configuration for Polyfill.io Vulnerability Rules
        • Configuration for Salesforce Metadata Rules
        • Metadata Rules on CodeScan Self-Hosted
      • Issues
        • Filtering Issues in CodeScan
        • Export issues to CSV in CodeScan Cloud
        • Exporting Issues using CodeScan-Export Tool
        • About Issue Status
        • Security Hotspots
      • Report and Analysis
        • Scheduled Reports
        • Analysis Scope on CodeScan Cloud
        • Ignoring Violations
        • Importing Salesforce CLI Code Coverage
        • Housekeeping
      • CodeScan Support
        • Raise a Service Request
      • CodeScan Integration
        • Integration Requirements
        • Project Naming Conventions
        • Single Sign-On (SSO)
          • Single Sign-On with OKTA
          • Single Sign-On with Entra ID
          • Single Sign-On with ADFS
          • Single Sign-On with PingOne
        • ARM
          • CodeScan Integration with ARM
        • CodeScan SFDX Plugin
          • Run analysis locally using SFDX
          • Importing Code Coverage from SFDX projects
        • IDE Plugins
          • Installing CodeScan for VS Code
          • Installing CodeScan for IntelliJ
        • Copado
          • Copado SFDX Integration
          • Copado MDAPI Integration
        • Flosum
          • CodeScan and Flosum Integration
        • Azure DevOps
          • Scan CodeScan Cloud projects in Azure DevOps
        • GitLab
          • Integrating CodeScan in GitLab
        • Bitbucket Pipelines
          • Integrating CodeScan in Bitbucket Pipelines
          • Reattaching Bitbucket Projects
        • GitHub Actions
          • Integrating CodeScan with GitHub Actions
        • Jenkins
          • CodeScan with Windows Agents
          • CodeScan with Linux/Unix Agents
          • Use Jenkins with CodeScan Salesforce project
        • Webhooks
          • Slack integration with Zapier
    • Vault
      • Vault™ Overview
      • Getting Started
        • Registering for an Account
        • Signing In
        • Resetting your Password
        • Managing Users and Roles
        • Setting Up Multifactor Authentication in Vault
        • Managing User Sessions
        • User Profile and Permission Access for Salesforce Users
        • Transferring Admin Ownership
        • Controlling Access to the Salesforce Org
      • Configuring Vault
        • Configure Backup Environment
          • Amazon AWS S3 Storage Environment
            • Bring your own Key (BYOK) with Vault
            • IAM Role Support
          • Google Cloud Platform
          • Create an Azure Storage Account
          • Azure Blob Storage Environment
          • Microsoft Azure Blob Retention Policy
        • Licenses
        • SSO Configuration
          • SSO for OKTA
          • SSO with Microsoft Entra ID for Vault
        • Registering Salesforce Org
          • Setup backup configuration for Salesforce Org
          • Archival Configuration
          • Unique Identifier (UID)
        • Scheduled Backup List
        • Alerts & Notifications
        • Workflow/Validation Rules
        • TLS Supported
        • Creating and Configuring Proxy Servers
      • Vault Features
        • Archive
          • Archiving Your Salesforce Data
          • Parent-Child Record Archival
        • Backup
          • Start the Backup
          • Schedule a Vault Backup
          • Understanding Backup Behavior
        • Compare
          • Comparing Two Backups
        • Compliance
          • GDPR - Secure and Comply
            • Right to Be Forgotten Request
          • PCI DSS
        • Replicate
          • Job Configuration
          • Job History
          • Masking Rules
        • Reporting
          • Archive Reports
          • Stale Jobs
        • Restore
          • Restoring the Metadata/Data to the Salesforce Org
        • SIEM Logs
        • Vault Connect
      • Vault Best Practices
      • Vault-FAQs
      • Knowledge Articles
        • Backup Support for Knowledge Articles
        • Restoring Knowledge Articles with Vault
        • nCino
          • Registering nCino configured Salesforce Org
          • Backup Configuration for your Salesforce Org
          • Archival Configuration for your Salesforce Org
          • Restoring nCino Features
    • Guard
      • Risk Assessment
      • Permissions Explorer
      • Change Monitoring
      • Policies
      • Integration User License
      • Data Classification
  • Resources
    • 🖥️AutoRABIT Support
    • 💬Community Forum
    • 📙Glossary
Powered by GitBook
On this page
  • Introduction
  • Feature Overview
  • Step-by-Step Guide
  • Create Connect Config
  • View Archived Data in Salesforce
  • Configure Connected Apps in Salesforce
  • Steps to Create Auth. Providers
  • Create External Data Sources
  • View Archived Rich Text Email Content
  • Sync with Salesforce
  • Global Search: Prerequisites, Limitations, and Troubleshooting
  • Prerequisite: Enabling Global Search with Vault Connect
  • Limitations of Querying Archived Data via Vault Connect
  • Troubleshooting Guide: Verifying Salesforce Queries to External Database (Vault Connect)
  • Prerequisites
  • Limitations

Was this helpful?

Edit on GitHub
Export as PDF
  1. Product Guides
  2. Vault
  3. Vault Features

Vault Connect

PreviousSIEM LogsNextVault Best Practices

Last updated 4 months ago

Was this helpful?

Introduction

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.

Feature Overview

  1. 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.

  2. External objects support most of the capabilities that standard and custom objects have in Salesforce.

  3. No need to install any managed packages or write custom scripts in Salesforce.

Step-by-Step Guide

Create Connect Config

  1. Log in to the Vault application.

  1. Navigate to the setup module of the Vault application. Click on the required Org.

  1. Click on the Connect (Beta) module of the Vault application.

  2. On landing on the Connect (Beta) tab of the Vault setup, the user will see the following message on the screen:

  1. 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).

  2. 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.

  1. Click on the Add Connect Config button on the application.

  1. 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.

  2. 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.

  1. Select the required config from the Archive Config section and click on the Next button.

  1. On clicking Next, you will be redirected to the Jobs section.

  1. Select the required Job and click on Next.

  2. On clicking Next, you will be redirected to the Objects section.

  1. 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.

  2. The following pop-up will be displayed, where the user can exclude the fields as required and click on Apply field.

  1. On clicking Save, you will be prompted to enter the Name and Description for the config being created.

  1. On entering the required details, click on Save.

  2. 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.

  1. On the Connect Config Summary, you can view all the configurations created.

View Archived Data in Salesforce

  1. Log in to the Salesforce org for which you want to view the data.

  2. Create Auth. Providers

    • Go to → Auth. Providers under setup.

    • Click on the Auth. Providers under setup.

  3. Click on New.

4. Select the Provider Type – Salesforce.

  1. Provide Name and URL Suffix and click on Save.

Note: Do not change the remaining settings on the layout.

  1. On completing the required selections, click on the Save button.

Configure Connected Apps in Salesforce

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.

Steps to Configure Connected Apps

  1. Go to App Manager from Quick Find and click on "New Connected App" → "Create a Connected App."

  2. Provide a Connected App Name, set the API Name to default, and provide the User's email in the "Contact Email" field.

  3. Under "API (Enable OAuth Settings)," enable the following two options:

    1. Enable OAuth Settings

    2. Enable for Device Flow

  4. Let the "Callback URL" be the default value at this stage.

  5. From the "Available OAuth Scopes", select:

    1. Full access (full)

    2. Perform requests at any time (refresh_token, offline_access).

  6. Ensure the following four checkboxes are checked:

    1. Require Proof Key for Code Exchange (PKCE) Extension for Supported Authorization Flows

    2. Require Secret for Web Server Flow

    3. Require Secret for Refresh Token Flow

    4. Enable Client Credentials Flow

  7. Please find the following screenshot for reference

  8. Click Save.

Steps to Create Auth. Providers

  1. Go to "Auth. Providers" from Quick Find and click New.

  2. Select the "Provider Type" as "Salesforce".

  3. Provide a "Name" and set the "URL Suffix" to default.

  4. Provide the “Consumer Key” & “Consumer Secret”

    1. 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).

    2. Click the “Copy” button to copy the respective “Consumer Key” & “Consumer Secret.”

  5. Under "Default Scopes", enter "refresh_token full" and click Save.

  6. After saving, you will see the "Callback URL."

  7. Copy the Callback URL, edit the Connected App, paste it in the "Callback URL" field, and click Save.

  8. Go to "External Data Sources" from Quick Find, select the external data source created, and click "Validate and Sync."

Create External Data Sources

  1. Go to → External Data Sources under setup.

  1. Click on New External Data Sources.

  2. 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.

  3. Create Tabs: Customers can view the archived data under these tabs.

    • Go to → Tabs under setup.

    • Click on the New button.

  4. Under Objects, you can see the objects that are part of the Config created with the naming convention “Object__X”.


View Archived Rich Text Email Content

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:

  1. Create a Visualforce Page:

    In Salesforce Setup, create a Visualforce page for the object where the rich text data needs to be displayed.

  2. Example: To display emailmessage body field in the emailMessage_x object layout, follow these steps:

  3. Open the Developer Console by going to: Setup → Developer Console

  4. After Landing on the developer console, create a new Visualforce page and save it to continue with the script creation.

  5. Enter the script and save it.

  6. 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>

  7. Add the Visualforce page to the object layout and continue to view the email messages in external objects:

    1. Go to the external object through: Setup → External Objects

    2. Select any external object as required. Here, email message is considered for illustration.

    3. Add the Visualforce page to the object layout

      1. Go to the ‘Page Layout’ in the external object and observe the Visualforce page.

      2. Observe the Visualforce pages highlighted.

      3. Add the Visualforce page to the layout. Observe the ‘EmsgVFPage’ added to the page layout.

  8. Verify the Update: Open a record within the object to ensure the rich text/html body, including images, is displayed correctly.

This enhancement ensures that archived email body content with rich text and images is rendered seamlessly in Salesforce.


Sync with Salesforce

Overview

This feature enables the user to sync the latest metadata changes on Salesforce with Vault Connect. The user can also view the data in the same structure and the same relationship hierarchies in the connected external objects.

Step-by-Step Guide:

  1. Log in to the Vault application.

  2. Click on any Org to navigate to Vault – Connect.

  3. Click on the “Connect” tab to go to the Connect application.

  4. Click on the “Sync with Salesforce” button to initiate the sync procedure

    • Please observe the information icon for informational purposes.

  5. On initiating “Sync with Salesforce,” the user will go to the “Sync history” page.

  6. This page will provide information on how many times the sync has happened to date.

  7. On clicking “Sync with Salesforce,” the following pop-up will be displayed.

  8. Clicking on “Confirm” will redirect the user to the object list page, where the list of objects is shown.

  9. Click on “View Logs” to display the related logs.

  10. Logs can be downloaded using the "Download" button.

  11. Click on any of the objects to open the related pop-up and make the required selections.

  12. Field Label Name: The field label can be updated to a custom name by clicking on the pencil icon provided.

  13. Reference to: If a field has a pencil icon beside it, then “Type” for that field will be set to “Reference.”

  14. For polymorphic fields, at least one reference has to be selected.

    • For polymorphic fields, a pencil icon will be displayed beside the fields under the “Reference to” column.

  15. An error will be displayed under the ‘error’ column if no references were selected under the “Reference to” column.

  16. On completing the selection(s), click on the “Sync with Salesforce” button to continue with the sync procedure.

  17. An information pop-up will be displayed on clicking the “Sync with Salesforce” button.

  18. Clicking on “CONFIRM” will display a success message pop-up.

  19. The latest job can be observed as the top entry on the “Sync history” page.

  20. Clicking on the latest job will provide the list of objects from the job.

  21. Hovering over the list of fields under the References column, the list of fields selected under the references will be displayed to the user.

  22. After performing the “Sync With Salesforce”, the user has to go to the “External Objects” and select the required object.

  23. To add the related lists to the page layout of the parent object, the user first has to set the field-level security by going to the field under the object. The permission should be set to 'visible.'

  24. The user can only view data to which they have access.

  25. After setting the permissions to visible, the user should continue to edit the parent object(s) to add related lists to the page layouts.

  26. Click edit on the “Page Layouts.”

  27. On opening the page layouts, the user can view the “Related Lists” on the left side pane as highlighted.

  28. Click on the related lists and continue to add the required related lists to the layout to view under the related lists section.

  29. After completing the required configuration, the user can continue to open the object on which the configuration is done to view the related list items when the parent record is opened.


Global Search: Prerequisites, Limitations, and Troubleshooting

Prerequisite: Enabling Global Search with Vault Connect

Steps to Enable Global Search

  1. Access Setup:

    • Go to Setup in Salesforce.

  2. Search for External Data Sources:

    • In the Quick Find box, search for External Data Sources.

  3. Edit External Data Source:

    • Select the external data source you created for Vault Connect.

    • Click on Edit.

  4. Enable Free-Text Search Expressions:

    • Enable the checkbox labeled Use Free-Text Search Expressions.

By following these steps, you will enable global search functionality for Vault Connect in Salesforce.

Limitations of Querying Archived Data via Vault Connect

1. Indexed Fields Only

  • Search and queries are restricted to indexed fields from the original object in Salesforce.

  • Note: To determine what is indexed in a Salesforce object, run the following query from the Salesforce developer console: SELECT QualifiedApiName FROM FieldDefinition WHERE EntityDefinition.QualifiedApiName =<Salesforce object Name> and IsIndexed = true

2. Complete Value Searches

  • Only complete value searches or queries using the equals (=) operator will work on indexed fields.

3. Non-Indexed Fields

  • Queries or Salesforce functionalities that require a query on non-indexed fields may or may not work.

  • Impact: As the size of your archived data increases, these queries are more likely to result in timeouts.

Troubleshooting Guide: Verifying Salesforce Queries to External Database (Vault Connect)

Issue

  • Symptom: Records are not visible in the external object or global search is not functioning.

Steps to Verify Salesforce Queries to Vault Connect

  1. Open Developer Console:

    • Navigate to the Developer Console in Salesforce.

  2. Change Log Level:

    • Click on the Debug tab.

    • Select Change Log Levels.

  3. Adjust General Settings:

    • Under the General Setting for your user, click on Add / Change under the Debug Level Action.

  4. Set Callout Level to Finest:

    • Change the callout level to Finest.

  5. Check Logs:

    • Look for logs with the operation "/aura". These logs will capture the details of the callouts from Salesforce to Vault Connect.

Resolution

  1. Validate and Sync External Data Source:

    • Go to Setup.

    • Search for External Data Sources.

    • Click the external data source you created for Vault Connect.

    • Click on Validate and Sync.

  2. Reestablish Link:

    • Completing the Validate and Sync will ensure that the link between Salesforce and the external data source is reestablished if there is any problem.

By following these steps, you can troubleshoot and resolve issues related to the visibility of records in external objects and the functionality of global search.

Prerequisites

Salesforce Connect OData 4.0 license subscription.

Note: Not required for free developer edition org.

Limitations

  1. Salesforce OData 4.0 adapter has a limitation on the number of callouts per hour. This will be addressed with the support for the Salesforce OData 4.01 adapter in subsequent versions of the capability.

  2. The solution only supports customers configured with AWS S3 as a storage option in Vault.

  3. Fields of type XmlObjectWrapper are not supported.

  4. Fields of the object that have soapType as double, values will be truncated according to the precision and scale, as defined in the metadata of the object’s field.

    For example: If a field holds decimal value information for that object, precision and scale values will be predefined.

    Precision: The maximum number of digits in a numeric value includes all numbers to the left and the right of the decimal point (but excludes the decimal point character).

    Scale: The number of digits to the right of the decimal point in a numeric value must be less than the precision value. Example 1:

    Define a custom number field, e.g., "Number." Give it length = 3 and decimal places = 1 (scale). It might seem that this is done to restrict the precision of the field to one decimal place. However, on the UI level (on a standard edit page), if you try to type in, for example, 237.631, it will round it off to 237.631. Here precision is 4 and scale is 1. When mapping it back to Salesforce as the external object’s field, the value will be truncated to 237.6.

    Example 2:

    Say a field holds info on geolocation latitude and longitude and their precision and scale are 5 and 2, respectively. Assign the value as 77.2090, then when mapping it back to Salesforce as the external object’s field, it will be truncated to 77.20.

  5. Field type "time" is not supported in this version.

All the limitations of Salesforce external objects are applicable as mentioned in this article:

There is a max limit of 5GB of archived data per customer supported for connecting to Salesforce external data source as part of the beta program. This can be extended to a higher limit by raising a request with .

No more than four external lookup fields can be added to your page layout. On Lightning Experience record pages, a Record Detail component that contains more than four external lookup fields breaks the page at runtime. Please refer to the following documentation for more information on the limitations related to the layouts .

Help and Training Community
support@autorabit.com
https://help.salesforce.com/s/articleView?id=sf.layouts_limitations.htm&type=5