Learn how to start a new workflow or open a deployed workflow in the integrated development experience, and then edit, check, and preview its BPMN file.

1. In the business configuration tree of the Reltio IDE extension view, expand the Workflows folder of the tenant, and then create the workflow in one of the following ways:

   To	Do this	Next step
   Create a workflow from a template	Right-click Process Definitions, and select New Workflow.... You can also select the New Workflow... icon on the row. The template contains a start event, one user task named Review, and an end event. The user task has the listeners that a user task requires.	Enter the process ID and the name.
   Create a workflow from a copy of a deployed workflow	Expand Process Definitions, right-click the workflow, and select Duplicate as Draft.... The new workflow is a copy of the deployed workflow.	Enter the process ID and the name.
   Update a deployed workflow	Expand Process Definitions, and select the workflow. The BPMN file of the workflow opens in a new editor tab.	Edit the BPMN file.
   Update a workflow in the custom workflow repository	Expand Process Definitions, and select the BPMN file marked repository. The BPMN file opens in a new editor tab.	Edit the BPMN file.

   Process Definitions lists the workflows that are deployed on the tenant, both built-in and custom. The integrated development experience downloads a copy of each deployed workflow to the Workflows/bpmn/ folder of your tenant folder. The tenant folder is <environment>/<tenant ID>/ in your workspace, the same folder that contains Business Config. When you update a workflow in the custom workflow repository, update it there, so that the repository stays the source of the workflow.

   

   

   

2. For a new workflow, enter the process ID and the name.
   1. In the New workflow on <tenant ID> box, enter the process ID, and then press Enter.

      For New Workflow..., the box is empty. For Duplicate as Draft..., the box shows the original process ID followed by Copy. Edit it to the process ID that you want. The process ID must meet the following rules:

      • It is not the process ID of another new workflow for the tenant. The comparison ignores capitalization.
      • It starts with a letter or an underscore.
      • It contains only letters, digits, underscores, dots, and hyphens.
      • It has 64 characters or fewer.
      If the process ID is already deployed on the tenant, a warning opens. Otherwise, a box titled Display name for <process ID> opens.
   2. (Optional) If a warning opens, respond to it.

      The warning means that a workflow with this process ID is already deployed on the tenant. The process ID determines what the deploy does, so choose one of the following options:

      • To create a separate workflow, close the warning, and then start the workflow again with a different process ID.

      • To add a new version of the deployed workflow, select Use this ID anyway. After the deploy, anything that starts the deployed 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.

   3. In the Display name for <process ID> box, enter the name, and then press Enter.

      For New Workflow..., the box shows the process ID. For Duplicate as Draft..., the box shows the original name followed by (copy).

      If the connected custom workflow repository already has a workflow with this process ID, a message shows where the file is, and the new workflow is not created. Open that file, or start again with a different process ID.

   The new workflow opens as a BPMN file in a new editor tab, and appears under Process Definitions with the pencil icon, marked • draft. Hover over the workflow to see its name, ID, and file. The file is saved as {processId}.bpmn20.xml in the Workflows/bpmn/ folder of your tenant folder. If the custom workflow repository is connected, this folder is the bpmn folder of your copy of the repository.

   

3. In the editor tab of the workflow, edit the BPMN file, and then save the file.

   The BPMN file is XML. Edit it in one of the following ways:

   • Edit the XML in the editor: Add, update, or remove elements, such as tasks, gateways, and sequence flows, to describe your flow.
   • Ask the AI agent to make the change: Describe the change in a natural language prompt, for example, "add a second approval step". The AI agent edits the file in place.

   

   Each step that runs Java logic names the Java class that it calls. Use the class name together with its package, in the form <package>.<ClassName>. The following table shows where to find the class names:

   Java logic	Where to find the class names
   Reltio's built-in Java logic	The New Workflow... template and the copies from Duplicate as Draft... already call these classes. For the classes that you add, see the workflow-custom module in the Workflow repository on GitHub.
   Java logic in a JAR file that is registered on the tenant	Under Java Classes, if the custom workflow repository is connected.
   New or updated Java logic	The classes that you write in Create or update the Java logic.

   To save the file, select File > Save, or press Ctrl+S (Cmd+S on macOS).

   For a deployed workflow, keep the process ID in the file unchanged. If you change it, the deploy creates a separate workflow instead of a new version of this one. After you save the file, local changes appears beside the process ID of the workflow under Process Definitions.

   

   The editor checks the file for errors as you edit it. You review its findings in the next step.

4. Review the findings that the editor reports for the BPMN file. Fix each error before you deploy.

   The editor checks the BPMN as you change it. Each finding appears as an underline on the element and in the Problems panel. To open the panel, select View > Problems. Findings do not block Deploy to Tenant, so a file that has errors can still be deployed. The tenant then rejects the file, or accepts it and fails when someone creates the workflow. Fix every error before you deploy.

   Severity	What to do
   Error (red underline and red icon)	Fix it before you deploy.
   Warning (yellow underline and yellow icon)	Review it, and fix it unless it is expected. For example, the editor shows a warning for a class from your own JAR file, because it checks only Reltio's built-in classes.

   

5. (Optional) For a deployed workflow, to review or undo your changes, right-click the workflow under Process Definitions, and select one of the following actions:

   Action	What it does
   Compare with Last Fetch	Opens a side-by-side view of your file and the version that the integrated development experience last fetched from the tenant.
   Discard Local Changes	Asks you to confirm, and then restores the version that was last fetched from the tenant. Your changes are lost.

   

6. (Optional) Preview the workflow as a diagram to check that the steps are in the order that you designed.
   1. In the business configuration tree, under Process Definitions, right-click the workflow, and select Show BPMN Diagram. You can also select Show BPMN Diagram in the editor toolbar. The diagram opens in a new tab.
   2. To find a step in the BPMN file, select the step in the diagram. The editor moves to that step.

   The diagram is read-only. To change the workflow, change the BPMN file in the editor. If the file is not valid XML, the preview shows the first problem and its line number instead of a diagram.