---
tags:
- UI Page widgets
alias: user-guide-uipage-widgets-checklist
widgetname: Checklist
description: "This documentation explains how to utilize and configure the Checklist Widget."
---

# Checklist

:core-entitytypes-checklist-lg:{style="font-size: 100px"}

## 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

{% include-markdown 'includes/pages/ui_widgets_general_steps.md' %}

![Checklist Widget - General tab](images/checklist-widget/checklist_widget_general.png)

## Widget Customization

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

    ![Checklist Widget - Style tab](images/checklist-widget/checklist_widget_style.png)

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.

    ![Checklist Widget - Setup tab](images/checklist-widget/checklist_widget_setup.png)

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.

    ![Checklist Widget - Links tab](images/checklist-widget/checklist_widget_link.png)

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

    ![Checklist Widget - Links viewed in the UI pages Links tab ](images/checklist-widget/checklist_widget_inputs.png)

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`.

    ![Checklist Widget - Material input in the links tab](images/checklist-widget/checklist_widget_links2.2.png)

    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`.

    ![Checklist Widget - Checklist Instance input in the links tab](images/checklist-widget/checklist_widget_links2.1.png)

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

    ![Checklist Widget - UI page links tab](images/checklist-widget/checklist_widget_links1.png)

4. Select **Save and Close** to apply the configuration.