You are here

Working with the Workflow API

A set of tutorials showing you how to use the Workflow API.

This section of the documentation consists of a number of hands-on tutorials which show you how to use the Workflow API.

CAUTION:
The tutorials must be completed in order.

The Workflow API deals with three main classes of objects:

  1. Workflow process definition
  2. Workflow process
  3. Workflow task

Workflow Process Definition

The workflow process definition can be thought of as a standard workflow type. There are several workflow process definitions included as standard, although the actual definitions available depends on version and type of SkyVault server. For example there are some differences between version 4.0 and 4.2 and between on-premise and the cloud version of SkyVault. Example workflow process definitions include:

  • Group Review and Approve
  • Pooled Review and Approve
  • Send Document(s) for Review

There are a number of other workflow process definitions available.

Workflow Process

A workflow process can be though of as an instance of a workflow process definition. Whereas the process definition is a template, the process itself is an active workflow.

Workflow Task

A workflow process consists of one or more task. The task it a specific item of work that needs to be carried out.

The Workflow API lets you create and work with these objects. The following tutorials demonstrates the most common usage cases.