Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


On this page:

Table of Contents

Step 1. Launch Aspire and open the Content Source Management Page

Launch Aspire (if it's not already running).

See:

  1. Launch Control.
  2. Browse to: http://localhost:50505. For details on using the Aspire Content Source Management page,
please refer to 
  1. see Admin UI.


Step 2. Add a new  Content Source

To specify exactly what which shared folder to crawl, we will need to create a new "Content Source".

To create a new content source:

  1. From the Content Source,
click on "
  1. select Add Source
" button
  1. .
Click on " Connector"
  1. Select Connector.

Step 2a. Specify Basic Information

In the "General" tab in the Content Source Configuration window, specify basic information for the content source:

  1. Enter a content source name in the
"
  1. Name
"
  1. field. 
    1. This is any useful name
which
    1. that you decide is a good name for the source. It will be displayed in the content source page, in error messages, etc.
  1. Click on the Scheduled
pulldown list
  1.  list and select one of the following: Manually, PeriodicallyDaily,
 
  1. Weekly or Advanced.
    1. 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
    1. this tutorial, you may want to
select Manually and
    1. select Manually and then set up a regular crawling schedule later.
  1. Click on the Action
pulldown list
  1.  list to select one of the following: Start, StopPause, or Resume.
    1. This is the action that will be performed for that specific schedule.
  2. Click on the Crawl
pulldown list and
  1.  list and select one of the following: Incremental, FullReal Time, or Cache Groups.
    1. This will be the type of crawl to execute for that specific schedule.

After selecting a ScheduledScheduled, specify the details, if applicable:

  • Manually: No additional options.
  • Periodically: Specify the "Run every:" options option 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, and then clicking on the day checkboxes selecting the check boxes 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 selecting the Add New option, and rearrange rearranging the order of the schedules.
Info
If you want to disable the content source just unselect the , clear the "Enable" checkbox. This is useful if the folder will be under maintenance and no crawls are wanted desired during that period of time.
Note
Real Time and Cache Groups crawl will be available depending of on the connector.
  

Step 2b. Specify the Connector Information

In the "Connector" tab, specify the connection information to crawl the Documentum.

  1. Enter the dctm docbase url you want to crawl (Format: dctm://<docbroker-server>:<docbroker-port>/<docbase>.
  2. Enter the username (aspire_crawl_account).
  3. Enter the user's password.
  4. 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.
  5. Enter the webtop URL. This URL will be suffixed with the object id ID and used as a value of the displayUrl element in the resulting metadata.
  6. Enter a 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 IDs for further processing. 
    You must use exactly these 2 two 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 an option for parallel processing in the scan phase.
  7. Enter DQL SELECT statements for the 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 . 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'):
    1. The incremental crawl DQL SELECT statement is for picking up “adds” and “updates” with the help of the r_modify_time attribute in the main table. Again the The r_object_id , and i_chronicle_id fields are mandatory. Normally this This query should be exactly the same as the query for the full crawl plus the parameter ${crawlTimeStamp}
    2. The Audit ACL updates the DQL SELECT statement is for tracking ACL changes and the . The table for querying is supposed to be is dm_audittrail. The fields r_object_id , and chronicle_id are mandatory. The parameter ${crawlTimeStamp} is expected to  should be used.
    3. The Audit deletes the DQL SELECT statement is for tracking deletes (documents or versions of documents) and the . The table for querying is supposed to be is dm_audittrail. The fields r_object_id , and chronicle_id are mandatory. The parameter ${crawlTimeStamp} is expected to should be used.
    4. The Audit safeguard SELECT statement is for checking that the ids IDs of documents (retrieved by the use of a previous audit DQL selects) exists in document table. Imagine the situation when we need to check not only We can check that the chronicle id ID really exists in the document table but and that it also exists in the requested WHERE set used in the incremental DQL. Otherwise, we could can track all deletes based by on the date but . However, we would not be sure if the particular audit event is for us interesting. For this checking relevant. The i_chronicle_id field is used and of course the WHERE part is similar to that in the incremental DQL. 
      The parameter ${auditChronicleId} will be expanded and the chronicle_id value from the audit table will be used. The field r_object_id is mandatory as , since this query  query also serves as a translator between chronicle_id (used in audit table) and r_object_id (from the document table).
    5. Check Select the Delete audit items check box if you want Aspire to delete the already processed row in the audit table.
  8. Enter the max file size. Any file larger than this size will be ignored by the connector. Unlimited to include  includes all files.
  9. Check on the Select other options as needed
    1. Include/Exclude patterns: Enter regex patterns to include or exclude files based on URL matches - the . The value of the attribute object_name is used as the value for URL.
    2. Non-text document filtering: Here You should only use 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 should follow after being crawled. This rules could be You can use these rules to specify where to publish the document, or which transformations needed on the data before are needed before sending it to a search engine. See Workflow for more information.

  1. For
the purpose of
  1. this tutorial, drag and drop the Publish To File rule found under the Publishers tab to the onPublish Workflow tree.
    1. Specify a 
Name and Description for
    1. Name and Description for the Publisher.
    2. Click Add.
After completing this steps click on the Save then Done and you'll be sent back
  1. Select Save and Done to return 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
  1. Select the Full crawl type option
to set it as "Full" (is set as "Incremental" by default and the
  1. . (The default is Incremental.) The first time it
'll
  1. will work like a full crawl. After the first crawl,
set it to "
  1. select Incremental
"
  1. to crawl for any changes done in the repository
)
  1. .
Click on the
  1. Select Start
button
  1. .

During the Crawl

During the crawl, you can do the following:
Click on the "Refresh" button
  1. Select Refresh 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 "
  1. Select Complete
"
  1. 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
"
  1. Error
" flag
  1. that will take you to a detailed error message page.

Step 4: Initiate an Incremental Crawl


  1. If you
only
  1. want to process only content updates from the Documentum (documents
which
  1. that are added, modified, or removed), then
click on the "Incremental" button
  1. select Incremental instead of
the "
  1. Full
" button
  1. . 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
"
  1. Incremental
" button
  1. option depends on the exact method of change discovery. It may perform the same action as a
"
  1. Full
"
  1. crawl and crawl
crawling
  1. 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
  1. Select the Advanced Configuration
checkbox
  1. check box to enable the advanced properties section.
  2. Scroll
down
  1. to Group Expansion and
click
  1. select the
checkbox
  1. check box.
  2. Add a new source for each repository from which you want to
expands
  1. expand groups from. (
you
  1. You'll need administrator rights on all of them to be able to do this.)
.
  1. Set the default domain, user name, and password of the crawl account.
  2. Set
an
  1. a schedule for group expansion refresh and cleanup.
  2. As an optional setting
click on
  1. select the
"
  1. Use external Group Expansion
" checkbox
  1. check box to select an LDAP Cache component for LDAP group expansion. See more info on the LDAP Cache component
on 
  1. at LDAP Cache.