Checklist#

Overview#

The Checklist widget supports Checklist execution. Use this widget instead of embedding checklist execution logic inside a generic Component widget, as it provides more predictable results and better alignment with Checklist workflows.

General Steps#

To use the Checklist widget in a UI Page, follow the steps below:

1. In any UI Page in Build mode, select the Checklist from the widgets list located on the left side of the page; drag and drop to the desired place in the UI Page.
2. Enter the Settings section of the widget through the three vertical dots.
3. In the General tab, provide a name and a description for the widget. Use the toggle buttons to specify whether the widget should be visible, display the header, or allow full screen mode. Additionally, determine if the widget can be opened as an image in a new tab or exported as an image.

Widget Customization#

1. Optionally, in the Style tab, you can define a Border Width and Color.

   

2. In the Setup tab, configure the Perform Checklist Mode:

   • Preview - displays the checklist in read-only mode.
   • Perform - allows the execution of the checklist directly in the UI Page, mirroring the behavior of the Checklist page.

   

3. In the Links tab, define the links between this widget and other elements of the UI Page. The widget must have a Checklist Instance and a Material as inputs.

   

   You can also configure these links in the Links tab of the UI page.

   

4. Select Save and Close to apply the configuration. The widget will be changed accordingly.

Real Use Case#

The Checklist widget requires two inputs - Checklist Instance and Material - which must be linked to service calls defined in the UI Page. The example below shows how to configure these links.

1. Add the Checklist widget from the Business category to the UI Page.

2. Fill in the General and Style tabs, and configure the Setup tab as needed.

3. In the Links tab, configure the following inputs:

   For the Material:

   • Source - Select the source service call (in this example, GetDataForPerformChecklistAssemblyStation).
   • Output - Choose the expected output (in this example, output$Material).
   • Target - Select Checklist.
   • Input - Choose Material.

   

   For the Checklist Instance:

   • Source - Select the source service call (in this example, GetDataForPerformChecklistAssemblyStation).
   • Output - Choose the expected output (in this example, output$ChecklistInstance).
   • Target - Select Checklist.
   • Input - Choose Checklist Instance.

   

   You can also configure these links in the Links tab of the UI Page.

   

4. Select Save and Close to apply the configuration.