Clarity LIMS
Illumina Connected Software
Clarity LIMS v6.3 & Lablink v2.5
Clarity LIMS v6.3 & Lablink v2.5
  • Release Notes Clarity LIMS v6.3
    • Release Notes Clarity LIMS v6.3.1
    • Release Notes Clarity LIMS v6.3.0
  • Technical Overview
    • Technical Requirements
  • Installation
    • Installation Procedure
    • Guide to Secret Management
    • Install/Upgrade Secret Management for Integration Modules
    • Change the Clarity LIMS Hostname
    • Update Server Passwords and Database Connection Details
  • On-Premise Deployments
    • Pre-installation Requirements
      • Install a Purchased SSL/TLS Certificate
      • Configure Your HashiCorp Vault
    • On Premise to On Premise Upgrade Procedures
    • On Premise to On Premise In-place Upgrade Procedures
    • On Premise to Hosted Upgrade Procedures
    • Hosted to On Premise Upgrade Procedures
  • Administration
    • Database Cleanup Procedure
    • Backup and Restore Procedure
    • Receiving and Decrypting Cloud Backup Data
    • LDAP Integration
      • Using the LDAP Checker Tool
    • Illumina Connected Software Platform Integration
    • Clarity LIMS Log Files
    • Customize the Term Used for Projects
    • Enforcing Unique Sample Names Within a Project
    • Container Name Uniqueness
    • Configure Electronic Signatures
    • Creating Enrypted Passwords
    • Config Slicer Tool
      • Managing Configurations with Config Slicer
      • Upgrading a configuration package/manifest file for compatibility with Config Slicer v3.0.x
      • Config Slicer Use Cases
      • Troubleshooting Config Slicer
    • Audit Trail
      • Enabling, Validating and Disabling Audit Trail
    • System Settings
    • Automation Worker Nodes
      • Troubleshooting Automation Worker
  • Clarity LIMS v6.3 Reference Guide
    • Dashboards
      • Overview Dashboard
      • Projects Dashboard
    • Projects and Samples
      • Projects
      • Samples Accessioning
        • Sample List for Batch Import
        • Guidelines and Tips for Batch Sample Import
      • Assign and Process Samples
    • Lab View
      • Requeue and Rework Samples
      • Storing Sample Aliquots for Later Use
      • Modifying Completed Step Details
      • Alert Notifications
    • Configuration
      • Lab Work
        • Steps and Master Steps
          • Step Milestones
          • Derived Sample Naming Convention Tokens
        • Protocols
        • Workflows
      • Consumables
        • Reagents
          • Reagent Kit Lot Manifest for Batch Import
        • Controls
        • Instruments
        • Labels
        • Containers
      • Custom Fields
      • User Management
        • Manage User Access
        • User Roles
        • Configured Role-Based Permissions
        • User and Profile Page
      • Automations
        • Automation Trigger Configuration
        • Copy Custom Fields from Step Input to Output
        • Template Files Associated With Automations
    • Automated Quality Control
      • Configure a QC System
    • Search
      • Basic Search
      • Advanced Search
    • Genealogy View
    • System Performance
      • Queue Performance and Usability
      • Demultiplexing API Endpoint Performance
    • Terms and Definitions
  • LabLink v2.5 Reference Guide
    • Project
      • Email Notifications for Notes
    • Resource Materials & Contact Us
    • Users
    • Configuration
    • Publishing Files and Progress
Powered by GitBook
On this page
  • Controls Configuration Screen
  • Add and Configure Controls
  • Add a New Controls
  • Enable controls on a step
  • Control Use Settings
  • Single Step Only Controls
  • Archived and Reactivate Controls
  • Delete Controls

Was this helpful?

Export as PDF
  1. Clarity LIMS v6.3 Reference Guide
  2. Configuration
  3. Consumables

Controls

This section describes how to add and configure the control samples used in your lab, and enable them for use on specific master steps.

Controls Configuration Screen

Controls behave like special samples that can be enabled at specific points in your workflows. However, unlike samples, controls do not need to belong to a project and do not have to be assigned to a workflow.

Add the control samples used in the lab to Clarity LIMS, and enable them for use on steps. When running a step on which control samples are enabled, the lab scientist can add those control samples to the Ice Bucket.

All users logged into the LIMS can access the Controls configuration screen. However, their user permissions determine what they are allowed to do in this screen.

