Difference between revisions of "Documentum Application Bundle (Aspire 2)"

From wiki.searchtechnologies.com
Jump to: navigation, search

For Information on Aspire 3.1 Click Here

Line 7: Line 7:
|appBundleName=Documentum Connector
|appBundleName=Documentum Connector
|typeFlags=scheduled, group-expansion
|typeFlags=scheduled, group-expansion

Latest revision as of 23:34, 8 December 2015

Documentum Application Bundle (Aspire 2)
AppBundle Name  Documentum Connector
Maven Coordinates  com.searchtechnologies.aspire:app-documentum-connector
Versions  2.2.2
Type Flags  scheduled, group-expansion
Inputs  AspireObject from a content source submitter holding all the information required for a crawl.
Outputs  An AspireObject containing the URL, content, ACLs and Metadata processed for each file.

The Documentum Connector performs full and incremental scans over a Documentum repository--docbase, cabinet or folder--and will extract document level security, metadata, and content from each object scanned. The connector allows you to filter the scanned files using regular expression patterns, to include containers (docbases, cabinets or folders) in the results, and to scan content recursively. Each scanned object will be tagged with one of three possible actions--add, update, or delete--and can be routed to any Aspire pipeline as desired.

The connector, once started, can be stopped, paused or resumed sending a new Scanner Configuration Job. Typically the start job will contain all information required by the job to perform the scan. When pausing or stopping, the connector will wait until all the jobs it published have completed before updating the statistics and status of the connector.


This section lists all configuration parameters available to install the Documenmtum Application Bundle and to execute crawls using the connector.

General Application Configuration

Property Type Default Description
snapshotDir string ${aspire.home}/snapshots The directory for snapshot files to be stored.
disableTextExtract boolean false By default, connectors use Apache Tika to extract text from downloaded documents. If you wish to apply special text processing to the downloaded document in the workflow, you should disable text extraction. The downloaded document is then available as a content stream.
workflowReloadPeriod int 15m The period after which to reload the business rules. Defaults to ms, but can be suffixed with ms, s, m, h or d to indicate the required units.
workflowErrorTolerant boolean false When set, exceptions in workflow rules will only effect the execution of the rule in which the exception occurs. Subsequent rules will be executed and the job will complete the workflow sucessfully. If not set, exceptions in workflow rules will be re-thrown and the job will be moved to the error workflow.
debug Boolean false Controls whether debugging is enabled for the application. Debug messages will be written to the log files.

Documentum Specific Configuration

Property Type Default Description
DCTMMaxSize long unlimited Max number of characters to extract from documents scanned from the Documentum repository. Number of characters or unlimited to extract all content.
DCTMHost string Documentum server host name to configure Group Expansion.
DCTMPort int Documentum server port number to configure Group Expansion.
DCTMDocbase string Documentum docbase repository to connect to for Group Expansion.
DCTMPropsFilePath string Documentum dfc.properties file location to configure Group Expansion.
DCTMUsername string Documentum username to configure Group Expansion.
DCTMPassword string Documentum user's password to configure Group Expansion.
aclsDebugFile string Optional, for Group Expansion. If specified, saves all ACLs downloaded to the given file.

Configuration Example

To install the application bundle, add the configuration, as follows, to the <autoStart> section of the Aspire settings.xml.

  <application config="com.searchtechnologies.aspire:app-documentum-connector">
      <property name="generalConfiguration">true</property>
      <property name="snapshotDir">${dist.data.dir}/${app.name}/snapshots</property>
      <property name="disableTextExtract">false</property>
      <property name="workflowReloadPeriod">15s</property>
      <property name="workflowErrorTolerant">false</property>
      <property name="DCTMHost"></property>
      <property name="DCTMPort">1489</property>
      <property name="DCTMDocbase">DocumentumRepository</property>
      <property name="DCTMPropsFilePath">config/dfc.properties</property>
      <property name="DCTMUsername">Administrator</property>
      <property name="DCTMPassword">pass1234</property>
      <property name="DCTMMaxSize">unlimited</property>
      <property name="debug">true</property>

Note: Any optional properties can be removed from the configuration to use the default value described on the table above.

Source Configuration

Scanner Control Configuration

The following table describes the list of attributes that the AspireObject of the incoming scanner job requires to correctly execute and control the flow of a scan process.

Element Type Options Description
@action string start, stop, pause, resume, abort Control command to tell the scanner which operation to perform. Use start option to launch a new crawl.
@actionProperties string full, incremental When a start @action is received, it will tell the scanner to either run a full or an incremental crawl.
@normalizedCSName string Unique identifier name for the content source that will be crawled.
displayName string Display or friendly name for the content source that will be crawled.

Header Example

  <doc action="start" actionProperties="full" actionType="manual" crawlId="0" dbId="0" jobNumber="0" normalizedCSName="FeedOne_Connector"
   scheduleId="0" scheduler="##AspireSystemScheduler##" sourceName="ContentSourceName">

All configuration properties described in this section are relative to /doc/connectorSource of the AspireObject of the incoming Job.

