Ethel Docs

These runners are related to working with OpenText Content Server.

The runners documented here are:

Other related runners:

OTCS connection

The connection object for all OTCS runners supports the following attributes:

Attribute	Data type	Default	Description
username	string, mandatory	none	The username for the connection.
password	string, mandatory	none	The password for the connection.
domain	string	none	The domain for the connection.
restUrl	string, mandatory for REST API	none	The URL to the REST API.
authUrl	string, mandatory for SOAP API	none	The URL to the SOAP authentication API
docManUrl	string, mandatory for SOAP API	none	The URL to the SOAP document management API
preferV1	boolean	false	Set to `true` to use the v1 REST API routes
useSoap	boolean	false	Set to `true` to use the SOAP API instead of the REST API

Example REST connection object:

{
  "username": "otadmin@otds.admin",
  "password": "otds",
  "restUrl": "http://server.lan/cs/cs/api/"
}

Example SOAP connection object:

{
  "username": "otadmin@otds.admin",
  "password": "otds",
  "authUrl": "http://server.lan/cws/services/Authentication",
  "docManUrl": "http://server.lan/cws/services/DocumentManagement",
  "useSoap": true
}

The SOAP webservices will have different URLs depending on whether they are using Java or .NET. The example above uses the default Java URL. A .NET URL would be http://server.lan/cws/DocumentManagement.svc. It's always safest to put the URL in a browser to check you have the right format.

OTCSExtractor

Production

This runner will extract information from Content Server. It will not extract any files from Content Server. To extract files from Content Server to upload to other systems add the OTCSStaging runner after this runner.

Configuration options

Option	Data type	Default	Description
addSummary	boolean	`false`	Whether to add a summary for each extractRoot, adds load so only use when needed
batchConfig	number \| BatchConfig, mandatory	none	See batches
cancelCheckNumber	number	`50`	How often, in tasks raised, to check if the extract should be cancelled
connection	LookupDetails, mandatory	none	The name and key to the lookup with the OTCS connection details
extractRoot	number \| number[], mandatory	none	The id numbers of containers to extract.
filters	string \| string[]	['extractItem.properties.type=ne\|[144,749]']	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	`quarantinedOTCSExtractor`	Name value for the quarantine lookup name

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

extractItem metadata for the item extracted
quarantine quarantine lookup for the item
extractHash lookup name used to store the extract hash, if hashName is configured

OTCSStaging

Production

This runner will copy files from Content Server to a staging location.

Configuration options

Option	Data type	Default	Description
allVersions	boolean	`false`	Whether to extract all versions or just the latest
connection	LookupDetails, mandatory	none	The name and key to the lookup with the OTCS connection details.
extractItem	string	`extractItem`	The message attribute containing the extracted item
stagingProvider	any, mandatory	none	The configuration details for the storage provider
streamFilesLimit	number	`52428800`	Number of bytes when the extractor should use a large file streaming approach

Message attributes

Option	Data type	Description
extractItem	CSNode, mandatory	The item extracted from Content Server

It adds the following attributes to the message object:

sourceFile the extracted file information

OTCSBWSLoader

Production

This runner will create business workspace objects in Content Server. Often used with database or text file extractors to create business workspaces.

Configuration options

Option	Data type	Default	Description
addFullItem	boolean	`false`	Whether to add the full created item to the message or just the node ID.
addHash	boolean	`true`	Whether to save the extractHash lookup
connection	LookupDetails, mandatory	none	The name and key to the lookup with the OTCS connection details.
handleExisting	string	`error`	This runner supports three options: `complete` - complete the task and add the hash `error` - throw an error
ignoreCase	boolean	`false`	When checking for existing items, use case sensitive or insenstive checks
loadItem	stromg	`loadItem`	The message attribute that contains the OTCSLoadItem object
loadItemTemplate	stromg	`loadItem`	The load item object with template literals. If populated loadItem is ignored.
loadedItemLabel	string	`OTCSLoadedItem`	The label to use for the loaded item in the message

