Skip to main content

Automation export and import

In briefAutomation export and import move a bundle of workflows, calendars, frequencies, properties, thresholds, resources and tags from one environment or tenant into another. Export returns exactly the objects you list; import applies a bundle as a single all-or-nothing transaction, matching existing objects by name.

WhereThere is no screen: both are API operations, run by an administrator with a client. Both need permissions that reach every workspace — see Permissions.

When

  • You are carrying a configuration built in a test environment into production.
  • You are lifting a working pattern from one institution's tenant into another.

To promote a single workflow through its own lifecycle, use Versions and deployments instead — usually the right choice.

How

  1. Export the objects you want, listing every calendar, frequency, property, threshold and resource the workflows use — export does not follow references.
  2. Import the bundle in the default mode, which refuses the whole import if any object already exists, or in overwrite mode to update existing objects in place.
  3. Move new objects out of the General workspace to where they belong.
  4. Re-enter every encrypted property value by hand.
Notes
  • Workflow names are matched without regard to case; every other kind of object is matched exactly.
  • Import points references to calendars, frequencies, thresholds, resources and tags at the objects in the target environment. A reference to an object deleted there is refused, not moved to a namesake.
  • Import also points jobs' cross-workflow dependencies, scripts, runners, agent pools, agents and connections at the target's objects by name; one that matches nothing keeps its identifier, with a warning.
  • Every imported job gets a fresh identity.
  • Imported jobs' custom fields are checked as a save checks them; a job with no value gets the field's default, a value that does not fit refuses the whole import, and a value for a field that was deleted or has never existed here is removed and listed in the response.
Watch out
  • Encrypted property values are never exported; those properties arrive empty.
  • Overwrite mode restores and overwrites a deleted object whose name is in the bundle.
  • A timed-out import (408) may still complete. Check before retrying.
  • An import is not checked for sub-workflows that are undeployed where the workflow runs Latest.