Products, parameters and groups

Configuration

Products, parameters and groups

This page explains the three lists that decide what your lab tests: parameters, groups of parameters and products. Work orders are built from them.

Who this is for: Laboratory owners and administrators, quality managers · You need: the "Manage parameters", "Manage groups of parameters" or "Manage products" permission, depending on what you change

The idea in short

List What it is Example
Parameter One thing you measure, with its unit, reference range and limits of detection. Lead, mg/kg
Group of parameters A ready-made set of parameters that are tested together, usually by one department. Heavy metals: lead, cadmium, mercury
Product What you receive for testing, with the groups of parameters it is usually tested for. Apples: Heavy metals, Pesticide residues

They build on each other: parameters go into groups, and groups go onto products. When a sample arrives, a work order is created from a product, from groups or from single parameters.

All three are found under Settings → Lab setup, as the Parameters, Groups of Parameters and Products tiles.

Parameters

How to add a parameter

  1. Open Settings and click the Parameters tile.
  2. Click New parameter.
  3. Fill in the fields (see the table below). Only Name is required. The window is wide: the fields are on the left in four parts (name and code, reference values, method limits, catalog and accreditation), and on the right On the report shows, as you type, how the parameter will read on a report — the markers raised, the reference value as it prints — and which groups it is in.
  4. Click Save changes.

To change a parameter, click its row. The row's ⋯ menu also has Duplicate (a new parameter with the same values; the external code is left empty, since it must be unique) and Delete, which is greyed out while a group holds the parameter.

The list shows each parameter's name (with its method code and external code under it), unit, reference value, LOD / LOQ, the groups it is in and whether it is accredited. The header counts your parameters, the accredited ones and those in no group. Search looks in the name, the method code, the external code (such as the CAS number) and the linked catalog substance, ignoring upper and lower case and accents; you can also filter by group and by accreditation.

Field What it means
Name and Suffix The name shown on work orders and reports. The suffix is a short marker (such as "1" or "a") shown as a superscript next to the value on a report. Explain what it means in the group's Legend.
Code and Suffix Your short code for the parameter, with its own superscript marker.
Unit The unit the result is given in, for example mg/kg.
Reference min / Reference max The reference range. Each is an operator (<, ≤, =, ≥, >) and a value. Fill in one or both.
LOD Limit of detection: the lowest amount the method can detect.
LOQ Limit of quantification: the lowest amount the method can measure reliably.
Measurement uncertainty The uncertainty of the result.
Reference value origin Where the reference range comes from, for example a regulation or standard.
Reference value for report and Suffix Free text shown on the report instead of the min/max range. Leave it blank to use the range.
External code An identifier from an outside standard (such as a LOINC or CAS number) or an internal code. If filled in, it must be unique.
Catalog substance An optional link to the shared substance catalog. See Catalog links.
Accredited Tick it if the parameter is within your accreditation scope.

There is no separate "method" field on a parameter yet, although the Settings tile mentions methods.

📷 Screenshot: the New parameter dialog with the reference range filled in

Other ways to add parameters

Both are under Import next to New parameter.

  • Import from Excel loads many parameters at once from a spreadsheet. See Importing from Excel.
  • Add from EU jurisdiction searches the EU Pesticides Database by name or CAS number and adds the substances you tick. The name, CAS number and catalog link are filled in for you. When the EU has one common limit across products, it is set as a generic Reference max: always check the real limit for each product. Substances you already have are marked Already imported and skipped.

Groups of parameters

A group bundles parameters that are tested together. On the group's page you set:

Section What it holds
Details Name, Name on the report (what the report prints for the group, when its name is an internal one such as "268 SUVA SLANINA - nitriti"; left empty, the report prints the name, which shows greyed out in the field), Responsible department (the department its work goes to; see assigning work) and Leading analyst. Picking a department fills in its leader as the leading analyst when none is chosen yet, and adds its laboratory.
Laboratories The laboratories that test this group.
Texts on the report Legend (explains the marks — superscripts — in parameter names, methods and reference values), Origin (where the reference values come from) and Report (any other text printed with the group). Each is a text editor: bold, italics, lists, sub- and superscript, links. Every work order starts from these texts and can change them for itself.
Parameters The parameters in the group, in the order they appear on the work order. Add them with Add a parameter... (one already in the group or among the configurable ones is listed but greyed out). Tick Standard on the ones that go on every work order. Tick Locked to allow only this group's parameters to be added to it on a work order.
Configurable parameters Parameters that are not part of the group, but that a technician can add to it on a work order when the test finds them. See Standard, locked and configurable.

In the Parameters table:

  • Change the order by dragging a row by its handle (⋮⋮), or focus the handle and press the up and down arrow keys. The search box narrows the rows; clear it to change the order again.
  • Several at once: tick rows, and a bar at the bottom of the screen offers Make standard, Make optional and Remove.
  • Removing a parameter here only takes it out of the group; the parameter itself stays.

The list of groups shows each group's department (in its colour), leading analyst, laboratories, how many parameters it has and how many are standard, and how many products use it. A group without a department is marked No department: its work reaches nobody until one is chosen. Search finds a group by its name or by the name or method code of a parameter in it, ignoring upper and lower case and accents; you can also filter by department, laboratory and leading analyst.

