CIFS Application Bundle (Aspire 2)

Revision as of 22:38, 8 December 2015 by Dherrera (talk | contribs)
Jump to: navigation, search

For Information on Aspire 3.1 Click Here

CIFS Application Bundle (Aspire 2)
AppBundle Name  CIFS Connector
Maven Coordinates  com.searchtechnologies.aspire:app-cifs-connector
Versions  {{{versions}}}
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 CIFS Connector performs full and incremental scans over a shared folder (including NTFS) and will extract security, metadata, and content from each file scanned. The connector allows you to filter the scanned files using regular expression patterns, to include folders in the results, and to scan subfolder content. Each scanned file 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.

NOTE: CIFS Application Bundle has malfunctions when another CIFS Application is installed on the same server and configure for another server on another domain. This also applies for the Publish To SharePoint 2013


This section lists all configuration parameters available to install the CIFS 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.

CIFS Specific Configuration

Property Type Default Description
ExtractTextMaxSize long unlimited The max number of characters to extract from a file or "unlimited" for no size restrictions.

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-cifs-connector">
      <property name="generalConfiguration">true</property>
      <property name="snapshotDir">${aspire.home}/snapshots</property>
      <property name="ExtractTextMaxSize">unlimited</property>
      <property name="disableTextExtract">false</property>
      <property name="workflowReloadPeriod">15s</property>
      <property name="workflowErrorTolerant">false</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 smb URL to crawl (smb:// format).
partialScan boolean false To run a partial scan – i.e. to only scan a portion of the larger directory. This is useful to re-process portions of your system without having to process the entire content source.
subDirUrl string Configurable when partialScan is set to true. The sub-directory which contains the documents to be processed for this partial scan. This directory must be a relative path to the parent directory. Only the documents in this sub-directory will be scanned. This is useful to re-process portions of your system without having to process the entire content source.
domain string The domain where the username, connecting to the shared folder, belongs to.
username string The username to connect with.
password string The password of the username to connect with.
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.
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.*"/>


  <url>smb://localhost/AspireTesting/LSA/Mahout Algorithms.txt</url>
  <snapshotUrl>003 smb://localhost/AspireTesting/LSA/Mahout Algorithms.txt</snapshotUrl>
  <fetchUrl>smb://localhost/AspireTesting/LSA/Mahout Algorithms.txt</fetchUrl>
  <displayUrl>smb://localhost/AspireTesting/LSA/Mahout Algorithms.txt</displayUrl>
  <id>smb://localhost/AspireTesting/LSA/Mahout Algorithms.txt</id>
  <connectorSpecific type="fileshare">
    <field name="smbUrl">smb://localhost/AspireTesting/LSA/Mahout Algorithms.txt</field>
    <acl access="allow" domain="NT AUTHORITY" entity="group" fullname="NT AUTHORITY\SYSTEM" inherited="true" name="SYSTEM" scope="machine" sid="S-1-5-18" sidType="windowsGroup"/>
    <acl access="allow" domain="SEARCH" entity="user" fullname="SEARCH\ralfaro" inherited="true" name="ralfaro" scope="global" sid="S-1-5-21-4065858124-1791371549-2540926932-1286" sidType="user"/>
    <acl access="allow" domain="BUILTIN" entity="group" fullname="BUILTIN\Administrators" inherited="true" name="Administrators" scope="machine" sid="S-1-5-32-544" sidType="localGroup"/>
    <acl access="allow" domain="" entity="group" fullname="\Everyone" inherited="true" name="Everyone" scope="machine" sid="S-1-1-0" sidType="localGroup"/>
    <acl access="allow" domain="S-1-5-21-4065858124-1791371549-2540926932" entity="group" fullname="S-1-5-21-4065858124-1791371549-2540926932\2687" inherited="true" name="2687" scope="machine" sid="S-1-5-21-4065858124-1791371549-2540926932-2687" sidType="windowsGroup"/>
      <include pattern=".*LSA.*"/>
      <exclude pattern=".*tmp.*"/>
    <item id="AAC954B9F7C1794CA8EFC3A02C16820A" level="3" name="Mahout Algorithms.txt" url="smb://localhost/AspireTesting/LSA/Mahout Algorithms.txt">
        <ancestor id="4646C909DA9EE32E5C36C8D5843DCEE3" level="2" name="LSA" parent="true" type="aspire/folder" url="smb://localhost/AspireTesting/LSA/"/>
        <ancestor id="D2B7229CA1C9BCC12AA27BB354BC2DD4" level="1" name="cifsTest" type="aspire/fileshare" url="smb://localhost/AspireTesting/"/>
  <protocol source="SmbFetchURLStage/protocol">smb</protocol>
  <host source="SmbFetchURLStage/host">localhost</host>
  <extension source="SmbFetchURLStage">
    <field name="modificationDate">2012-07-24T20:58:32Z</field>
  <contentType source="ExtractTextStage/Content-Type">text/plain; charset=windows-1252</contentType>
  <extension source="ExtractTextStage">
    <field name="Content-Encoding">windows-1252</field>
    <field name="resourceName">smb://localhost/AspireTesting/LSA/Mahout Algorithms.txt</field>
  <content source="ExtractTextStage">;