Ethel Docs

Mock runners

These runners are generally used in testing and getting to know how ethel works. They don't contact any source or target system, they just update the message object and generate other tasks if other runners are configured.

The runners are:

MockExtractor

Demo only

This runner mocks extracting objects from a source system

Configuration options
Attribute Data type Default Description
addMessage boolean false Whether to add an object to the body to simulate larger extractors
batchConfig number | BatchConfig none See batches
cancelCheckNumber number 100 How often, in tasks raised, to check if the extract should be cancelled
generateError number none Whether to generate a random error. The smaller the number the more likely an error. 1 gives an error every time.
messages number 10 The number of tasks to create
randomiseWait boolean false Whether to randomise the wait number
wait number none Milliseconds to wait before raising the next task

Message attributes

If configured, it adds the following from a SharePoint message 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

MockTransformer

Demo only

This runner mocks transforming the message

Configuration options
Attribute Data type Default Description
crash boolean false Generate a node crash event to test how the system goes down and recovers
generateError number none Whether to generate a random error. The smaller the number the more likely an error. 1 gives an error every time.
randomiseWait boolean false Whether to randomise the wait number
wait number none Milliseconds to wait before raising the next task

Message attributes

This runner does not use or update the message object.


MockLoader

Demo only

This runner mocks loading objects into a target system

Configuration options
Attribute Data type Default Description
addHash boolean false Whether to save the extractHash lookup
generateError number false Whether to generate a random error. The smaller the number the more likely an error. 1 gives an error every time.
randomiseWait boolean false Whether to randomise the wait number
wait number none Milliseconds to wait before raising the next task.

Message attributes
Option Data type Description
extractHash Lookup The extract hash object

This runner does not update the message object.