Open Material Deviation#

ChecklistInstance.OpenMaterialDeviation

Overview#

This operation is used to create and open a Material Deviation for an item of a Checklist Instance. This is usually integrated into other functionality such as Maintenance Management and Exceptions Management.

Setup#

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

Preconditions#

1. The Checklist Instance Item belongs to a Checklist Instance that:

   • Is Active, Open, and Long Running.
   • Has a Material associated to it.
   • Has a Material Deviation Protocol associated to it.

2. The Checklist Instance Item:

   • Exists, is Active (not Terminated), and the Is Active is true.
   • The Activity Type is Manual Task, and its State is not Skipped or Completed.
   • If the Deviation Type is Change Checklist Item or Remove Checklist Item, the state must not be Started. Additionally, there must be no Data Collection posted or BOM Part consumed for that Checklist Instance Item.
   • If the Deviation Type is Add Checklist Item, the base Checklist Instance Item must have the property Is Floating set to false. Additionally, the base Checklist Instance Item must be Not Started if the new Checklist Item is to be added Before.
   • If the Deviation Type is Change BOM Item, Remove BOM Item or Add BOM Item:
     • Both the previous Quantity for the BOM Instance Item (for Change BOM Item and Remove BOM Item), and the new Quantity for the BOM Instance Item must be greater than or equal to zero.
     • If the Deviation Type is Change BOM Item or Remove BOM Item:
       • The Checklist Item must have at least a BOM Instance Item associated with it.
       • Only BOM Instance Item for which the Is Reference set to false can be Removed or Changed.
       • Only BOM Instance Item for which the Lower and Upper Tolerances are not defined (or equal to the Required Quantity – this means the upper and lower tolerances are zero) can be Removed or Changed.
     • If the Deviation Type is Add BOM Item, the associated Checklist Instance must have a BOM Instance associated with it.

Sequence of Steps#

Matching the conditions above, from your Checklist, create/open a Checklist Instance for a Material. Go to your Checklist Instance and:

1. Select the item you want to open a deviation for.

2. If the conditions are met, the Open Deviation button becomes available on the top ribbon:

   

3. You can select one of the following Material deviations:

   • Add Item After
   • Add Item Before
   • Change Item
   • Remove Item
   • Add BOM Items
   • Change BOM Items
   • Remove BOM Items

   

4. If you add a Checklist Item before (Add Item Before) or after (Add Item After) the selected Checklist Instance Item, you must create a new Checklist Item that meets the conditions above.

5. If you change (Change Item) the selected Checklist Instance Item, a new Checklist Instance Item is created based on the selected one. This option is similar to Add Item Before/Add Item After operation, except that it starts with a pre-filled Checklist Item:

   

   Note

   The initially set Group property cannot be modified.

   Furthermore, if any Checklist Instance Item Parameter has a value already, that Checklist Instance Item Parameter cannot be changed in any way.

6. If you remove (Remove Item) the selected Checklist Instance Item, check the information, and select Remove:

   

7. If you Add BOM Items, you must provide the Product, Quantity, Units and optionally the Color:

   

   Note

   If a Product has the Default Units property set, those units will be automatically applied. If needed, you can override them by specifying valid Units from the Units Lookup Table.

   Additionally, when adding new Products, their Product Type must not be Part, Durable or Packaging, and you can change the order of the newly added BOM items.

8. If you Change BOM Items, you can specify a new Product, a new Quantity, new Units and optionally a new Color:

   

   Note

   When performing Change BOM Items, at least one of the following properties must be changed: Product or Quantity.

   If a Product has the Default Units property set, those units will be automatically applied. If needed, you can override them by specifying valid Units from the Units Lookup Table.

   Additionally, when adding new Products, their Product Type must not be Part, Durable or Packaging, and on changing BOM Items, the order maintains its original sequence, and cannot be modified.

   When only the Quantity is changed, Information Capture will be required for the BOM Item if it is enabled.

9. If you Remove BOM Items, check the information, use to delete the item directly in the wizard and select Remove:

   

For any item, you can view its details (read only) by selecting the icon:

Here are some examples:

And you can also expand items to see their details: