> ## Documentation Index
> Fetch the complete documentation index at: https://koreai.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# 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)                                                                                       |
| **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** | Yes                                                                                                                                 |

## 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

1. In Salesforce, go to **Setup**, enter **App Manager** in the **Quick Find** box, then select **App Manager**.
2. Click **New External Client App**.
3. Enter an app name and provide the basic details.
4. Enable **OAuth Settings**.
5. Under **App Settings**, provide the **Callback URL**. Copy the Callback URL from the auth profile creation widget in Artemis.
6. 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`)
7. Click **Create**. This generates a consumer key and secret.
8. Copy these and provide them in the auth profile in Artemis.

## Step 2. Create the OAuth Profile in Artemis

1. Open the Salesforce connector.
2. Click **New Salesforce OAuth Profile** under **Salesforce OAuth Profile**.
3. Enter:
   * Name and description of the profile.
   * Client ID (Consumer Key)
   * Client Secret (Consumer Secret)
4. Create the profile and use it for authorization of the Salesforce Connector.
5. 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**.                                                                                                                                                                                                                                                                                                                                                                                                                                  |

> **Note:** 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.

## Step 4. Configure Filters

Each selected object type supports independent filtering.

For each object, configure:

* Modified After
* Modified Before
* Parameter Filters

Parameter filters translate into Salesforce SOQL `WHERE` clauses, so only matching records are indexed.

This enables different filtering criteria for each object type.

## 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:

1. Click **Generate Proposal Preview**.
2. Review the selected objects, filters, indexing scope, and the permission configuration.
3. Click **Approve & Start**.