Lotus Notes Application Bundle (Aspire 2)

From wiki.searchtechnologies.com
Revision as of 23:38, 8 December 2015 by Dherrera (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

For Information on Aspire 3.1 Click Here

Lotus Notes Application Bundle (Aspire 2)
AppBundle Name  Lotus Notes Connector
Maven Coordinates  com.searchtechnologies.aspire:app-lotus-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 Lotus Notes Connector performs full and incremental crawls over a Lotus Domino server and will extract security, metadata, and content from each object scanned. The connector allows you to select which application databases will be included in the crawl. 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. 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 Lotus Notes 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.


Lotus Notes Specific Configuration

Element Type Default Description
url string The URL to crawl.
userName String username The user name to connect to Lotus Notes with.
password String secretpassword The password to connect to SharePoint with.
defaultDisplayName String notes The name of the crawl, if one is not given in the control job.
snapshotDir String . The directory for snapshot files.
waitForSubJobsTimeout long 600000
(=10 mins)
Scanner time out while waiting for published jobs to complete.
scanRecursively boolean false Indicates whether the child containers should be scanned or not.
indexContainers boolean false Indicates whether the container items should be indexed or not.
indexMailDbs boolean false Indicates whether the connector should crawl mail databases inside Lotus Notes.
useLDAPCache boolean false Check for an installed "Aspire LDAP Cache" component for group expansion.
externalGroupServerPath string empty List of installed "Aspire LDAP Cache" components.


Configuration Example

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

<connectorSource>
  <url>10.40.40.114</url>
  <username>Admin Administrator</username>
  <password>encrypted:317C2FA5E804421BA2375D8B9FAE23A6</password>
  <includeDBs>
    <database database="docLibra.nsf"/>
  </includeDBs>
  <indexMailDbs>true</indexMailDbs>
  <scanRecursively>true</scanRecursively>
  <indexContainers>true</indexContainers>
  <fileNamePatterns/>
</connectorSource>

Group Expansion Configuration

Property Type Default Description
Lotususername string User name for Lotus Notes authentication.
Lotuspassword string User password for Lotus Notes authentication.
Lotushost string Designates a site collection to scan for groups.
includeDBs/databases xml List of databases to get the groups from



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-lotus-connector:">
  <properties>
    <property name="generalConfiguration">true</property>
    <property name="useGroupExpansion">true</property>
    <property name="Lotushost">10.40.40.114</property>
    <property name="Lotususername">Admin Administrator</property>
    <property name="Lotuspassword">encrypted:317C2FA5E804421BA2375D8B9FAE23A6</property>
    <property name="includeDBs"><databases><database>docLibra.nsf</database></databases></property>
    <property name="geSchedule">0 0 0 ? * *</property>
    <property name="useLDAPCache">false</property>
    <property name="externalGroupServerPath"/>
    <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="debug">false</property>
  </properties>
</application>


Output

<job id="10.10.22.98:50505/2014-06-05T23:57:52Z/0/4" time="2014-06-05T23:59:21Z">
<doc>
  <url>docLibra.nsf:74A1AD06B9A1DC7388257B6600611042</url>
  <id>docLibra.nsf:74A1AD06B9A1DC7388257B6600611042</id>
  <displayUrl>docLibra.nsf:74A1AD06B9A1DC7388257B6600611042</displayUrl>
  <snapshotUrl>003 docLibra.nsf:74A1AD06B9A1DC7388257B6600611042</snapshotUrl>
  <repItemType>aspire/document</repItemType>
  <connectorSpecific>
    <field name="attachmentCount">0</field>
    <field name="parentUNID"/>
    <field name="parentDatabase">docLibra.nsf</field>
    <field name="Form">Document</field>
    <field name="CurrentUser">CN=Admin Administrator/O=search</field>
    <field name="Resubmit">0</field>
    <field name="ReviewType">1</field>
    <field name="ReviewWindow">0</field>
    <field name="NotifyAfter">0</field>
    <field name="Subject">favorite doc</field>
    <field name="SubmitNow">0</field>
    <field name="$UpdatedBy">CN=Admin Administrator/O=search</field>
  </connectorSpecific>
  <created>2013-05-09T17:40:11Z</created>
  <lastAccessed>2013-05-09T17:40:31Z</lastAccessed>
  <lastModified>2013-05-09T17:40:31Z</lastModified>
  <fetchUrl>http://10.40.40.114/__88257AC90071FA4C.nsf/0/74A1AD06B9A1DC7388257B6600611042?OpenDocument</fetchUrl>
  <acls>
    <parentAcl access="allow" domain="domain" entity="group" fullname="CN=lotusserver/O=search|Developers Top Level" name="CN=lotusserver/O=search|Developers Top Level" scope="global"/>
    <parentAcl access="allow" domain="domain" entity="user" fullname="CN=Ernesto Harler/O=search" name="CN=Ernesto Harler/O=search" scope="global"/>
    <parentAcl access="allow" domain="domain" entity="user" fullname="CN=Admin Administrator/O=search" name="CN=Admin Administrator/O=search" scope="global"/>
    <parentAcl access="allow" domain="domain" entity="group" fullname="CN=lotusserver/O=search|docLibra.nsf|-Default-" name="CN=lotusserver/O=search|docLibra.nsf|-Default-" scope="global"/>
    <parentAcl access="allow" domain="domain" entity="group" fullname="CN=lotusserver/O=search|docLibra.nsf|$PublicAccess" name="CN=lotusserver/O=search|docLibra.nsf|$PublicAccess" scope="global"/>
    <parentAcl access="allow" domain="domain" entity="group" fullname="CN=lotusserver/O=search|Human Resources Group" name="CN=lotusserver/O=search|Human Resources Group" scope="global"/>
    <parentAcl access="allow" domain="domain" entity="user" fullname="CN=lotusserver/O=search" name="CN=lotusserver/O=search" scope="global"/>
    <parentAcl access="allow" domain="domain" entity="group" fullname="CN=lotusserver/O=search|Developers Level 2" name="CN=lotusserver/O=search|Developers Level 2" scope="global"/>
    <acl access="allow" domain="domain" entity="user" fullname="CN=Admin Administrator/O=search" name="CN=Admin Administrator/O=search" scope="global"/>
    <acl access="deny" domain="domain" entity="user" fullname="CN=Andres Coto/O=search" name="CN=Andres Coto/O=search" scope="global"/>
    <acl access="deny" domain="domain" entity="user" fullname="Anonymous" name="Anonymous" scope="global"/>
    <intersectionAcl access="allow" domain="domain" entity="user" name="CN=Admin Administrator/O=search+CN=lotusserver/O=search|Developers Top Level" scope="global"/>
    <intersectionAcl access="allow" domain="domain" entity="user" name="CN=Admin Administrator/O=search+CN=lotusserver/O=search|docLibra.nsf|-Default-" scope="global"/>
    <intersectionAcl access="allow" domain="domain" entity="user" name="CN=Admin Administrator/O=search+CN=lotusserver/O=search|Human Resources Group" scope="global"/>
    <intersectionAcl access="allow" domain="domain" entity="user" name="CN=Admin Administrator/O=search+CN=lotusserver/O=search|docLibra.nsf|$PublicAccess" scope="global"/>
    <intersectionAcl access="allow" domain="domain" entity="user" name="CN=Admin Administrator/O=search+CN=lotusserver/O=search|Developers Level 2" scope="global"/>
  </acls>
  <isDeleted>false</isDeleted>
  <size>339</size>
  <docType>container</docType>
  <sourceName>Doc-Test</sourceName>
  <sourceType/>
  <connectorSource>
    <url>10.40.40.114</url>
    <username>Admin Administrator</username>
    <password>encrypted:317C2FA5E804421BA2375D8B9FAE23A6</password>
    <includeDBs>
      <database database="docLibra.nsf"/>
    </includeDBs>
    <indexMailDbs>false</indexMailDbs>
    <scanRecursively>true</scanRecursively>
    <indexContainers>true</indexContainers>
    <fileNamePatterns/>
    <displayName>Doc-Test</displayName>
  </connectorSource>
  <action>add</action>
  <hierarchy>
    <item id="E1E534BCB7F143C1FDBF45B0EF5090CE" level="3" name=":74A1AD06B9A1DC7388257B6600611042" type="aspire/document" url="docLibra.nsf:74A1AD06B9A1DC7388257B6600611042">
      <ancestors>
        <ancestor id="BD81AE08922788F13AEDB857E17940E2" level="2" name="docLibra.nsf" parent="true" type="aspire/applicationDatabase" url="docLibra.nsf"/>
        <ancestor id="6CF9BA5ED4A271C76FDBE6B63DAE2BA1" level="1" name="Doc-Test" type="aspire/server" url="CN=lotusserver/O=search"/>
      </ancestors>
    </item>
  </hierarchy>
  <contentType source="ExtractTextStage/Content-Type">text/plain; charset=windows-1252</contentType>
  <extension source="ExtractTextStage">
    <field name="Content-Encoding">windows-1252</field>
    <field name="resourceName">docLibra.nsf:74A1AD06B9A1DC7388257B6600611042</field>
  </extension>
  <content source="ExtractTextStage"> content of favorite doc&#13;

</content>
</doc>
</job>