TeamForge Application Bundle (Aspire 2)

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

For Information on Aspire 3.1 Click Here

 (2.1 Release)  

TeamForge Application Bundle (Aspire 2)
AppBundle Name  TeamForge Connector
Maven Coordinates  com.searchtechnologies.aspire:app-teamforge-connector
Versions  2.2.2
Type Flags  scheduled
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.
Feature only available with Aspire Enterprise

The TeamForge Connector performs full and incremental scans over a TeamForge repository and will extract security, metadata, and content from each object scanned. 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 via the Scheduler Component. 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.



Configuration

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

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 string 15s 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.
sessionTimeout string 10m The timeout when downloading attachments from repository.Defaults to ms, but can be suffixed with ms, s, m, h or d to indicate the required units.


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-filesystem-connector">
    <properties>
      <property name="generalConfiguration">true</property>
      <property name="snapshotDir">${aspire.home}/snapshots</property>
      <property name="disableTextExtract">false</property>
      <property name="workflowReloadPeriod">15s</property>
      <property name="workflowErrorTolerant">false</property>
      <property name="debug">true</property>
      <property name="sessionTimeout">10m</property>
    </properties>
  </application>

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


Group Expansion Configuration

Property Type Default Description
TeamForge URL string TeamForge repository URL The URL to get security group information.
Username string The username to connect for TeamForge repository.
Password string The password to connect for TeamForge repository.
Group cache refresh Drop down menu Every hour Refresh rate for Group cache
useGE boolean false Check this if you want to use group expansion.
useLDAPCache boolean false Check this if you want to use an external server to perform group expansion (Group Expansion Manager is required).
externalGroupServerPath select Indicates the path of the component that gets the external groups from LDAP.


Source Configuration

Property Type Default Description
TeamForge URL string The Url to crawl (you have to specify the protocol).
Username string The Username to connect with.
Password string The password of the Username to connect with.


Output


<doc>
  <url>http://10.40.40.198/sf/go/proj1007</url>
  <displayUrl>http://10.40.40.198/sf/go/proj1007</displayUrl>
  <snapshotUrl>001 http://10.40.40.198/sf/go/proj1007</snapshotUrl>
  <fetchUrl>http://10.40.40.198/sf/go/proj1007</fetchUrl>
  <parentId>http://10.40.40.198/sf/</parentId>
  <docType>container</docType>
  <repItemType>aspire/project</repItemType>
  <id>proj1007</id>
  <title>look</title>
  <description>Branding Project</description>
  <connectorSpecific type="teamforge">
    <field name="date_created">2013-12-16T19:15:26Z</field>
    <field name="hierarchy_path"/>
    <field name="parent_projectId"/>
    <field name="path">projects.look</field>
    <field name="locked">false</field>
  </connectorSpecific>
  <sourceName>teamforge</sourceName>
  <sourceType>teamforge</sourceType>
  <acls>
    <acl access="allow" entity="user" fullname="New Admin" name="newadmin" scope="global"/>
    <acl access="allow" entity="user" fullname="SCM viewer" name="scmviewer" scope="global"/>
    <acl access="allow" entity="user" fullname="TeamForge Administrator" name="admin" scope="global"/>
  </acls>
  <connectorSource>
    <url>http://10.40.40.198/</url>
    <username>admin</username>
    <password>encrypted:8F51820C8DA15CBE0FC9A07E99674290</password>
    <indexContainers value="on">true</indexContainers>
    <fileNamePatterns/>
    <scanRecursively>true</scanRecursively>
    <displayName>teamforge</displayName>
  </connectorSource>
  <action>add</action>
  <hierarchy>
    <item id="70424EA9CAA6FB35307A3C67603D7885" level="1" name="goproj1007" type="aspire/project" url="http://10.40.40.198/sf/go/proj1007">
      <ancestors>
        <ancestor id="B612A3E0E8BF4917B60F9E1E948566A0" level="0" name="teamforge" parent="true" type="aspire/root" url="http://10.40.40.198/sf/"/>
      </ancestors>
    </item>
  </hierarchy>
  <content/>
</doc>
</job>