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

Workflow translator for cloud

Owned by Robert Alexander Marshall
Last updated: Jun 19, 2023
4 min read
1 Overview | 2 Workflow Cloud translator view | 3 Workflow elements translated to cloud compatible JSON | 4 What is not translated to cloud compatible code? | 5 Use workflow translator

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.

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 that are not translated to cloud compatible code by the tool are listed in the Messages dialog box.

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).

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)

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.

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

Use workflow translator

See also

Comala Document Management Server and Data Center

Migration: Comala Document Management to Cloud

Comala Document Management Cloud