Workflow Packages

Workflow Packages

Concept

A Workflow Package is a configuration of workflows that you bundle and import into different staging or integration environments. When you export a configuration, you assign a version number to the resulting Workflow Package. MediationZone stores multiple versions of a Workflow Package in an environment so that you can roll back or switch between versions quickly. MediationZone does not create or manage a source control or artifact repository. To version-control Workflow Packages across environments, store them in an artifact or image repository that you manage outside MediationZone.

You use Workflow Packages to move configuration data between environments such as development, test, and production.

The key features of Workflow Packages are the following:

  • Versioning: The package name and version number uniquely identify the contents of a Workflow Package. To version-control Workflow Packages across environments, store them in an artifact or image repository that you manage outside Usage Engine.

  • Rollback: You can roll back to, or switch between, versions of a package that are stored in the environment.

  • Predictable: The same content is guaranteed in all environments.

  • Dependent: Simple dependency handling.

Workflow Packages are accessed and managed from the System Exporter (Manage → System Exporter).

Workflow Packages Management

In the System Exporter, set the Export type to Workflow Package. There are two main sections – the Available entries list on the left and the Logs screen on the right.

system exporter-wfpackage.png
Workflow Packages Selection Screen

At the top to the right, there are buttons used to manage Workflow Packages.

Workflow Package management buttons

Button

Description

Button

Description

Export

Opens the Workflow Package export pop-up dialog.

Refresh

Refreshes the Available entries list.

Option

Not available when Workflow Package is selected as the export type.

Expand all

Expands all available workflows in the entries list.

Collapse all

Collapses all available workflows in the entries list.

To create a Workflow Package, select the list of workflows to include and click the Export button. This opens a dialog.

Workflow package export dialog

Setting

Description

Setting

Description

Package name

Specify the name of the Workflow Package.

Package version

Designate the Workflow Package version. Only numbers can be entered.

Output option

You can specify either a Download or a Commit Workflow Package export format.

You can cancel the Workflow Package creation by clicking Close at any time or create the Workflow Package by filling in all the necessary information and clicking the Export button.

When a successful export has been created a pop-up dialog is shown with the title and download link of the Workflow Package. Follow the download link to retrieve a copy of the exported workflow, and Close it by clicking the button.