Worksheets in QBench

1. Overview

   Worksheets in QBench enable users to efficiently manage and organize test data, automate calculations, and pull data into reports. This guide provides an in-depth explanation of worksheet types, configurations, and best practices to optimize their use.

   Types of Worksheets

   QBench supports the following worksheet types, each catering to specific laboratory needs:

   1. Dynamic Worksheets:
      • Flexible spreadsheet-based worksheets with features like drag-and-drop for rows and columns, calculations, and conditional formatting.
      • Designed for advanced customization and integration with QBench APIs.
   2. Spreadsheet Worksheets:
      • Utilize Excel/Google Sheets-like functionality powered by Hyperformula.
      • Support for named cells, calculations, and reference fields.
   3. QWML (QBench Worksheet Markup Language) Worksheet:
      • Allows users to create custom worksheet layouts using QBench's proprietary markup language.
      • Enables embedding of input fields, calculations, and conditions directly within the worksheet.
      • Highly customizable for specific workflows and lab needs.

   How to Create Worksheets

   1. Navigate:
      • Go to Configuration > Lab > Worksheets.
      • From here, you have two options:
        1. Press the +New Worksheet button to start creating a new worksheet.
        2. Click All to access the Worksheet landing page and press the Create button in the upper right corner to begin creating a new worksheet.

   

   2. Provide Worksheet Details:
      • Name: Enter a name for the worksheet. This is required.
      • Type: Select one of the available worksheet types. This is also required:
        1. Dynamic Worksheets
        2. Spreadsheet Worksheets
        3. QWML Worksheets
      • Description (Optional): Add a description to specify the purpose or intended use of this worksheet.
      • Active/Inactive: Choose whether the worksheet should be active or inactive.
      • Require Reason for Updates: Specify if users will be required to provide a reason when updating this worksheet.
   3. Save:
      • Once all details are complete, press the Save button to finalize and create the worksheet.
      • After saving, the following tabs will now appear:
        1. Details: Houses the worksheet's name, type, description, and other metadata.
        2. Configuration: The section where you can begin designing the worksheet.
        3. Versions: Lists all versions of the current worksheet along with their varying statuses.
        4. Key Value Store: Functions like a dictionary of values (e.g., LOD, LOQ) that can be mapped to multiple worksheets.
        5. Assays: Displays a filtered list of all assays this worksheet is assigned to.
        6. Locks: Shows the history of locks applied to the worksheets.

   

   • Note: All saved worksheets will be listed in the Worksheet Landing Page and can be filtered based on various criteria.

   Configuration

   1. Navigate to the Configuration Tab:
      • After creating or selecting a worksheet, go to the Configuration tab to begin setting up additional options and details.
   2. Save a New Version:
      • Before beginning configuration, press the Save as a New Version button to ensure changes are tracked.
      • Tip: Press the Save Draft button frequently during configuration to avoid losing progress.
   3. Configure Based on Worksheet Type:
      • Dynamic Worksheets: Follow the Dynamic Worksheets Guide for detailed configuration instructions.
      • Spreadsheet Worksheets: Refer to the Spreadsheet Worksheets Documentation for more information on setup and use.
      • QWML Worksheets: See the QWML Configuration Manual for guidance on creating and configuring these worksheets.

   Versions

   The Versions tab provides an overview of all iterations of a worksheet, enabling users to track updates and manage different statuses. Key features include:

   • Version History:
     • View a list of all versions of the worksheet, including their statuses (e.g., Draft, Pending, Approved, Rejected, Obsolete).
   • Version Control:
     • Manage and revert to previous versions if necessary.
     • Identify differences between versions to ensure proper configuration tracking.
   • Status Management:
     • Easily update a worksheet’s status (e.g., set a Draft to Approved or mark older versions as Obsolete).

   How to Mark a Worksheet as Approved and Active:

   1. Save the Draft:
      • Ensure that the current draft of the worksheet is saved before making changes to its status.
   2. Navigate to the Versions Tab and Update Status:
      • Click on the Draft status of the worksheet.
        • Tip: Once a status is changed from Draft, edits cannot be made until a new version is created.

   

   • Select Yes to set the draft as Pending Approval.

   

   • Select the Pending status and mark it as Approved.
     • Note: A user can also reject a version at this step.

   

   • Select Yes to set the draft as Approved.

   

   • Select Yes to set the draft as Active.

   

   • The worksheet is now approved and active, meaning it can be used elsewhere in QBench.

   

   Note:

   • Once a worksheet is approved, a user can select the Approved status and mark the version as Obsolete, if needed.

   

   Examples of How to Use a Worksheet

   • Assigning Worksheets to Assays:
     1. Navigate to Configuration > Lab > Assay.

   

   2. Select the assay associated with this worksheet.
   3. Add the worksheet to the assay at the appropriate object level:
      • For test-level association, select the worksheet title in the Test Worksheet field.

   

   • For batch-level association, select the worksheet title in the Batch Worksheet field.

   

   4. After the Worksheet is assigned, it will appear at the appropriate object level when a Test/Batch is created with this assay.
   • Assigning Worksheets to Various Other QBench Modules: 
     1. Protocol Steps
     2. Equipment
     3. Inventory
     4. Logs