Skip to main content
Version: Current

Migration of Automation

Overview​

The Automation Migration feature allows you to move suspended automation instances from one agent version to another.

This is especially useful for:

  • Long-running automations
  • Human-in-the-loop processes
  • Scenarios where a newer agent version contains fixes or enhancements

Instead of restarting automation from scratch, migration ensures that existing suspended instances continue execution on the newer version.


Accessing Migration​

To access the Migration feature:

  1. Click on the Settings (⚙️) icon in the top-right corner.
  2. Navigate to Tools → Migrations.

Migration Page


Permissions​

To perform automation migration, a user must have:

  • Migrate Automation → Allows creating and executing migrations
  • View BPA Process
  • View Process Instance Details

Key Concepts​

Migration​

A Migration defines how automation instances move from one version to another, including:

  • Source Version
  • Target Version
  • Activity Mapping

Activity Mapping​

Activity mapping determines how execution resumes in the target version.

  • Auto Mapping

    • Based on internal IDs or activity names
  • Manual Mapping

    • Required when activities are renamed, removed, or restructured

Migration Mapping


Migration Instance​

Each automation selected for migration is tracked individually:

  • Pre-migration state
  • Migration status
  • Errors (if any)

Prerequisites​

Before migrating:

  • Automation must be in Suspended state
  • Must NOT be in Debug mode
  • Source version must match the automation version
  • Target agent version must exist

Creating a Migration​

Step 1: Select Automations​

  1. Click New Migration
  2. Select one or more suspended automations

Migration Mapping


Step 2: Configure Migration​

Provide:

  • Migration Name
  • Target Version

System auto-fills:

  • Automation Name
  • Agent Name
  • Source Version

Migration Mapping


Step 3: Review Activity Mapping​

  • Validate auto-generated mappings
  • Adjust mappings if required

⚠️ Migration will re-route execution to the mapped activity in the target version. Incorrect mapping can lead to inconsistent behavior.


Step 4: Create or Migrate​

  • Create → Saves migration configuration (Pending state)
  • Migrate → Immediately executes migration

Migration Page


Creating vs Executing Migration​

ActionDescription
CreateSaves migration configuration without executing
MigrateExecutes migration immediately
Apply Migration (later)Executes a previously created migration

Migration Templates (Bulk Migration)​

When multiple automations of the same agent need migration:

  • Create a migration once
  • Reuse it as a template
  • Apply it to multiple automation instances

This enables:

  • Consistent mappings
  • Faster bulk migration
  • Reduced manual effort

Migration List Page​

The Migrations page shows all migrations.

You can view in:

  • Card View
  • Table View

Available Actions​

ActionDescription
ViewView migration configuration
Apply MigrationExecute pending migration
Reports / DetailsView migration results
DeleteRemove migration record

Migration Execution​

Once triggered, migration runs in the background.

What Happens Internally​

  1. State Snapshot

    • Backup of current execution state
  2. Version Update

    • Instance updated to target version
  3. Recursive Update

    • Includes sub-processes
  4. Entity Remapping

    • Logs
    • Tasks
    • Bookmarks
  5. Execution Continuity

    • Missing steps are marked as Skipped

Validation​

Before execution, system validates:

  • Automation is suspended
  • Version alignment
  • Mapping correctness
  • Target activity availability

Migration Summary​

Provides execution insights:

Metrics​

  • Total
  • Success
  • Failed
  • Running
  • Progress %

Refresh​

  • Re-syncs migration data with the latest execution state
  • Instantly updates metrics (Total, Success, Failed, Running, Progress %)
  • Reloads instance statuses and error logs without page reload

Instance Details​

  • Status per automation
  • Error logs (if failed)

Activity Mapping View​

  • Shows actual source → target mapping per instance

Post Migration​

  • Automation resumes from mapped activity
  • Runs under the new agent version

⚠️ If migration fails:

  • Review error logs
  • Fix mapping or structural issues
  • Retry migration

Important Notes​

  • Migration is only supported for Suspended automations
  • Always review activity mappings carefully
  • Structural changes between versions may require manual mapping
  • Use templates for bulk and consistent migrations