How to create a group

  1. Open Settings and click the Groups of Parameters tile.
  2. Click New group of parameters.
  3. Fill in Details, choose the Laboratories, write the texts and add the parameters.
  4. Click Create (or Create and Edit to stay on the group).

A group that a product or a work order uses can't be deleted; the Delete section at the bottom of its page says what still uses it.

Overrides: when one group needs different values

Sometimes a parameter needs a different unit, range or limit in one group, for example lead in water versus lead in food. Instead of creating a second parameter, use an override:

  1. In the Parameters table of the group, click the Overrides button on the parameter's row (Add, or "2 overridden" when it already has some).
  2. In Field overrides, fill in each field you want to change for this group. Every empty field shows the parameter's own value in grey.
  3. Click Apply, then save the group.

Only filled-in fields are overridden. Empty fields keep following the parameter, including later changes to it; for the sign and Accredited, choose As parameter. You can override the unit, reference min and max, LOD, LOQ, measurement uncertainty, reference value origin, the suffixes, reference value for report and Accredited.

Measurements per result works the same way for the whole group: set it on the group (The same for every parameter) and every parameter in it takes that many measurements or units, unless its own override says otherwise. See Several measurements for one result.

📷 Screenshot: the Field overrides dialog with Unit and Reference max filled in

Standard, locked and configurable

These settings decide what goes on a work order when the group is added, and what can be added to it later.

Setting What it does
Standard (per parameter) Ticked parameters go on the work order when the group is added. Unticked ones stay in the group and can be added to the work order later with Add parameters….
Locked (per group) Ticked: only the group's own parameters can be added to it on a work order. Unticked: any parameter can be added.
Configurable parameters A separate list for the group. They never go on a work order by themselves. A technician adds the ones the test finds with Add configurable parameters…. A parameter can be in the group or in this list, not both.

Example: a pesticide screen. You don't know in advance which pesticides a sample contains, so list the pesticides you can detect as configurable parameters. When the technician finds some, they add those to the work order and enter the results.

Products

A product is what you receive for testing. On the product's page you set:

Section What it holds
Details Name and Catalog product (its entry in the shared catalog; regulatory limits are looked up through it).
Laboratories The laboratories that test this product.
Groups of parameters The groups the product is usually tested for, in the order they go on the work order. Add them with Add a group of parameters... (one already on the product is listed but greyed out). Each row shows the group's department and how many parameters it has; drag a row by its handle (⋮⋮) to change the order, or tick rows to remove several at once.
Default expert opinion A text editor (bold, lists, links…).

An expert opinion is the lab's written conclusion on a sample. The Default expert opinion is the text a new work order for this product starts with, so you only edit what differs.

The list of products shows each product's catalog entry, its groups of parameters, its laboratories and how many work orders were made from it. Search finds a product by its name or its catalog product's name, ignoring upper and lower case and accents; you can also filter by group and by laboratory. A product with no groups is marked No groups yet.

How to create a product

  1. Open Settings and click the Products tile.
  2. Click New product.
  3. Fill in Details, choose the Laboratories, add the groups of parameters and, if you like, write the default expert opinion.
  4. Click Create (or Create and Edit to stay on the product).

A product that work orders were made from can't be deleted; the Delete section at the bottom of its page says how many.

How they are used on work orders

When you create a work order for a sample, you choose a Source:

Source What the work order gets
Product One panel for each of the product's groups. The product's default expert opinion fills in the work order's Expert opinion.
Group of parameters One panel for each group you choose, with the group's Standard parameters. You can choose several.
Parameter The chosen parameters, in a panel called Additional parameters.
  • If the sample already has a work order, choosing a product replaces it, and its results are removed. You are asked to confirm first.
  • Each panel keeps a copy of the parameters and values as they were when it was created. Later changes to a parameter, group or product don't change existing work orders, so finished results always match what was tested.
  • Panels can be renamed and reordered, and the same group can be added twice.
  • More parameters can be added to a group's panel later: the group's other parameters, its configurable parameters, and any parameter if the group isn't locked. See Work orders.

Estimated work time

Parameters, groups of parameters and products each have an Estimated work time: how long their work takes once a technician starts it, as a whole number of Hours or Days (working hours and working days of your working hours). A work order's estimated end uses the largest estimate among its product, groups and parameters, so set it where it is known and leave it empty elsewhere. See Estimated end time.

Changing an estimate applies to work orders planned from then on; work orders that already have an estimated end keep it.

A parameter can be linked to a Catalog substance and a product to a Catalog product. These are the shared catalogs that regulatory frameworks use for their limits (MRLs, the highest legally allowed amount of a substance). With both links in place, SmartLIMS can find the legal limit for a result automatically. See Regulatory limits and catalogs.

Rules

Rule What happens
A parameter, group or product still in use It can't be deleted.
Two parameters with the same External code Not allowed.
Editing a parameter or group Existing work orders keep their copy; only new work orders get the change.
Override ticked in a group That field no longer follows the parameter for this group.
A parameter both in the group and in its configurable parameters Not allowed.

Tips

  • Set a Responsible department on every group, so new work orders go straight to the right people.
  • Use overrides rather than duplicate parameters. It keeps one parameter per substance, which also keeps catalog links simple.
  • Fill in Accredited carefully. It marks which results fall within your accreditation scope.
  • Use the Legend to explain every suffix you use in the group.
↑↓ to move ↵ to open esc to close