File System Onsite Connector

The File System Connector retrieves documents from a computer file system and indexes them into Haven OnDemand. You provide the starting directory, and the connector collects documents from that directory and, optionally, any subdirectories.

The File System Onsite Connector is an onsite Connector, which you install on your own system. For details on how to download and install this connector, see Use the File System Onsite Connector.

Note: The user that the FileSystemConnector service runs as must have at least read-access to the target file system If this is not the case, change the user to one with the necessary rights level.

Filesystem_onsite Connector Configuration

This section outlines the configuration options that you can set for the Filesystem_onsite connector flavor. You can use these in the JSON object that you pass to the config parameter in the Create Connector API.

Note: All the options are case sensitive.

Required Parameters

Parameter Type Description
directoryPathCSVs String A comma-separated list of directories to scan for documents to ingest. You must escape backslashes in file paths. For example, for Windows, use double backslashes: C:\\users.

Optional Parameters

Parameter Type Description Default
servicePort Integer The configured service port for the connector. This value is set in the connector configuration file, and the connector uses this port to listen for service control requests, such as stopping the connector.
This port must be available on the machine where the connector is installed, and the connector will open it. If port 8002 is not available on your connector host machine, you must reconfigure it. If you have more than one instance of the connector on your host machine, you must change this value for all but one of the connectors.
8002
aciPort Integer The configured action port for the connector. This value is set in the connector configuration file, and the connector uses this port to listen for actions, such as requesting a connector run.
This port must be available on the machine where the connector is installed, and the connector will open it. If port 8000 is not available on your connector host machine, you must reconfigure it. If you have more than one instance of the connector on your host machine, you must change this value for all but one of the connectors.
8000
directoryRecursive Boolean Whether to scan subdirectories of the directoryPathCSVs directories. Set this parameter to false if you do not want to scan subdirectories. True
manipulate_reference_prefix String A directory path prefix that you want to replace in your document references. When a document has a reference that matches this prefix, the connector replaces the prefix with the value that you specify in the new_reference_prefix parameter. For example C:\\. You must escape backslashes in file paths. For example, for Windows, use double backslashes: C:\\users.
new_reference_prefix String The directory path prefix to use to replace the prefix you specify in manipulate_reference_prefix. When a document has a reference that matches the manipulate_reference_prefix, the connector replaces the prefix with this value. For example \\\\testshare\\. You must escape backslashes in file paths. For example, for Windows, use double backslashes: C:\\users.

Example Configuration

{
	"directoryPathCSVs" : "C:\\users,C:\\Documents",
	"directoryRecursive": true,
	"servicePort": 8002,
	"aciPort": 8000,
	"manipulate_reference_prefix": "C:\\Stuff",
	"new_reference_prefix": "\\\\share\\"
}

Filesystem_onsite Connector Destination

This section outlines the options that you can set for the destination that the connector indexes into. You can use these in the JSON object that you pass to the destination parameter in the Create Connector API.

Note: All the options are case sensitive.

Required Parameters

Parameter Type Description
action Enum The action to take when indexing documents. You can use the following options:
  • addtotextindex. Add documents directly to a Haven OnDemand text index.

Parameters for Add to Text Index Action

The following parameters are required in the destination JSON object when action is set to addtotextindex

Parameter Type Description
index String The name of the text index that you want to index documents into. This index must already exist in Haven OnDemand (created by the Create Text Index API).

Example Destination

{
	"action": "addtotextindex",
	"index": "testindex"
}

Filesystem_onsite Connector Schedule

This section outlines the options that you can set for the schedule that the connector runs on. You can use these in the JSON object that you pass to the schedule parameter in the Create Connector API.

Note: All the options are case sensitive.

Required Parameters

Parameter Type Description
frequency Object The frequency configuration that describes how often to run the connector.

The frequency object must contain the following parameter:

Parameter Type Description
frequency_type Enum The type of frequency configuration to use. This setting affects the other parameters that you must set in the frequency object. You can use one of the following values:
  • seconds. The connector frequency is set in seconds. You must also specify the interval parameter.

When you have set the frequency_type parameter to seconds, you must also set the following parameters:

Parameter Type Description
interval Integer The number of seconds between each connector run. This interval measures from the start of one connector run to the start of the next.
Note: The exact interval that the connector uses might vary by up to 30 minutes, depending on load on the system and the scheduler.

Optional Parameters

Parameter Type Description
occurrences Integer The number of times to attempt to schedule a connector run. If you do not set occurrences, the number of runs is unlimited.
start_time String The time of day to start the connector, in one of the following date formats:
  • HH:mm:ss Z
  • HH:mm:ss ZZ
  • HH:mm:ss
If you add a schedule, and set start_time, the connector runs at the start time, and then after every interval elapses.
If you add a schedule, but do not set start_time, the connector runs each time the service starts, and then after every interval elapses.
If you do not add a schedule, and you do not set start_time, the connector runs each time the service starts.

Example Configuration

{
	"occurrences": 5,
	"start_time": "11:55:00",
	"frequency": {
		"frequency_type": "seconds",
		"interval": 21600
	}
}

Filesystem_onsite Connector Limits

The File System Onsite Flavor Connector has the following limits:

Schedule

Property Max Limit
interval 31536000

Static_resource_unit_cost

It costs 1 static resource unit to create a filesystem_onsite flavor connector.