---
alias: user-guide-checklist-index
description: "This documentation outlines the structure and usage of a checklist system for defined procedures"
---

# Checklist

:lock: Checklist.**Show**

## Overview

A **Checklist** consists of a procedure, in the form of a sequence of **Checklist Items**, that need to be carried out at a specific situation. A good example is a maintenance checklist.

The **Checklist Items** can be of four types:

* **Manual Task** - a manual procedure where additional data can be collected.
* **Manual Action** - a DEE action rule which is manually triggered.
* **Automatic Action** - a DEE action rule which is automatically triggered.
* **Signature** - as item which needs to be signed with the user name and password.

In addition, each **Checklist Item** can be:

* **Sequential** - needs to be performed in a sequence.
* **Floating** - can be performed at any time (not possible for Automatic Actions).

A **Checklist Item** can further be:

* **Optional** - it is not necessary to be carried out (not possible for Automatic Actions), that is, it can be skipped.
* **Mandatory** - it needs to be performed.

A **Checklist** in itself represents only a template or definition, from which instances can be created. A **Checklist Instance** is an active object that is created based on the **Checklist**, and it has a lifetime which is independent from the **Checklist** definition.

A **Checklist** can be executed in two modes:

* **Immediate** - the checklist is completely executed at one time in one shot.
* **Long Running** - the checklist is executed over a long period of time with intermediate data persistency.

It is possible to associate **Checklists** with Material Tracking using the [[materialchecklistcontext-st]] Smart Table.

## Global and Versioned Data

A **Checklist**, being a change controlled object, contains global data and versioned data components, as show in the next picture.

```mermaid
graph TD
subgraph Checklist
Main1["Global Data<br>(Without Change Control)"] --- A1[Scope]
Main2["Versioned Data<br>(With Change Control)"] --- A2[All other]
end

classDef mermaid_title color:#000, fill:#fafafa, stroke:#fafafa, stroke-width:0x, font-size:100%, font-weight:200;
classDef mermaid_start color:#000, fill:#fafafa, stroke:#fafafa, color:#fafafa, stroke-width:0x, font-size:100%, visibility: hidden;
classDef mermaid_businessdata color:#000, fill:#65CDE8, stroke:#65CDE8, stroke-width:0px, font-size:100%;
classDef mermaid_nonbusinessdata color:#000, fill:#B7DEE8, stroke:#B7DEE8, stroke-width:0px, font-size:100%;
classDef mermaid_entity color:#000, fill:#FB9F53, stroke:#FB9F53, stroke-width:0px, font-size:100%;
classDef mermaid_entitylinked color:#000, fill:#FCD5B5, stroke:#FCD5B5, stroke-width:0px, font-size:100%;
classDef mermaid_context color:#000, fill:#B9CDE5, stroke:#B9CDE5, stroke-width:0px, font-size:100%;
classDef mermaid_optional color:#000, fill:#B7DEE8, stroke:#65CDE8, stroke-width:1px, font-size:100%, stroke-dasharray: 5 5;
classDef mermaid_state color:#000, fill:#d7e4bd, stroke:#000, stroke-width:1px, font-size:100%, font-weight:300;
class Main1,Main2 mermaid_entity
class A1,A2 mermaid_entitylinked
```

The scope of the checklist is used to filter the application of the **Checklist**, and can be:

* **General** - general purpose checklist.
* **Maintenance Management** - applicable to Maintenance Management.
* **Exception Management** - applicable to Exception Management.
* **Material Tracking** - applicable to Material Tracking.
* **Resource Tracking** - applicable to Resource Tracking.

## Tying Everything Together

```mermaid
graph LR
    A1[Maintenance Activity] --- Main[Checklist]
    A2[Maintenance Activity Order] --- L1
    Main === L1[Checklist Instance]
    N1[Protocol Instance Path] --- L1
    A3[Material] --- L1
    L1 === L2[Checklist Instance Item]
    L2 === L3[Checklist Instance Item Parameter]
    Main === L4[Checklist Item]
    L4 -.- A4[Roles]
    L4 === L5[Checklist Item Parameter]
    C1[Material Checklist Context] -.- Main

classDef mermaid_title color:#000, fill:#fafafa, stroke:#fafafa, stroke-width:0x, font-size:100%, font-weight:200;
classDef mermaid_start color:#000, fill:#fafafa, stroke:#fafafa, color:#fafafa, stroke-width:0x, font-size:100%, visibility: hidden;
classDef mermaid_businessdata color:#000, fill:#65CDE8, stroke:#65CDE8, stroke-width:0px, font-size:100%;
classDef mermaid_nonbusinessdata color:#000, fill:#B7DEE8, stroke:#B7DEE8, stroke-width:0px, font-size:100%;
classDef mermaid_entity color:#000, fill:#FB9F53, stroke:#FB9F53, stroke-width:0px, font-size:100%;
classDef mermaid_entitylinked color:#000, fill:#FCD5B5, stroke:#FCD5B5, stroke-width:0px, font-size:100%;
classDef mermaid_context color:#000, fill:#B9CDE5, stroke:#B9CDE5, stroke-width:0px, font-size:100%;
classDef mermaid_optional color:#000, fill:#B7DEE8, stroke:#65CDE8, stroke-width:1px, font-size:100%, stroke-dasharray: 5 5;
class Main mermaid_entity
class A1,A2,A3,A4,A5,A6,A7,A8,A9,A10,A11,A12 mermaid_businessdata
class L1,L2,L3,L4,L5,L6,L7,L8,L9 mermaid_entitylinked
class C1,C2,C3,C4,C5,C6 mermaid_context
class N1,N2,N3,N4,N5,N6 mermaid_nonbusinessdata

click Main "../../business-data/checklist"
click A1 "../../business-data/maintenance-plan"
click A2 "../../business-data/maintenance-activity-order"
click A3 "../../business-data/material"
click A4 "../../administration/security/roles"
click C1 "../../administration/tables/smart-tables/materialchecklistcontext"
```

## Sequence Of Steps

The necessary steps for correctly using a **Checklist** are the following:

1. Create **Checklist** - note that it is necessary to associate the **Checklist Version** to a **Change Set**.
2. Approve the Change Set, which contains the **Checklist Version** that has been created.  

!!! note
    For convenience, the Checklist can be configured to use implicit Change Sets. For more information, see [[user-guide-change-set-page]] section for more information.

    You may also find the [[tutorials-npi]] tutorial helpful for a practical walkthrough.

{{ generate_index() }}