This site has moved to the integrated Appfire documentation and information site for our apps.

From February 2024 this site is no longer updated.

Take a look here! If you have any questions please email support@appfire.com

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 15 Current »

Overview

This is an initial release of our Workflow Translator for Cloud. Further versions will have greater capability. For example, support for the translation of further server workflow elements and parameters 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 from the workflow builder by setting the following dark feature: comalatech.workflows.migration.translator.enabled

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 and the cloud compatible JSON code 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.

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

Some elements and parameters of the server workflow may not be cloud JSON compatible.

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

Paste the cloud compatible JSON 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 will need to be recreated manually in the cloud workflow using workflow builder or code editor in cloud, for example, workflow triggers. Cloud JSON triggers use different functionality, 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 JSON code.

  • Workflow

    • name

    • description (if present

    • state

      • name

      • description (if present)

      • final

      • color

    • state transitions

      • select*

      • approved

      • rejected

      • updated

      • expired

    • approval

      • name

      • description ((if present)

      • approve button label (if present)

      • reject button label (if present)

* The submit transition is not translated directly but when 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 these have different functionality to those in server.

Workflow JSON code triggers can be created and used in a cloud but these have different functionality to those in server.

Metadata and other values 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 paramrter

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

  • taskable parameter

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

  • duedate parameter

    • manual addition of an expiry due date for each state using workflow builder in cloud

  • changeduedate parameter

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

For a workflow approval

  • credentials parameter

    • requirements for user authentication using an e-signature can be added for each approval in cloud workflow builder

  • assignable parameter

    • each approval can be set as Users can be assigned through UI in cloud workflow builder or code editor

  • minimum parameter

    • the minimum parameter and value can be set in the cloud workflow builder or code editor

  • a number of approval parameters used to manage reviewers, for example selectedApprover are not translated using the cloud translator

    • approval reviewer assignment can be configured in the cloud workflow builder or code editor with the option to limit the setting by adding one or more users and/or user groups

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.

Further releases of the Workflow Translator for Cloud tool will include additional support for the translation of workflow elements and parameters to cloud compatible JSON code and may include some currently listed above as not supported.

Use workflow translator

In your server instance open workflow builder for your workflow.

When enabled as a dark feature for your server instance, Workflow Translator for Cloud is available when using workflow builder in the global workflows dashboard, the space tools document management dashboard and from a page when a page workflow is applied.

In the space tools document management dashboard open the ellipsis menu for a space workflow.

Choose Edit to open workflow builder.

Choose the Cloud Translator button.

The current workflow template markup for server is displayed in the Actual Workflow dialog box.

The server workflow markup can be edited in the Actual Workflow dialog box prior to choosing to translate the workflow to cloud compatible JSON code. Changes made in this dialog box will also be retained on returning to server workflow builder visual editor and markup editor.

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

  • the cloud compatible JSON code is displayed in the Translated Workflow dialog box

  • workflow elements and parameters that have not been translated by the cloud translator are displayed in the Messages dialog box

Unsupported elements

Elements and parameters that are not supported by the workflow translator may be available in cloud but with different features and functionality. Some of these, for example, elements such as triggers and workflow elements parameters 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 cloud

  • confluence usernames used in the workflow must be replaced with user corresponding cloudIDs

  • e-signatures availability only with time-based token

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

Choose the Translated Workflow copy icon to copy the cloud compatible JSON code to the clipboard.

The workflow code can be then pasted to the code editor in the Comala Document Management Cloud space settings document management dashboard and saved as a new workflow in your cloud site.

Or copy and save in a text or code editor if you are translating a number of server workflows.

Invalid workflow

If the server workflow cannot be translated a warning message is displayed.

Check that the server workflow is a valid workflow. If error persists content our support team.

See also

Comala Document Management Server and Data Center

Migration: Comala Document Management to Cloud

Comala Document Management Cloud

  • No labels