Overview

The QBench Visual Editor Template provides an intuitive way to create, customize, and manage templates for reports, labels, and print documents. It supports both visual configuration and underlying code for flexibility, making it a versatile tool for laboratories. This guide outlines key features and step-by-step instructions to help you effectively utilize the Visual Editor Template, ensuring alignment with the training process provided by QBench experts.

Applies To:

Laboratory administrators configuring reports, labels, or print documents.
Users managing custom templates for QBench workflows.
Teams requiring dynamic visual customization for lab outputs.

Within QBench, the Visual Editor can be used to create:

Reports: This includes order-level reports (details for all samples and tests in an order), sample-level reports (details for a single sample and its associated tests), and test-level reports (details for a single test).
Labels: Useful across the system for items such as samples, tests, equipment, inventory items, and stock.
Print Documents: These can serve purposes beyond reports and labels, such as sample submission forms, chain-of-custody documents, or summaries for batch analyses.
- For example:
  - Batch-level print documents can generate monthly summary reports for analyses conducted on multiple samples over a defined period.
  - Test-level print documents can provide detailed insights, such as out-of-spec investigations for specific tests.
Invoices and Quotations: Allow for professional documentation of financial transactions.

The Visual Editor includes dynamic functionality such as a field picker for inserting variables like test results, making it a versatile tool for generating structured, data-driven documents within QBench. Examples can be found in the Examples Section of this document.

Key Features:

Drag-and-Drop Interface: Simplifies template creation for users of all skill levels.
Dynamic Variables: Automate data insertion with system fields, enabling accurate and consistent data representation.
Advanced Customization: Supports:
- Barcodes and QR codes for efficient sample and test tracking.
- Conditional formatting to visually highlight critical data.
- Image embedding for logos, diagrams, and other visuals.
- Charts to represent data graphically, enhancing report clarity.
Worksheet Exports: Easily incorporate worksheet data into reports, ensuring seamless integration with lab workflows.
Named Cells: Allows precise mapping of worksheet data fields for targeted reporting.
Multi-Level Reports: Enables dynamic creation of order-level, sample-level, and test-level reports tailored to specific needs.

Getting Started

Accessing the Visual Editor

Navigate to Configuration > Application > Templates.
Select the type of template you want to create (Label, Print Document, or Report).
Click New Template and choose Visual Editor as the editor type.

Editor Types:

Visual Editor: A user-friendly interface for quick and intuitive setup. Ensure you select the Visual Editor option to access this tool and work in the correct environment for creating templates efficiently.
Code Editor: Designed for users comfortable with HTML and advanced coding. This option is not recommended for most users.

Structure and Functionality

The QBench Visual Editor is structured to provide a highly customizable environment for generating templates. Its components work in tandem to manage dynamic and static content efficiently. Here is a breakdown of its key elements:

Header: Appears at the top of each page for static elements such as titles, company logos, and summary information.
Body: Displays dynamic content, including loops, variables, and tables for organized data presentation.
Footer: Positioned at the bottom of each page, typically containing page numbers, disclaimers, or QR codes.
Page Setup: Controls layout elements like page size, orientation, and margins to ensure compatibility with output formats like labels or reports.
Variables: Dynamic fields that pull real-time data into the template, such as sample IDs, user names, or timestamps.
Loops: Automate data repetition, such as listing tests for a sample, using row-based, column-based, or sub-item list structures.
Images: Incorporate sample images, plate photos, or other visuals that can be attached to various levels in QBench.
Charts: Embed data visualizations linked to QBench’s charting functionality for batch or test-level insights.
Report Export Range: Use this to pull specific worksheet data, such as analyte summaries or detection limits, into your report.
Named Cells: Target specific data points from a worksheet by naming cells, avoiding the need for full-range exports.
Signatures: Automatically incorporate user-uploaded signatures from their profile into various documents for seamless personalization and authentication.

With these components, users can design templates that cater to a wide range of laboratory documentation needs, ensuring precision and adaptability.

User Interface & Design

