Connect the custom workflow repository

Learn how to connect the Bitbucket repository that Reltio provides for your custom workflows to the integrated development experience, and review the files in it.

The custom workflow repository is a Bitbucket repository that Reltio provides for your custom workflows. It stores the Java code that your custom workflow steps call, along with any BPMN files you add. After a pull request is merged, a Reltio pipeline builds the Java code into a JAR file. Reltio owns and manages the repository, and grants access to your team. For more information, see configure custom workflows and the Workflow FAQ.

Connect the repository once for each tenant, when a workflow needs new or updated Java logic, or to store the BPMN files of your workflows in it. A workflow that uses only the Java logic that is already on your tenant does not need the repository. For the steps to write the Java logic, see Create or update the Java logic.

Prerequisites

Before you begin, confirm the following requirements:

The workflows of the tenant are loaded in the business configuration tree of the Reltio IDE extension view. For the steps, see View the workflows.
Reltio created the custom workflow repository, and you have its Git URL. If you do not have a repository, contact Reltio Support. For the request, see configure custom workflows.
Your Bitbucket account has access to the custom workflow repository.
Git is installed on your computer. To check, run git --version in a terminal. If the command is not found, add Git to the PATH environment variable of your system, or set the git.path setting in Cursor or VS Code to the location of the Git executable. To install Git, see Git downloads.

To connect the custom workflow repository

In the business configuration tree of the Reltio IDE extension view, expand the Workflows folder of the tenant that you want to connect the repository for, and select Connect Custom Workflow Repository.... Alternatively, right-click Workflows, and select Connect Custom Workflow Repository....

A box titled Connect Custom Workflow Repository opens at the top of the window.

Figure 1. Connect Custom Workflow Repository menu
In the Connect Custom Workflow Repository box, enter the Git URL of the custom workflow repository, and then press Enter.
The URL must meet the following rules:
- It uses the form https://..., ssh://..., or git@host:path. For example,
  - https://bitbucket.org/acme/acme-workflows.git
  - ssh://git@bitbucket.org/acme/acme-workflows.git
  - git@bitbucket.org:acme/acme-workflows.git
- It does not contain a password. To sign in, use SSH or your Git credential manager.
- It does not contain spaces.
The integrated development experience starts to copy the repository to your computer, into the Workflows folder under the tenant's folder in your workspace. A notification titled Cloning Custom Workflow Repository... shows the progress. In the rest of this topic, the copy is called your copy of the repository.

New workflows that you have not deployed yet are in Workflows/bpmn/. They stay there and become part of your copy of the repository, so the next commit includes them. A message tells you when this applies. If one of these files has the same name as a file in the repository, your file is kept, and the message names it.
(Optional) If Git asks you to sign in, sign in.

Git asks you to sign in when the repository requires it. Sign in with your Git credential manager or your SSH key, depending on how you set up Git. When the copy finishes, a notification confirms the connection: Connected the Custom Workflow Repository for "<tenant ID>". If it built a new JAR, use Refresh JARs to pick it up. The business configuration tree updates, and you review it in the next step.

In the business configuration tree of the Reltio IDE extension view, under the Workflows folder of the tenant, review the new groups. The Connect Custom Workflow Repository... row is replaced by the following items:


Group	What it contains
Java Classes	The Java files of the repository, grouped by module. Each class shows its package.
Java Tests	The Java test files, grouped by module.
Process Definitions	The BPMN files of the repository, in the same list as your deployed and new workflows. Each file shows its process ID, repository, and its status.

Java Classes and Java Tests appear while the repository is connected, even when they are empty, and each shows the number of files. To open a file in the editor, select it.

Figure 2. Java Classes and Java Tests in the Workflows folder

Result

The Workflows row of the tenant shows repository connected. Hover over the row to see the repository URL and the folder of your copy.

Each BPMN file of the repository appears in its own row under Process Definitions, with the repository icon, even when the tenant has a deployed workflow with the same process ID. Its status compares the file in your copy of the repository with the workflow that has the same process ID on the tenant:


Status	Meaning
not deployed	No workflow with this process ID is deployed on the tenant.
differs from tenant	The deployed workflow differs from the file. Any difference counts, including formatting, comments, and diagram changes.
same as tenant	The deployed workflow matches the file.
deployed • not compared yet	A workflow with this process ID is deployed, and the file has not been compared with it since you last edited a BPMN file of the repository. To compare, right-click Workflows, and select Refresh Sync Status.

To work with the repository, right-click Workflows in the business configuration tree, and select one of the following actions:


Action	What it does
Refresh Sync Status	Compares the BPMN files with the deployed workflows, and updates their statuses. New and deleted files appear in the list automatically.
Open Repository Folder	Opens the folder of your copy of the repository on your computer.
Open Repository in Browser	Opens the repository URL in your browser.
Disconnect Custom Workflow Repository	Asks you to confirm, and then removes the connection. For details, see the following paragraphs.

Disconnect the repository

When you select Disconnect Custom Workflow Repository, a confirmation box lists what happens to the files. Select Disconnect to continue. The following changes apply:

The files that came from the repository are removed from the Workflows folder, so that you can connect another repository.
Your new workflows and the files that you added yourself are kept.
Repository files that have uncommitted changes are kept.
Commits that you have not pushed are lost.

If the integrated development experience cannot read the repository, every file in the Workflows folder stays in place, and only the connection and the local Git history are removed.

A notification confirms the result: Tenant "<tenant ID>" is no longer connected to a Custom Workflow Repository, and its files were removed from Workflows/. The Connect Custom Workflow Repository... row appears again.

Disconnecting does not change anything on the tenant or in the Bitbucket repository.

Verification steps

To confirm that the repository is connected, check the business configuration tree of the Reltio IDE extension view:

Under the Workflows folder of the tenant, confirm that Connect Custom Workflow Repository... no longer appears, and that the Workflows row shows repository connected.
Expand Java Classes and Java Tests. Confirm that the groups list the Java files of the repository.
If the repository contains BPMN files, expand Process Definitions. Confirm that each file shows its process ID and repository. After the comparison, each file also shows a status.

Next steps

To create or update a workflow, see Create or update a workflow. If the connection fails, see Troubleshoot workflows.

Unify and manage your data

Connect the custom workflow repository

Footer