Salesforce Connector: Adding a new connection

ViaWorks Admin Wizard

When installing the connector, the following values in the Admin Wizard below needs to filled in.

Under 'Known Salesforce Entities to index', it is possible to do a quick selection for indexing certain object types. The entity types selected here, will have predefined metadata fields and no custom fields are selected. It is possible to add these same known entity types on a wizard page called Entity Settings Page. On this later page it is also possible to select which metadata fields to add - including custom fields.   

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 10%. The other limit is when to stop making any API call from the connector. This restriction also includes Salesforce login in ViaWorks. Here this limit is set to 60%. This second limit is stored and used within the Security Authentication plugin.

On the second page of the Admin Wizard the Consumer Key and the Consumer Secret must be included. The index user need to have Salesforce API access. 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 AD user is used for an AD email look-up, during the user identification. Several AD fields, including UPN, are checked for the authenticated user in ViaWorks - looking for a username in Salesforce.   

On this page the entities to index are chosen. This list also includes custom entities - with the file ending _c. The entity types can be added, edited and deleted. In the Entity Field Selection all possible metadata fields are listed. This list also includes custom fields for not custom entity types. In the dropp down meny the document name is selected. This will be the title of documents for this entity type in the search.  

On this last page the connection settings are listed. The RunGeneralEntity is for entities selected in Entity settings. RunAccount is for the predefined entity types with preselected metadata values.