Perform Checklist Instance#

ChecklistInstance.Perform

Overview#

Performs a Checklist either Immediate or Long Running. This is usually integrated into other functionality such as Maintenance Management and Exceptions Management.

• A Checklist performed in mode Immediate needs to be completed in one snapshot and data is committed all at once.
• A Checklist performed in mode Long Running can be performed over a long period of time and data is committed after the completion of each Checklist Item.

Setup#

No special setup is required other than to meet the preconditions of the transaction.

Preconditions#

• The Checklist is Active or Checklist Version is Effective.
• The Checklist scope is General.
• If the Checklist is Long Running it must have been opened first.
• The Checklist Instance exists in the system and it is in the Active state.
• The Checklist Execution State cannot be Paused.

Sequence of Steps#

To execute the Checklist Instance, you need to:

1. Find the desired Checklist Instance (for Long Running) or Checklist (for Immediate) and select Perform.

The item list is divided into mandatory and optional and can be switched by selecting the appropriate list on the top right-hand corner of the list.

When you perform a Checklist Instance, if the Checklist Item is a Manual Task with the tracking type of Start And End, you may undo the start by selecting the icon. This option will only be available if no Data Collection information has been posted and no Parts have been consumed:

Optionally, you may add comments to the Undo Start of Checklist Item, as shown below:

Checklist Item Type#

Items are presented in the following manner:

Table: Checklist Item types

Checklist Item State#

The icon shown on the left of the Checklist Item has the meaning as described in the table below:

Table: Checklist Item states

Checklist Item Information#

Additional Checklist Item information is presented on the right of each Checklist Item:

Table: Checklist Item information

If the Checklist has an associated Data Collection, the parameters of the Data Collection must be completely filled in before the Checklist Item can be marked as completed:

If the Checklist has an associated BOM of scope Parts, for each Checklist BOM item provide the following information:

• If the BOM Product is optional, you must confirm whether you are skipping it.
• If the Part Type is Consumable and you activated the Consume Quantity property when creating the Product, you may add one or more Materials to meet the Required Quantity. If you have not enabled the Consume Quantity property, you must enter the Required Quantity manually.
• If the Part Type is Repairable, and a Material already exists at the Resource Part for that Product and Designator, you must replace it by removing the existing Material and adding a new one. If no Material exists, simply add a new one.
• An Information Value if Information Capture Required is set to true. If partial consumption is not allowed (Consume Quantity is false) and Information Capture Required is true, you must provide the required information and consume the entire quantity in a single step — it cannot be split into parts.

If the Checklist has an associated BOM of scope Materials, for each Checklist BOM item provide the following information:

• Add one or more Materials to meet the Required Quantity (Substitute Products are also supported).
• If the Lower Tolerance and Upper Tolerance Required Quantity are set, the Required Quantity may vary between these values.
• For BOM Items with negative quantity, specify exactly one Material to fulfill the negative consumption in a single transaction. This quantity is fixed and cannot be modified.
• An Information Value if Information Capture Required is set to true.

If a parameter is of type File, you can capture images or upload a file to complete filling in the parameter:

The following table describes the file types that are supported for this parameter:

Table: Supported file types

Correct Checklist Instance#

If you have access to the ChecklistInstance.Correct feature, when there is no Checklist Item in progress and the Checklist Instance is not yet closed, you can go back to a Checklist Item that was completed and edit (correct) the value of a parameter of that Checklist Item:

When editing the value of a parameter of a previously completed Checklist Item, the Checklist Item status automatically changes to Edit mode:

The Checklist Item must have been previously performed for any correction to be applied. If it has not been performed, a warning will be displayed on the bottom-left of the screen:

To make the changes effective and to proceed with the Checklist, you must select the icon on the left of the Checklist Item.

Complete and Close the Checklist#

For Checklists performed in Immediate mode, the perform can be concluded by completing all items and selecting Perform Immediate. For Checklists performed in Long Running mode, the state of the Checklist will be committed to the database after each Checklist Item is completed, or after you choose Save and Close. When all Checklist Items are completed for a Checklist performed in Long Running mode, you can only select Close.