Message attributes

Option	Data type	Description
loadItem	OTCSLoadItem, mandatory	The information used by the loader to create the item.

Message attribute names can be changed in the configuration options.

It adds the following attributes to the message object:

OTCSLoadedItem the created object, either the ID number of the full object depending on configuration

OTCSLoader

Production

This runner will create objects in Content Server

Configuration options

Option	Data type	Default	Description
addCategoriesAfterCreate	boolean	`false`	Whether to add the categories when the item is created or in the next transaction
addFullItem	boolean	`false`	Whether to add the full created item to the message or just the node ID
addHash	boolean	`true`	Whether to save the extractHash lookup
connection	LookupDetails, mandatory	none	The name and key to the lookup with the OTCS connection details.
handleExisting	string	`error`	This runner supports three options: `complete` - complete the task and add the hash `error` - throw an error `overwrite` - overwrite the existing file with the newly extracted file
ignoreCase	boolean	`false`	When checking for existing items, use case sensitive or insenstive checks
loadItem	stromg	`loadItem`	The message attribute that contains the OTCSLoadItem object
loadedItemLabel	string	`OTCSLoadedItem`	The label to use for the loaded item in the message

Message attributes

Option	Data type	Description
extractHash	Lookup	The extract hash object
loadItem	OTCSLoadItem, mandatory	The information used by the loader to create the item.

Message attribute names can be changed in the configuration options.

It adds the following attributes to the message object:

OTCSLoadedItem the created object, either the ID number of the full object depending on configuration

FSToOTCSTransformer

Production

This runner will transform file system objects into Content Server objects. This runner assumes the message was created by the FileSystemExtractor

Configuration options

Option	Data type	Default	Description
extractItem	string	`extractItem`	The message attribute containing the extracted item
loadRoot	number, mandatory	none	The id where objects will be loaded.
removeExtension	boolean	`false`	Whether to remove the extension from the name of document objects
sourceFile	string	`sourceFile`	The message attribute with the extracted file information

Message attributes

Option	Data type	Description
extractItem	FSExtractItem, mandatory	The FSExtractItem object
sourceFile	string \| 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 OTCSLoadItem object

SPToOTCSTransformer

Production

This runner will transform SharePoint objects into Content Server objects. This runner assumes the message was created by the SharePointStaging runner.

Configuration options

Option	Data type	Default	Description
extractFields	string	`extractFields`	The message attribute containing the extracted field definitions
extractItem	string	`extractItem`	The message attribute containing the SharePoint item
extractRoot	string	`extractRoot`	The message attribute with the initial extractor config
extractValues	string	`extractValues`	The message attribute containing the extracted field values
handleMetadataError	string	`error`	Whether to throw an error or log a warning if there is an error in mapping the metadata. Use warning for just logging a warning
loadRoot	number, mandatory	none	The id number of the container where the load starts
metadataMapping	{ [source: string]: string }	none	The mappings of SharePoint field names to CS attribute ids. Key value pairs with the SharePoint field as the key.
removeExtension	boolean	`false`	Whether to remove the extension from the name of document objects
sourceFile	string	`sourceFile`	The message attribute with the extracted file information

Message attributes

Option	Data type	Description
extractFields	object[]	The extracted SharePoint field definitions
extractItem	object, mandatory	The SharePoint list item ojbect
extractRoot	object, mandatory	The configuration used for the extract item
extractValues	{ [EntityPropertyName: string]: any }	The extracted SharePoint field values
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 OTCSLoadItem object

Content Server runners

OTCS connection

OTCSExtractor

Configuration options

OTCSStaging

Configuration options

Message attributes

OTCSBWSLoader

Configuration options

Message attributes

OTCSLoader

Configuration options

Message attributes

FSToOTCSTransformer

Configuration options

Message attributes

SPToOTCSTransformer

Configuration options

Message attributes