Page History
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 Content Source
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 " Connector".
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.
- 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 the the Documentum.
- Enter the dctm docbase url you want to crawl (Format: dctm://<docbroker-server>:<docbroker-port>/<docbase>.
- Enter the username (aspire_crawl_account).
- Enter the user's password.
- Enter the location of the dfc.properties file. Make sure the dfc.properties file correctly points to the dfc.keystore in the property: dfc.security.keystore.file.
- Enter the webtop URL. This URL will be suffixed with the object id and used to request the object directly from Documentum. I. e. http://<servername>:<port>/webtop/objectId=
- Enter DQL SELECT statement for full crawl. This statement is supposed to query the table with documents - i.e. dm_document and provide the set of ids for further processing. You must use exactly these 2 mandatory fields in SELECT - r_object_id and i_chronicle_id. There is also the parameter {SLICES} to be used as a part of WHERE clause. If used the full crawl select would be internally run as 16 other selects (e.g. <fullSelect> AND r_object_id LIKE '%0' - <fullSelect> AND r_object_id LIKE '%f'). The purpose of this is to provide possibility for parallel processing in scan phase.
- Enter DQL SELECT statements for incremental crawl. In those statements the parameter ${crawlTimeStamp} should be used. This parameter will be expanded by Aspire at the start of crawling and the time of the last crawl will be used to track down the changes - e.g. ${crawlTimeStamp}
-> date('09/22/2016 12:00:00','mm/dd/yyyy hh:mi:ss'):- The incremental crawl DQL SELECT statement is for picking up “adds” and “updates” with the help of r_modify_time attribute in the main table. Again the r_object_id, i_chronicle_id fields are mandatory. Normally this query should be exactly the same as the query for the full crawl plus the parameter ${crawlTimeStamp}
- The Audit ACL updates DQL SELECT statement is for tracking ACL changes and the table for querying is supposed to be dm_audittrail. The fields r_object_id, chronicle_id are mandatory. The parameter ${crawlTimeStamp} is expected to be used.
- The Audit deletes DQL SELECT statement is for tracking deletes (documents or versions of documents) and the table for querying is supposed to be dm_audittrail. The fields r_object_id, chronicle_id are mandatory. The parameter ${crawlTimeStamp} is expected to be used.
- The Audit safeguard SELECT statement is for checking that the ids of documents retrieved by the use of previous audit DQL selects exists in document table. For this checking i_chronicle_id field is used. The parameter ${auditChronicleId} will be expanded and the chronicle_id value from audit table will be used. The field r_object_id is mandatory as this query also serves as a translator between chronicle_id used in audit table and r_bject_id from the document table.
- Check the Delete audit items check box if you want Aspire to delete the already processed row in audit table.
- Enter the max file size. Any file larger than this size will be ignored by the connector. Unlimited to include all files.
- Check on the other options as needed
- Include/Exclude patterns: Enter regex patterns to include or exclude files based on URL matches - the value of the attribute object_name is used as the value for URL.
- Non-text document filtering: Here only the Regex file option for identifying non-text files should be used. The Documentum attribute a_content_type is used as a non text filter field.
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
- 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 (documents which are added, modified, or removed), then click on the "Incremental" button instead of the "Full" button. The 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.
Info |
---|
Statistics are reset for every crawl. |
Group Expansion
Group expansion configuration is done on the "Advanced Connector Properties" of the Connector tab.
- Click on the Advanced Configuration checkbox to enable the advanced properties section.
- Scroll down to Group Expansion and click the checkbox.
- Add a new source for each repository you want to expands groups from (you'll need administrator rights on all of them to be able to do this).
- Set the default domain, user name and password of the crawl account.
- Set an schedule for group expansion refresh and cleanup.
- As an optional setting click on the "Use external Group Expansion" checkbox to select an LDAP Cache component for LDAP group expansion. See more info on the LDAP Cache component on LDAP Cache