Skip to main content

Manage workflow definitions

Find workflow definitions by name or ID, open their settings, and verify imported designs before using them.

A workflow definition is the editable design that stores the steps, conditions, and variables of a workflow. Approval workflows are created with approval forms. List workflows are configured in a data list and run when their trigger conditions are met. Scheduled workflows run on a schedule you configure.

See the workflow designer overview for approval workflows and Create list workflows for data-list triggers.

View workflow definitions

  • System administrators can go to Admin Center → Workflow settings → Workflow definitions.

  • Application administrators can select the gear icon in their application to open Application Settings → Workflow settings → Workflow definitions.


Filter Workflow Definition

  1. Under Workflow type, choose List workflow, Approval workflow, or Scheduled workflow to narrow the results by type.

  2. Enter all or part of the Workflow name. If you know the exact Workflow ID, use it to find a specific definition.

  3. Select Search. Verify the workflow name, ID, and type on the result before opening its menu.

In Admin Center, use All applications to select an application under its workspace.

Note:

The All applications filter is available in Admin Center. In Application Settings, the list is scoped to the application you opened.


Create a New Scheduled Workflow

Select New workflow → Scheduled workflow. Define the timing and frequency, including the time zone, then complete the workflow design. See Scheduled Workflow for the schedule options and setup steps.


Accessing Workflow Options

Open the three-dot menu next to the workflow name. The available actions depend on the workflow type. To delete multiple definitions, select their rows and use Delete in the upper-right corner. Check each selected workflow ID and its related records before deleting.

Approval Workflow

  • Edit settings opens the workflow's name, identifier, and description.

  • Open form designer opens the designer for the selected workflow.

  • Export to template saves a local copy of the latest definition. Import from template loads a previously exported definition.

  • Delete workflow removes the selected definition and its related records.

The approval workflow menu shows Edit settings, Open form designer, Import from template, Export to template, and Delete workflow.

For a template import, first export a copy of the destination's current definition if it contains work you need to keep. In a test application, open the destination workflow's menu and select Import from template. Reopen the designer and check the imported steps, conditions, variables, and any references to application resources. If you publish the imported design, verify the resulting version in Published workflows and test one submission with sample data.

Warning:

Deleting a workflow definition permanently removes the definition, its workflow instances and tasks, and their related data. You cannot undo this action.

List Workflow

Use Open form designer to edit the workflow or Delete workflow to remove it. The list workflow menu has no template import or export. To set or review its trigger conditions, open the data list's workflow settings.

Scheduled Workflow

  • Edit settings manages settings such as the schedule and time zone. Open form designer opens the designer.

  • Start manually starts a workflow run without waiting for its schedule. Before using it in a test application, review any steps that write records or send messages.

  • Import from template loads a saved scheduled workflow definition. Export to template saves the current definition for reuse. After importing, review the schedule, time zone, and resources in the destination application before testing a run.

  • Delete workflow permanently removes the workflow and its related data.


View details of workflow definitions

Select a workflow name in the list to open its details. Use Open in Designer to edit the definition and Variables → View details to inspect its defined variables. The workflow diagram shows the latest definition's steps. The details also provide Delete, which removes the definition and its related records.

Use Manage published workflows to inspect or export a specific released version. To check the status or version of a particular run, look it up by tracking number in View and manage workflow instances.

Did this answer your question?