Models

The Workflow Designer uses models to refer to the different building blocks of a workflow:

Model Description
Process A business process diagram that uses the Business Process Model and Notation (BPMN) standard.
Form A form presenting or requesting information that a workflow users interacts with.

Find and view models

Every workspace and app has a Models page where you can see the models associated with the workspace or the app, with various options to help you efficiently locate and view your workflow models:

  • Filter by name: Enter part or all of a model name to narrow down the list of models.
  • View options: Click Sliders icon View options to open the controls for changing how models are shown:
    • View: Select List view or Grid view to change the layout.
    • Sort: Choose to sort by Name or Key, and in Ascending or Descending order.
  • Filter by tags: Filter models by one or more tags.

Adding models

The Add icon Create button on the Models page of a workspace or app allows you to:

  • Create new workflow models from scratch by defining their basic properties.
  • Import existing workflow definitions from BPMN or XML files or forms from FORM files.
  • Include models from other workflows or other workspaces into your current app, allowing for reuse and consolidation of forms and processes.

Manage models

After you added models, you can manage them by modifying their properties, downloading definitions, tracking their usage, starring them for quick access, or removing them when they are no longer needed.

  1. On the Models page of a workspace or an app, locate the desired model.
  2. Click the More icon more icon next to it.

    A drop-down menu appears with available actions:

    ActionDescription
    EditOpens the model in the process form designer for modifications, in the Editing page.
    DownloadDownloads the model file to your local machine. This is useful for backup, version control, or sharing outside of the Workflow Designer.
    PropertiesOpens a dialog box where you can view and edit the model metadata, including the name, key, tags, and description.

    You must open the model in an app to modify the model key.

    UsageShows a list of other processes, forms, or apps where the selected model is currently being used. This is a critical feature for understanding dependencies before making changes or removing a model.
    Star model Marks the model as a favorite, making it easier to visually find it.
    RemoveDeletes the model permanently from the Workflow Designer.

    Removing a model is a permanent action. If the model is referenced or used in any other processes, form, or application, the removal causes errors or breaks functionality in those dependent items. Always check the usage of a model before removing it.

Restore a previous version of a model

You can restore a previous version of a process or form from the model Editing page:

  1. In the toolbar, click Version explorer icon the version explorer icon.
  2. Select a past model version.

    A preview of the selected version appears.

  3. Click the Revert to this version button.
  4. In the Revert this model dialog box, click Accept to confirm the change and close the version explorer.

A new version of the model is created based on the selected past version.