Share via

lotusnotestemplate.xml reference

  • Article

 

Applies to: FAST Search Server 2010

Use a copy of lotusnotestemplate.xml to change the settings for the FAST Search Lotus Notes connector.

The FAST Search Lotus Notes connector uses the configuration settings to control content extraction from Lotus Domino. You can run multiple instances of the FAST Search Lotus Notes connector at the same time if you use different configuration files for each instance.

Customizing lotusnotestemplate.xml

Note

To modify a configuration file, verify that you meet the following minimum requirements: You are a member of the FASTSearchAdministrators local group on the computer where FAST Search Server 2010 for SharePoint is installed.

To extract content from a Lotus Notes database and feed it to a FAST Search Server 2010 for SharePoint installation, first create a copy of the lotusnotestemplate.xml file. Edit the copy in a text or XML editor of your choice (except Notepad) to include the elements and settings for your environment.

To test your settings, run:

<FASTSearchFolder>\bin\lotusnotesconnector.bat testconnections -f <configuration file>

where <configuration file> is the path and file name of your configuration, and <FASTSearchFolder> is the path of the folder where you have installed FAST Search Server 2010 for SharePoint, for example C:\FASTSearch.

The FAST Search Lotus Notes connector connects to all external systems, such as the Lotus Domino server, the FAST Search Server 2010 for SharePoint installation, and the state database, to verify the connection parameters. The connector will not process any data.

To run the FAST Search Lotus Notes connector and feed content to FAST Search Server 2010 for SharePoint, run:

<FASTSearchFolder>\bin\ lotusnotesconnector.bat start -f <configuration file>

Parameter groups quick reference

The following table lists the parameter groups in lotusnotestemplate.xml. These groups can appear in any order.

Parameter group Description

Connection

Specifies how to connect to the Domino server.

Filters

Specifies the content to crawl.

FASTSearchSubmit

Describes the properties used to communicate with FAST Search Server 2010 for SharePoint when submitting content.

XMLExport

Specifies the values for exporting to XML formatted file(s).

Normalization

Specifies how to transform/normalize items before the connector sends them to the content distributor.

ConnectorExecution

Specifies general values that were used when you run the connector.

StateTracker

Specifies the behavior of the state tracker database. It is used for incremental crawling.

General

Specifies the configuration name.

lotusnotestemplate file format

XML elements in lotusnotestemplate.xml begin with < and end with />. The XML is defined in FastConnectorConfig-1.0.dtd.

The basic format is as follows:

<group name="group_name">

    <parameter name="parameter_name" type="parameter_type">

        <value>value</value>

    </parameter>

</group>

Parameter names are case-sensitive, types are not. Parameter names and types must be enclosed in quotation marks (" ").

A parameter definition can span multiple lines. Spaces, carriage returns, line feeds, and tab characters are ignored in an element definition.

For example:

<group name="ConnectorExecution">
    <parameter name="QueueSize" type="integer">
         <value>200</value>
    </parameter>
    <parameter name="WorkFolder" type="string">
         <value>../var/lotusnotesconnector</value>
    </parameter>
</group>

Tip

For long parameter definitions, position values on separate lines and use indentation to make the file easier to read.

The <FastConfig> element is a special case and is required. All other elements are contained within the <FastConfig> element, and the element is closed with </FastConfig>.

Here is a sample snippet from a configuration file:

<!DOCTYPE FastConfig SYSTEM "dtd/FastConnectorConfig-1.0.dtd"><FastConfig>
    <group name="ConnectorExecution">
       <parameter name="QueueSize" type="integer">
             <value>200</value>
        </parameter>
       <parameter name="WorkFolder" type="string">
             <value>../var/lotusnotesconnector</value>
       </parameter>
    </group>
</FastConfig>

You can add comments anywhere, delimited by <!-- and -->.

For example:

<!DOCTYPE FastConfig SYSTEM "dtd/FastConnectorConfig-1.0.dtd"><FastConfig>
    <!-- The parameter group ConnectorExecution specifies general values
          used when running a connector. -->
    <group name="ConnectorExecution">
       <parameter name="QueueSize" type="integer">
             <value>200</value>
       </parameter>
       <parameter name="WorkFolder" type="string">
             <value>../var/lotusnotesconnector</value>
       </parameter>
    </group>