Property Type Default Description
url string The Documentum URL to crawl (dctm://host:port/docbase/cabinet/folder format).
username string The username to connect with to the Documentum repository.
password string The password of the user to connect with.
dcfPropsFilePath string The file path location of the dfc.properties file.
webtopUrl string The URL prefix used to access the objects through Webtop application. I.e. http://server.com/webtop/objectId=". The object id will be appended to the given URL to query for the object.
maxFileSize long unlimited The limit size in MB of the content to be crawled.
indexContainers boolean false true if folders (as well as files) should be indexed.
scanRecursively boolean false true if subfolders of the given URL should be scanned.
scanSystemCabinets boolean false true if hidden and private cabinets of Documentum should be scanned.
fileNamePatterns/include/@pattern regex none Optional. A regular expression pattern to evaluate file urls against; if the file name matches the pattern, the file is included by the scanner. Multiple include nodes can be added.
fileNamePatterns/include/@pattern regex none Optional. A regular expression pattern to evaluate file urls against; if the file name matches the pattern, the file is excluded by the scanner. Multiple exclude nodes can be added.

Scanner Configuration Example

  <doc action="start" actionProperties="full" normalizedCSName="cifsTest">
        <include pattern=".*LSA.*"/>
        <exclude pattern=".*tmp.*"/>


  <snapshotUrl>006 dctm://</snapshotUrl>
  <connectorSpecific type="documentum">
    <field name="object_name">dm_document-0024.txt</field>
    <field name="r_object_type">dm_document</field>
    <field name="r_creation_date">12/5/2013 2:13:59 PM</field>
    <field name="r_modify_date">12/5/2013 2:13:59 PM</field>
    <field name="r_modifier">Administrator</field>
    <field name="r_access_date">1/22/2014 2:42:11 PM</field>
    <field name="a_is_hidden">F</field>
    <field name="i_is_deleted">F</field>
    <field name="a_retention_date">nulldate</field>
    <field name="a_archive">F</field>
    <field name="a_link_resolved">F</field>
    <field name="i_reference_cnt">1</field>
    <field name="i_has_folder">T</field>
    <field name="i_folder_id">0b0010e18001d14b</field>
    <field name="r_link_cnt">0</field>
    <field name="r_link_high_cnt">0</field>
    <field name="r_assembled_from_id">0000000000000000</field>
    <field name="r_frzn_assembly_cnt">0</field>
    <field name="r_has_frzn_assembly">F</field>
    <field name="r_is_virtual_doc">0</field>
    <field name="i_contents_id">060010e18001c31b</field>
    <field name="a_content_type">crtext</field>
    <field name="r_page_cnt">1</field>
    <field name="r_content_size">511425</field>
    <field name="a_full_text">T</field>
    <field name="a_storage_type">filestore_01</field>
    <field name="i_cabinet_id">0c0010e1800175ca</field>
    <field name="owner_name">Administrator</field>
    <field name="owner_permit">7</field>
    <field name="group_name">docu</field>
    <field name="group_permit">5</field>
    <field name="world_permit">3</field>
    <field name="i_antecedent_id">0000000000000000</field>
    <field name="i_chronicle_id">090010e18001d15c</field>
    <field name="i_latest_flag">T</field>
    <field name="r_lock_date">nulldate</field>
    <field name="r_version_label">1.0,CURRENT</field>
    <field name="i_branch_cnt">0</field>
    <field name="i_direct_dsc">F</field>
    <field name="r_immutable_flag">F</field>
    <field name="r_frozen_flag">F</field>
    <field name="r_has_events">F</field>
    <field name="acl_domain">Administrator</field>
    <field name="acl_name">dm_450010e180000101</field>
    <field name="i_is_reference">F</field>
    <field name="r_creator_name">Administrator</field>
    <field name="r_is_public">T</field>
    <field name="r_policy_id">0000000000000000</field>
    <field name="r_resume_state">0</field>
    <field name="r_current_state">0</field>
    <field name="r_alias_set_id">0000000000000000</field>
    <field name="a_is_template">F</field>
    <field name="r_full_content_size">511425</field>
    <field name="a_is_signed">F</field>
    <field name="a_last_review_date">nulldate</field>
    <field name="i_retain_until">nulldate</field>
    <field name="i_partition">0</field>
    <field name="i_is_replica">F</field>
    <field name="i_vstamp">0</field>
    <acl access="allow" domain="dctm://" entity="group" fullname="dctm://" name="dm_world" scope="global"/>
    <acl access="allow" domain="dctm://" entity="group" fullname="dctm://" name="Administrator" scope="global"/>
    <acl access="allow" domain="dctm://" entity="group" fullname="dctm://" name="docu" scope="global"/>
    <item id="246AEB4224DF69E86C83D5AFC357A3FD" level="6" name="dm_document-0024.txt" url="dctm://">
        <ancestor id="6846F1C598D288AC85E2DDE6F178B488" level="5" name="folder-1-3" parent="true" type="aspire/dm_folder" url="dctm://"/>
        <ancestor id="2760A49EEC1E0C469929E66A909BBCAA" level="4" name="folder-1" type="aspire/dm_folder" url="dctm://"/>
        <ancestor id="2F224B8B2365BE6BFD1554713BFFF190" level="3" name="5000-500KB" type="aspire/dm_cabinet" url="dctm://"/>
        <ancestor id="A5ECC7C3A8738BB297CC336536AD3B60" level="2" name="DocumentumRepository" type="aspire/docbase" url="dctm://"/>
        <ancestor id="93EAEBDC4E5AF3FFF212F8E80902AF01" level="1" name="documentum" type="aspire/documentum" url="dctm://"/>
  <contentType source="ExtractTextStage/Content-Type">text/plain; charset=windows-1252</contentType>
  <extension source="ExtractTextStage">
    <field name="Content-Encoding">windows-1252</field>
    <field name="resourceName">dctm://</field>
  <content source="ExtractTextStage">Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula eget dolor. Aenean massa. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Donec quam felis, ultricies nec, pellentesque eu, pretium quis, sem. Nulla consequat massa quis enim. Donec pede justo, fringilla vel, aliquet nec, vulputate eget, arcu. In enim justo, rhoncus ut, imperdiet a, venenatis vitae, justo.