Edit

Migrate packages of Tasks and BPs

When exporting and importing the model, its Training Configuration settings (see Business Process > Configure AutoML) are not preserved and reset to default.

Machine Learning Pipelines are preserved as is.

The best way to migrate a Process or a Task from one WorkFusion environment to another, for example, from DEV to PROD, is to create a Package and import it.

A Package is a ZIP archive containing:

• XML file with Task or BP export information (design, settings)
• All Data Stores that are used in a Task or BP steps
• Meta information

You must have the Import and Export permission to view, import, and export packages.

Create package

1. Go to Business Processes (or Tasks) > Packages tab.

2. Click the New Package button.

   

3. Enter a meaningful Name and Description for the package.

   

4. Choose Data Stores to include in the Package by ticking the appropriate checkboxes.

   The list contains all Data Stores used in BP Tasks (Manual or Bot). You can uncheck a Data Store if you are sure that the target WorkFusion environment contains one with the same name and appropriate data.

5. Choose the Target Version for current Package. This feature helps move processes from instances with older version installed to new instances and vice versa.

6. Click the Save button.

Download package

To download a Package to your local machine, click the appropriate Download button in the Actions grid column.

As a result, the Package will be downloaded as a ZIP file.

You can delete a Package if it is not needed anymore. Click an arrow icon near the Download button and select the Delete action.

Importing package

1. Log in to the target WorkFusion environment, for example, PROD or UAT.

2. Go to Business Processes (Tasks) and click Import Package in the top right corner.

   

3. Upload the Package ZIP archive downloaded from the source environment and click the Preview Package button.

   

4. The Package Import page is shown. Resolve all possible conflicts:

   

   You could see the following warnings:

   • "<N> business processes of version <date> are active": In this case, decide whether you want to overwrite active processes or not. You can optionally pause or stop active processes.
   • "The package was exported from WF version <XXX>. This environment has WF version (YYY)": In this case, the import can potentially cause some issues. Check its results in the generated log file.

5. If you are importing the same Package more than once, you need to create a new version or overwrite a particular version of this Task (BP).
   When overwriting an existing process version, you can have a diff view for process structure and each process step. This function can help make a decision whether to rewrite a process or not.

   

   After applying overwrite in import, the following changes are applied:

   • Completed tasks and processes will have an old version.
   • Draft tasks and processes will have a new version.
   • Processing tasks and processes without significant changes (steps added, deleted, or substituted with other steps) will have a new version.
   • Schedules are switched to a new version.

   If the imported and existing process versions have significant differences (steps added, deleted, or substituted with other steps), you need a special Advanced Package Import permission to make such potentially dangerous overwrite. For details, see Role Management.

   Click to see detailed description

   This import type can be required when there is a need to update active process runs, avoid schedule re-creation, or reuse already configured start-task plugins by UUID.

   When importing a Package with a modified process structure, the following notifications are shown:

   • Amount of added or removed process steps and rules
   • Amount of active process runs

   

   When you overwrite an active process run, its result data can be inconsistent because of added/removed/changed steps and rules.

6. If your package contains Data Stores and/or included Bot Configs, you can get the following Resolve Import Conflict section(s):

   

   Choose one of the options (Replace, Keep, or Rename) for each conflict section.

   • Data Stores are compared by structure and number of records.

   • For included Bot configs, you can toggle a diff view.

7. When all import conflicts are resolved, click the Import Package button in the bottom left corner.

8. If the Package has been successfully imported, you will see the import result message.

   

   1. You can download a detailed import Report by clicking the View import log file link. This log can be useful in case some issues are found after import.
   2. When a Package has been imported, WorkFusion checks its structure and displays useful notes and action items to be done before running the imported Task or Process (e.g. "Define global variables")

9. View the imported BP (Task) or navigate elsewhere using main menu.

The imported BP or Task will create a Run in a Draft state.

When a new version of a Task is imported to a target WorkFusion environment, Automation settings, Workforce, and Prices parameters will be copied from the previous version that already exists on this environment.

Version labels

Let's assume that you have a BP and:

• Created the first package for this BP and imported this package to the PROD environment.
• Edited BP and saved it.
• Created the second package for this BP and imported this package to the PROD environment.

As a result, each new imported Package creates a BP or Task Run that is automatically labeled by a timestamp.

The latest version is marked with green color, other versions have grey color.

The following Task and BP settings are NOT included in a Package:

• Workforce and Prices for each Manual task (when importing, these settings will be taken from target instance defaults)
• Global variable values (when importing, respective columns are created in the "Global Variables" datastore, but with empty values)
• Bonus Rules
• Custom Attributes
• Priority
• Permanent open tasks
• Forcefully complete option