Compatible with Fusion version: 4.0.0 through 5.12.0
The Salesforce V1 connector uses the Salesforce REST API to ingest and index data from a Salesforce Connected App in a Salesforce repository.
ImportantV1 deprecation and removal noticeStarting in Fusion 5.12.0, all V1 connectors are deprecated. This means they are no longer being actively developed and will be removed in Fusion 5.13.0.The replacement for this connector is in active development at this time and will be released at a future date.If you are using this connector, you must migrate to the replacement connector or a supported alternative before upgrading to Fusion 5.13.0. We recommend migrating to the replacement connector as soon as possible to avoid any disruption to your workflows.
Connector flow The Salesforce REST API has an authentication procedure and API usage limits.
You need to have the Consumer Key and Consumer Secret of the Salesforce Connected App, which must be created by a Salesforce administrator for the account. Instructions on how to do this follow the datasource configuration details.
There are two details to be aware of with SOQL queries. If no results are returned, try adding the id field to the SELECT. Special characters like % require escape sequences. For example, %25example%25.

​
Prerequisites

Perform these prerequisites to ensure the connector can reliably access, crawl, and index your data. Proper setup helps avoid configuration or permission errors, so use the following guidelines to keep your content available for discovery and search in Fusion.
  • A Salesforce account with API access is required for the connector to fetch data.
    • API access in Fusion requires a Developer Edition of Salesforce.
  • A Connected App in Salesforce is needed to authorize Fusion via OAuth 2.0.
    • Enable the appropriate Salesforce OAuth scopes:
      • Manage user data via APIs (api).
      • Perform requests at any time (refresh_token, offline_access).
  • Permissions in Salesforce for the account used by Fusion must have the following:
    • Read access for the objects and fields being crawled, including the read-only SystemModstamp field for incremental crawls.
  • For security trimming, the account must be able to access sharing rules and ACL data.

​
Authentication

Setting up the correct authentication according to your organization’s data governance policies helps keep sensitive data secure while allowing authorized indexing. Here are the recommended authentication steps for using the Salesforce V1 connector in Lucidworks Fusion.

​
Configure app in Salesforce

Create a Connected App in Salesforce:
  1. Navigate to Setup > App Manager > New Connected App and enter a Connected App Name, API Name, and Contact Email.
  2. Under API (Enable OAuth Settings), enable Enable OAuth Settings.
  3. Set the callback URL to any valid URL such as \https://localhost/callback as Fusion does not use it directly for this flow.
  4. Select the required OAuth scopes:
    1. Access and manage your data (api).
    2. Perform requests on your behalf at any time (refresh_token, offline_access).
  5. Save the app and wait until it is created.
  6. Once the app is available, copy the Consumer Key and Consumer Secret to use in Fusion.

​
Enter credentials in Fusion

In Fusion, enter the credentials you gathered, then save and test the datasource. If authenticated successfully, the connector will be able to fetch and index Salesforce records and list the Salesforce objects in Fusion.

​
Security Trimming

When you enable security trimming for a Salesforce V1 connector, the system uses the Fusion username and tries finding the identical ID in Salesforce. If it finds this ID, then it uses the permissions given to that ID in Salesforce and applies a filter to the search query. If the ID is not found then it applies a filter to block all documents from being shown. The security trimming feature assumes that the Fusion username is the same as Salesforce alias. When retrieving data from Salesforce, the connector retrieves the user Id based on the Fusion username (Salesforce alias) via the query: 
     Select Id from User WHERE alias={username}
If it is not found, then the connector will create a security filter to deny access to all documents. If you are logged into the Fusion UI or send a request to the REST API with username “admin”, the Salesforce V1 connector uses that as the value of property “salesforce_username”. Therefore, in Fusion, you must have accounts which reflect the Salesforce accounts.

​
Configuration

When entering configuration values in the UI, use unescaped characters, such as \t for the tab character. When entering configuration values in the API, use escaped characters, such as \\t for the tab character.