Skip to main content

Modeling Steps (Protocols)

Goals

  • Know what Standard and Sample Protocols are and when to use them.

  • Know how to create new Protocols using:

    • Protocol details

    • Custom fields

Key Terms

Table 21. 

Term

Definition

Protocol (Step)

Defines the data to collect while processing the Batch.

Standard Protocol

Associates process data with the Batch.

Sample Protocol

Creates a child Entity from the Batch (parent).



What are Protocols?

Protocols (Steps) define the data to collect while processing the Batch. Contiguous fields assigned to the same group represent a Sub-Step.

master_field_grouping_3_3.png

If the grouping includes two (2) colons followed by text, the fields will be placed in a Sub-Step Table named using the text after the colons.

mes_field_grouping_3_3.png

Note

Discontiguous fields assigned to the same group create separate Sub-Steps.

Fields not assigned to a group create their own Sub-Step.

How to create new Protocols

Go to: L7|MasterProtocols+ New Protocol

master_new_protocol_3_3.png

Protocol Details

master_protocol_details_3_3.png
  • Use in manufacturing – should be set to “Yes” for Protocols that will be used in L7 MES.

  • Protocol Type – standard or sample.

    • Pipeline Protocols cannot be used in L7 MES.

    • Pipelines are executed from Pipeline button fields.

  • Duration (hours) – the time it takes to complete the Protocol.

    • This detail is used in L7 Scheduling.

  • Version – a new version of the Protocol is created each time it is saved.

    • Pin - locks the Protocol into a previously saved version for explicit use in Workflows.

  • Group Samples – N/A to L7 MES, only one (1) Batch per Batch Record.

  • Instructions – plain text or formatted using the rich text editor in the expanded instructions window.

    • Protocol instructions appear at the beginning of the Step in the Batch Record.

    • Image height cannot exceed 600 pixels.

  • OnRender – custom behavior triggered when the Step renders in the Batch Record.

Note

onRender is covered in more detail here and in Client-Side Development.

To register, please visit L7 University.

  • Fields – Step data collected while processing the Batch.

  • Flex View Designer and Storage Policy – N/A to L7 MES.

  • Actions – custom behavior triggered when a condition is satisfied while processing the Step.

    • Protocol Actions are covered in more detail here.

Standard Protocols

Standard Protocols have the default Complete field displayed as the last field in the Protocol. All fields before Complete are custom fields created to collect process-specific data.

master_protocol_fields_3_3.png

Sample Protocols

Sample Protocols have two (2) key components:

master_sample_protocol_components_3_3.png
  1. The Parent-Child Relationship must be defined.

  2. The Entity Type must be selected and represents the child Entity that will be created.

Note

While there are three (3) options, only 1-to-1 is supported in L7 MES.

  • In a 1-to-1 Sample Protocol, each parent creates one (1) child Entity.

In L7 MES, Sample Protocols are used to create an Item from the Batch.

The default fields Parent ID and Note appear at the beginning of every Sample Protocol. L7|ESP sets the Parent ID, User-provided Notes become the description of the newly created Item.

master_sample_protocol_default_fields_3_3.png

Note

The Sample ID Sequence field defines the ID Sequence that will be assigned to the Item being created. Once an Item Type has been selected, this field will default to the ID Sequence assigned to that Item Type in L7|Master.

When an Item is created, the following default fields will appear ahead of the custom fields attributed to the Item:

master_sample_protocol_default_item_fields_3_3.png
  • Initial Quantity

  • Lot ID

  • Serial ID

  • Status

  • Vendor

  • Expiration

Custom Fields

After you enter a Display Name and choose the Protocol Type, you can add custom fields to the Protocol. Over a dozen different field types are available in L7|ESP.

master_new_protocol_field_3_3.png

Note

Link and Container location are not supported in L7 MES.

In the Field Details panel, the basic details are generally the same for all field types. They allow you to:

master_protocol_field_details_3_3.png
  • Name the field.

Note

Display Name vs. ID: Display Name is the name that appears in the user interface (UI). ID is a fixed value used to reference the field. This differentiation ensures stability when changing the name of a custom resource field.

