Versions Compared

Old Version 1

changes.mady.by.user Robert Alexander Marshall

Saved on

compared with

New Version Current

changes.mady.by.user Robert Alexander Marshall

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Excerpt
hiddentrue
namerefinedpageimage
Image Removed

Table of Contents
maxLevel3
minLevel2
absoluteUrltrue
excludeSee also
typeflat
separatorpipe

Translate your server workflow to cloud compatible JSON code

...

Overview

You can use the workflow translator for cloud tool in your server or data server app to translate a workflow template in your instance to a cloud-compatible JSON code workflow. The translated JSON code template can be copied and added to a space in your cloud instance using the code editor in the Comala Document Management app in Confluence Cloud.

...

Translate your server workflow to a cloud-compatible workflow

Excerpt
nameusingtranslator_1

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.

A global administrator must enable the workflow translator for your Confluence server or data center instance.

In the space document management dashboard:

  • open the ellipsis menu for a space scope workflow

Image Added

Choose Edit to open the workflow builder.

Image Added

Choose the Cloud Translator button.

Image Added

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

cdmc_workflowtranslator_untranslated.pngImage Added
Info

Before translating the workflow, you can edit the server workflow markup in the Actual Workflow dialog box. Changes made in this dialog box are retained when you return to the workflow builder and markup editor in your server or data center app.

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

cdmc_workflowtranslator_highlightedunsupported_translated.pngImage Added

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

Image Added

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

cdmc_worklfowtranslator_extract_unsupportedmacros.pngImage Added

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 includes the following warning message about different functionalities in the 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

Image Added
Info

All dialog boxes in the Workflow Translator for Cloud are scrollable if required to view all the content.

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

Image Added

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.

Suppose you copy several templates and save them as text files before adding them to the cloud app. In that case, use a code editor rather than a text editor to avoid the creation of unrecognized characters in the JSON code, such as “ (curled) in place of " (straight).

Invalid workflow

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

Image Added

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

If the error persists, contact Appfire support.

Add your cloud-compatible JSON code as a workflow schema to your cloud site

Excerpt
nameusingtranslator_2

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.

cdmc_documentmanagmentdashboard_cloud_bundledworkflows_no_active_wf.pngImage Added

  • choose Create New Workflow

cdmc_createnewworkflow_visualbuilder.pngImage Added

  • select the Code Editor icon

The Workflow schema code for the base two-

...

state workflow is displayed.

cdm_cloud_code_editor_pasted_crewatenewworkflow_base_workflow.pngImage Added

  • 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

cdm_cloud_code_editor_pasted_tranalatedworkflow.pngImage Added

  • choose Save

  • choose Exit

cdmc_documentmanagmentdashboard_cloud_translated_workflow added as custom_wf.pngImage Added

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 Untranslated Macros dialog box in the hosted app Workflow Translator for Cloud.

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

The workflow, including workflow triggers, can be edited in both the cloud app code editor and the visual editor.

Unsupported elements

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

The following macros are not supported

  • get-metadata

  • set-metadata

The following parameters for the state macro are not supported

  • hidefrompath

  • hideselection

  • taskable

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.

Elements with different functionalities

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

  • a workflow trigger with a supported event in the cloud is translated. However, a trigger with no supported event in the cloud is not translated

  • workflow trigger actions with a supported action in the cloud are only translated if the trigger event is translated.

Some triggers can be translated with empty trigger actions if there is no supported cloud workflow trigger action.

Workflow parameters, although translated in the tool, also have different functionality in the cloud, and these should be reviewed in use and, if required, updated/amended by editing the workflow parameter in the workflow builder visual editor.

The submit transition is not translated directly, but when present in the server workflow, it is created in cloud-compatible JSON code as a select transition with a single destination state.

Info

Atlassian continually updates the capabilities of the Confluence Cloud platform. We are also committed to developing our cloud apps, including translating additional workflow elements and parameters to cloud-compatible JSON code using Workflow Translator for Cloud in our server and data center apps.