By default, only the Administrator role has the Configuration:update permission. For more on user roles and permissions, see User Roles and Configured Role-Based Permissions.

ClarityLogin Permission Access
  • View the list of controls but not add, edit, or delete them (all fields are read-only and New Control, Delete, Cancel, and Save buttons do not display).

  • View the details of a control, including the steps on which it is enabled.

Configuration: Update Permission Access

All actions listed in ClarityLogin, plus:

  • Add new controls

  • Modify controls

  • Delete controls

Access the Controls screen and View Controls
  1. On the main menu, select Configuration.

  2. On the configuration screen, select the Consumables tab and then select Controls.

  3. In the Control Samples area on the left:

    • Active control samples are listed alphabetically. These controls are in use, or are available for use, in the lab.

    • Archived control samples are listed in a separate group at the bottom of the list. These controls are not currently available for use in the lab.

    • For both active and archived controls, the number of steps on which a control is enabled is displayed. Hover over the label to see a list of the steps and the protocols that include those steps.

  4. Select a control sample to view its details on the right.

Add and Configure Controls

There is no limit to the number of controls you can create or the number of steps on which you can enable a control. When adding a new control, you are not required to enable it on a step. You can do this action at any time.

Control sample/step configuration is bidirectional. Enable a control sample on a step in the following situations:

  • When adding control samples on the Controls configuration screen (described in this section).

Add a New Controls

  1. On the main menu, select Configuration.

  2. On the configuration screen, select the Consumables tab, then select Controls.

  3. On the Controls configuration screen, select New Control.

  4. Type a name for the control sample. This name displays in queues of steps on which controls are enabled. This field is the only required field.

  5. [Optional] Enter additional details for the control sample:

    • Supplier—Enter the commercial vendor name. If this control sample was made in the lab, enter in-house.

    • Cat. #—Enter the catalog number.

    • Website—Enter the website of the commercial vendor. If it is an in-house control, enter the URL of the internal web page that contains details of the in-house control. When viewing details for the control sample, lab scientists can select the link to open the web page in a new browser window.

  6. In the Control Use section, note the following defaults:

    • The status of the new control is set to Active.

    • The new control is not flagged as a single step only control.

  7. Select Save.

    The new control displays in the Control Samples list.

Enable controls on a step

Enabling controls on steps makes them available for use in the lab.

To enable a control sample on a step, complete the following steps:

  1. On the Controls configuration screen in the Control Samples list, select the control to enable on steps.

  2. In the Control Use area, select the protocol that includes the step on which you want to enable the control. Type the first few letters of the protocol to filter the list.

  3. In the adjacent list, select the step on which you want to enable the control.

  4. Enable the control on additional steps, if necessary.

  5. Select Save.

    The Control Samples list now indicates that the control has been enabled on a step. Hovering over the 'On 1 step' label displays a popup that shows the protocol and step involved.

Control Use Settings

Control Status

The status of a control may be Active or Archived.

  • Active controls are controls that are in use or available for use in the lab workflows.

  • Archived controls are controls that are not currently available for use in the lab workflows.

    • Lab users do not see archived controls when initiating steps.

    • Configuration details for archived controls are saved, so it is easy to reactivate them.

In the Control Samples list, archived controls are listed in their own group. Select the arrow to expand the list and view control details.

Single Step Only Controls

Single step only controls do not progress in workflows. When completing a step, lab users do not need to select a Next Step for these controls.

Use this option to represent single-use, disposable samples such as QC standards, molecular weight ladders, and blanks.

Archived and Reactivate Controls

Archived Controls

  1. In the Control Samples list, select the control to archive.

  2. On the Status of Control slider, select Archived.

  3. Select Save.

Reactivate and Archived Controls

  1. In the Control Samples list, expand the archived control group and select the control to be activated.

  2. On the Status of Control slider, select Active.

  3. Select Save.

Delete Controls

When deleting controls, keep the following details in mind:

  • You can only delete control samples that have not been used in a step.

  • If a control sample has been recorded in a step, or is currently being used in a step, you cannot delete it. The Delete button is not enabled.

To delete a control:

  1. On the Controls configuration screen in the Control Samples list, select the control to delete.

  2. In the Control Sample Details area on the right, select Delete.

PreviousReagent Kit Lot Manifest for Batch ImportNextInstruments

Last updated 9 months ago

Was this helpful?

When configuring a step (see ).

Add and Configure Master Steps and Steps