Getting Started with AireFlow

What is AireFlow?

AireFlow is an event driven workflow system for coordinating real-world processes using human-actionable tasks. There are three main concepts that define how AireFlow works: tasks, events & workflow definitions. Workflow definitions define templates for tasks to be created when certain events happen.

Some examples of tasks could be:

• Reviewing a form submission
• Sending an email to a clinician
• Waiting for a patient to respond to a form

Some examples of events could be:

• A form being submitted
• A button being clicked in a third party system
• A task being created
• A task being completed

AireFlow is intended for integration with other systems rather than being a standalone service. The preferred approach is to use our multi-tenanted production instance. However, in certain situations where it is required, we are able to create on-prem installations.

How do I create real tasks?

Before you can create task instances for a real world use case, you must start with a workflow definition to describe the type of tasks you want to create.

Once you've defined your task, you need to specify which type of event will cause a task instance to be created by adding a trigger.

Now that you have a task definition with a trigger, whenever the relevant event happens a new task instance will be created. Most workflows will need to start with a Custom Event, which is fired by calling the events API. Alternatively, to test your workflow from the management screens, go to the Event Definitions page and click the send icon on the right hand side of an event. Enter the relevant values and click Fire Event to simulate a call to the events API.

How can I see what AireFlow is doing?

The easiest way to see what AireFlow is doing is to visit the Event Log, where you can see a list of every event that has been processed. This screen will show you both custom events and task events, so you can see which events have been sent from external systems (such as AireForms) via the api, as well as events that have been emitted by tasks being created and updated.

You can also search by any field to narrow the Event Log down to some more specific events, for example you could enter a subject ID in the search bar to see all events for a particular patient, or you could enter a workflow name to see any events from a specific workflow.

How do I create a tenant?

Tenants are created & managed via AireIdentity