Skip to main content

​
How it works

The Salesforce connector indexes documents from your Salesforce. These documents organized around the Objects that you indicate. Examples are below.

​
Setting up

​
Authorization

1

Log in to Salesforce

Log into Salesforce. The Salesforce user must be an organization member or have admin access to the data you would like to index.
2

Open Settings

Click the profile avatar and choose Settings.Salesforce user menu showing path to Settings
3

Reset security token

Select My Personal Information → Reset My Security Token.Salesforce settings highlighting Reset My Security Token
4

Check email for token

Check your email for the security token.Email example showing Salesforce security token message
5

Use credentials in Onyx

Once the token has been regenerated, you can use it (as well as your username and password) to authorize your Onyx connector.

​
Indexing

1

Create a new Salesforce Connector

Navigate to the Admin Panel and select the Salesforce Connector Tile.
2

Create a new credential

Click on the Create New button and provide your Username, Password and the Security Token received from the above steps.Select the new credential and click Continue.
3

Define the Salesforce Object(s) you wish to index

Enter the Salesforce Object(s) you wish to index and organize your Onyx documents by.
  • Make sure to use the singular version of object name (e.g. Opportunity instead of Opportunities)
  • If no objects are indicated, it will default to indexing by Account
  • Each Onyx Document extracted from Salesforce contains all fields and associations of each object. For example, when indexing each Account we include the fields of the AccountFeed and AccountShare objects as well (but not the associations of those objects). This can lead to bloated queries and memory intensive indexing in larger salesforce instances.
Use the Advanced mode to have finer grain control over what is indexed.
Specify which objects, fields, and associations get indexed with a json object.Top level keys are Salesforce Objects, each value is a JSON object specifying:
  • fields: a list of strings describing the fields of the object to index
  • associations: a JSON object mapping a Salesforce Object associated with the parent object to a list of fields to be indexed for the child object
Example
{
  "Account": {
    "fields": ["Id", "Name", "Industry", "CreatedDate", "lastModifiedDate"],
    "associations": {
        "Contact": ["Id", "FirstName", "LastName", "Email"],
        "Opportunity": ["Id", "Name", "StageName", "Amount", "CloseDate"]
    }
  },
  "Lead": {
    "fields": ["Id", "FirstName", "LastName", "Company", "Status"],
    "associations": {}
  }
}
4

Click on the **Connect** button.

Click on the Connect button and your connector will be created. Onyx will automatically begin indexing your Salesforce data.

​
An Example

You indicate you’d like to organize information by Account and click connect Onyx Salesforce connector example configuration using Account object Onyx will generate a document for every single Account in your Salesforce. Attached to each document will be all the information associated with that Account. This information would also include information from the Account’s children objects (E.g. all associated Contacts, Notes, etc.). This means indicating Account means that all Contacts that are attached to an account will also be grabbed If you want to index any Contacts that aren’t attached to any Accounts, (as well as Accounts), you would indicate that like so: Onyx Salesforce connector advanced JSON configuration for Account and Contact objects
⌘I