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 2 Next »

Translate your server workflow to cloud compatible JSON code

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.

Add your cloud compatible JSON code as a workflow schema 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 cloud. Once added, this workflow can be then be updated with both the the visual editor and the code editor.

Add the cloud compatible JSON code

Navigate to the cloud app space settings document management dashboard.

Choose Edit Workflow for the current space workflow.

To avoid overwriting an existing cloud workflow, choose one of the workflows installed with the cloud app using Manage Workflows. These installed workflows cannot be overwritten and the editor will save any any changes as a copy.

Select Use Code Editor.

The code editor is only available in the cloud space settings document management dashboard.

The Workflow schema code for the current space workflow is displayed.

Highlight all the code in the dialog box and delete.

Paste into the empty Workflow schema dialog box the cloud compatible JSON code copied from the server workflow builder Workflow Translator for Cloud option

The pasted cloud compatible JSON code will not overwrite the existing space workflow if this was one of the workflows bundled with the app. If you have chosen to edit a custom workflow ensure that the pasted code has a different workflow name to avoid overwriting this workflow.

Choose Apply.

The translated workflow is added to the space settings document management dashboard as the current space workflow.

This workflow will also be available in the workflow picker for the current space.

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

You will need to review your cloud workflow and edit the workflow where appropriate to meet your process needs in cloud including

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

The following elements are not supported:

  • trigger

The following parameters are not supported:

state

  • hidefrompath, hideselection, taskable

Triggers are available in Comala Document Management Cloud but with different functionality. Triggers in cloud are added and edited in workflow builder visual editor

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

The following parameters are not available in cloud

  • hidefrompath

  • hideselection

  • taskable - tasks are not a feature of Confluence Cloud

There is no equivalent selectedApprovers parameter in our cloud app. But the approval is translated to settings in cloud that are set to 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 cloud.

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.

The capabilities of the Confluence Cloud platform are continually updated by Atlassian. We are also committed to developing our cloud apps. This includes further releases of our Workflow Translator for Cloud on our server/data center app to support translating more workflow elements and parameters to cloud compatible JSON code.

  • No labels