Workflow forms best practices

Recommendation

Design forms for consistency and better user experience.

Impact

  • Improve user experience and usability of forms in workflows.

Recommended action

Example workflow form

  • Form structure:
    • Add subtitles to break up longer forms and to offer a clear grouping of attributes.
    • Numbering the subtitles allows you to add additional information in your business process documentation and gives users a better sense of where they are in the process.
    • Where possible, consider splitting certain forms into multiple screens or steps, such as 1. General Information or 2. Data Flow in the image above.
  • User task names:
    • When using multiple forms for a single task, give users a clear indication of which step they are in by including the information in the user task names, for example Create new Data Demand (1/2).
  • Field types:
    • Where rich text input is not needed, use a plain text input to make the forms less complex.
  • Documentation:
    • The Description attribute is visible in the tables of the Tasks page before the task is opened. It also appears below the task name once a task is open.
  • Buttons
    • Add the same set of buttons for all forms if possible:
      • Back: go back to the previous form.
      • Next: go to the next form.
    • Add additional buttons depending on the use cases of the workflows:
      • Save: save the current status.
      • Cancel: cancel (end) the workflow.
      • Delete: delete created resources, for example assets and domains.
      • Submit: submit the changes and go to the next form.
    • Avoid using duplicate or general values for outcome buttons. Instead, use more descriptive values which are unique. For example, include the form name and add the value of the button: rolesNext.