L7|ESP Glossary
A
- AG Grid
A fully-featured and highly customizable JavaScript data grid with no third-party dependencies.
- API
API stands for Application Programming Interface. An API is a method for one computer program to communicate with another computer program.
- Applet
A customizable application that can be created using HTML, JavaScript, and CSS. They are displayed in the Applets App and can be configured to appear in the app tray and on the home page.
- L7 Assets
L7 application used for location management of Containers, Kits, and Equipment. Formerly called L7 Locations app in earlier versions of L7|ESP.
B
- Batch
Manufacturing run to produce a Product.
- Batch Record
An executed instance of a Master Batch Record.
- BOM
The Bill of Materials (BOM) tab displays information about Kits associated with the Batch (Available Items) and the Items consumed during Batch production (Item Usage).
- BOM Plan
Type of Dynamic Execution Plan (DEP) used to modify the parameters of Inventory Items Use fields and Resource Link fields of type Kit that restrict Items to a kit.
- Bundle
A bundle is a group of related content items and extensions packaged together into a single file (created in L7|HUB).
C
- Collection
A named group of content items that can later be maintained and exported as a Bundle (like a draft or in-progress Bundle; created in L7|HUB).
- Configuration
Arbitrary key-value definitions that generally have no standard semantic meaning to L7|ESP Core software.
- Connector
Functional connections between L7|ESP and third-party instruments or software. This could be a Python script, or collection of scripts, used for generating sample manifests and parsing outputs from an instrument. For example, an Illumina Connector would generate sample sheets for Illumina sequencers. These scripts are used in Pipelines
- Container
A physical location that stores Entities, Items, Equipment and/or other Containers. Containers are instances, or occurrences, of Container Types. Examples include: freezer boxes, bookcases, rooms, and buildings. Containers are managed in L7 Assets.
- Container Type
Defines the attributes of a Container, including its content, dimensions, and custom fields. The Container Type builder is used to model both general Containers and Kits.
- Content
Any physical location. Containers are instances, or occurrences, of Container Types; they can contain Entities, Items, and other Containers.
- Custom Field
Metadata associated with a data model (Entity Type, Equipment Type Container Type, or Item Type) and/or data fields in a Protocol.
D
- Dashboard Report
A Dashboard Report is a read-only Report that provides high-level operational metrics to summarize and display what is happening in the labs. L7|ESP comes with several stock Dashboard Reports located in the Dashboard app, but custom Reports can be created as well using HTML, Javascript, and CSS.
- Dashboard Widget
Multiple types of charts that can be used to provide specific metrics and are based on fixed parameters that are used to query the database.
- Data Link
Pull external and upstream data into a Protocol from the same Workflow, an upstream Workflow in the Workflow Chain, or an Entity.
- Digitalization
The use of digital technologies and digitized data to impact how work gets done and transform how departments within a company interact – and how the company interacts with its value chain partners.
- Digitization
The conversion of analog information to digital (paper to electronic) and automation of existing manual and paper-based processes.
- Dynamic Execution Plan (DEP)
DEPs are process plans that provide alternative parameters for procedural Steps belonging to a specific Recipe (Workflow Chain). DEPs consist of Sample and Specification Plans.
E
- EBR
The Electronic Batch Record (EBR) for the Recipe, based on the Sample Plan and Specification Plan selected. Operators record data in this tab during production.
- Entity
The smallest data component, it represents any resource that is submitted to, or a component of, a business process (i.e., patient or blood sample). Entities are instances, or occurrences, of Entity Types.
- Entity Class
A categorical way of grouping different Entity Types. Each Entity Class will receive its own app in L7|ESP, useful for managing user access with Roles in L7 IAM.
- Entity Type
Defines the attributes of an Entity, including its custom fields and ID Sequence(s).
- Entry
An electronic notebook page in L7 Notebooks used to enter details of experiments during research or clinical development. Each Entry is assigned to a Notebook.
- Equipment
Physical equipment and instruments used, tracked, and managed during business operations. Equipment are instances, or occurrences, of Equipment Types. Modeled in L7|MASTER's Equipment Type builder; shares similar features as Container Types, but with additional maintenance scheduling functionality. Equipment are managed in L7 Assets.
- Equipment Type
Defines the attributes of an Equipment, including its maintenance schedule(s), maintenance Workflow(s), associated vendors, custom fields, dimensions, and storage contents.
- ESP Client
A command line utility for interacting with L7|ESP and a full Python API (similar to an Object Relational Mapper) for interacting with L7|ESP data models
- Experiment
Collection of Entities submitted to a Workflow or Workflow Chain.
F
- Flexview
An interactive, fully customizable view of a Protocol in a LIMS Worksheet.
- Flexview widget
Composable, pre-configured elements that make up a Flexview.
G
- General Plan
Type of Dynamic Execution Plan (DEP) used to modify the parameters of any custom field type. When used in combination with other DEP types, the General Plan is applied first.
- Generic renderer
Flexview widget that executes arbitrary HTML and JavaScript.
- Grouping (formerly Var Group)
Custom field setting found under Basic Details, behavior differs by application:
Data Models: Organize custom fields into tabs on the Entity details page.
L7 LIMS: Organize shared protocol fields into tabs at the top of the LIMS Worksheet
L7 MES: Organize protocol fields into Sub-Steps in the EBR tab
I
- Input Pipeline Connectors
These scripts are used for parsing, or inputting data into L7|ESP. Input Connector code will take in the data from certain lab instruments and do something with that data, such as generate a Report, capture data, or perform statistical analysis
- Instance
In object-oriented programming, an instance is a specific realization of any object.
- Invokable
User-defined back-end (server side) Python function that can be called from a custom API endpoint.
- Invokable.js
User-defined JavaScript functions available to Protocol Event Handlers (OnRender and OnChange), Flexview, Applets, and Reports.
- Item
A resource that is consumed as part of a business process. Items are instances, or occurrences, of Item Types. Items are managed in L7 Inventory.
- Item Type
Defines the attributes of an Item, including its type (consumable or reagent), units, custom fields, Vendors, and ID Sequences.
J
- JSON
JSON stands for Javascript Object Notation. It is a text-based representation of object structures. For instance, a JSON representation of an L7|ESP Entity might be: { "name": "ESP000001", "uuid": "9caac2ec-e508-42ac-baad-ee9f987405fe", "entity_type_name": "Patient", "fields": { "Blood Type": "AB", "Blood Type Rh": "+" } }
K
- Key-value pair
A key-value pair consists of two related data elements: A key, which is a constant that defines the data set (i.e., animal, weight), and a value, which is either the data that is identified or a pointer to the location of that data (i.e., dog, 70). Example of key-value pairs include:
animal: dog
,weight: 70
,myFile: /path/to/myFile
- Kit
A physical kit that stores the Items intended to be used together during a process. Kit containers are instances, or occurrences, of Container Types that have "Is a Kit Type" selected. Kits are managed in L7 Assets.
L
- L7|ESP Expression Language
An embedded programming language, based on Python, that offers a set of pre-defined functions for interacting with L7|ESP. Expressions follow the form
{{ <Expression> }}
- L7|HUB
A repository of robust, standardized, and scalable content designed to accelerate implementation times while improving quality.
- L7|HUB App
Provides an interface for packaging, viewing, and transferring any content between two or more L7|ESP instances.
- L7 LIMS App
Laboratory Information Management System, used to process samples and associated data.
- L7 Location App
Location app is used to manage physical storage locations (e.g., wells, plates, racks, freezers, rooms, etc.)
M
- L7 MES App
Manufacturing Execution System, allows users to capture, review, and report on data about the manufacturing process, including process parameters, bill of materials, sample plans, and adherence to specification limits, in a manner compliant with the requirements laid out by regulatory agencies.
- Master Batch Record (MBR)
A template that contains documented set of steps required to manufacture a product. An MBR can contain any combination of instructions, images, and data capture necessary to document the manufacturing process. MBRs are modeled as Workflow Chains.
- MES Product
A Product represents the thing being manufactured in L7 MES. The Product is the parent of the Batches, which records the steps taken to create the Product. L7 MES Products belong to the "MESProduct" Entity Class.
N
- Node
Procedures: Visual representation of a single Protocol Workflow in a Procedure.
Workflow Chains: Visual representation of a Workflow or Procedure in a Workflow Chain.
- Node Library
Procedures: When creating a Procedure, the Node Library displays a list of all Workflows containing a single-Protocol registered in the system.
Workflow Chains: List of all Workflows and Procedures registered in the system. Procedures are only supported in L7 MES.
- Notebook
An electronic Notebook Library comprised on Entries. Used to organize Entries in L7 Notebooks.
- Numeric Field
Refers to a custom field that has Type set to Numbers only allowed.
O
- Object
Refers to a custom field that has Type set to Numbers only allowed.
- onChange
User-defined JavaScript function that is triggered when a given value in a L7 LIMS Worksheet changes.
- onRender
User-defined JavaScript function that is triggered when a Protocol is rendered in a L7 LIMS Worksheet.
- Outline pipeline connector
These scripts create readable files to be consumed by instruments. Because these files are leaving L7|ESP, they are considered “output”. A common use of output Pipeline Connectors is to generate runsheets based on data stored within L7|ESP. These runsheets can then be automatically sent to the instrument, which saves time and ensures accurate data entry.
P
- Pipeline
Collection of Tasks (shell scripts) run on compute resources.
- Pipeline button
Type of custom field that associates a Pipeline with a field in a Protocol. Allows multiple Pipelines to be added to a single Protocol.
- Pipeline protocol
Launches a Pipeline. Pipeline Protocols are being deprecated in favor of Pipeline Buttons which offer more flexibility.
- Pipeline report
A Pipeline Report is a special file generated after a Pipeline was run. Pipeline Reports are constructed in the Analysis app and while the Reports themselves are in HTML, they can embed other objects, such as files, images, and tables. Pipeline Reports are visible in the Analysis app, and the LIMS Worksheet they were executed in.
- Plotly.js
A free and open-source graphing library for Python.
- Procedure
An ordered chain of Workflows comprised of single-Protocols, sometimes referred to as a Protocol Chain. Only supported in L7 MES. The Procedure renders as a Unit Operation, allowing users to repeat Steps (Protocols) in the EBR.
- Project
Collection of Experiments.
- Protocol
Sequence of steps performed on an Entity. Protocols define the data to collect while performing the Experiment.There are three types of Protocols in L7|ESP: Standard, Sample, Pipeline
- Protocol Action
Behavior that is triggered when a Protocol is saved and at other key points in the life cycle of a Worksheet.
- Protocol Library
List of all Protocols registered in the system.
- Protocol Step (MES)
Defines the data to collect while processing the Batch.
- Python
A high-level, interpreted, general purpose programming language with a design focus on readable and maintainable code.
Q
- Quality Review
A tab in MES used to review and correct data in the Batch Record.
R
- Recipe
Manufacturing process to produce a Product.
- Reports
Offer a custom display that can include various objects (such as: files, images, or tables), are associated with the single execution of a Pipeline and appear in the L7 Analysis App and L7 LIMS
- Repository
A source code repository is a central file storage location that is utilized by a version control system to store multiple versions of files. The version control system can then control the access, creation, maintenance, modification, and use of the source code
- REST API
An application programming interface (API) that adheres to the constraints of REST architectural style and allows for interaction with representational state transferable (RESTful) web services. A client and a server communicate through HTTP requests to perform standard database functions such as creating, reading, updating, and deleting records (also known as CRUD) within a resource.
- Runsheet
A file that provides a set of instructions for an instrument
S
- Sample Plan
The Sample Plan tab displays information about the Sample IDs reserved and later assigned to Samples collected during Batch production. It also allows Users with the appropriate permissions to print and reconcile unused Sample labels.
- Sample Point Field
A type of custom field used to create new Samples during production. It creates parent-child relationships between the Batch Entity Type and the Samples being collected, but data cannot be collected against these new Samples in the Batch Record.
- Sample Protocol
General: Creates child Entities of the same or different Entity Type.
MES: Creates a child Entity from the Batch (parent).
- Sample Set
A collection of Entities processed in a Protocol.
- Server
A piece of computer hardware or software (computer program) that provides functionality for other programs or devices, called "clients".
- Signature Flow
Structured signature queues configured in L7|Master.
Completed signatures record the reason, username, and date-time of the signature to aid customers in their 21 CFR Part 11 compliance. Sections 11.200 and 11.300 of the Part 11 regulations lay out the requirements for non-biometric-based digital signatures in the form of identification code and password. L7's interpretation of these requirements is that an identification code is not a username, but a password-like value. As such, L7's interpretation of the requirements is that for full Part 11-compliant signing, in addition to users authenticating into the system via username and password, an additional "code" is required. This code is internal to L7|ESP and separate from the SSO password and is the value to be input into the approval field.
- Sign Off
A tab in L7 MES used to facilitate the final review of a Batch.
- Specification
Specifications are important metrics associated with a manufacturing process (Recipe). In L7|ESP, a Specification is a numeric field with:Spec Type Min and/or max value
- Specification Plan
A specific type of plan that enables you to modify the Specifications in a Recipe without changing the underlying process Steps.
- Specification Plan
A specific type of plan that enables you to modify the Specifications in a Recipe without changing the underlying process Steps.
- Spec Type
“Spec Type” is a picklist parameter for numeric fields in the Protocol builder. The list of available Spec Types is configured in the Configuration App.
- Standard Protocol
General : Associates experimental (process) data with an Entity.
L7 MES: Associates process data with the Batch.
- Step
A subset of a Unit Operation that represents one set of activities in L7 MES. Steps are modeled as Protocols.
- Sub-Step
A logical grouping of fields within a Step that typically represents one activity in L7 MES. Sub-Steps are created using the "Grouping" setting in the field's Basic Details.
- Swim Lane
Provide a way to visually organize nodes into discrete categories.
T
- Tasks
Templatized shell scripts that run on available compute resources (e.g., clusters, clouds, or directly in the server hosting L7|ESP). Because Tasks can call any shell command, they can be used for parsing instrument output files, conducting automated analyses, generating instrument runsheets, interacting with L7|ESP itself or any third-party system. The most common Tasks execute a Python script.
- Transition Rule
A logic statement that determines when Entities will transition to the next node in a Workflow Chain or Procedure.
- Transition Strategy
A logic statement that states which Entities will transition to the next node in a Workflow Chain or Procedure.
U
- Unit Operation
1) An activity or set of activities that results in a physical change to the product being manufactured. 2) A subset of the actions to manufacture a product, typically centered around one piece of equipment, or one set of activities that produces a physical change.
Modeled as either a Workflow or a Procedure; represented as a node in a Workflow Chain.
V
- Var Group
General: Organize custom fields into tabs on the Entity details page.
L7 MES (Sub-step): Organize custom fields into Sub-Steps in the EBR tab
- Vector field
A custom field available for L7 MES Protocols that creates a table with a dynamic number of rows. Manufacturing operators are able to add/remove rows within the bounds of the defined min/max range.
- Vendor
Person or place an Item is purchased.
- Vue.js
An open-source front end JavaScript framework for building user interfaces and single-page applications.
W
- Widget
Used in L7 Notebooks, flexview, and applets, widgets represent functional elements that can be added to an Entry or report.
- Workflow
Ordered collection of Protocols, representing a discrete unit of operation.
- Workflow Chain
General: Ordered collection of Workflows representing a business process.
L7 MES: Ordered collection of nodes (Workflows and/or Procedures) representing an end-to-end business process (i.e., recipes).
- Workgroup
IAM resource used to organize Users and restrict access to content.
- Worksheet
Spreadsheet-style data entry for Entities submitted to an Experiment.
Y
- YAML
YAML stands for “YAML Ain’t a Markup Language”. It is a text-based representation of object structures as a more human-readable alternative to JSON and other formats. For instance, the same L7|ESP Entity represented in YAML would be: name: ESP000001 uuid: 9caac2ec-e508-42ac-baad-ee9f987405fe entity_type_name: Patient fields: Blood Type: AB Blood Type Rh: +
Var names
Var names are listed in the table below.
Var name | Description |
---|---|
name | Entity name. |
desc | Entity description. |
url | (API) URL for the Entity. |
meta | Meta dict for the Entity. |
uuid | Entity UUID. |
cls | Entity Class. |
deleted | True if the Entity is archived, otherwise false. |
created_at | Created timestamp. |
updated_at | Last modified timestamp. |
owner | Name of the current Entity owner (normally the Entity creator). |
entity_type_uuid | UUID of the Entity's Entity Type. |
entity_type_name | Name of the Entity's Entity Type. |
in_workflow_instance | Whether this Entity has ever been submitted to a Workflow. |
barcode | Entity's barcode value. |