General
Supported version
...
A connection to Salesforce is established based on the username, password, User Security Token, Consumer Key and the Consumer Secret provided in the Admin Wizard. The Salesforce API is used for all communication with the application.
Content types
The connector can index following content types.
- Users
- Accounts
- Contacts
- Opportunities
- Leads
- Attachments
...
The salesforce security token is given for each user and can be reset and sent by email from Salesforce. This user token is needed together with the username and password to get access to the API and use the connector. It is possible to omit the token and only use the username and password to login. This is done by adding the IP in use under IP Login IP Ranges in Salesforce. The ranges are given for each profile group (for example System Administrator etc). Each user having the current profile can then login without the security token. Still a random text string must be filled in the field salesforcetoken in the window, to be able to authenticate the user, but this text is ignored.
...
After installing the connector using the MSI package the Salesforce Fetch Service can be started. When the fetch service is running please open the ViaWorks Management Console to set up an connection.
ViaWorks Admin Wizard
When installing the connector the following values in the Admin Wizard below needs to filled in.
Under Salesforce Entities to index, it is possible to restrict indexing to certain object types.
There could be quite strict API restriction for organizations. The maximum number of calls to the API is calculated for a 24 hours period. Information about the current API usage is found in the response header and checked in the program. Two different stop limits are set in the wizard and used by the connector. Both limits are in percentage of the maximum numbers of API calls. The first one is a limit for when to start a full crawl. In the example above this limit is set to 20%. The other limit is when to stop making any API call from the connector. This restriction also includes Salesfoece login in Viaworks. Here this limit is set to 80%. This second limit is also stored in the database to be used within the Security Authentication plugin.
The Consumer Key and the Consumer Secret must be included in the second page of the Admin Wizard. As mentioned under Authentication the User Security Token must be included unless the IP that is used is added to the "Login IP Ranges" in Salesforce (for the profile of the index user).
The values Consumer Key and Consumer Secret are used with the Source Credentials entered in Viaworks (browser login at search time - see Authentication) to authenticate the user. FullStopAPILimit is the same as the second limit from the general settings (stop all API calls). Not even authenticating the user is possible if the organizations API usage exceeds this limit (here set to 80%).
The 3 values used by the Security Authentication plugin are stored in database table search.auth_realm_setting.
Custom Templates
Custom templates are not in use.
Security
A user can be granted access to an item in several ways. Not all possible ways are currently included in the connector. The possible security overrides depends on the Salesforce edition.
...
As mentioned above a Connected App must be registered in the Salesforce application to generate a Consumer Key and a Consumer for connecting to the Salesforce API. A Connected App can be created under Setup → Create → Apps as shown below.
Salesforce API
Salesforce objects and the API can be tested in the developer console in the application or in the workbench: https://workbench.developerforce.com/login.php
API Documentation: https://developer.salesforce.com/docs/atlas.en-us.192.0.api.meta/api/sforce_api_quickstart_intro.htm
...