Sequential Workflow Editor Docs

📄️ Introduction to Sequential Workflow Editor

Powerful workflow editor builder for sequential workflows. Written in TypeScript. Mainly designed to work with the Sequential Workflow Designer component. To execute your model you may use the Sequential Workflow Machine or any other workflow engine. It supports front-end and back-end strict validation of the model. 0 external dependencies.

📄️ Initialize with JS or TS

In this tutorial we will show you how to initialize the Sequential Workflow Editor with JavaScript or TypeScript.

📄️ Initialize with React

In this tutorial we will show you how to initialize the Sequential Workflow Editor with React.

📄️ Initialize with Angular

In this tutorial we will show you how to initialize the Sequential Workflow Editor with Angular.

📄️ Initialize Pro

Create a new auth token for your GitHub account with the read:packages permission. Next, create .npmrc file in the root folder of your project and pass there your auth token.

📄️ Variables

The Sequential Workflow Editor enables you to establish variables that can be utilized by the workflow steps. In the editor, variables are organized into scopes, following a similar pattern as most programming languages. When a variable is defined in the parent scope, it can be accessed in the child scope, but not vice versa.

📄️ Definition Activator

When you have created a definition model you may want to use it to create a definition. The most popular use case is to create a start definition for the designer.

📄️ Dynamic Model

In most parts of this documentation and our example, the model is static. At development time, we define the model, the steps, and the properties of each step. However, in some cases, we need to create a dynamic model. For example, we may have a separate editor outside the workflow designer that allows the user to define steps, etc. This issue also applies to simpler scenarios, such as dynamic choices in a dropdown. This article explains how to handle these scenarios.

📄️ Updating Model

During the development of your application, you may need to update the model. For example, a step that initially required setting a single property might now require setting two properties. If you simply extend the model by adding a new property, the Sequential Workflow Editor will crash for definitions created before the update.