Salesforce Connector Configuration Reference

Configuration

Salesforce REST API to extract data from a Salesforce repository via a Salesforce Connected App.

Configuration

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

Property Description

collection

Collection

Collection documents will be indexed to.

type: string

pattern: ^[a-zA-Z0-9_-]+$

connected_app_client_id

Salesforce Client Id

required

Salesforce connected app Consumer Key

type: string

minLength: 1

connected_app_client_secret

Salesforce Client secret

required

Salesforce connected app Consumer Secret

type: string

minLength: 1

diagnostic_mode

Diagnostic Mode

type: boolean

default value: 'false'

is_production_environment

Is production environment

Set to true for production instances and false for sandboxes.

type: boolean

default value: 'true'

objects_to_crawl

Objects to crawl

List of objects to crawl, separated by commas and no spaces.

type: array of string

default value: [ Case, CaseComment, CaseHistory, CaseFeed, FeedComment, Asset, Account, Contact, Opportunity, Product2, ]

salesforce_password

Salesforce password

required

type: string

minLength: 1

salesforce_username

Salesforce username

required

type: string

minLength: 1

soql_query

Custom SOQL query

Optional SOQL query to limit or join records fetched for indexing.

type: string

maxLength: 15000

Enable Security Trimming

Property

Description

Field Mapping

Initial Mappings Description

mappings

Field Mappings

List of mapping rules

type: array of object

object attributes: {
  operation : {
    display name: Operation
    type: string
    default value: 'copy'
    description : The type of mapping to perform: move, copy, delete, add, set, or keep.
    enum: { copy move delete set add keep     }

    }
  source (required) : {
    display name: Source Field
    type: string
    description : The name of the field to be mapped.
    }
  target : {
    display name: Target Field
    type: string
    description : The name of the field to be mapped to.
    }
  }

reservedFieldsMappingAllowed

Allow System Fields Mapping?

type: boolean

default value: 'false'

unmapped

Unmapped Fields

If fields do not match any of the field mapping rules, these rules will apply.

type: object

    }
  source : {
    display name: Source Field
    type: string
    description : The name of the field to be mapped.
    }
  target : {
    display name: Target Field
    type: string
    description : The name of the field to be mapped to.
    }
  }

ConnectorDb Configuration

Property Description

aliases

Process Aliases?

Keep track of original URI-s that resolved to the current URI. This negatively impacts performance and size of DB.

type: boolean

default value: 'false'

inlinks

Process Inlinks?

Keep track of incoming links. This negatively impacts performance and size of DB.

type: boolean

default value: 'false'

inv_aliases

Process Inverted Aliases?

Keep track of target URI-s that the current URI resolves to. This negatively impacts performance and size of DB.

type: boolean

default value: 'false'

type

Implementation Class Name

Fully qualified class name of ConnectorDb implementation.

type: string

default value: 'com.lucidworks.connectors.db.impl.MapDbConnectorDb'

minLength: 1

General Configuration

Property

Description

description

Description

Optional description for datasource instance.

Datasource ID

Unique name for datasource instance.

pipeline

Pipeline ID

The index pipeline used to process documents.