Steps | Labii Documentation (original) (raw)
For the complete documentation index, see llms.txt. This page is also available as Markdown.
Steps
Track and manage the progress of laboratory projects or tasks by breaking them down into individual steps with timers, variables, comments, and action buttons for guided protocol execution.
3.0.0 (updated on 2024-01-01)
The Steps widget enables laboratory teams to break complex projects, protocols, and tasks into individual, ordered steps and track their completion in real time. Each step displays its content, a built-in timer, a comment area, and configurable action buttons, giving technicians everything they need to execute a procedure without leaving the record. Steps can be marked as complete (with automatic user and timestamp capture) and optionally verified by a second reviewer, supporting dual-role quality control. Steps can be created manually, imported from .txt, .docx, or .md files, or generated automatically from a protocol name using the built-in AI assistant. The Run Procedure mode further enhances guided execution with full-screen step display and text-to-speech narration.
- Experimental Protocol Execution: Load a standard operating procedure (SOP) as a step list and guide bench scientists through each stage, capturing completion timestamps and verifications for regulatory records.
- Sample Processing Workflows: Break multi-stage sample handling (receipt, labeling, aliquoting, storage) into discrete steps so technicians can track progress and record step-specific results.
- Quality Control Checklists: Enforce dual-role QC by requiring one user to complete each step and a second to verify it before proceeding.
- Time-Sensitive Procedures: Attach timers to steps that require precise incubation or reaction times, alerting users when to proceed.
- Onboarding and Training: Provide new staff with guided, step-by-step procedures that they work through interactively, with text-to-speech narration in Run Procedure mode.
- Document Import Efficiency: Import existing protocol documents (
.txt,.docx,.md) directly into the widget to avoid manual re-entry of established procedures.
The read-only view displays a numbered list of all steps. Each row shows the step order number, step content, completion status, verification status, and the recorded user and timestamp for any completed or verified steps. Completed steps have a teal background. Timer countdowns and action buttons are hidden in this view.
- Completion Indicator: Completed steps display the completing user's name and timestamp inline.
- Verification Indicator: Verified steps display the verifying user's name and timestamp.
- Step Variables: If a restricted step has variables recorded, they appear inline below the step content.
The edit view activates all interactive controls for each step.
Each step row in edit view provides the following controls (visibility controlled by configuration):
Edit the step content inline.
Edit the step's action buttons and timer.
Insert a new step directly above the current step.
Mark the step as complete. Captures the user and timestamp automatically. Step background turns teal.
Reverse the completion status of a completed step.
Mark the step as verified (available only after a step is completed). Captures the verifying user and timestamp.
Open a dedicated results section linked to this step.
Record step-specific variables or comments (available when is_restricted is enabled for the step).
Drag to reorder the step within the list.
Configure the Steps widget to show or hide controls based on your workflow requirements.
Click the Configure button (Widget edit button) at the bottom of the Steps widget to open the settings panel.
Enable or disable the controls you need:
- Should display Edit button: Show the Edit button on each step row.
- Should display Insert button: Show the Insert button to allow inserting steps above existing ones.
- Should display Complete button: Show the Complete and Undo buttons for step completion tracking.
- Should display Verify button: Show the Verify button (only visible after a step is completed).
- Should disable actions if step not current: When checked, users can only interact with the current active step; all other steps are locked until the preceding step is completed.
Click Save to apply the configuration.
For regulated laboratory environments (GLP, GMP), enable Should display Complete button, Should display Verify button, and Should disable actions if step not current together to enforce strict sequential execution with dual-role sign-off.
The Verify button only appears on a step after it has been marked as complete. Ensure the Complete button is also enabled when using the Verify feature.
Click Add Step at the bottom of the step list.
Fill in the step fields:
- Step: The content or instructions for the step.
- Action: Optional action buttons (Name, Icon, Action type, Parameters). See Flowchart for supported action types.
- Timer: Optional countdown timer (Hours, Minutes, Seconds) to indicate how long to wait before executing the next step.
Click Save to add the step to the list.
Load Steps from an External File
Import an existing protocol document to populate the step list automatically.
Click Add Step to open the step creation panel.
Drag and drop a .txt, .docx, or .md file into the cloud upload area, or click the cloud icon to browse for a file.
All steps detected in the document are loaded into the widget in the order they appear in the source file. Review and adjust as needed.
Formatting each line or numbered item as a separate step in your source document ensures the cleanest import results.
Use the built-in AI assistant to generate protocol steps automatically from a protocol name or description.
Click Add Step to open the step creation panel.
Locate the AI input area and enter the name or a brief description of the protocol.
Submit the prompt. The AI generates a structured set of steps based on the protocol description.
Review the generated steps, edit any that need adjustment, and save.
Run Procedure mode provides a guided, full-screen execution experience with optional text-to-speech narration — ideal for hands-on bench work.
Click the Run Procedure button in the Steps widget header.
The first step opens in a full-screen modal. Read or listen to the step instructions. Text-to-speech narration starts automatically by default.
Perform any step actions available in the modal (Add results, Add variables, Complete, Verify, Start timer).
Click Next to proceed to the next step, or Previous to go back. Use Goto step to jump to any specific step.
Continue until all steps are complete, then close the modal.
Run Procedure Controls:
Jump directly to any step by selecting it from a list.
Manually trigger text-to-speech narration for the current step.
Disable automatic text-to-speech narration.
Open the results section for the current step.
Record step-specific variables or comments.
Mark the step complete with user and timestamp.
Reverse completion status.
Structuring Steps for Clarity
- Write each step as a single, actionable instruction. Avoid combining multiple actions in one step, as this makes completion tracking ambiguous.
- Use the Timer field for steps with defined wait periods (e.g., incubations, centrifugation) so users receive a time cue automatically.
- Attach Actions to steps that require opening a form, link, or downstream workflow to keep all necessary resources accessible from the step itself.
Compliance and Audit Readiness
- Enable Should display Complete button and Should display Verify button for any regulated procedure. Completion and verification records capture user identity and timestamp automatically, satisfying 21 CFR Part 11 and GxP audit requirements.
- Enable Should disable actions if step not current to enforce strict sequential execution and prevent out-of-order sign-off.
- Use Add results to link a data entry section to the step where observations are recorded, keeping results traceable to the specific step that generated them.
- For recurring protocols, import steps from a master
.docxor.mdfile rather than recreating them manually on each new record. - Use the AI step generator to draft a step list quickly from a protocol name, then refine the output — this is faster than writing from scratch for well-known procedures.
- In Run Procedure mode, enable text-to-speech narration so technicians can follow the protocol hands-free at the bench.
Combining the Steps widget with a CKEditor section for background notes and a Data Grid or Files section for raw data creates a complete, self-contained experimental record.
- Avoid hiding both the Complete and Verify buttons in regulated workflows, as this removes the audit trail for step sign-off.
- Avoid placing too many actions on a single step; this can overwhelm users. Instead, split complex steps into discrete sub-steps.
- Instead, use the Insert function to add interim steps when a procedure needs to be refined mid-execution.
Flowchart: Presents the same type of process as a visual node diagram with conditional branching and redirect loops. Use the Flowchart widget when the workflow has decision points or non-linear paths. Use Steps when a sequential list view is sufficient.