Create Checklist#

Checklist.Create

Overview#

This operation is used to create a Checklist, this is, a step-by-step list of actions.

Preconditions#

• The Checklist name must be provided and must be unique.

Sequence of Steps#

There are several ways to create a new versioned object. Depending on the level, follow these steps to get started:

• Entity - in the landing page of this entity type in the Business Data menu or in the details page of an existing entity of the same type, select New on the top ribbon. For more information, see Creating Entity Objects.
• Revision - if you want to create a new revision, go to the New dropdown button on the top ribbon and select Revision. For more information, see Revisions.
• Version - if you want to create a version associated to an existing revision, go to the New dropdown button on the top ribbon and select Version. For more information, see Versions.

Step 1: Change Set#

1. Choose an existing Change Set or select Create to create a new Change Set. If configured to support implicit Change Sets, it is also possible to check the Use Automatic Change Set option.
2. Optionally, select an Approval Role.
3. Optionally, set the Make Change Set Items Effective on Approval to true so that the Change Set items become effective when the Change Set is approved.

Step 2: General Data#

1. Provide a Name for the checklist.
2. If you are creating a new version, the revision that was selected when you started the process will be the revision to which this version will be associated. If you are creating a new entity or revision (with a new version associated to it), provide a Name for the revision or it will be automatically generated for you. For more information on revision naming, see Revision Naming.
3. Optionally, enter a Description.
4. Select the Type of checklist. The list of possible values is taken from the ChecklistType Lookup Table.

5. Select the Scope of the checklist. It is possible to select one of the following scopes:

   • Exception Management
   • General
   • Maintenance Management
   • Material Tracking
   • Resource Tracking

6. Select the Execution Mode:

   • Long Running - the checklist will be executed over a certain period of time and data will be committed as it is being executed. This mode cannot be used for checklists with the scope Resource Tracking.
   • Immediate - the checklist will be executed all at once and data will be committed at once. This option is not available for the following scopes:
     • Exception Management
     • Maintenance Management

7. If the scope is Material Tracking and the execution mode is Long Running, you can associate a BOM to the Checklist. There are several specific restrictions to the objects to be used, namely:

   • For scope Material Tracking, the BOM scope must be Weigh And Dispense or Materials and it must be effective.
   • For scope Maintenance Management, the BOM scope must be Parts and it must be effective.
   • There is a match between the BOM items in the referenced BOM and the BOM items in the Checklist item.
   • For all Checklist items that reference the same BOM item, either all specify a Quantity or none do.
   • The same Product can only be referenced once in the same Checklist item.
   • The sum of the Quantity of all Checklist items that reference the same BOM item must be less or equal than the corresponding BOM item quantity.

8. If the scope is Material Tracking, Maintenance Management or Resource Tracking, you can associate a Data Collection of scope General to the Checklist. There are several specific restrictions to the objects to be used, namely:

   • There is a match between the Data Collection parameters in the referenced Data Collection parameters and the Data Collection parameters in the Checklist item.
   • All Data Collection parameters are different from Rule.

9. Optionally, specify a documentation URL for the Checklist.

Step 3: Items#

At this point the Checklist is created but there are no Checklist Items defined for it.

To build the Checklist structure, select Edit in the center of the page. A new central panel will appear where you can add items (left) and their details (right).

To build the Checklist structure, select Add Item and a new row will be inserted in the structure. You can and as many items as you need. Optionally, you can define a Group (give it a name), which will be used to gather Checklist items. All Checklist items must either have a defined group or no group at all.

General Data#

For each item, specify:

• Name of the checklist item.
• Optionally, enter a checklist item Type. The values are taken from the ChecklistItemType Lookup Table.
• Optionally, provide a Documentation URL for the checklist item. A valid URL will be displayed in a separate tab named Document and can also be opened in a new tab for an easier viewing experience.
• The Activity Type:
  • Manual Task - a manual procedure from which additional parameters can be collected.
  • Manual Action - a DEE action that is triggered manually. Note that Manual Actions cannot be applied to a checklist that is in the Immediate mode.
  • Automatic Action - a DEE action that is triggered automatically. Note that Automatic Actions cannot be applied to a checklist that is in the Immediate mode.
  • Signature - an item that needs to be signed with a username and password.
• The Tracking Type:
  • Start And End - the start and the end need to be captured (not applicable to Manual Actions, Automatic Actions and Signatures).
  • End - captures only the completion of the task.
• Optionally, a Valid From date and time.
• Optionally, a Valid To date and time - if both Valid From and Valid To are defined, the Valid To must be greater than the Valid From.

• For Manual and Automatic Actions, specify the corresponding DEE rule.

  Warning

  The selected DEE rule must return a dictionary with a key named Result.

• Specify whether the checklist item is Floating or not. A floating item can be performed at any time whereas a non-floating item needs to be executed in a sequence.

• Specify whether the checklist item is Optional or not. An optional checklist item can be skipped.

Instructions#

