Screens

Screens (or forms) are used throughout the frontend to collect information from the user.

There are two different types of screens within the system:

Screens are stored within the hocs-workflow service. The name of the file is the name of the screen.

These forms are embedded are used outside of BPMN workflows and aren’t directly involved in the process flow of a case.

These screens are used directly within a cases BPMN flow and outcomes of these can drive the direction of a case.

Schema

{
  "title": "",
  "defaultActionLabel": "",
  "fields": [],
  "secondaryActions": [],
  "validation": "{}",
  "props": {},
  "summary": []
}

The title of the form to display to the user.

The label that is displayed as the submit button.

A list of fields that should be displayed to the user.

A list of secondary actions that the user can select.

These don’t cause a form submission and thus case data is not updated with current form values on click.

Form level validation that is run on submission of the form (link).

This is a collection of ‘other’ key-value pairs that should be passed through to the resulting component.

A list of basic mapping displaysAllows for a basic field case data mapping display under the form.

{
  "label": "", 
  "renderer": "", 
  "attribute": ""
}

The label to show to the user.

An optional renderer that designates the format that the data should be rendered as.

The case data value that the data should be pulled from.