Deploy a workflow

Learn how to deploy the BPMN file of a new or updated workflow from the integrated development experience to the tenant, and how to respond to the confirmations that appear.

When you deploy a workflow, the integrated development experience sends its BPMN file to the tenant. The process ID in the file determines what the deploy does. A new process ID adds a separate workflow. A process ID that is already deployed adds a new version of that workflow. New instances of the workflow use the deployed version, and instances that are already running are not changed. For details, see Process IDs.

Prerequisites

Before you begin, confirm the following requirements:

The BPMN file of the workflow is created or updated, and the Problems panel shows no errors for it. For the steps, see Create or update the BPMN file.
If the workflow calls new or updated Java logic, its JAR file is registered on the tenant. For the steps, see Create or update the Java logic.
Your Reltio user has the ROLE_WORKFLOW_MANAGER role on the tenant. This role is required to deploy a workflow.

In the business configuration tree of the Reltio IDE extension view, under Workflows > Process Definitions, right-click the workflow, and select Deploy to Tenant. Alternatively, select the Deploy to Tenant icon on the row or in the editor toolbar.

For a workflow in the custom workflow repository, deploy the BPMN file from its own row, marked repository. For a deployed workflow, Deploy to Tenant is available only when the workflow has local changes. If the file has unsaved changes, the integrated development experience saves them before it deploys.

If the process ID is already deployed on the tenant, a confirmation dialog opens. Respond to it in the next step. Otherwise, the deploy starts.

Figure 1. Deploy to Tenant on a workflow

(Optional) If a confirmation dialog opens, respond to it.

Read the dialog, and then select Deploy new version to continue, or close the dialog to cancel. When the AI agent deploys the workflow, the confirmation dialog always opens.

The dialog includes the following messages:


Message	What happens if you continue
The process ID is already deployed on the tenant.	The deploy adds a new version of that workflow. Anything that starts the workflow, such as a data change request, starts your version, for every entity type that uses the workflow. Instances that are already running are not changed.
The process ID is a Reltio built-in workflow that is already deployed.	The deploy adds a new version of the built-in workflow. Reltio starts built-in workflows automatically, for example when a user submits a data change request, so your version runs for every entity type that uses the workflow.
The name of the BPMN file and the process ID inside the file are different.	The tenant uses the process ID inside the file, not the file name. That process ID determines whether the deploy adds a separate workflow or a new version of a deployed workflow.

Figure 2. Confirmation dialog for a deployed workflow

(Optional) If a message says that the workflow changed on the tenant since your last fetch, respond to it.
The message opens when the version on the tenant differs from the version that you opened. If you deploy, your version becomes the new version on the tenant. Select one of the following options in the message:
- To compare the two versions first, select Review changes. A side-by-side view of the version on the tenant and your version opens. A second message asks whether to deploy your version. Select Deploy to continue, or close the message to cancel.
- To deploy your version without comparing, select Deploy anyway.
- To cancel, close the message.

Result

The integrated development experience deploys the workflow to the tenant, and a notification shows Deployed "<process ID>" to <tenant ID>. If the Workflow Adapter returns a warning, a second notification shows it.

Under Process Definitions, a new workflow no longer shows • draft, and an updated workflow no longer shows local changes. If the workflow does not appear, right-click Workflows, and select Refresh Workflows.

The BPMN file stays in the Workflows/bpmn/ folder of your tenant folder. The deploy does not commit or push it. If the custom workflow repository is connected, the BPMN file of the repository keeps its own row under Process Definitions. To update its status, right-click Workflows, and select Refresh Sync Status. For the status meanings, see Connect the custom workflow repository.

Verification steps

To confirm that the workflow is deployed, perform the following steps:

In the business configuration tree, expand Workflows > Process Definitions. Confirm that the workflow appears with its name, followed by its process ID, and that it does not show • draft or local changes.
Hover over the workflow. Confirm that the tooltip shows Custom workflow, your user name next to Deployed by, and the deploy time next to Deployed.
If the workflow is in the custom workflow repository, right-click Workflows, and select Refresh Sync Status. Confirm that the BPMN file of the repository shows same as tenant.

Next steps

A workflow with a new process ID is not started by existing triggers, such as data change requests. To start it, use the Workflow API. If the deploy fails, see Troubleshoot workflows.

Unify and manage your data

Deploy a workflow

Footer