Workflow Engine v0.1.0 API Reference

This is the WorkflowEngine api module. For more info see the README

This module represents a piece of required or optional data that can be attached to a workflow step or a workflow in general.

In-memory storage is an in memory implementation of the WE.StorageAdapter behaviour. It is a naieve implementation mainly used for testing purposes or to get up to speed quickly in dev. The data in this storage is stored in memory and won't persist once the application is stopped.

A behaviour for storage adapters. This adapter is responsible for storing the engine's history and the documents into a storage solution. By default the WE.Adapter.Local is loaded and used. It is recommended to only use this in memory adapter in dev and test becasue a restart will purge all its data.

The workflow module is a module used for describing a workflow. A workflow is a collection of steps tied together by sequence flows. There are two types of steps. These are events and tasks. An event is a step where the workflow is notified of something. It is a single point in time. A task is a step with a start, an end and a duration.