Configuration File - Tag Description

The tags in this configuration file are described below:

1. feedLocation: This can be either of the following:
a. URL of the directory if the data feed is a directory feed. This URL should be FTP URL or File URL of the directory where the data feeds are located.
For example:
ftp://host1.domain.com/relativePathOfDirectory.
file://host1.domain.com/c:\dir1\dir2\dir3
file://host1.domain.com//private/home/dir1/dir2/dir3

File URL can be used if the data feeds are available on the same machine as SES. The path specified in the URL should be absolute path of the directory.

FTP URL should be used to access data feeds on any other machine. The path of the directory in the URL can be
i. Absolute: The absolute path should be specified following the `/` after the host name in the URL.
ii. Relative: Relative path should be specified relative to the home directory of the user used to access FTP feeds.

Note: The user ID used to crawl the source should have write permissions on the errorFileLocation directory so that the data feeds can be deleted after crawl.

b. URL of the control file if the data feed is a control feed. This URL can be HTTP(S), FILE or FTP URL.
For example,
http://host1.domain.com:port/context/control.xml.

The path in FTP and File protocols can be absolute or relative as explained in case of directory feed.

2. feedType: Indicates the type of feed. Valid values are
i. directoryFeed
ii. controlFeed
iii. dataFeed

3. errorFileLocation: This is an optional parameter to specify the directory where status feeds should be uploaded.
A status feed is generated after processing each data feed indicating the status of processing the feed. This status feed is named as <data feed file name>.suc or <data feed file name>.err depending on whether the processing was successful or not respectively. Any errors encountered will be listed in the error status feed. The feed with which errors were encountered will be backed up with extension .prcsdErr in the same directory and processing will continue with the next feed.

This directory should be on the same machine containing the feeds. The value of this element should be absolute path of the directory. The user ID used to access the data feed should have write permission on the directory.

If no value is specified for this parameter, the status feed will be uploaded to the same location as the data feed.

If the feedLocation is a HTTP URL, the errorFileLocation should also be a HTTP URL, to which the status feeds will be posted. If no value is specified for errorFileLocation, the status feeds will be posted to the URL given in the feedLocation tag.

4. sourceName: This is an optional parameter specifying the name of the source. The value specified for the sourceName in the configuration file should match the sourceName specified in the Control /Data feeds.

5. securityType: This is an optional parameter to specify the security type. Valid values are
i. noSecurity - Default. There is no security information associated with this source at the document level.
ii. identityBased - Identity based security model is being used for documents in the feed.
iii. attributeBased - Attribute based security model is being used for documents in the feed. With this security model, security attributes should be specified in the securityAttribute tag and the values for these attributes should be specified for each document.

6. securityAttribute: One or more tags of this type should be specified for attribute-based security. Each tag should contain the following attributes:
i. name - Name of the security attribute
ii. grant - Boolean parameter indicating whether this is a grant/deny attribute. The security attribute is considered a grant attribute if the value is true and a deny attribute if the value is false.