</FastConfig>

Parameter group: Connection

The parameters in this group specify the connection to the Lotus Domino server.

Parameter Type Value Description

Hostname

string

text

The host name of the Domino server.

This can be a host name, a fully qualified domain name, the Domino server name (in the form <host>/<domain>), or "localdisk".

The reserved keyword "localdisk" instructs the connector to look for databases on the local Lotus Notes client.

Password

string

text

The encrypted password that is used to authenticate to the Lotus Notes client.

This must match the password that you last used to log on to the Lotus Notes client on this computer. The password must be encrypted. Encrypt it with the <FASTSearchFolder>\bin\connectorpwgen.bat utility.

The encrypted password cannot contain any new line or white-space characters; remove them when you copy the encrypted password from the console.

Note

The password must be encrypted by the same user who will decrypt it (e.g., the user who will run the connector).

Example

<group name="Connection">
    <parameter name="Hostname" type="string">
        <value>dominoserver.company.com</value>
    </parameter>
    <parameter name="Password" type="string">
        <value>AQAAANCMnd8BFdERjHoAwE/Cl+sBAAAAPF3E/uqo8kuy05Vfl6hBWAAAAABSAAAATQBpAGMAcgBvAHMAbwBmAHQAIABFAG4AdABlAHIAcAByAGkAcwBlACAAUwBlAGEAcgBjAGgAIAAtACAAQwBvAG4AbgBlAGMAdABvAHIAcwAAAANmAACoAAAAEAAAAN/ksvnBFepWFXzS9BFNY6AAAAAABIAAAKAAAAAQAAAAvbI2O5PXmb6wDzAeEfvNeRAAAABEqBeLrh8usMBfBhA7J8t1FAAAAD54sadCcKVwSRyxdU0TO6XjyCdH</value>
    </parameter>
</group>

Parameter group: Filters

The parameters in this group specify which content to crawl, through several include and exclude filters.

Parameter Type Value Description

DataBase

string

text

A list of databases to crawl. May contain view names.

Specify a view in the format: <database path>#viewname. Separate multiple databases with a semicolon (;).

When you specify a view, only the search formula of the view is used.

ViewName

string

text

Specifies a particular view on several databases at the same time.

Use if the view is not specified in the DataBase parameter.

When you specify a view, only the search formula of the view is used.

IncludeDataBases

string

text

Lists one or more include filters, regular expressions, for database names/paths. For example: Attach.*\.nsf;help\/.*\.nsf.

Separate multiple include filters with a semicolon (;).

Use when the DataBase parameter is empty, and in combination with the ExcludeDatabases filter.

ExcludeDataBases

string

text

Lists one or more exclude filters, regular expressions, for database names/paths. For example: mail\\.*\.nsf;schema.nsf;names.nsf;help.*\.nsf.

Separate multiple exclude filters with a semicolon (;).

Use when the DataBase parameter is empty, and in combination with the IncludeDatabases filter.

This parameter overrides the include filter; use it to narrow included content.

IncludeAttachmentExtensions

string

text

List of file name extensions for attachments that should be indexed. Separate multiple include filters with a semicolon (;).

If both IncludeAttachmentExtension and ExcludeAttachmentExtensions are specified, ExcludeAttachmentExtensions will be ignored.

ExcludeAttachmentExtensions

string

text

List of file name extensions for attachments that should not be indexed. Separate multiple exclude filters with a semicolon (;).

If both IncludeAttachmentExtension and ExcludeAttachmentExtensions are specified, ExcludeAttachmentExtensions will be ignored.

MaxAttachmentSize

integer

size

Specifies the maximum size of attachments, in kilobytes.

Default: 10000

SearchQuery

string

text

Specifies a query using the Notes Query Language.

For example: SELECT Form="Item"

The query is applied to any database that has no view specified.

If any of these parameters is changed so that items that were indexed previously no longer should be indexed, the corresponding items will not be removed from the index. In this case, you should clear the state tables by setting the StateTracker/PurgeAtStart parameter to true. You must also delete all the items in the FAST Search Server 2010 for SharePoint search index by deleting/purging the collection.

