List of Plugins

These plug-ins are included with Muse (via the builtins package).

Event Log Writer

Writes the event log to disk. The log will be stored in the task folder provided by the Local Storage Location plug-in. The log is written in 2 formats, JSON and plain text. Events are written as they are received.

JUnit Report

Writes a JUnit-compatible report with the result of a Task Suite. The file will be written to the location specified by the Local Storage Location plugin.

List of Plug-ins

This plug-in is a container for other plug-ins. Plug-ins included in this list will be initialized in the same order they are in the list - allowing precise control over the order of plug-in initialization.

To use this effectively, set the Apply Automatically parameter of all included plug-ins to false.

Local Storage Location

Provides other plug-ins with the location where automation artifacts (outputs) should be stored for local storage.

Parameters:

  • Base location - the path

Save Result to Local Storage (Disk)

Saves results (produced by other plug-ins) to local storage. Uses the Local Storage plug-in to determine the location.

Parameters:

  • Save results from events - If true, listen for TaskResultStoredEvents and store those results immediately.
  • Delete results from context - If true and saving results from events, remove the result from the context after saving them (by setting the context variable to null). This may allow the result object to be garbage collected, if it is not referenced elsewhere, reducing memory usage for long-running tasks.
  • Save when task completes - If true, look for Data Collectors in the context when the task completes and store their TaskResultData locally.

Task Defaults Initializer

For each default value defined in the task, store it into the execution context before the task starts.

Parameters:

  • Overwrite - If true, overwrite existing values in the context (default is false).

Task Result Calculator

Determines the result of the task. This plug-in is also a DataCollector and the TaskResultData may be stored locally as result.json.

Parameters:

  • Fail on failure - if true, any event with the failure tag will be added to the list of failures in the task result. Default is true.
  • Fail on error - if true, any event with the error tag will be added to the list of failures in the task result. Default is true.
  • Fail on interrupt - if true, any InterruptedEventType event will be added to the list of failures in the task result. Default is true.

Task Suite Result Calculator

Collects and calculates the results of a task suite. This plug-in is also a DataCollector and the TaskResultData may be stored locally as TaskSuiteResultCounts.json.

Variable List Initializer

Injects the variables in a Variable List project resource into a task execution context.

Parameters:

  • List Id - the resource id the variable list

Wait After Step

Executes a wait after each step finishes. This can be used to slow down the task in order to, for example, emulate a task executing at human speed.

Parameters:

  • Delay - the amount of time to wait (in ms). Default is 1000 (1 second).