Ethel Docs

File system runners

These runners are related to working with the file system:

FileSystemExtractor

Production

This runner extracts items from a file system. One task per document or directory

Configuration options
Option Data type Default Description
addSummary boolean false Whether to capture detailed information about the extract location
batchConfig number | BatchConfig, mandatory none See batches
cancelCheckNumber number 100 How often, in tasks raised, to check if the extract should be cancelled
extractRoot string | string[], mandatory none Path to the directory or directories where extract starts.
followSymLink boolean false Whether to use the target of a link object as the object or not
filters string | string[] [
'extractItem.name=true|eq|[".DS_Store","Thumbs.db"]',
'extractItem.name=sw|~$',
'extractItem.type=ne|File',
]		 The extract items to be ignored or included. See Ignoring extract items for more information.
hashName string, mandatory none The lookup name for the extract hash
quarantinedLookupName string quarantinedFileSystemExtractor Name value for the quarantine lookup
recursive boolean true Whether to extract the root folder descendants
stagingProvider any none The configuration details for the storage provider
Message attributes

It adds the following attributes to the message object of raised tasks:

  • extractItem information about the extracted item
  • quarantine the lookup to add to quarantine the file
  • sourceFile the extracted file information

FileSystemLoader

Production

This runner adds a file to the specified file path

Configuration options
Option Data type Default Description
addHash boolean true Whether to save the extractHash lookup
handleExisting string error This runner supports three options:
  • complete - complete the task and add the hash
  • error - throw an error, this is the default option
  • overwrite - overwrite the existing file with the newly extracted file
loadItem string loadItem The message attribute that contains the FSLoadItem object
Message attributes
Option Data type Description
extractHash Lookup The extract hash object
loadItem, mandatory FSLoadItem The information used by the loader to create the item.

Message attribute names can be changed in the configuration options.

This runner does not change the message object.

FSToFSTransformer

Tested

This runner will transform file system extract items into file system load items on another path. This runner assumes the message was created by the FileSystemExtractor

Configuration options
Option Data type Default Description
loadRoot, mandatory number none The path to the directory where loading starts.
Message attributes
Option Data type Description
extractItem, mandatory Lookup The FSExtractItem object.
sourceFile string | SourceFile The extracted file information

It adds the following attributes to the message object:

  • loadItem the FSLoadItem object

OTCSToFSTransformer

Production

This runner will transform the message object for the FileSystemLoader

Configuration options
Option Data type Default Description
addHash boolean true Whether to add the hash for shortcuts
appendVersionToFileName boolean false Whether to append the version number before the file extension
createMetadataFile boolean false Whether to create a file with the OTCS metadata
createShortcutFile boolean false Whether to create a file with the path to the shortcut target
extractItem string extractItem The message attribute with the CSNode object
loadRoot number, mandatory none The path to the directory where loading starts.
sourceFile string sourceFile The message attribute with the extracted file information
Message attributes
Option Data type Description
extractItem, mandatory Lookup The FSExtractItem object.
sourceFile SourceFile[] The extracted file information

Message attribute names can be changed in the configuration options.

It adds the following attributes to the message object:

  • loadItem the FSLoadItem object

SPToFSTransformer

Developed

This runner will transform the message object for the FileSystemLoader

Configuration options
Option Data type Default Description
appendVersionToFileName boolean false Whether to append the version number before the file extension
createMetadataFile boolean false Whether to create a file with the OTCS metadata
extractItem string extractItem The message attribute with the SharePoint object
extractRoot string extractRoot The message attribute with with the configuration used for the extract item
loadRoot number, mandatory none The path to the directory where loading starts
sourceFile string sourceFile The message attribute with the extracted file information
Message attributes
Option Data type Description
item, mandatory any The SharePoint object.
listUrl, mandatory string The SharePoint object.
sourceFile StagedFile[] The extracted file information

Message attribute names can be changed in the configuration options.

It adds the following attributes to the message object:

  • loadPath the path where the file is copied
Driver Lane © 2020-2025