L7|ESP will set the Display Name as the ID if the user does not define the ID themselves.

  • Define the field type.

  • Assign a default value (static value or Python expression).

  • Group the fields into Sub-Steps.

  • Add field-level instructions (plain text or formatted using the rich text editor).

    • Image height cannot exceed 600 pixels.

  • Hide the field if:

    • It should be conditionally visible.

  • Make the field read-only if:

    • It has a computed value and should not be editable (data integrity).

  • Make the field required if:

    • A value must be recorded, either as part of the business process or data dependencies in L7|ESP.

Note

The shared toggle is N/A to L7 MES and reportable fields are used in L7|Intelligence.

Exceptions to basic field details:

  • Approval fields cannot be hidden or made read-only, and are required by default.

  • Instruction fields cannot have a default value because they do not have any data associated with them.

Custom Editor – not supported in L7 MES.

Custom Renderer – not supported in L7 MES.

Event Handler onChange – custom behavior triggered when a field value changes. This includes entering a value for the first time.

Note

onChange is covered in more detail here and in Client-Side Development.

To register, please visit L7 University.

Field Parameters

Field parameters are dependent on the field type, see the table below for more information:

Table 22. 

Field Type

Parameters

Free-form text entry – enter any character (both text and numbers allowed).

Rich Text is not supported in L7 MES.

master_text_field_parameters_3_3.png

Numbers only allowed – enter any number.

See Entity Types and Specifications to learn more.

master_numeric_field_parameters_3_3.png

Picklist – select one (1) or more static or dynamic options.

master_picklist_field_parameters_3_3.png

Date/Time – select a date and/or time in predefined or custom formats.

master_date_field_parameters_3_3.png

Checkbox – boolean true or false.

N/A

Attachment – attach one (1) or more files with predefined or custom extensions.

master_attachment_field_parameters_3_3.png

Barcode – capture data as a barcode (1D, mini data matrix, or QR).

Entity barcode assigns the value as the Entity’s barcode.

* This is the Entity being processed when the barcode is collected.

master_barcode_field_parameters_3_3.png

Approval – enter an electronic signature.

Only Signature Flows should be used in L7 MES for Step and Batch Sign Off.

master_approval_field_parameters_3_3.png

Pipeline Button – execute a Pipeline (computational task).

* Automate manual tasks, data egress and ingress.

Select a Pipeline and define its variables.

Pipeline – collection of Tasks (shell scripts) run on compute resources (cluster, cloud, or directly in L7|ESP).

* Pipeline are covered in more detail in Client-Side Development.

To register, please visit L7 University.

master_pipeline_field_parameters_3_3.png

Resource link – link to another L7|ESP resource.

If the Link Type is Entity Class, Container, Item, or Service Type, a multi-select picklist will appear to restrict to the selected:

  • Entity Types, Container Types, Item Types, or Service Types.

If the Link Type is Container, a multi-select list of statuses can be selected to filter the list of Containers based on their status.

This status can be updated after use.

* Container statuses are managed in the esp Configuration.

master_resource_field_parameters_3_3.png

Inventory item use – track Items and their consumption.

Record used quantity – if deselected, the field will convert to a multi-select picklist, and only the Item name will be recorded in the Worksheet.

Only use items within containers – restrict available inventory to Items stored in a location (e.g., kit); use an ESP Expression to reference a Resource Link field of type Container:

{{ [json_loads(cell('Field ID', 'Protocol ID'))['uuid']] }}

master_inventory_field_parameters_3_3.png

Instructions – field-level instructions that do not require data collection.

* Image height cannot exceed 600 pixels.

N/A

Sample Point – create new Samples during production.

See Sample Plans to learn more.

master_sample_field_parameters_3_3.png

Vector - create a table with a dynamic number or rows.

Add Time Recording Column - if selected, a date/time field named "Time" will be added to the table as the first column ("Time" display name is editable). The Datetime format will follow the format set in the esp configuration file, under the datetime_formats code block.

Rows - set the min, max, and default number of rows. Manufacturing operators will be able to add/remove rows within the bounds of the min/max range.

master_vectorParameters_3_4.png

To add columns to the table, expend the Vector field displayed in the main viewing area, then click + Add Vector Columns. Only free-form text entry and numeric data types are supported at this time. Numeric Vector fields can be configured as specifications.

master_vectorColumns_3_4.png

Note

Vector fields are only supported in L7 MES at this time and require "Use in manufacturing" to be set to "Yes".

onChange event handlers are disabled for Vector fields.