The QBench Visual Editor is a powerful, intuitive tool that enables users to create and manage templates for reports, labels, and print documents. Its design streamlines template creation, supporting both dynamic data integration and aesthetic customization.

Configuration Tabs

The Visual Editor is structured into four main tabs, each tailored for a specific aspect of template management:

Details Tab
- Purpose: Define the basic properties and context of the template.
- Features:
  - Specify the template title and associated functional level (e.g., order, sample, or test).
  - Choose the editor type (Visual Editor is required for this functionality).
  - Enable or disable the template for active workflows.
- Example Use: Assign a template to an order-level COA report.
Design Tab
- Purpose: The primary workspace for building and customizing templates.
- Features:
  - Define and structure the Header, Body, and Footer sections.
  - Configure page settings like margins, dimensions, and alignment.
  - Use tools to insert variables, loops, images, and charts.
- Example Use: Create a sample-level report with a dynamic table listing test results.
Versions Tab
- Purpose: Track and manage the lifecycle of template iterations.
- Features:
  - View version history, including drafts and active versions.
  - Select an active version for use in workflows.
- Example Use: Activate a newly tested version of a print document for production use.
Attachments Tab
- Purpose: Add supplementary materials to templates.
- Features:
  - Include static files or dynamically linked attachments.
- Example Use: Attach a regulatory compliance document to a sample-level report.

Design Configuration & Tools

The Design Tab provides a rich, configurable workspace divided into four key sections:

Header

Purpose: Displays consistent information across all pages.
Common Elements:
- Static text (e.g., company name, report title).
- Dynamic variables (e.g., customer name, report date).
- Logos or accreditation symbols.
Example Use: Add a company logo and client details in every report header.

Body

Purpose: Contains the main content of the template.
Common Elements:
- Tables and loops for dynamic data presentation.
- Charts, images, and worksheet data export ranges.
- User or sample-specific attachments.
Example Use: List all tests for a sample in a detailed table with accompanying charts.

Footer

Purpose: Add closing details or supplementary information.
Common Elements:
- Page numbers, QR codes, and version history.
- Static disclaimers or accreditation logos.
Example Use: Include a QR code linking to a public report version.

Page Setup

Purpose: Configure layout and document dimensions.
Options:
- Adjust margins, page size, and alignment.
- Define header and footer sizes.
Example Use: Set dimensions for a shipping label template.

Toolbar Functionality

The Visual Editor toolbar offers an array of tools to enhance and format templates across the Header, Body, and Footer sections:

Text Formatting
- Options: Bold, italic, underline, font size, alignment, and colors.
- Example Use: Highlight section headers with bold and larger font sizes.
Lists
- Options: Numeric, alphanumeric, and bulleted lists.
- Example Use: Enumerate sample preparation steps in a report.
Page Elements
- Options: Insert page breaks, symbols, or emojis.
- Example Use: Add a page break between sections for clarity.
Dynamic Tools
- Insert Variable: Add dynamic fields for real-time data integration.
- Insert Loop: Automate repetitive data displays (e.g., multiple samples or tests).
- Advanced Tools: Configure charts, images, barcodes, and signatures.

Inserting Variables & Loops

Inserting Variables
- Purpose: Dynamically pull data into templates from QBench fields.
- Steps:
  1. Place the cursor at the desired location.
  2. Use the "Insert Variable" tool.
  3. Choose the top-level variable (e.g., sample, test, or order).
  4. Select the field (e.g., sample.id, order.date_created).
- Example Use: Add a "Sample ID" field that updates automatically for each report.
Using Loops
- Purpose: Automate the display of repetitive data.
- Types:
  1. Table Rows: Create vertical lists of data.
  2. Table Columns: Display horizontal data arrays.
  3. Sub-Item Lists: Present comma-separated values or inline lists.
- Example Use: List all tests associated with an order in a table.
Inserting Images
- Purpose: Add static or dynamic images to templates.
- Steps:
  1. Use the "Insert Variable" tool.
  2. Select an image from the sample or test attachments.
  3. Resize or reposition as needed.
