Skip to content

Import a Workflow

Using import functionality, you can create a new workflow or add it as a version to an existing workflow in your account. The import process preserves workflow configuration while handling environment variables, errors, and role permissions.

When a workflow is imported, its prompts, properties, and linked workflows with their configurations are carried over. This ensures that the workflow works seamlessly in the new system. Additionally, any models present in the exported workflow — specifically external and open-source models — will be automatically linked and integrated. If any child workflows are missing or there are conflicts, the system will notify you.

Creating a new workflow involves importing a .zip package from your local system with the flow definition, app definition, and environment variables JSON files from another environment. During the creation journey, assign the imported workflow a unique name to avoid conflicts with existing workflow. Learn more.

When importing a workflow version to a parent workflow, the imported flow definition becomes the new in-dev version, overriding the flow, app definition, and environment variable files. The previous version is renamed and saved in the list, with optional backup of the current version available.

Once the import is complete, the workflow canvas is updated with the latest configuration changes.

Note

Users with only Viewer permissions can't import a workflow.

Best Practices

  • Export the workflow first: Always export the current workflow version before importing. This ensures you have all the necessary configurations.

  • Check the environment and load dependencies: Ensure the new environment is set up with all required dependencies such as models, linked workflows, and other configurations before importing. This helps ensure compatibility and smooth functionality after the import.

    • Verify that the correct model is already available in the new environment.
    • Ensure any linked workflows are already present in the new environment, by the same name as it's preferred for auto linking.
    • Check environment variables and configuration files to prevent any mismatches.

  • Import the parent workflow and version: After verifying the dependencies in the new environment, import the parent workflow and any associated versions. Ensure there are no conflicts with existing workflows.

Import a Workflow

To initiate a workflow creation journey through the import functionality, follow these steps:

  1. Log in → In AI for Process Modules top menu → Click Workflows.

    access workflows

  2. Do one of the following based on your requirements:

  • If you don't have any existing workflows and want to create one by importing from another environment, click Import a workflow. Import a workflow
  • If you already have workflows deployed, the following page is displayed. To import a workflow, select the relevant tab on the Workflows dashboard and click Import a workflow. Workflow dashboard
  1. In the Import workflow window, providing the following information is mandatory.
    • Workflow Name: Provide a unique workflow name.
    • Flow definition file: Upload the required flow_definition.json file from your local directory. The file includes the workflow's canvas definitions (node definitions) and AI node configurations, including prompts, hyperparameters, and timeout information.

Providing the following information is optional:

  • App definition file: Upload the required app_definition.json file, which includes general information about the workflow version and guardrails
  • Environment variable file: Upload the required env_variables.json file, which includes the environment variables set for the workflow.

Note

  • The Import button is enabled when the required information is provided.
  • AI node models and guardrail configurations may not be available in the current account. Reconfigure them before running the workflow.
  • The model name from the original workflow is imported as a placeholder into the AI node's Select Model field. Later, you can assign a value from the available options.
  • The values for System Prompt, Prompt, Timeout, and Hyperparameters are imported for the AI node.

  1. Click Import.
    2. click import

Once the import is complete, the system will redirect you to the Workflow page, where you can access the new workflow's canvas by clicking Go to flow. tool flow page

The imported workflow is listed under All Workflows and My Workflows on the Workflow dashboard.

Important

  • The status of the imported workflow is set to In Development.
  • The node types, workflow descriptions, input and output variables, scanners, and sync/async setup are kept intact during the import.
  • If the AI node's model doesn't match any available models in the current account, the model field is kept empty, but all prompt definitions are imported.
  • API keys are't transferred during the import process.
  • The imported workflow can't be shared with other users.

Failure Scenarios

The import may fail due to an incompatible workflow version, a corrupt file, an internal error, or missing guardrails in the current account, triggering an error notification.

Import Workflow as a Version

Use the Import functionality under Workflows > Configurations to add a workflow as a version of a parent workflow, replacing the existing one. You should back up the current in-development version to preserve its configuration definitions. The export file is saved as 'Exported_Workflow Name.zip.’

When you import an workflow as a version, you must upload all the following files:

  • Flow definition file: Upload the required flow_definition.json file from your local directory. The file includes the workflow's canvas definitions (node definitions) and AI node configurations, including prompts, hyperparameters, and timeout information.
  • App definition file: Upload the required app_definition.json file, which includes general information about the workflow version and guardrails.
  • Environment variable file: Upload the required env_variables.json file, which includes the environment variables set for the workflow. Any conflicts between environment variables in the parent workflow and the imported version must be resolved. Learn more.

Steps to Import a Workflow

Note

To import a workflow as a version, the parent workflows must be deployed in your account.

To import a workflow as a version, follow the steps below:

  1. Log in → In AI for Process Modules top menu → Click Workflows.

  2. Click the Workflows tab on the top navigation bar, and select the workflow you want to import.

  3. Click Configurations on the left menu.

  4. Scroll down to the Import a workflow section and click Import. import a workflow

  5. (Optional) In the following dialog, select the Back up your current workflow option to preserve the data of the version being replaced.

    import confirmation

NOTE

Backing up automatically exports and saves the .zip package of the workflow definition files to the designated location when the import is initiated. Learn more.

If you choose not to back up/export the workflow configurations, unselect the back-up option and proceed to the next step.

  1. Click Import in the confirmation dialog.
  2. In the Import WOrkflow window, upload the required JSON files and click Import.

Note

Workflow Name is't required since the current version’s name is assigned.

The imported workflow is validated, and if no errors exist, the workflow is imported successfully.

The imported version is added under the parent workflow.

Important

  • The status of the parent workflow is set to "In Development.”
  • Updated on reflects the date the version was imported.

Conflicting Environment Variables

When importing environment variables during workflow version import, conflicts may arise between those of the parent workflow and the imported version. If neither workflow has environment variables, no conflicts occur.

Important

Verify the environment variables before importing. For conflicting values, the existing ones are retained if not changed.

You must resolve conflicting variables by either keeping the existing value (of the version being replaced) or replacing them (with values from the imported workflow) to ensure a smooth import process.

When conflicting environment variables are detected, it displays the following window. To resolve conflicts, follow the steps below:

  1. Select the Conflicting variables tab.
  2. Select either Overwrite to replace the existing variable with the imported one or select Keep existing.
  3. Click Proceed to continue importing. import tool

Editing Existing and Imported Variables

To resolve conflicts by editing either the existing or imported environment variables, select the relevant tab in the Edit Environment Variable window and follow the steps provided.

  1. Click the Three-dots (Ellipsis) icon of the required variable.

  2. Select Edit.
    edit variable

  3. Change the required values in the Edit Variable window.

  4. Click Save.
    save variable

To cancel the import process during the conflicting environment variables resolution, click Cancel in the Edit Environment Variable window, and then click Confirm.

  • Create a Workflow- Create a new workflow and configure its flow.
  • Export a Workflow- Export the set configurations of a workflow for data sharing and preservation.
  • Deploy a Workflow- Explore synchronous and asynchronous deployment methods for workflow integration.
  • Configure a Workflow- Modify the workflow's details, configure settings, or undeploy and delete it if unused.