Fields and Data Types Overview

Introduction

The "Fields and Data Types" page in QBench empowers administrators to customize the structure and flow of their data. This page provides powerful tools for managing data fields, ensuring consistency, and tailoring the platform to meet unique organizational needs. With this feature, you can:

• Define custom fields to suit your workflows.
• Configure field data types and validation rules for improved accuracy.
• Organize and control the visibility of fields across forms.
• Maintain data integrity through constraints like uniqueness and default values.

This article provides a comprehensive overview of the "Fields and Data Types" page, its capabilities, and how to use it effectively.

General Overview

Purpose of the Page

• Manage custom and core fields for various object types.
• Configure validation rules such as required fields, default values, and unique constraints.
• Group and organize fields for better usability.
• Adjust the order and visibility of fields to streamline workflows.

Typical Users

• Only QBench Administrators have access to this page.

Supported Object Types

Up to 19 object types can be configured, depending on your subscriptions and active modules. These include:

• Orders, Sample, Test, Source, Project, Epic, Batch, Assay, Panel, Customer, Invoice, Supplier, Contact, Equipment, Document, Issue, Inventory Item, Inventory Stock, and Location.

Additional configurations are available for Default Test Comments and Default Test Results.

Features, Options, and Other Capabilities

Supported Field Types

You can create and manage the following field types:

• Number
• Text
• Text Box (Paragraph)
• Date
• Date & Time
• Checkbox
• Dropdown
• Dropdown (Multi)
• Hyperlink
• Object Relationship
• Object Relationship (Multi)
• Rich Text

Key Features and Customization Options

The "Fields and Data Types" page provides numerous configuration options:

1. Field Identifier: The internal system name for the field. This is set during creation and cannot be edited later.
2. Field Label: The display name of the field throughout the application. Editable only for custom fields.
3. Make Required: Makes the field mandatory for saving data.
4. Reason Required When Updating: Prompts users to provide a reason for updating field values.
5. Make Unique: Ensures the field’s value is unique across entries (50-character limit).
6. Default Value: Automatically populates the field when creating entities via forms. This does not apply to entities created through APIs or automations.
7. Dropdown Options: Specifies the selectable options for dropdown fields in JSON format.
8. Object Type: Defines the target object for Object Relationship fields.

Core Fields

Core fields are predefined and cannot be deleted. These fields are essential to QBench’s core functionality and include settings like required fields and default values. However, customization options for core fields are limited.

Other Features

1. Edit Workflow Name: Allows administrators to rename workflows, reflecting changes globally throughout QBench. Available for Orders, Sample, Source, Project, Epic, Assay, and Panel.
2. Field Grouping: Groups fields into accordions for better organization on forms.
3. Show/Hide Fields: Controls field visibility to align with your workflow.
4. Top 3 Fields Search: For certain object types, the top three fields in the configuration are prioritized during searches.
5. Show on Order Receiving: Enables specific fields (e.g., Sample or Test fields) to appear on the Order detail page.

User Workflows

Key Actions

1. Adding a new field.
2. Editing a field’s configuration.
3. Deleting a custom field.
4. Adjusting the field order.
5. Showing or hiding fields.
6. Grouping fields together.

Step-by-Step Instructions

Adding a New Field:

1. Click the + New Field button.
2. Enter the required Field Identifier and Field Label.
3. Configure the field type and other options.
4. Click Save.

Editing a Field Configuration:

1. Click the Pencil Icon next to the field.
2. Modify the desired settings (e.g., Default Value, Required).
3. Click Save.

Deleting a Custom Field:

1. Open the field’s settings via the Pencil Icon.
2. Click the Delete button.

Adjusting Field Order:

1. Use the "sandwich" icon to drag and reorder fields.

Showing or Hiding Fields:

• To hide: Click Hide next to the field.
• To show: Check Show Hidden Fields and click Show next to the field.

Grouping Fields Together:

1. Click the Edit Group button.
2. Select an existing group or create a new one.
3. Assign fields to the chosen group.

Advanced Settings and Examples

Show on Order Receiving

This feature applies to specific object types like Samples and Tests. When enabled, selected fields will appear on the Order detail page. For example:

• "Sample Description" and "Sample Attachments" fields can be displayed under the relevant order.

Default Test Comments and Results

Administrators can configure default comments and results to appear as dropdown options in the Test List Page. Users can save time by selecting from these pre-configured entries.

Visual Aids

Navigation to "Fields and Data Types" Page

Page Overview

Fields Overview

Custom Field Configuration

Creating a New Field Group

FAQs and Best Practices

FAQs

1. What happens if I delete a custom field?
   • The field and associated data will be removed, but core fields cannot be deleted.
2. How do I make a field required?
   • Use the "Pencil Icon" to edit the field and check the Make Required option.

Best Practices

• Regularly review and clean up unused fields to maintain clarity.
• Use Field Grouping to simplify forms and improve user experience.
• Configure default values for frequently used fields to save time.