Skip to end of banner
Go to start of banner

Workflow translator for cloud

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Current »

Overview

Workflow Translator for Cloud - all the server/data center workflow elements may not be translated to cloud-compatible JSON code.

A data center/server workflow can be translated into cloud-compatible JSON code using Workflow Translator for Cloud available in workflow builder.

This feature can be disabled and hidden in workflow builder by the global admin configuration for the app (v6.18.0 or later).

The workflow cloud compatible JSON code can be copied and then added to a cloud site space using the app workflow code editor in cloud.

As some product features in Cloud are different to data center/server, the workflow builder cloud translator will not translate all the elements and parameters of the data center/server workflow into a cloud compatible JSON workflow.

Workflow Translator for Cloud is available when accessing workflow builder for a workflow in the global workflows dashboard; the space settings document management dashboard; and on a page with an applied page workflow.

Workflow Cloud translator view

The workflow cloud translator button (if enabled) is displayed in the workflow builder navigator panel.

Workflow translator for cloud can be used to translate the server workflow for a selected workflow to cloud compatible JSON code. This can be copied and pasted to the Comala Document Management Cloud workflow code editor in a cloud site.

Choose the Cloud Translator button in the workflow builder navigation panel to view the current workflow in the cloud translator.

Choose the Translate button to translate and display the cloud-compatible JSON code for the workflow in the Translated Workflow dialog box.

Any workflow elements or parameters not translated to cloud-compatible code by the tool are displayed in the Messages dialog box.

Some elements and parameters of the server workflow may not be translated. The workflow must be edited in the cloud app.

Select the copy icon next to the Translated workflow box title to copy the workflow cloud-compatible JSON code to the clipboard.

Paste the cloud compatible code to the Comala Document Management Cloud workflow code editor in a space in your cloud site (or paste as a text to a text/code editor for storage).

Elements listed in the Messages dialog box need to be recreated manually in the cloud workflow using the workflow builder visual editor or the code editor. For example, workflow triggers. Cloud triggers use different functionalities, including different workflow events and trigger actions. The product comparison page for Comala Document Management can be used to check the feature differences between the server and cloud apps.

Workflow elements translated to cloud-compatible JSON

Workflow Translator for Cloud translates the following elements and their parameters of a server workflow into cloud-compatible code.

  • Workflow

    • name

    • description (if present)

    • state

      • name

      • description (if present)

      • final

      • color

      • due date 6.18.0+

    • state transitions

      • select*

      • approved

      • rejected

      • updated

      • expired

    • approval

      • name

      • description ((if present)

      • approve button label (if present)

      • reject button label (if present)

      • credentials 6.18.0+

      • minimum 6.18.0+

      • assignable 6.18.0+

      • user 6.18.0+

      • group 6.18.0+

      • selectedapprover and selectedapprovers 6.18.0+

    • workflow parameters 6.18.0+

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

What is not translated to cloud-compatible code?

Unsupported workflow elements not included in the cloud-compatible JSON code translation

Workflow parameters can be created and used in a cloud but have different functionalities from those in the server app.

Workflow JSON code triggers can be created and used in a cloud but have different functionality from those in the server app.

Metadata and other value references are not translated.

In cloud, unsupported parameters include

For the workflow

  • header parameter

  • footer parameter

For a workflow state

  • hideselection parameter

    • not available in cloud

  • hidefrompath parameter

    • cannot be hidden from the progress bar in the workflow popup

  • taskable parameter

    • manual addition of workflow tasks by a user is not supported

  • changeduedate parameter

    • user by default can edit the due date for a state

Read Confirmations are not translated in the cloud-compatible code. In a cloud site, read confirmations are added using the Comala Read Confirmations Cloud app.

The Workflow Translator for Cloud tool may include additional support to translate workflow elements and parameters to cloud-compatible JSON code includ some currently listed above as not supported.

Use workflow translator

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

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.

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.

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

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.

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.

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

If the error persists, contact our support team.

See also

Comala Document Management Server and Data Center

Migration: Comala Document Management to Cloud

Comala Document Management Cloud

  • No labels