Review how There are two ways to configure the Salesforce Connector.
On this page:
Step 1. Launch Aspire and open the Content Source Management Page
Launch Aspire (if it's not already running). See:
- Launch Control
- Browse to: http://localhost:50505. For details on using the Aspire Content Source Management page, please refer to Admin UI
Step 2. Add a new Salesforce Content Source
Image Removed
To specify exactly what shared folder to crawl, we will need to create a new "Content Source".
To create a new content source:
- From the Content Source , click on "Add Source" button.
- Click on "Salesforce Connector".
Image Removed
Step 2a. Specify Basic Information
In the "General" tab in the Content Source Configuration window, specify basic information for the content source:
- Enter a content source name in the "Name" field.
- This is any useful name which you decide is a good name for the source. It will be displayed in the content source page, in error messages, etc.
- Click on the Scheduled pulldown list and select one of the following: Manually, Periodically, Daily, Weekly or Advanced.
- Aspire can automatically schedule content sources to be crawled on a set schedule, such as once a day, several times a week, or periodically (every N minutes or hours).For the purposes of this tutorial, you may want to select Manually and then set up a regular crawling schedule later.
- Click on the Action pulldown list to select one of the following: Start, Stop, Pause, or Resume.
- This is the action that will be performed for that specific schedule.
- Click on the Crawl pulldown list and select one of the following: Incremental, Full, Real Time, or Cache Groups.
- This will be the type of crawl to execute for that specific schedule.
After selecting a Scheduled, specify the details, if applicable:
- Manually: No additional options.
- Periodically: Specify the "Run every:" options by entering the number of "hours" and "minutes."
- Daily: Specify the "Start time:" by clicking on the hours and minutes drop-down lists and selecting options.
- Weekly: Specify the "Start time:" by clicking on the hours and minutes drop-down lists and selecting options, then clicking on the day checkboxes to specify days of the week to run the crawl.
- Advanced: Enter a custom CRON Expression (e.g. 0 0 0 ? * *)
Info |
---|
You can add more schedules by clicking in the Add New option, and rearrange the order of the schedules. |
Info |
---|
If you want to disable the content source just unselect the the "Enable" checkbox. This is useful if the folder will be under maintenance and no crawls are wanted during that period of time. |
Note |
---|
Real Time and Cache Groups crawl will be available depending of the connector. |
Step 2b. Specify the Connector Information
In the "Connector" tab, specify the connection information to crawl Salesforce.
- Enter the Salesforce URL you want to crawl.
- Enter the Salesforce accounts information (username and password). The connector will switch between accounts based on the SOAP API limits
- Enter the security token.
- Check on the other options as needed:
- Enable TLS: Salesforce encryption protocol.
- Page Size: elements to retreive per request
- Connection Timeout and Connection retries.
- Index Specific Types: to specify which type of item to crawl (all types selected by default).
- Fetch Knowledge Articles: You need to enable the Knowledge Base functionality in your SalesForce Server.
- Select the KA type from Draft, Published or Archived
- if you want the standard fields select "Generic", this one will get only the standard field of every article
- if you want the custom fields select "Specific"
- Add the names of the articles types and change the sQueries files to add the query with the custom fields for the new type. (please view sQueries File).
- Crawl Chatter Feeds: to crawl the chatter feeds for each user (only if the user is selected as specific type)
- Specify the Consumer Key
- Specify the Consumer Secret.
- Specify the Chatter Page Size.
- Check Standard user options to filter non-standard user from the crawl.
- Salesforce Queries File: location of queries file (please check sQueries File).
- API Version: version of Salesforce server.
- Fetch Attachments: Fetch all available attachments (You need to select a Salesforce Type).
- Use Own SOAP Login Endpoint: Use to authenticate with a different SOAP login.
- Use Own REST Login Endpoint: Use to authenticate with a different SOAP login.
- External Classpath: to load your own enterprise jar in order to crawl custom objects and fields (please check Enterprise Jar).
- Enter regex patterns to include or exclude items.
Step 2c. Specify Workflow Information
In the "Workflow" tab, specify the workflow steps for the jobs that come out of the crawl. Drag and drop rules to determine which steps should an item follow after being crawled. This rules could be where to publish the document or transformations needed on the data before sending it to a search engine. See Workflow for more information.
- For the purpose of this tutorial, drag and drop the Publish To File rule found under the Publishers tab to the onPublish Workflow tree.
- Specify a Name and Description for the Publisher.
- Click Add.
After completing this steps click on the Save then Done and you'll be sent back to the Home Page.
Step 3: Initiate a Full Crawl
Now that the content source is set up, the crawl can be initiated.
- Click on the crawl type option to set it as "Full" (is set as "Incremental" by default and the first time it'll work like a full crawl. After the first crawl, set it to "Incremental" to crawl for any changes done in the repository).
- Click on the Start button.
During the Crawl
During the crawl, you can do the following:
- Click on the "Refresh" button on the Content Sources page to view the latest status of the crawl.
The status will show RUNNING while the crawl is going, and CRAWLED when it is finished.
- Click on "Complete" to view the number of documents crawled so far, the number of documents submitted, and the number of documents with errors.
If there are errors, you will get a clickable "Error" flag that will take you to a detailed error message page.
Step 4: Initiate an Incremental Crawl
If you only want to process content updates from the Salesforce (documents which are added, modified, or removed), then click on the "Incremental" button instead of the "Full" button. The Salesforce connector will automatically identify only changes which have occurred since the last crawl.
If this is the first time that the connector has crawled, the action of the "Incremental" button depends on the exact method of change discovery. It may perform the same action as a "Full" crawl crawling everything, or it may not crawl anything. Thereafter, the Incremental button will only crawl updates.
Statistics are reset for every crawl.
Group Expansion
Group expansion configuration is done on the "Advanced Connector Properties" of the Connector tab.
...
:
Configure the Salesforce Connector using the Aspire Rest API.
Configure the Salesforce Connector using the Aspire Admin UI.
...