Use Workflow Translator for Cloud in server to translate your server workflows to cloud compatible code

Overview

You can use the workflow builder Workflow Translator for Cloud option (from v6.17.10+) to translate the server workflow into cloud-compatible JSON that can be copied and pasted into the app JSON editor in the cloud app instead of creating a new workflow from scratch in the cloud.

If required, the workflow can then be customized further in the Comala Document Management Cloud app using

Some workflow elements and parameters are not supported in Confluence Cloud and are not translated by the Workflow Translator for Cloud. Some elements, such as triggers, have different functionalities and are not translated. These need to be added to the workflow in the cloud site.

Using the Atlassian migration tool to migrate your Comala workflows from Server is not currently supported. You must install and license the Comala Document Management for Cloud and manually add or create any custom Comala workflow in your Confluence Cloud site.

Differences between our server and cloud apps are listed in a feature matrix comparing Comala Document Management Server and Cloud apps. The workflows bundled with the Comala Document Management for Cloud app have different functionality than those in the server/data center app. Please ensure you review the functionality of these workflows in the cloud.

Workflow translator for cloud

v6.17.10+

In a server or data center, a workflow can be translated to cloud-compatible JSON code using the Workflow Translator for Cloud option in the workflow builder.

The Messages dialog box displays any server or data center app workflow element that cannot be translated. Some later versions of the app also highlight these elements in the workflow markup.

Using the Translated Workflow copy icon option, you can copy the cloud-compatible JSON code to the clipboard. Once copied, you can choose Create New Workflow in your cloud site’s space document management dashboard and paste the code into the code editor.

Some elements and parameters not translated by the server Workflow Translator for Cloud tool, such as triggers, can be created in the cloud, as these have different features and functionality in the cloud platform.

Using Workflow Translator for Cloud

https://fast.wistia.com/embed/medias/pql582luzs.jsonp

Workflow Translator for Cloud is available in the workflow builder in the global workflows dashboard, the space document management dashboard, and from a page when a page workflow is applied.

In the space document management dashboard

  • open the ellipsis menu for a space scope workflow

Choose Edit to open the workflow builder.

Choose the Cloud Translator button.

The Actual Workflow dialog box displays the current server or data center workflow.

Choose the Translate button to translate the server workflow to cloud-compatible JSON code.

The Translated Workflow dialog box displays the cloud-compatible JSON code workflow.

The Messages dialog box displays workflow elements and parameters the cloud translator has not translated.

Unsupported elements

Some elements and parameters the workflow translator does not support are available in the cloud but have different features and functionality. Some of these, such as triggers, can be added to the workflow in the cloud app visual builder or code editor.

The workflow translator v6.18.0+ includes the following in a warning message about different functionalities in cloud:

  • approval user and group condition parameters work slightly differently in the cloud

  • you must replace confluence usernames used in the workflow with the corresponding userIds in the cloud

  • e-signature authentication for an approval reviewer is only available through the use of a time-based token

Copy the cloud-compatible JSON code to the clipboard using the Translated Workflow copy icon.

Paste the copied workflow template code to the code editor in the Comala Document Management Cloud space document management dashboard and save it as a new workflow in your cloud site space.

Invalid workflow

A warning message is displayed if the translator cannot translate the server workflow.

Check that the server workflow is valid in the server app.

If the error persists, contact our support team.

Add cloud-compatible workflow JSON code to your cloud site

After translating a server workflow into cloud-compatible JSON, this can be copied and pasted into the app code editor in the cloud app instead of creating a new workflow from scratch in the cloud. Once added, this workflow can be updated with both the visual and code editor.

Add the workflow template JSON code

Navigate to the space document management dashboard in the cloud app.

  • choose Create New Workflow

  • select the Code Editor icon

The Workflow schema code for the base two-state workflow is displayed.

  • highlight all the code in the dialog box and delete it

  • paste into the empty Workflow schema dialog box the copied cloud-compatible JSON code

  • choose Save

  • choose Exit

The workflow is added to the dashboard and as an option in the workflow picker when adding a page workflow.

The new workflow does not include any workflow elements and parameters listed in the Messages dialog box in the workflow builder Workflow Translator for Cloud server workflow builder.

You need to review your cloud workflow and edit it where appropriate to meet your needs in the cloud. You need to

The following elements and parameters in our example workflow were listed in the Messages dialog box in the Workflow Translator for Cloud.

Triggers are available in Comala Document Management Cloud but with different functionality.

The following parameters are not available in the cloud

  • hidefrompath

  • hideselection

  • taskable - tasks are not a feature of Confluence Cloud

There is no equivalent selectedApprovers parameter in our cloud app. However, the approval is translated to settings in the cloud that only allow selected approvers to undertake the approval. The approval can be checked using the options in the approval editor in the visual builder in the cloud, and it can also be checked when the workflow is applied to a page.