Example

<group name="Filters">
    <parameter name="DataBase" type="string" separator=";">
        <value></value>
    </parameter>
    <parameter name="ViewName" type="string">
        <value></value>
    </parameter>
    <parameter name="IncludeDataBases" type="string" separator=";">
        <value>help\\.*</value>
    </parameter>
    <parameter name="ExcludeDataBases" type="string" separator=";">
        <value>help\\.*api.*</value>
    </parameter>
    <parameter name="IncludeAttachmentExtensions" type="string" separator=";">
        <value>doc;xls;ppt;pdf</value>
    </parameter>
    <parameter name="ExcludeAttachmentExtensions" type="string" separator=";">
        <value></value>
    </parameter>
    <parameter name="MaxAttachmentSize" type="integer">
        <value>10000</value>
    </parameter>
    <parameter name="SearchQuery" type="string">
        <value>SELECT Form="Item"</value>
    </parameter>
</group>

Parameter group: FASTSearchSubmit

The parameters in this group describe communication properties for submitting content to FAST Search Server 2010 for SharePoint.

Parameter Type Value Description

ActuallyPublish

boolean

true|false

If true, submits items to FAST Search Server 2010 for SharePoint.

If false, the connector will crawl content from Lotus Domino. However, it will not submit it to the search index. Use this setting for test runs of other parameters (e.g., parameter settings in the Filters group).

Default: true

Collection

string

text

Name of the FAST Search Server 2010 for SharePoint crawl collection to feed.

Example

<group name="FASTSearchSubmit">
    <parameter name="ActuallyPublish" type="boolean">
        <value>true</value>
    </parameter>
    <parameter name="Collection" type="string">
        <value>lotusnotes</value>
    </parameter>
</group>

Parameter group: XMLExport

The parameters in this group specify an export to XML formatted file(s). Export content to XML during testing, to see the contents.

Only text data is exported to XML; binary content is not exported.

Parameter Type Value Description

ExportToXML

boolean

true|false

If true, exports all items to XML.

Default: false

The exported XML is stored in <FASTSearchFolder>\var\lotusnotesconnector\<collection name>\xml.

Example

<group name="XMLExport">
    <parameter name="ExportToXML" type="boolean">
        <value>true</value>
   </parameter>
</group>

Parameter group: Normalization

The parameters in this group specify how to transform/normalize items before submitting them to the content index.

Parameter Type Value Description

FixedFields

string

text

Assigns fixed fields and field values to all crawled items. This is a list of semicolon separated field names/value pairs in the form: field1:value1;field2:value2.

The fields are added exactly as written. They are case-sensitive.

DominoWebServerPrefix

string

text

Specifies the Domino Web server that search results should link to.

If this Domino Web server differs from the server being crawled, this parameter will override the item URLs with those of the Domino Web server.

SecurityDomainId

string

text

Specifies the security domain ID for Lotus Notes (the ID provided when the Lotus Notes user store was created).

The domain ID should match the Identity property in the Lotus Notes user store cmdlet, and the FSAOutput/SecurityDomainId in the Lotus Notes user directory configuration file.

DateTimeFormat

string

text

Modifies the parsing of ACL change time stamps.

You should not have to change this parameter. The connector automatically parses time stamps the last time that database security changed. However, if the connector reprocesses databases that have not been modified since the previous run, provide a date-time format in this parameter.

Example date-time formats:

  • dd/MM/yyyy hh:mm:ss aa

  • MM/dd/yyyy hh:mm:ss aa

  • yyyy/MM/dd hh:mm:ss aa

Leave the Normalization/DateTimeFormat parameter empty, unless the connector is crawling a Lotus Notes database that has a different locale than the Domino server. For example: the Domino server has a locale with a time stamp in the form: "28/07/2009 14:56:34", but the database was created on a Domino server that has a locale where the same time stamp is formatted as: "07/28/2009 02:56:34 PM". In this case, the parameter should contain: "MM/dd/yyyy kk:mm:ss aa".

Example

<group name="Normalization">
    <parameter name="FixedFields" type="string">
        <value></value>
    </parameter>
    <parameter name="DominoWebServerPrefix" type="string">
        <value>http://dominowebserver.company.com</value>
    </parameter>
    <parameter name="SecurityDomainId" type="string">
        <value>lnx</value>
    </parameter>
    <parameter name="DateTimeFormat" type="string">
        <value></value>
    </parameter>
</group>

Parameter group: ConnectorExecution

The parameters in this group specify general values that were used during a connector run.

Parameter Type Value Description

QueueSize

integer

1 - 10000

Specifies the size of the internal queue of items.

Increasing this value may increase performance but it may also increase memory consumption of the connector.

Default: 200

DocumentLoggingFrequency

integer

10 - 50000

Specifies the number of items processed before the connector logs a message about how many items it has processed.

Default: 1000

WorkFolder

string

Folder name

Specifies the work folder (either a relative or absolute file path) for all file output. This includes log files and XML output files.

The folder is automatically created if it does not exist.

Multiple connector configurations should have different values for this parameter.

Default: ../var/lotusnotesconnector

NumAdapters

integer

1 - 32

Specifies several adapter threads, or how many databases the connector crawls in parallel.

Increasing this value will increase performance of the connector but it may also increase memory consumption.

Default: 3

AdapterThrottleSleepMS

integer

0 - 10000

Specifies the number of milliseconds the adapter should wait between fetching each item from the source.

Use to throttle the feeding rate of this connector instance.

Default: 0

EnableStatustracker

boolean

true|false

If true, logs the item crawl status to the database. If false, disables status tracking.

Disabling tracking will reduce the load on the state database. But you will be unable to check the status of individual items using SQL Server Reporting Services.

You do not have to change these settings unless you are running multiple connector configurations.

Example

<group name="ConnectorExecution">
    <parameter name="QueueSize" type="integer">
        <value>200</value>
    </parameter>
    <parameter name="DocumentLoggingFrequency" type="integer">
        <value>1000</value>
    </parameter>
    <parameter name="WorkFolder" type="string">
        <value>../var/lotusnotesconnector2</value>
    </parameter>
    <parameter name="NumAdapters" type="integer">
        <value>4</value>
    </parameter>
    <parameter name="AdapterThrottleSleepMS" type="integer">
        <value>0</value>
    </parameter>
    <parameter name="EnableStatustracker" type="boolean">
        <value>false</value>
    </parameter>
</group>

Parameter group: StateTracker

The parameters in this group specify the behavior of the state tracker database, used for incremental crawling.

Parameter Type Value Description

PurgeAtStart

boolean

true|false

If true, all data in the state tracker tables is purged at startup, telling the connector to retrieve everything, even if it was crawled previously.

Use when testing your configuration. Set to false when in production.

Default: false

Example

<group name="StateTracker">
    <parameter name="PurgeAtStart" type="boolean">
        <value>false</value>
    </parameter>
</group>

Parameter group: General

Specifies the configuration name.

Parameter Type Value Description

Name

string

text

Specifies the configuration name.

Use only when you have multiple databases with the same fields that should be mapped to different managed properties.

The name must be unique, with a maximum length of 32 characters, in the range a-f and 0-9.

Names that are less than 32 characters will be padded to construct a GUID of 32 characters. This propset-ID GUID identifies the source of crawled properties as they enter the search engine, for mapping crawled properties to managed properties.

If Name is blank, a predefined Lotus Notes propset-ID and the predefined mapping will be used, which can be extended.

You do not have to enter a value for this parameter unless you have multiple databases with the same field that should be mapped to different managed properties via separate mappings.

For example: Database a.nsf and b.nsf both contain a field that is named "lastmodified". In a.nsf, this field is a string specifying the user who last modified the database. In b.nsf, this field is a datetime and contains the time stamp when the database was last modified. For a.nsf, "lastmodified" maps to the managed property "modifiedby". For b.nsf, "lastmodified" maps to the managed property "lastmodifiedtime". Two different connector configurations are required for crawling these two databases.

Example

<group name="General">
    <parameter name="Name" type="string">
        <value>abcdef01</value>
    </parameter>
</group>

See Also

Reference

lotusnotesconnector.bat reference

Concepts

Manage crawling with the FAST Search Lotus Notes content connector