User Interface

The App Editor allows the definition of an application bundle of processes, cases and other related models. An App once defined can be published (deployed) to the runtime engines and started by users.

610 design app editor

A list of the existing Apps is displayed, ordered by date or name, with options to:

The following sections describe all the available functionality in detail.

Creating New Apps

Clicking the Create app button opens a dialog that prompts you to enter basic information:

610 app new
  • The display name of the App

  • The App’s unique key

  • An optional description of the App

By clicking Create new app definition, a new app definition is created and you are redirected to the details view of the App where you can make further configurations. See App Editor for more information.

App Details

Here, you see the name, description, version, creator and the modification date of the model as well as the current values of the properties that are used to define the page. The models that are already included in the App are also shown.

610 app details

If you want to see an older version of your model, press on the History button and choose the version you are interested in viewing.

On the top-right, there are these icons:

140 icon edit model

Edits the name, description, and key of the model.

140 icon duplicate model

Duplicates the model.

140 icon delete model

Deletes the model.

140 icon download model

Downloads the app.

610 icon import i18n

Upload a translations file.

610 icon import app

Import an app zip file.

710 icon publish

Publish the model for use.

820 icon model editor

Opens the editor of the model which allows you to modify the content of the model.

App Editor

The App Editor allows you to define a bundle of models to be managed together as an App, including its appearance, features and allowed users.

610 app edit

You can set the following properties of an App:

  • An icon which can be used to distinguish it from other apps.

  • A theme that, similarly to the icon, can be used to further differentiate the App both in Flowable Design and any other application, such as Flowable Work and Flowable Engage.

  • Groups of users that can access the app.

  • Specific users that can access the app.

If the groups and users are left undefined, all groups and users can access the App definition. Please note that the user and group restrictions only apply to Flowable Design and do not have any effect on the runtime behavior of the deployed apps.

To add or remove models from an app, click on the Edit included models button. This opens a dialog that allows you to choose the Process, Case, Form, Decision Table and other models you wish to be included.

610 app include

In order to add models to your app, simply click on an item in the list of models. This model then becomes part of the deployments that takes place when publishing this app. If you want to remove a model from the app, select the model again. Models that are part of the app are indicated by a + icon.

Please be aware that it is not necessary to add models which are referenced in another model. For instance, if you wish to add a process model which contains a User Task referencing a form, you do not have to add that form to your app’s models manually. However, you do have to add the process or case model itself. After saving an App if you view its details again you can see the linked models shown along with those you added explicitly. If the border around a model is dark blue, it means it was added explicitly, otherwise it was included by reference.

Adding FlowApp Pages

An App can also include Page models to provide custom dashboard and views. This kind of App is referred to as a FlowApp. To make a FlowApp you need to enable the "Include FlowApp pages" option. This opens an additional area to add Page models. A FlowApp can be navigated to directly if a FlowApp URL key is given.

610 app pages

Under the Pages table is a dropdown menu that allows you to select a Page model to add. Pages are added to the table in the order they are added. The order of Pages is used by Flowable Work and Flowable Engage when displaying them, and up and down arrows allow you to reorder the Pages in the table.

It is possible to change the label of a Page, so it can have a more application-specific display label. Each Page can also have a URL key that allows the individual Pages to be accessed directly by URL.

Importing Apps

Clicking the Import app button opens a dialog that prompts you to select a file to import.

610 app import

There are options that define how the import should behave:

Option Comment

Renew

Attempt to link users and groups if imported from another system.

Warn

If identical model keys are found, warn the user and stop.

Update

If identical model keys are found, continue and treat as updates.

Create

If identical model keys are found, continue and create as new models.