You can define instructions to be performed. This can be formatted in rich text in the editor.

Parameters#

For Manual Tasks and Signatures, specify the desired Parameters and provide:

• The Name.
• Whether it is Optional or not.
• The Source:
  • Free, which is further defined by:
    • Type - Boolean, Date Time, Decimal, File, Integer, Long, String, Url.
    • For numeric types, there can be a minimum and maximum value (the minimum and maximum values may be inclusive or not).
    • A Format, used for input and display purposes. For more information, see String Formats.
    • A Default value, compatible with the Type.
    • A date time picker mode for the Date Time parameter: Date, Date Time, Time.
    • A File, to allow capturing images or attaching a file.
  • Lookup Table, which is further defined by:
    • The Lookup Table.
    • Optionally, a Default value.
  • Query, which is further defined by:
    • The Entity Type.
    • The Query Name.

Diagram#

You can associate a diagram to a checklist item by uploading a file that can be used as an illustration of the procedure you want to detail. The image is uploaded through a control in the Diagram tab.

In the Diagram tab you can also have direct access to images, diagrams, and other document types from the Product that are associated to the BOM, which is associated to the Checklist. As well as images, diagrams, and other document types from the BOM that is associated to the Checklist:

After uploading the file, you can annotate the diagram directly over it, using a simple annotation tool within the same tab. By selecting the file you want to annotate you access the icon to open the Add Annotations dialog:

At the bottom right corner you have controls that add different types of annotations to the image:

• Text boxes
• Polygons
• Images

On top of the image you have several controls that provide easy tools for annotation and editing:

Adding a new Text Box allows you to add text and an arrow indicating a specific point in the drawing. Double-click on the shape and you can edit the text:

To add a Polygon, select the icon and select each point you want to join until the line is closed by selecting the original point:

To change the font, background or line colors and border widths for any annotation, select the desired effect using the tools on top of the image and then select the annotation you want to edit.

To add an image, select the appropriate icon and use the file upload control accordingly (upload from a local file or from a web URL). Place the image where desired and select Add to save.

If you want to remove any annotation, select it and select :

In the main Diagram tab, select to toggle the visibility of the annotations:

If you want to download the diagram, select . You can also decide to download the diagram with the annotations. In this case, a new image file will be created by flattening the layers of the main image with the annotations created on top. To remove the diagram, select .

Signatures#

The Signature Activity Type will display a new tab called Signatures so that you can add the signatures that are allowed to sign the checklist item.

To add signatures, open the Signatures tab and select Manage. Add as many signatures as needed (select or accordingly and you can order the items with the and arrows), specify at least one item, and provide the following information for each item:

• The Text to display as name for the signature.
• The Role associated with the signature (only users with this role will be able to sign the checklist item).
• An optional Certification associated with the signature.
• Whether or not you can sign the checklist item, Allow Self.

Select Add and the signature is added to the list of available signatures.

Document#

A valid Documentation URL will be displayed in a separate tab named Document and can also be opened in a new tab to enable an easier viewing experience:

Data Collection Parameters#

If you assign a Data Collection to a Checklist, you can also define that some or all of the Data Collection parameters must be filled in when the Checklist is performed. There are some restrictions to the parameters, as follows:

• For all referenced Data Collection parameters that have Checklist items with FromSample and ToSample values defined, the system must ensure that the number of samples present in all Checklist items that reference that Data Collection parameter is greater or equal to the value for MinSamples in the Data Collection parameter.
• For all Checklist item Data Collection parameters, either FromSample and ToSample are both defined, or none are.
• The same parameter can only be referenced once in the same Checklist item Data Collection parameter.
• If the corresponding Data Collection parameter SampleCountPercentage is defined, the FromSample and ToSample cannot be defined.
• If the corresponding Data Collection parameter SampleKeyType is SampleSize, the FromSample and ToSample cannot be defined.
• If the FromSample is defined, the ToSample must be greater or equal to the FromSample.
• There can be only one reference to the same Data Collection parameter if FromSample and ToSample are not defined (meaning all the parameters must be collected). Also, there cannot be any overlap of FromSample and ToSample values for the same referenced Data Collection parameter.

BOM Products#

If a BOM was defined, you can specify a list of BOM Products for the Checklist item and provide the following for each item:

• The BOM Product - from which the Product is retrieved.
• If the Product appears various times in the BOM, the BOM Item Number is also needed, and it must be unique for the same Checklist item.

• Optionally, a quantity – if defined, it must be below or equal to the respective BOM item.

  Note

  If a quantity is not defined, it is assumed that the full quantity will be consumed.

• Optionally, a color to cross-check the Product in the diagram.

  Note

  The system indicates which BOM Products have already been used and in which quantities.

Visual Conventions#

Critical Manufacturing MES uses icons to quickly convey specific information about Checklist items, helping you to understand the type and significance of each item at a glance. The table below lists the possible icons and their corresponding meanings.

Table: Visual Conventions

Wrap-up#