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

acl_collection

ACL collection ID

Specify a Solr collection ID here for use with security trimming. Please make sure this collection exists in the cluster You can create this collection using the Collection manager.

type: string

pattern: ^[A-Za-z0-9_\-]+$

acl_commit_after

ACL commit after (ms)

If you are using the acl collection indexing, this will set the frequency of SOLR commits to the acl collection.

type: integer

default value: '60000'

exclusiveMinimum: false

minimum: -1

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

reservedFieldsMappingAllowed

Allow System Fields Mapping?

type: boolean

default value: 'false'

retentionMappings

Field Retention

Define here which fields should be kept or deleted

type: array of object

object attributes: {
  field (required) : {
    display name: Field
    type: string
    description : The name of the field to operate on.
    }
  operation : {
    display name: Operation
    type: string
    default value: 'keep'
    description : The type of operation to perform: keep (default) or delete
    enum: { keep delete     }

}
}

translationMappings

Field Translations

Define here fields that should be moved or copied to another field. When a field is moved, the values from the source field are moved over to the target field and the source field is removed. When a field is copied, the values from the source field are copied over to the target field and the source field is retained.

type: array of object

object attributes: {
  operation : {
    display name: Operation
    type: string
    default value: 'copy'
    description : The type of operation to perform: copy (default) or move.
    enum: { copy move     }

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

unmappedRule

Unmapped Fields

Define here how fields not mapped by the above rules should be handled. By default, any remaining fields will be kept on the document.

type: object

object attributes: {
  delete : {
    display name: Delete
    type: boolean
    default value: 'false'
    description : Delete all unmapped fields
    }
  fieldToCopyValuesTo : {
    display name: Copy
    type: string
    description : Copy all unmapped field values to this field
    }
  fieldToMoveValuesTo : {
    display name: Move
    type: string
    description : Move all unmapped field values to this field
    }
  keep : {
    display name: Keep
    type: boolean
    default value: 'true'
    description : Keep all unmapped fields
    }
  valueToAddToUnmappedFields : {
    display name: Add
    type: string
    description : Add this value to all unmapped fields
    }
  valueToSetOnUnmappedFields : {
    display name: Set
    type: string
    description : Set this value on all unmapped fields
    }
  }

updateMappings

Field Value Updates

Define here values that should be added to or set on a field. When a value is added, any values previously on the field will be retained. When a value is set, any values previously on the field will be overridden.

type: array of object

object attributes: {
  field (required) : {
    display name: Field
    type: string
    description : The name of the field to operate on.
    }
  operation : {
    display name: Operation
    type: string
    default value: 'add'
    description : The type of operation to perform: add (default) or set.
    enum: { add set     }

    }
  value (required) : {
    display name: Value
    type: string
    description : The value to add to or set on the field.
    }
  }

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.