Salesforce connector

The Salesforce Connector enables Artemis to index Salesforce content and make it searchable. The connector authenticates using OAuth 2.0 Authorization Code (User Delegated) and indexes content accessible to the authorized Salesforce user. The connector supports indexing multiple Salesforce standard and custom objects, configurable content filters, scheduled synchronization, and permission-aware access control.

Specification	Details
Repository Type	Cloud
Authentication	OAuth 2.0 Authorization Code (User Delegated), OAuth 2.0 Client Credentials
Supported Content	Knowledge Articles, Cases, Accounts, Contacts, Leads, Opportunities, Tasks, Salesforce Files, Attachments, Comments, Custom Objects
Content Filtering	Yes
Permission-aware ACL	Yes
Scheduled Synchronization	Supported (off by default)

Prerequisites

Administrator access to the Salesforce application.
A Salesforce Connected App to enable Artemis and Salesforce integration.

Step 1. Create an External Client App in Salesforce

In Salesforce, go to Setup, enter App Manager in the Quick Find box, then select App Manager.
Click New External Client App.
Enter an app name and provide the basic details.
Enable OAuth Settings.
Under App Settings, provide the Callback URL. Copy the Callback URL from the auth profile creation widget in Artemis.
Select the following OAuth Scopes:
1. Full access (full)
2. Perform requests at any time (refresh_token, offline_access)
3. Manage user data via APIs (api)
Click Create. This generates a consumer key and secret.
Copy these and provide them in the auth profile in Artemis.

Step 2. Create the OAuth Profile in Artemis

Open the Salesforce connector.
Click New Salesforce OAuth Profile under Salesforce OAuth Profile.
Enter:
- Name and description of the profile.
- Client ID (Consumer Key)
- Client Secret (Consumer Secret)
Create the profile and use it for authorization of the Salesforce Connector.
After authorization, Artemis can automatically discover the domain and the organization ID.

Step 3. Configure the Content Scope

Select the Salesforce objects to include in the indexing scope. Depending on the selected object type, additional configuration options are available.

Object-specific Configuration

Object Type	Additional Configuration
Knowledge Articles	Configure the Knowledge Languages to index by specifying one or more Salesforce Knowledge locale codes (for example, `en_US`, `fr_FR`, `de_DE`). Optionally specify Additional Body Fields as a comma-separated list of Salesforce field API names (for example, `Details__c`, `Resolution__c`) whose contents should be appended to the indexed article body. Specify Filter Fields as a comma-separated list of Knowledge Article field API names (for example, `Country_Code__c`, `Product__c`) to publish as filterable metadata in Artemis.
Comments	Select whether to index Case Comments, Chatter Feed Posts, or both.
Attachments / Salesforce Files	Select an Attachment Format Policy to control which file formats are indexed.
Cases, Accounts, Contacts, Leads, Opportunities, Tasks	No additional configuration is required. You can filter these objects using the options described in Configure Filters.
Custom Objects	Add each custom object explicitly, then configure its fields, optional detail endpoint, and filters. See Configure custom objects.

To find a field’s API name in Salesforce, navigate to Setup → Object Manager → Object → Fields & Relationships, then select the field. The API Name is displayed in the field details.

Configure custom objects

Use this option to index Salesforce custom objects (sObjects) that aren’t in the standard object list. You add each custom object explicitly and choose which fields to index.

Field	Description
Object API name	The exact API name of the custom sObject, for example `My_Custom_Object__c`. Custom object and field API names end in `__c`. To find an object’s API name, go to Setup → Object Manager in Salesforce.
Display name (optional)	Display name
Title field (optional)	Title
Fields (optional)	Comma-separated Salesforce field API names to include, for example `Name, Description__c, Status__c`.
Body fields (optional)	Comma-separated field API names composed, in order, into the document body, for example `Description, Resolution__c`.
Filter fields (optional)	Comma-separated field API names published as filterable metadata instead of document text, for example `Country_Code__c, Product__c`. The values never appear in the document body.
Endpoint path (optional)	A per-record Salesforce REST API endpoint that returns additional content, such as a large text field. The path must start with `/services/` and contain `{id}`, which is replaced with each record’s ID. Example: `/services/data/v67.0/sobjects/My_Custom_Object__c/{id}`. This is the sObject Rows resource. The version in the path is the Salesforce REST API version, so use one your org supports.
Content path (optional)	The field in the endpoint’s response to use as the document body, for example `Body__c`.
Parameter filters (optional)	Field and value pairs compiled into the object’s SOQL `WHERE` clause, so only matching records are indexed. Click Add filter to add a pair. The field must be readable by the authorized Salesforce user and can’t be a long text area, encrypted, or base64-encoded field. Use single quotes around values that need quotes (double quotes cause an error), and no quotes for numbers or dates. See SOQL WHERE.

Step 4. Configure Filters

Each selected object has its own settings under Object configuration. Expand an object to configure it. Settings apply only to that object, and an object shows only the settings it supports. For each object, you can configure:

Setting	Description
Body Fields	Comma-separated Salesforce field API names composed, in order, into the document body. Leave empty to publish the whole record.
Filter Fields	Comma-separated field API names published as filterable metadata instead of document text. Use this for short attributes you filter on.
Modified After / Modified Before	Indexes only records modified within this date range.
Parameter Filters	Field and value pairs that translate into the object’s SOQL `WHERE` clause, so only matching records are indexed.

This enables different filtering criteria for each object type.

For custom objects, set body fields and filter fields in the custom object configuration (Step 3). Here you set only the modified-date range and parameter filters.

Step 5. Configure Permissions

Enable Permission-aware ACL to synchronize Salesforce permissions. When enabled, Artemis imports native Salesforce access controls, including:

Sharing Rules
Record Visibility
User Roles
Permission Sets

Search results are filtered so users only see content they are authorized to access in Salesforce.

Step 6. Configure the Synchronization Schedule

Specify the reconciliation interval. Artemis periodically synchronizes the selected Salesforce content to keep the index up to date.

Step 7. Preview and Start Indexing

Before indexing begins:

Click Generate Proposal Preview.
Review the selected objects, filters, indexing scope, permission configuration and the field mapping.
Click Approve & Start.

Get started

Build

Optimize

Deploy

Analyze

References

Prerequisites

Step 1. Create an External Client App in Salesforce

Step 2. Create the OAuth Profile in Artemis

Step 3. Configure the Content Scope

Object-specific Configuration

Configure custom objects

Step 4. Configure Filters

Step 5. Configure Permissions

Step 6. Configure the Synchronization Schedule

Step 7. Preview and Start Indexing