Automated workflows

The Automated Workflows API and Service allows you to register actions, register triggers, and send triggers. An automated workflow in Relativity is composed of one trigger and multiple actions.

Common use cases:

• Register Automated Workflows Actions
• Register Automated Workflows Triggers
• Send Automated Workflows Triggers

Fundamentals of automated workflows

An automated workflow is composed of one trigger and multiple actions.

Triggers

Think of a trigger as an event that a workflow is listening to, to start its execution.

Trigger types:

• Manual Trigger—a trigger that can only start a workflow manually with the press of a button. The types listed below can also be manually triggered.
• Event Trigger—a trigger that listens for an event or trigger to happen, to start the workflow.
• Scheduled Trigger—a trigger that starts a workflow periodically, such as daily, monthly, weekly, or hourly.

Actions

An action is an operation that a workflow should perform. Actions are executed from top to bottom. Actions and triggers can have parameters, called inputs in the Automated Workflows API.

Actions can report statuses to the workflow they are running from. The statuses are:

• Not Run
• Pending
• In Progress
• Completed
• Completed with Errors
• Failed
• Canceled

Some of these statuses are affected by user interaction. For instance a cancellation of a workflow done by a user will render the status of the action as Canceled. Some are based on a success or failure of calling an API defined in the action. For instance, a Completed with Errors status received as the response of an API call will render the action as Completed with Errors.

Troubleshooting information

Some troubleshooting tips for working with automated workflows programmatically.

• Event handlers do not benefit from the built-in IoC container registration that a Relativity Kepler does. You need to either create your own registration for the event handler or manually create the dependencies for it.
• When reusing code in between a Kepler Service and an event handler, you may see install errors in the event handler not being able to find the class, or the instance being null.
• the "x-csrf-header" header is required for Kepler Calls. Use a "-" as its value.

• Take precautions to avoid circular dependencies with triggering workflows.

Automated Workflows API content

.NET API

• Automated Workflows API - Relativity.AutomatedWorkflows.SDK. This package contains the Relativity Automated Workflows SDK to integrate with the Automated Workflows framework, e.g. register actions, register triggers and send triggers

REST services

• Automated Workflows REST Service - Relativity.REST/API/relativity-automated-workflows. Exposes REST endpoints to integrate with the Automated Workflows framework, e.g. register actions, register triggers and send triggers

Version History