Product Selector

Fusion 5.11
    Fusion 5.11

    Salesforce V1 Connector Configuration Reference

    Table of Contents

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

    This service has an authentication procedure and API usage limits.

    You need to have the Consumer Key and Consumer Secret of the Salesforce Connected App, which must be created by a Salesforce administrator for the account. Instructions on how to do this follow the datasource configuration details.

    Security Trimming

    When you enable security trimming for a Salesforce connector, the system uses the Fusion username and tries finding the identical ID in Salesforce. If it finds this ID, then it uses the permissions given to that ID in Salesforce and applies a filter to the search query. If the ID is not found then it applies a filter to block all documents from being shown.

    The security trimming feature assumes that the Fusion username is the same as Salesforce alias. When retrieving data from Salesforce, the connector retrieves the user Id based on the Fusion username (Salesforce alias) via the query:

         Select Id from User WHERE alias={username}

    If it is not found, then the connector will create a security filter to deny access to all documents.

    If you are logged into the Fusion UI or send a request to the REST API with username "admin", the Salesforce connector uses that as the value of property "salesforce_username". Therefore, in Fusion, you must have accounts which reflect the Salesforce accounts.

    Configuration

    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.

    Connects to a Salesforce web service. This connector requires that you have a Developer Edition organization and have enabled the Salesforce REST API.

    id - stringrequired

    Unique name for this datasource.

    >= 1 characters

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

    pipeline - stringrequired

    Name of an existing index pipeline for processing documents.

    >= 1 characters

    description - string

    Optional description for this datasource.

    properties - Properties

    Datasource configuration properties

    db - Connector DB

    Type and properties for a ConnectorDB implementation to use with this datasource.

    type - string

    Fully qualified class name of ConnectorDb implementation.

    >= 1 characters

    Default: com.lucidworks.connectors.db.impl.MapDbConnectorDb

    inlinks - boolean

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

    Default: false

    aliases - boolean

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

    Default: false

    inv_aliases - boolean

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

    Default: false

    salesforce_username - string

    >= 1 characters

    salesforce_password - string

    >= 1 characters

    connected_app_client_id - string

    Salesforce connected app Consumer Key

    >= 1 characters

    connected_app_client_secret - string

    Salesforce connected app Consumer Secret

    >= 1 characters

    enable_security_trimming - boolean

    Security trimming restricts query results to records the user is allowed to access by indexing user access information with other document metadata. Enable this option to index user access metadata.

    Default: false

    is_production_environment - boolean

    Set to true for production instances and false for sandboxes.

    Default: true

    objects_to_crawl - array[string]

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

    Default: "Case""CaseComment""CaseHistory""CaseFeed""FeedComment""Asset""Account""Contact""Opportunity""Product2"

    soql_query - string

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

    <= 15000 characters

    acl_collection - string

    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.

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

    acl_commit_after - integer

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

    >= -1

    exclusiveMinimum: false

    Default: 60000

    diagnostic_mode - boolean

    Default: false

    initial_mapping - Initial field mapping

    Provides mapping of fields before documents are sent to an index pipeline.

    skip - boolean

    Set to true to skip this stage.

    Default: false

    label - string

    A unique label for this stage.

    <= 255 characters

    condition - string

    Define a conditional script that must result in true or false. This can be used to determine if the stage should process or not.

    reservedFieldsMappingAllowed - boolean

    Default: false

    retentionMappings - array[object]

    Fields that should be kept or deleted

    object attributes:{field required : {
     display name: Field
     type: string
    }
    operation : {
     display name: Operation
     type: string
    }
    }

    updateMappings - array[object]

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

    object attributes:{field required : {
     display name: Field
     type: string
    }
    value required : {
     display name: Value
     type: string
    }
    operation : {
     display name: Operation
     type: string
    }
    }

    translationMappings - array[object]

    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.

    object attributes:{source required : {
     display name: Source Field
     type: string
    }
    target required : {
     display name: Target Field
     type: string
    }
    operation : {
     display name: Operation
     type: string
    }
    }

    unmappedRule - Unmapped Fields

    Fields not mapped by the above rules. By default, any remaining fields will be kept on the document.

    keep - boolean

    Keep all unmapped fields

    Default: true

    delete - boolean

    Delete all unmapped fields

    Default: false

    fieldToMoveValuesTo - string

    Move all unmapped field values to this field

    fieldToCopyValuesTo - string

    Copy all unmapped field values to this field

    valueToAddToUnmappedFields - string

    Add this value to all unmapped fields

    valueToSetOnUnmappedFields - string

    Set this value on all unmapped fields