- Example Use: Include chromatogram images uploaded to the test level.
Inserting Charts
- Purpose: Visualize data trends or results.
- Steps:
  1. Create charts under Configuration > Lab > Charts.
  2. Assign charts to assays or test methods.
  3. Insert charts using the "Insert Variable" tool.
- Example Use: Embed a line chart showing microbial counts over time.
Inserting Barcodes
- Purpose: Generate barcodes or QR codes for tracking and accessibility.
- Steps:
  1. Use the "Insert Variable" tool.
  2. Choose the barcode type (Code 128 or QR Code).
  3. Configure size and placement.
- Example Use: Add a QR code linking to a public report.
Inserting Signatures
- Purpose: Authenticate documents with user-specific signatures.
- Steps:
  1. Upload signatures under User Settings.
  2. Use the "Insert Variable" tool to add signature fields.
  3. Select signature images or name strings for insertion.
- Example Use: Add a reviewer’s signature to certify a report.

Best Practices

Preview Frequently: Test variables, loops, and formatting with sample data.
Optimize Layouts: Use tables and whitespace for clarity.
Plan for Errors: Configure fallbacks for missing data, such as custom IDs or optional fields.
Maintain Version Control: Use the Versions Tab to manage template updates.

By mastering the QBench Visual Editor's interface and functionality, you can create dynamic, professional, and efficient templates tailored to your laboratory's needs.

Step-By-Step For Common Use Cases

Creating Label Templates

Labels are versatile and can be used for samples, tests, or inventory. You can choose templates from the gallery or create custom labels.

Steps to Create a Label Template:

Select Template Type: Choose from the gallery or start from scratch.
Name Your Template: For example, "Sample Labels" or "Test Inventory."
Define Label Level: Specify whether the label applies to samples, tests, or other levels.
Add Design Elements:
- Insert static text such as "Sample ID".
- Use "Insert Variable" to dynamically pull data fields (e.g., Sample ID or User ID).
Incorporate Barcodes or QR Codes:
- Select barcode type (Code 128 or QR Code).
- Adjust size and placement.
Set Page Layout:
- Adjust margins (recommended: 0.1 inches).
- Define label dimensions based on your printer.
Preview and Save: Use sample data to preview your template.

Creating Print Document Templates

Print documents such as Chain of Custody (COC) forms can be generated at various levels (e.g., Order or Sample).

Steps to Create a Print Document Template:

Configure Headers and Footers:
- Add static text, logos, or images.
- Use "Insert Variable" to pull dynamic fields.
Set Up the Body Section:
- Insert loops to display multiple rows of samples or tests.
- Choose display formats: rows, columns, or sub-item lists.
Enable Dropbox Sign (Optional): Add signature fields for regulated workflows.
Preview and Save: Adjust formatting and preview with sample data.

Creating Report Templates

Reports are used for Certificates of Analysis (COA), sample-specific reports, or test-specific results.

Steps to Create a Report Template:

Select Report Level: Choose Order, Sample, or Test.
Define File Naming Conventions:
- Use Jinja syntax for dynamic file names (e.g., {{ order.id }}_COA_Report).
Insert Worksheet Data:
- Use "Render Worksheet" to include a data table.
- Pull individual or multiple named cell values using "Worksheet Values."
Add Charts:
- Use the "Insert Variable" tool to embed charts linked to your data.
Preview and Save: Test your report with various data sets.

Template Examples

Test Level Report

Batch Level Print Document

Inventory Label

FAQs

How do I add a logo to a template?

Drag and drop or copy-paste an image into the desired section.
Resize by dragging the corners or holding Shift to adjust proportions.

Can I use custom naming conventions for reports?

Yes, use Jinja syntax to dynamically generate file names based on data fields.

How do I integrate barcodes or QR codes?

Use the "Insert Variable" option to add barcodes/QR codes for any supported field.

How do I preview templates?

Use the "Preview" button to check templates with sample data.

Related Articles

QBench Worksheet Markup Language Documentation
Dynamic Worksheets Guide
Customizing QBench Reports

Feedback and Support

Still have questions? Contact our support team at support@qbench.com.