Lab Work

Use the Lab Work configuration screen to model the workflows, protocols, and master steps used in the lab on the Lab Work configuration screen.

Lab Work Overview

To access the Lab Work configuration screen, the Configuration:update permission is required. Without this permission, the Lab Work tab is not visible.

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.

To view and configure lab work components:

1. On the main menu, select Configuration.

2. Select the Lab Work tab.

   The main navigation panel lists the Workflows, Protocols, Steps and Master Steps configured in Clarity LIMS. From here, complete the following actions as needed:

   • View the relationships between workflows, protocols, steps, and master steps.

   • View workflow, protocol, step, and master step configuration in the form beneath the navigation panel.

   • See the status of workflows (pending, active, or archived).

   • Add and modify workflows, protocols, steps, and master steps.

3. Select a workflow, protocol, step, or master step to view related configuration items in the other lists.

   Selecting a protocol highlights the following items:

   • All workflows that include the selected protocol are highlighted.

   • All steps in the selected protocol are highlighted.

   • All master steps from which the steps are derived are highlighted.

   Selecting a workflow highlights the following items:

   • All protocols in the workflow, which display sequentially at the top of the Protocols list.

   • All steps in those highlighted protocols.

   • All master steps from which the highlighted steps are derived.

   Zoom out in the browser to maximize the number of items visible in the lists. Drag the lower edge of the panel to see more list items.

Best Practice for Lab Work Configuration

The best practice method for creating and configuring lab work components in Clarity LIMS is as follows.

1. Create and configure master steps.

2. Create and configure protocols.

3. Create and configure steps, adding them to the appropriate protocols, and using the master steps Create and configure workflows, adding required protocols.

4. Create and configure workflows, adding required protocols.

While these are the recommended steps, you can create protocols first, or create workflows and add the protocols later. However, before creating a step, you must select the protocol in which to add the step, and the master step on which to base its configuration.

Lab Work, Custom Fields and Automations Configuration Restrictions

When working with workflows, protocols, steps, and master steps, there are some restrictions you should be aware of. These restrictions are summarized below, and are also described in the articles that discuss the configuration details of each component.

The following section also lists the restrictions associated with custom fields and automations.

• Custom fields are configured on the Custom Fields configuration screen. Refer to Custom Fields.

• Step automations are configured on the Automations configuration screen. Refer to Automations.

Workflow and Protocol Restrictions

• Empty protocols cannot be added to a workflow. The protocol must include steps.

• Empty workflows cannot be activated. However, empty workflows can be saved in the pending state.

• Modify a workflow only while it remains in the pending state. You cannot rename a protocol included in an active or archived workflow.

• Delete a workflow only while the workflow remains in the pending state. You cannot delete active or archived workflows.

• A protocol cannot be removed from an active or archived workflow.

• A protocol cannot be deleted from an active or archived workflow.

• A protocol cannot be added to an active or archived workflow.

• Protocols cannot be reordered within an active or archived workflow.

Step Restrictions

• Steps in a protocol cannot be added, reordered, or deleted in an active or archived workflow.

• Settings saved as part of the master step configuration cannot be configured at step level. On the step configuration form, these settings display with a Locked icon.
• The master step can be changed, providing the new master step is of the same step type. The list of master steps is filtered to show valid options.

• If you remove configured settings from a master step, the settings on the derived steps revert to their default values unless doing so would leave the step in an unworkable state. For example, the last container from a step cannot be removed. Exceptions to this 'revert to default' rule are noted where applicable.

Master Step Restrictions

• A master step cannot be deleted if it is used to generate a step that is in an active or archived workflow.

• A master step cannot be deleted if it has already been used to create one or more steps. First, delete the step, and then delete the master step. In this case, the Delete button is disabled.

• After a step type has been chosen and saved as part of a master step configuration, it cannot be change.

Custom Field Restrictions

• A master step field cannot be deleted if it has been assigned a value, or is in use in a step. If a step derived from the master step with which the field is associated has been started.

• A custom field no longer displays if deleted in the LIMS interface; however, its information is retained in the database for historical purposes.

• If the field name specified is the same as a field that has been deleted, the new field is created and the conflicting field name is renamed in the database.

• A custom field cannot be deleted on a global field object or master step with the same name as an existing field on that object/master step.

  For example, if a global field is created called 'Description' on the Account object, another global field cannot be created called 'Description' on the Account object. However, a 'Description' field on the Project object can be created.

Step Automation Restrictions

• Multiple automations with the same name cannot be enabled on a master step, even if the automations are configured differently.

• Two automations can have the same name as long as they are unique in some other way. For example:

  • channel name is unique, or

  • command line is unique, or

  • run-program-per-eventvalues (available in the API only) are unique

NOTE: Attached files and associated master steps are ignored in these comparisons.