Home
Home
German Version
Support
Impressum
25.2 Release ►

Start Chat with Collection

    Main Navigation

    • Preparation
      • Connectors
      • Create an InSpire VM on Hyper-V
      • Initial Startup for G7 appliances
      • Setup InSpire G7 primary and Standby Appliances
    • Datasources
      • Configuration - Atlassian Confluence Connector
      • Configuration - Best Bets Connector
      • Configuration - Box Connector
      • Configuration - COYO Connector
      • Configuration - Data Integration Connector
      • Configuration - Documentum Connector
      • Configuration - Dropbox Connector
      • Configuration - Egnyte Connector
      • Configuration - GitHub Connector
      • Configuration - Google Drive Connector
      • Configuration - GSA Adapter Service
      • Configuration - HL7 Connector
      • Configuration - IBM Connections Connector
      • Configuration - IBM Lotus Connector
      • Configuration - Jira Connector
      • Configuration - JVM Launcher Service
      • Configuration - LDAP Connector
      • Configuration - Microsoft Azure Principal Resolution Service
      • Configuration - Microsoft Dynamics CRM Connector
      • Configuration - Microsoft Exchange Connector
      • Configuration - Microsoft File Connector (Legacy)
      • Configuration - Microsoft File Connector
      • Configuration - Microsoft Graph Connector
      • Configuration - Microsoft Loop Connector
      • Configuration - Microsoft Project Connector
      • Configuration - Microsoft SharePoint Connector
      • Configuration - Microsoft SharePoint Online Connector
      • Configuration - Microsoft Stream Connector
      • Configuration - Microsoft Teams Connector
      • Configuration - Salesforce Connector
      • Configuration - SCIM Principal Resolution Service
      • Configuration - SemanticWeb Connector
      • Configuration - ServiceNow Connector
      • Configuration - Web Connector
      • Configuration - Yammer Connector
      • Data Integration Guide with SQL Database by Example
      • Indexing user-specific properties (Documentum)
      • Installation & Configuration - Atlassian Confluence Sitemap Generator Add-On
      • Installation & Configuration - Caching Principal Resolution Service
      • Installation & Configuration - Mindbreeze InSpire Insight Apps in Microsoft SharePoint On-Prem
      • Mindbreeze InSpire Insight Apps in Microsoft SharePoint Online
      • Mindbreeze Web Parts for Microsoft SharePoint
      • User Defined Properties (SharePoint 2013 Connector)
      • Whitepaper - Mindbreeze InSpire Insight Apps in Salesforce
      • Whitepaper - Web Connector - Setting Up Advanced Javascript Usecases
    • Configuration
      • CAS_Authentication
      • Configuration - Alerts
      • Configuration - Alternative Search Suggestions and Automatic Search Expansion
      • Configuration - Back-End Credentials
      • Configuration - Chinese Tokenization Plugin (Jieba)
      • Configuration - CJK Tokenizer Plugin
      • Configuration - Collected Results
      • Configuration - CSV Metadata Mapping Item Transformation Service
      • Configuration - Entity Recognition
      • Configuration - Exporting Results
      • Configuration - External Query Service
      • Configuration - Filter Plugins
      • Configuration - GSA Late Binding Authentication
      • Configuration - Identity Conversion Service - Replacement Conversion
      • Configuration - InceptionImageFilter
      • Configuration - Index-Servlets
      • Configuration - InSpire AI Chat and Insight Services for Retrieval Augmented Generation
      • Configuration - Item Property Generator
      • Configuration - Japanese Language Tokenizer
      • Configuration - Kerberos Authentication
      • Configuration - Management Center Menu
      • Configuration - Metadata Enrichment
      • Configuration - Metadata Reference Builder Plugin
      • Configuration - Mindbreeze Proxy Environment (Remote Connector)
      • Configuration - Personalized Relevance
      • Configuration - Plugin Installation
      • Configuration - Principal Validation Plugin
      • Configuration - Profile
      • Configuration - Reporting Query Logs
      • Configuration - Reporting Query Performance Tests
      • Configuration - Request Header Session Authentication
      • Configuration - Shared Configuration (Windows)
      • Configuration - Vocabularies for Synonyms and Suggest
      • Configuration of Thumbnail Images
      • Cookie-Authentication
      • Documentation - Mindbreeze InSpire
      • I18n Item Transformation
      • Installation & Configuration - Outlook Add-In
      • Installation - GSA Base Configuration Package
      • JWT Authentication
      • Language detection - LanguageDetector Plugin
      • Mindbreeze Personalization
      • Mindbreeze Property Expression Language
      • Mindbreeze Query Expression Transformation
      • SAML-based Authentication
      • Trusted Peer Authentication for Mindbreeze InSpire
      • Using the InSpire Snapshot for Development in a CI_CD Scenario
      • Whitepaper - AI Chat
      • Whitepaper - Create a Google Compute Cloud Virtual Machine InSpire Appliance
      • Whitepaper - Create a Microsoft Azure Virtual Machine InSpire Appliance
      • Whitepaper - Create AWS 10M InSpire Appliance
      • Whitepaper - Create AWS 1M InSpire Appliance
      • Whitepaper - Create AWS 2M InSpire Appliance
      • Whitepaper - Create Oracle Cloud 10M InSpire Application
      • Whitepaper - Create Oracle Cloud 1M InSpire Application
      • Whitepaper - MMC_ Services
      • Whitepaper - Natural Language Question Answering (NLQA)
      • Whitepaper - SSO with Microsoft AAD or AD FS
      • Whitepaper - Text Classification Insight Services
    • Operations
      • Adjusting the InSpire Host OpenSSH Settings - Set LoginGraceTime to 0 (Mitigation for CVE-2024-6387)
      • app.telemetry Statistics Regarding Search Queries
      • CIS Level 2 Hardening - Setting SELinux to Enforcing mode
      • Configuration - app.telemetry dashboards for usage analysis
      • Configuration - Usage Analysis
      • Deletion of Hard Disks
      • Handbook - Backup & Restore
      • Handbook - Command Line Tools
      • Handbook - Distributed Operation (G7)
      • Handbook - Filemanager
      • Handbook - Indexing and Search Logs
      • Handbook - Updates and Downgrades
      • Index Operating Concepts
      • Inspire Diagnostics and Resource Monitoring
      • Provision of app.telemetry Information on G7 Appliances via SNMPv3
      • Restoring to As-Delivered Condition
      • Whitepaper - Administration of Insight Services for Retrieval Augmented Generation
    • User Manual
      • Browser Extension
      • Cheat Sheet
      • iOS App
      • Keyboard Operation
    • SDK
      • api.chat.v1beta.generate Interface Description
      • api.v2.alertstrigger Interface Description
      • api.v2.export Interface Description
      • api.v2.personalization Interface Description
      • api.v2.search Interface Description
      • api.v2.suggest Interface Description
      • api.v3.admin.SnapshotService Interface Description
      • Debugging (Eclipse)
      • Developing an API V2 search request response transformer
      • Developing Item Transformation and Post Filter Plugins with the Mindbreeze SDK
      • Development of a Query Expression Transformer
      • Development of Insight Apps
      • Embedding the Insight App Designer
      • Java API Interface Description
      • OpenAPI Interface Description
    • Release Notes
      • Release Notes 20.1 Release - Mindbreeze InSpire
      • Release Notes 20.2 Release - Mindbreeze InSpire
      • Release Notes 20.3 Release - Mindbreeze InSpire
      • Release Notes 20.4 Release - Mindbreeze InSpire
      • Release Notes 20.5 Release - Mindbreeze InSpire
      • Release Notes 21.1 Release - Mindbreeze InSpire
      • Release Notes 21.2 Release - Mindbreeze InSpire
      • Release Notes 21.3 Release - Mindbreeze InSpire
      • Release Notes 22.1 Release - Mindbreeze InSpire
      • Release Notes 22.2 Release - Mindbreeze InSpire
      • Release Notes 22.3 Release - Mindbreeze InSpire
      • Release Notes 23.1 Release - Mindbreeze InSpire
      • Release Notes 23.2 Release - Mindbreeze InSpire
      • Release Notes 23.3 Release - Mindbreeze InSpire
      • Release Notes 23.4 Release - Mindbreeze InSpire
      • Release Notes 23.5 Release - Mindbreeze InSpire
      • Release Notes 23.6 Release - Mindbreeze InSpire
      • Release Notes 23.7 Release - Mindbreeze InSpire
      • Release Notes 24.1 Release - Mindbreeze InSpire
      • Release Notes 24.2 Release - Mindbreeze InSpire
      • Release Notes 24.3 Release - Mindbreeze InSpire
      • Release Notes 24.4 Release - Mindbreeze InSpire
      • Release Notes 24.5 Release - Mindbreeze InSpire
      • Release Notes 24.6 Release - Mindbreeze InSpire
      • Release Notes 24.7 Release - Mindbreeze InSpire
      • Release Notes 24.8 Release - Mindbreeze InSpire
      • Release Notes 25.1 Release - Mindbreeze InSpire
      • Release Notes 25.2 Release - Mindbreeze InSpire
    • Security
      • Known Vulnerablities
    • Product Information
      • Product Information - Mindbreeze InSpire - Standby
      • Product Information - Mindbreeze InSpire
    Home

    Path

    Sure, you can handle it. But should you?
    Let our experts manage the tech maintenance while you focus on your business.
    See Consulting Packages

    Salesforce Connector
    Installation and Configuration

    InstallationPermanent link for this heading

    Using the Salesforce connector, your data from Salesforce can be indexed.

    Plugin installation via Mindbreeze Management CenterPermanent link for this heading

    To install the plug-in, open the Mindbreeze Management Center. Select “Configuration” from the menu pane on the left-hand side. Then navigate to the “Plugins” tab. Under “Plugin Management”, select the appropriate zip file and upload it by clicking “Upload.” This either automatically installs or updates the connector to the selected version. In the process, the Mindbreeze services are restarted.

    Configuration of Salesforce Permanent link for this heading

    To be able to index Salesforce, a crawling user with an associated "Mindbreeze Crawling" profile must be created.

    Creating a Crawling ProfilePermanent link for this heading

    A crawling profile is required to define the objects and data that a user can access, as well as the permissions they have within the application.

    Open “Setup“ – “Administration“ – “Users“ – “Profiles“ and click “New“

    In the next step, create a new profile that is a copy of the existing System Administrator profile.

    When this is complete, edit the profile to have the desired permissions.

    It is recommended to give the profile as many permissions as possible, otherwise there may be issues resolving ACLs or principals in the "Salesforce Principal Resolution Service".

    The permission "View All Data" must be enabled, otherwise the principal resolution will not work properly.

    Creating the Crawling-UserPermanent link for this heading

    After the crawling profile has been successfully created, the crawling user can now be created.

    Open “Setup“– “Administration“ – “Users“ – “Users“ and click “New User“.

    When creating the new user, make sure that the previously created crawling profile is selected. Furthermore, no specific user type (e.g. "Offline User") may be specified.

    Filtering Users Without ProfilePermanent link for this heading

    Users who do not have an assiociated profile (e.g. programmatically created users) pose are problematic because important authorization information cannot be retrieved from the profile.

    This is especially the case if an attempt is made in the Principal Resolution Service to determine the user's authorization for various objects. If this is the case, the following error message will appear in the log:
    No such relation 'Profile' on entity 'User'.

    If this is the case, the Salesforce Developer console can be used to filter for users without a profile and assign them a profile. An administrator user can use this console.

    In the Developer Console, you can use the following command to find all active users and their profiles:
    SELECT Username, ProfileId, Profile.Name FROM User WHERE IsActive=true

    Users who have no profile assigned to them can be identified by the "null profiles" value.

    Configuring MindbreezePermanent link for this heading

    Configuring the IndexPermanent link for this heading

    Click on the “Indices” tab and then on the “Add index” symbol to create a new index.

    Enter the index path. Adapt the Display Name of the Index Service and the related Filter Service if necessary

    Configuring the data sourcePermanent link for this heading

    In the "Data Sources" tab, select the category "Salesforce" and, if necessary, a Caching Principal Resolution Service. With the button "Add Data Source" further instances can be added and configured.

    Connection Settings (Crawler)Permanent link for this heading

    Login Endpoint

    The Salesforce instance which should be indexed.

    Production Instance

    The newest Version of Salesforce which can be used.

    Production V36.0

    An older Version of Salesforce which does not yet support indexing of Chatter Posts.

    Sandbox Instance

    A Sandbox Instance of Salesforce

    Custom Login Endpoint

    A custom Salesforce Instance which should be indexed.

    Custom Endpoint URL

    The URL of the Salesforce Instance which should be indexed.

    TLS Version

    The TLS Version which should be used.

    Auto is recommended.

    Username

    The Username of an User with read-only Permissions.

    Password

    The Password for the Crawling User.
    If the server is not a trusted host, the security token should be provided together with the password in the “Password” Field.

    Authorization Settings (Crawler)Permanent link for this heading

    In order to authorize search results, either a Caching Principal Resolution Service or the Authorization Provider is required. In case of a Caching Principal Resolution Service, the following settings can be skipped. The Authorization Provider in the tab “User Email Resolution” needs to obtain search user principals which are Object Type Permissions in Salesforce associated with that user (identified by email address) in ObjectPermissions. Therefore it is necessary to obtain the search user’s email address first if it is not provided by client service.

    Disable User Email Resolution

    Disables the resolution of the Username using LDAP.

    Username

    The email of the searching user.

    If "Disable User Email Resolution" isn’t selected, the Username can also be specified.

    Domain

    The domain over which the Username should be resolved.

    Password

    The password to register to the domain.

    After authenication in client service if the username is not the email address than it is necessary to resolve email through LDAP. The required credentials can be provided directly in “Username”, “Domain” and “Password” fields. Alternatively its possible that Kerberos is used for authentication. In this case only “Domain” field should be configured. If domain field is also empty than the first configured domain in Network settings will be used.

    In order to obtain the search user’s object type permissions the configured crawler user (see Connection Settings above) should have the “View Setup and Configuration” permissions in Salesforce.

    Sources SettingsPermanent link for this heading

    Per default the connector provide a list of object types “Default Object Types” which will be indexed when the crawler is started. For crawling other object types the query in “SOQL Query” field will be used. This query must contain the key column name, display date column name and title column name.

    E.g. with the following SOQL query the documents of the type Idea are indexed with the Body metadatum.

    SELECT Id, SystemModstamp, Title, Body FROM Idea

    By customizing the descirptors one can select individual properties of the tables.The connector detects the fields by iterating the describeSObject Metadata in the Salesforce API.

    In addition to the preset "Default Object Types", the parameter "FeedItem" can be specified to index the chatter posts. However, this possibility requires a configuration of a "Salesforce Caching Principal Resolution Service".

    All Object types except “Document” and “ContentDocument” that contain a HTML field are crawled with the content of that HTML field as the document content. If there is more than one HTML field, then the field to be used as document content can be configured using “HTML Content Metadata” property, where “Object Type” and “HTML Content Field Name” should be provided. For “Document” objects the content of the “Body” field is crawled as document content. For “ContentDocument” objects the content of corresponding the latest “CurrentVersion” object is crawled as document content.

    Configuring the index for custom objectsPermanent link for this heading

    The configuration of an index for custom objects is explained with the following example.

    SetupPermanent link for this heading

    Two custom objects were created in Salesforce. Those custom objects are:

    • Node (API Name: mindbreeze__Node__c)
    • Task (API Name: mindbreeze__Task__c)

    The custom object “Node” has a lookup field to the objects “Node” (self-reference) and to the second custom object „Task“.

    The structure of the two custom objects is built as displayed in the following diagram:

    Indexing of standard objects and custom sourcesPermanent link for this heading

    To index standard objects, it is not necessary to add “Custom Sources” in the section “Sources” in the “Configuration”. Retrieving all sectors with the parent sector can be done by adding the two custom objects to the setting “Default Object Types”.

    The setting “Custom Sources” can be used to select specific metadata that is to be indexed.

    If a referenced object is to be included, it must be indexed independently. This can be done by adding it to “Default Object Types” or to “Custom Sources”. Depending on how the object was indexed, the query that refers to the object will show all (Default Object Types) or custom (Custom Sources) metadata.

    The referenced object is included with a query like this:

    SELECT Id, Name, mindbreeze__Parent__c, mindbreeze__Task__c

    FROM mindbreeze__Node__c

    It is not possible to refer to specific metadata from the referred object with queries like:

    SELECT Id, Name, mindbreeze__Parent__r.Id, mindbreeze__Parent__r.Name

    FROM mindbreeze__Node__c

    To fetch referenced metadata, add the Synthesized Metadata Definition in the section “Synthesized Metadata”:

    Finally, by indexing with the specified settings, the following documents are the result:

    Configuring the Caching Principal Resolution ServicePermanent link for this heading

    In the new or existing service, select the Salesforce Principal Resolution Service option in the Service setting. For more information about additional configuration options and how to create a cache and how to do the basic configuration of a cache for a Principal Resolution Service, see Installation & Configuration - Caching Principal Resolution Service.

    Connection Settings (Principal Resolution Service)Permanent link for this heading

    The settings for the connection to Salesforce in the Principal Resolution Service are identical to those in the Crawler listed here.

    Authorization SettingsPermanent link for this heading

    If a resolution of the user name is desired, this can be implemented via a "Parent Service".

    For more information about the section Parent Service, see Installation & Configuration - Caching Principal Resolution Service - Parent Cache Settings. For a practical example of a use case for Parent Cache settings, see Installation & Configuration - Caching Principal Resolution Service - Special Use Cases.

    Download PDF

    • Configuration - Salesforce Connector

    Content

    • Installation
    • Configuration of Salesforce
    • Configuring Mindbreeze

    Download PDF

    • Configuration - Salesforce Connector