use-workflows-automate-tasks-230x144

Choose an article below to learn how to create and run workflows to automate your frequent tasks and important processes.


You can use the workflow features in OMNIC Paradigm software to automate important procedures and frequent tasks. A workflow is a series of software operations that can be initiated with the click of a button. The software operations are represented by tiles, which you drag and drop onto the workflow canvas in OMNIC Paradigm software. You can specify settings for data collection, provide instructions for operators, and define data processing, reporting, and archiving in advance. Once a workflow has been created, operators can use it repeatedly to complete the steps the same way every time.

This article provides an overview of these basic workflow features and tools:

  • Workflow pane
  • Play Workflow window
  • Workflow editor

Workflow Pane

The workflow pane is always available at the bottom of the OMNIC Paradigm dashboard. Use this space to preview and play workflows you’ve created, and to open the workflow editor to edit or create a new workflow.

Figure 1. Workflow Pane on the OMNIC Paradigm Dashboard

use-workflows-automate-tasks-1-690x455

1. Most recent workflows (click once to preview a workflow; click twice to play it)
2. Right-click a workflow for more options

3. Preview of selected workflow
4. Enlarge or reduce the Workflows pane

Table 1. Work with existing workflows from the workflow pane

To do this... Take this action
Select and preview a workflow Click once on the workflow name
Test or run a workflow Double-click the workflow name. This opens the Play Workflow window where you can step through the workflow tasks.
Edit, rename, duplicate, delete or export the selected workflow Right-click the workflow and choose an option from the shortcut menu.

Play Workflow Window

Use the Play Workflow window to test or run a workflow. To open the Play Workflow window, double-click a workflow name in the Workflows list on the dashboard.

Figure 2. Double-click a Workflow Name to Run the Workflow

use-workflows-automate-tasks-2-690x432

1. Selected workflow (double-click to open and run this workflow)

From the Play Workflow window, use the arrow button to move to the next task in the workflow. The workflow will play exactly as it has been designed, with tasks and operator messages displayed as indicated by the workflow.

Figure 3. Play Workflow Window

use-workflows-automate-tasks-3-690x454

1. Toolbar

To stop the workflow and return to the dashboard, click the Stop button in the Play Workflow window. (If the workflow doesn’t have a Stop button, click the Dashboard button on the toolbar to stop the workflow.)

Workflow Editor

The workflow editor contains all the tools for creating workflows, including the workflow menu, toolbar, tile selection bar, and canvas. To open the workflow editor, right-click a workflow name on the dashboard and choose Edit from the shortcut menu.

You can also open the workflow editor from the OMNIC Paradigm main window by choosing:
File (menu) > Workflows > Create Workflow

The workflow canvas is where you select and set up the tasks you want the workflow to perform and join tasks together to create the workflow. The workflow editor opens with the mandatory “Workflow Start” and “Workflow End” tiles displayed on the canvas. Available settings for each tile in the current workflow are in the expandable sections below the canvas. Tools for scrolling, zooming and resetting the canvas view are at the right. A handy toolbar is above the canvas.

Figure 4. Workflow Editor

use-workflows-automate-tasks-4-690x431
  1. Toolbar
  2. Tile selection bar
  3. Canvas
  4. Tile settings
  1. Tools to adjust and reset the canvas view
  2. Start tile
  3. End tile

Each task is represented by a colorful tile in the tile selection bar. Here are some commonly used examples:

use-workflows-automate-tasks-8-106x123
use-workflows-automate-tasks-5-106x123
use-workflows-automate-tasks-6-106x123
use-workflows-automate-tasks-7-106x123

Tools for creating, opening, and exporting workflows are located in the Workflow submenu (available from the OMNIC Paradigm File menu). Example workflows, available here, are a good place to start, or you can create a workflow from a spectrum’s history. See “Create and Run Your First Workflow” for details.

Tiles can be added, moved, copied and deleted to create the desired workflow. For more information, see the article titled “Edit a Workflow.”

This article explains a simple way to create workflows in OMNIC Paradigm software. For basic information about workflows and brief descriptions of the workflow features and editing tools, see the article titled “About Workflows” in the OMNIC Paradigm online help.

Note The software operations to create workflows are available only in the desktop version of OMNIC Paradigm software (not the touchscreen version).

There are several ways to create workflows. Some approaches may work better than the others, depending on the steps you are trying to automate and how you want to start. For example, you can create a new workflow by:

  • building a workflow from scratch
  • editing a workflow that someone gave you
  • duplicating an example workflow provided with the software
  • performing the measurement tasks you want to automate and letting the software create the workflow from the spectrum’s history information

This article shows how the software can create a workflow automatically based on the history of an acquired spectrum. It also demonstrates how to:

  • run a workflow from the workflow editor or dashboard
  • identify workflow generated spectra
  • edit a workflow by adding tiles, and
  • fix a common workflow error

The last section provides useful tips for creating and editing workflows.

Create a Workflow

To create a new workflow from an acquired spectrum

1. From the OMNIC Paradigm dashboard, acquire a spectrum of a sample material. It doesn’t matter what kind of material or sampling technique you use. If the software requires a new background measurement, go ahead and do that first. When the sample measurement is completed, the sample spectrum is displayed in the spectral view.

Here is our example spectrum (plastic bag measured with an Attenuated Total Reflectance, or ATR, accessory) displayed in the spectral view:

use-workflows-automate-tasks-2-1-690x431

2. Make sure the spectrum is selected in the spectral pane and then perform any processing or analysis steps you like (for example, subtraction, baseline correction, correlation search, etc.).

Here is our example spectrum after applying Advanced ATR Correction and Automatic Baseline Correction and then performing a Correlation Search.

use-workflows-automate-tasks-2-2-690x431

3. Give your spectrum a descriptive name (the software will use this name for the created workflow).

  • Right click the image of the original spectrum in the results panel and choose Rename Spectrum.
  • Replace the default name with a descriptive name for your workflow and choose OK.
    Here is our renamed example spectrum.

     

use-workflows-automate-tasks-2-3-690x431

4. Once you have completed your processing and analysis steps, click the History button in the results panel.

The history panel shows all the tasks performed on the selected spectrum in the order in which they were performed. Here is the history information for our example spectrum.

use-workflows-automate-tasks-2-4-690x431

5. At the bottom of the history panel, click Create Workflow.

use-workflows-automate-tasks-2-5-326x711

The software creates a workflow that includes all of the steps you just performed. The workflow is displayed in the workflow editor. Each performed task is represented by a colorful tile. Depending on which steps you performed, your workflow may look different from our example below:

use-workflows-automate-tasks-2-6-690x431

6. To save your new workflow, click the Save button on the toolbar.

use-workflows-automate-tasks-2-7-631x392

7. To run the workflow, click the Run button on the toolbar.

The workflow performs the same tasks you completed manually in exactly the same sequence. In our case, we measured a spectrum, performed an Advanced ATR Correction, corrected the spectral baseline, and performed a correlation search.

When the workflow is done, the software returns to the Workflow Editor.

8. Click the Dashboard button on the toolbar to see your newly created workflow in the Workflows list.

The workflow is named automatically based on the name of the spectrum used to create it. Here is our newly created example workflow in the Workflows list and a preview of the workflow in the preview box.

use-workflows-automate-tasks-2-8-690x431

9. The workflow-generated spectra appear in the Measurements list.

use-workflows-automate-tasks-2-9-690x358

Our example workflow created four spectra, the measured background spectrum, the measured sample spectrum, the ATR corrected sample spectrum, and the ATR and baseline corrected sample spectrum with the search results. The workflow-generated spectra are named with the Tile Name properties of their associated workflow tiles.


Add Tiles to a Workflow

This section demonstrates how to use the workflow editing tools to add tiles to your auto-generated workflows.

1. From the dashboard, right-click the workflow name and choose Edit.

use-workflows-automate-tasks-2-10-690x432

The workflow opens in the workflow editor.

use-workflows-automate-tasks-2-6-690x431

2. Add a Tag Spectrum tile to the workflow.
Workflow-generated spectra are saved in the OMNIC Paradigm database along with any data acquired manually. Let’s tag the workflow spectra to associate them with our workflow. This makes it easy to open and view them later.

  • In the workflow editor, drag the Tag Spectrum tile from the selection bar to the canvas so that your mouse cursor hovers over the grey arrow between the Measurement and ATR Correction tiles.
    The grey arrow changes to a plus sign.
use-workflows-automate-tasks-2-12-690x432

b. Release the mouse button.
The tile is added to that location in the workflow and its settings box is opened below the canvas.

use-workflows-automate-tasks-2-13-690x431

c. In the Tag Settings enter a base name for your workflow-generated spectra, such as “ATR Search Spectra”, make sure Select Spectrum is set to your measured spectrum (“Measurement - Sample”), and choose OK.

use-workflows-automate-tasks-2-14-690x157

The Tag Spectrum tile will automatically add the “ATR Search Spectra” tag to each spectrum generated by the workflow. We’ll explain how to search for those spectra later.

Now let’s explore what happens when we add a tile that flags an error.

3. Add a Report Template tile to the workflow.

  • In the workflow editor, use the mouse to hover over the grey arrow between the Search and End tiles (arrow changes to a plus (+) sign) and then click the mouse button. The software opens the Add Tile box. (This is another easy way to add tiles.)
use-workflows-automate-tasks-2-15-690x432

b. In the Add Tile box, select the Template Report and choose OK.

The tile is added to that location in the workflow and its settings box is opened below the canvas.

use-workflows-automate-tasks-2-16-690x263

Notice that the Report Template tile has a red border, which indicates the workflow won’t run successfully right now. If we view the Report Template settings, the boxes are all blank.

use-workflows-automate-tasks-2-17-690x251

To fix the problem, we need to specify a template for the report and which results to include.

c. Set Template Type to your preferred report style (we are using the Search Results template), set Search Results To Display to your workflow’s output (“Search Result” in our example) and choose OK.

use-workflows-automate-tasks-2-18-690x269

Notice that the red border is no longer there.

use-workflows-automate-tasks-2-16-690x263

4. To save the updated workflow, click the Save button on the toolbar.

5.To run the workflow, click the Run button on the toolbar.
The workflow runs through all the steps and then displays the final report.

Click the arrow button to end the workflow.

use-workflows-automate-tasks-2-19-690x432

6. Click the Dashboard button on the toolbar to return to the dashboard.

7. If you select the workflow in the Workflows list, the preview has been updated.

use-workflows-automate-tasks-2-20-690x430

8. If you enter your tag in the Search box, the software shows you the workflow-generated spectra in the Measurements list.

use-workflows-automate-tasks-2-9-690x358

To view the spectra in the spectral pane, use Shift + Click to select all four in the Measurements list, then right-click and choose “Open Selected Measurements.”

9. To see the workflow-generated report, click this arrow button and select “Reports.”

use-workflows-automate-tasks-2-22-690x360

Tips on Creating Workflows

Before you head off to create more workflows, read through these answers to common questions about workflows and tips for solving any problems that may occur.

  • Is the order in which the tiles appear in the workflow important? Yes, the order of the tiles is important. Each workflow tile builds on the previous tiles, and all the tiles are interconnected by their input requirements and their output results. For example, if you add a Measure tile, it creates an output result (a spectrum), which can only be accessed by tiles positioned after the Measure tile in the workflow. If you want to baseline correct the acquired spectrum, you would need to add a Baseline tile after the Measure tile, and then set the Baseline input to the Measurement output (i.e., the spectrum). Otherwise, the Baseline tile will have a red border, indicating it contains options that must be set before the workflow will run. If you see a tile that has a red border, use the mouse to hover over that tile for help finding the source of the problem.
  • Do I need to add a background measurement to my workflow? Not unless you want the workflow to perform an operation only on the background spectrum. If you only need a background spectrum in order to process your measured sample data, then you just need to add a Measure tile to the workflow and use the Measure tile settings to define the background measurement.
  • Can I change the titles of the workflow tiles? Each workflow tile has a setting that specifies the tile name. (Double-click the tile in the workflow editor to open its associated settings.) The Tile Name setting can be used to add detail to your workflow. This can help the workflow developer keep things organized, especially when creating workflows that contain multiple paths or loops, or multiple tiles of the same type (several Measure tiles, for example, in the same workflow).
    The tile names may also be used to name output files when the workflow is run. Here are some examples:
    • Measure tile. This tile acquires background and sample spectra. When the workflow is run, the sample spectrum is saved with the tile name of its associated Measure tile.
    • ATR Correction Tile, Process Tile, etc.. Tiles that operate on acquired spectra generate output spectra that are saved along with the final sample spectrum when the workflow is run. Each interim “processed” spectrum is saved with the tile name of the workflow tile that generated it.
    • Report tile. This tile creates a sample report. When the workflow is run, the report is saved with the tile name of its associated Report tile.
  • Should every workflow have an Archive tile? The answer to this question is “no.” Any spectra and reports generated from a workflow are saved automatically in the OMNIC Paradigm database, along with all the other spectra and reports that are created manually with the spectrometer (that is, not from a workflow). If you want to save your workflow-generated spectra and reports as files that can be archived or opened elsewhere (from your OMNIC Paradigm workstation software, for example), use an Archive tile to create those files automatically.
  • Why doesn’t my workflow run? Before you run a newly created workflow, ensure there are no tiles with a red border. Here is an example:
use-workflows-automate-tasks-2-23-690x270

The workflow will not run to completion if it contains a tile with a red border.
If your workflow has a red bordered tile, use the mouse to hover over the tile for tips on how to solve the problem. Typically, the red border indicates the tile contains required options that have not been set. However, it can also mean the tile is “illegal.” For example, if you place a Baseline tile before a Measure tile in a workflow, the Baseline tile will have a red border and the workflow will contain an unresolvable error because there is no output spectrum to baseline correct.

Workflow tiles are icons that represent the tasks a workflow can perform. Each tile has settings that define what the tile does when the workflow runs. To see a tile’s settings, add the tile to your workflow on the workflow canvas, then double-click the tile.

This reference of workflow tiles is organized alphabetically. Each tile description includes a description of available settings.

Archive

Send data and reports to a user specified location. This location can be on your local system or on a network or flash drive for alternate storage.

Setting

Description

Select data to archive The base name is prepended to the full file name.

When the file is archived, it is named according to the following template:

<base name>_<workflow name>.<tile name of data creation>.<variable name>_YYYY_MM_DD_HHMMSS_<time zone in GMT>.<file extension>

For example, with a base name of “example” and a workflow called “my workflow”, a spectrum collected on the Measure tile would be archived as the following:

“example_my workflow.Measure.Sample_ 2019_06_25_104928_GMT-0500.spa”

File location The directory in which the file will be archived.
Tile name Sets the name of the tile in the workflow canvas

ATR Correction

Corrects ATR spectra for the effects of variation in the depth of penetration and the shifting infrared absorption bands that occur with the ATR technique.

Setting

Description

Crystal type Select the type of crystal used to measure the sample.
Angle of incidence Enter the angle of incidence that was used to measure the sample. See the specifications for the accessory to obtain this value.

The Everest ATR Accessory: 45°

The default value is 45.00
Sample refractive index Enter the refractive index of the sample at 1000 cm-1. Most organic materials range between 1.45 and 1.55 at 1000 cm-1. Materials that contain carbon black have higher refractive index values (1.7 or higher). If you do not know the refractive index of your sample material at 1000 cm-1, we recommend using the default value of 1.5.
Number of bounces Enter the expected number of internal reflections of the infrared beam that occurred in the ATR crystal. See the documentation for your ATR accessory for information about crystal material, angle of incidence, and the number of bounces.

The default value is 1.00
Select spectrum ATR Correction is applied to the specified spectrum.
Tile name Sets the name of the tile in the workflow canvas

Decision

With a Decision tile, you can control the flow of the workflow based on criteria that you specify. For example, you can provide two separate paths based on whether or not a correlation search result had a match value above a specified threshold.

Setting

Description

Pass/Fail Select a pass/fail decision type to use a previously generated pass/fail result as the decision criteria.

For example, the Peak Analysis tile can generate a pass/fail result based on the measurement of the peak height. For instance, you can specify that if the peak height is above a given value, generate a pass result, and if it was below that value, generate a fail result. Then, you can use the decision tile to continue the workflow in two separate paths, depending on that result.
Numeric Value Select a numeric value to be used in the decision. The value can be data generated in a previous workflow tile or it can be a value that the operator entered using the Instruction tile.

For example, you can check if the match value of a search result was above a specified threshold and continue the workflow based on that criteria.
String Value Select a string value to be used in the decision. The string can be data generated in a previous workflow tile or it can be text entered by the operator using the Instruction tile.

With a string value, you can check if the selected value is equal to or contains your test string.

For example, if you select Contains and provide “Poly” as the test string, the decision tile will evaluate to True if the selected value is Polystyrene.
Spectrum Age Ccontrol the flow of the workflow depending on the age of a spectrum.

For example, you can check if a background spectrum is more than 20 minutes old before moving on to another step in the workflow and then measuring a new background if necessary.
Tile name Sets the name of the tile in the workflow canvas

Delay

Pauses the workflow for the indicated amount of time before proceeding.

Setting

Description

Delay (seconds) The number of seconds that the workflow will remain paused
Message The message is displayed to the operator during the delay
Tile name Sets the name of the tile in the workflow canvas

End

Every workflow has at least one End tile. If your workflow includes Decision or Selection tiles, there may be more than one possible ending.

Setting

Description

End type Choose Success or Failure for a visual indication of the workflows end state. The end type does not affect data in the workflow. It only provides a visual cue to the workflow developer.
Note Use the note field to enter text for a tooltip that appears when hovering over the tile in the workflow canvas. This is useful for providing a reminder to the workflow developer. For example, if used with a Failure end type, the note could summarize the test that caused the failure.
Tile name Sets the name of the tile in the workflow canvas

Export

Exports collected data to a CSV file.

Setting

Description

Select data to export Select available data that can be exported to the CSV file, such as peak heights or search result match values.
Append to file If selected, will append the exported data to an existing CSV file.

To append the data to an existing file, enter the name of the file in the File Name field. If the file doesn’t exist, a new file will be created with the name you entered.
File name (only available if Append to File is selected)

Enter the name of the file that the data will be appended to. If the file does not already exist, a new file will be created.
File base name (only available if Append to File is not selected)

The file base name is added to the file name before the date and time
File location The directory in which the file will be appended or created
Tile name Sets the name of the tile in the workflow canvas

Instruction

Use the Instruction tile to provide additional instructions to the workflow operator. The Instruction tile can also include entry fields for the operator to enter text or numeric data. These entries can later be used in the workflow. For instance, text entered by the operator can be added to a custom report.

Setting

Description

Add Image Add an image that the operator will see on the instructions screen during the workflow. Valid file types include:

.PNG
.JPG
.GIF
.BMP
Add Text Box Use to add text. This is useful for providing instructions to the operator and for adding labels to text and numeric entry fields.
Add or Remove PDF Provide a button that operators can click or touch to view a specified PDF.

After adding the document button, click the button to specify the PDF file.
Add or Remove Cancel Button Provides a cancel button that the operator can click or touch to stop the workflow.
+ Text Entry Allows the operator to enter text which can be used later in the workflow.

For example, the operator can enter a file path which can be used in the Archive tile.
+ Numeric Entry Allows the operator to enter a numeric value which can later be used as a variable in other tiles.

For example, the numeric value entered can be used in the Decision tile as the condition in a Numeric Value decision.
+ Value Display data from a variable, such as match value of a result from a correlation search.
Tile Name Sets the name of the tile in the workflow canvas

Load Spectrum

Load a SPA file to use during the workflow. You can browse to a file location on the instrument computer or on a flash drive or network location.

This can be useful for importing a saved spectrum to use as a reference. For instance, you may want to import a reference spectrum to use in a subtraction operation.

Setting

Description

File name Browse to a SPA file to include a spectrum
Tile name Sets the name of the tile in the workflow canvas

Measure

Use the measure tile to measure the background and a sample and to set the measurement settings. Spectra and reports created during the workflow are saved to the database and can be archived with the Archive tile.

Setting

Description

Background settings Specifies whether the workflow will prompt the operator to acquire a new background, use a spectrum from another tile in the workflow, or measure a background only, without measuring a sample.
Use internal polystyrene sample If selected, an internal polystyrene reference sample installed in the instrument will be used to validate the instrument’s performance.
Use background prompt Select to provide instructions to the operator before measuring the background. It is a good idea to instruct the operator to prepare to measure the background.
Use sample prompt Select to provide instructions to the operator before measuring the sample. You may want to instruct the operator to insert the sample.
Allow other workflows to access result of measurement If selected, you can include spectra from this workflow in other workflows. For example, once this workflow is run and has measured a sample, a separate workflow could use the collected spectra as a reference spectrum or in a report.
Show spectrum during measurement Select to view the spectrum during the measurement. If not selected, operators see only a progress indicator.
Progress text Provide a custom message to operators during the background and sample measurement.
Other Measurement Settings Customize the measurement settings used in this workflow or match the settings used with another spectrum.

Number of scans: The number of times that the sample will be scanned. More scans typically means for accurate data, but will take longer to measure.

Atmospheric suppression: Used to suppress the effects of CO2 and H2O.

Match Settings: Select to match the measurement settings used with a specified SPA or QNT file. Select All Settings to review all of the settings used with this measurement.

Spectrum Title: Select to append variable data to the spectrum title.

See Measurement Settings and Advanced Measurement settings for a description of additional settings.
Tile name Sets the name of the tile in the workflow canvas

Peak Analysis

Analyze the Peak Height or the Peak Ratio of a spectrum.

Setting

Description

Peak Height Measure the height of a peak from zero absorbance (or 100% transmittance), without regard to the position of the baseline, or from the baseline. If measured from the baseline, the measurement is called the "corrected peak height."

Peak position: Enter the wavenumber of the peak to be measured.

Corrected: Select to measure the peak height from the spectral baseline rather than from zero absorbance (or 100% transmittance)

Reference point: Select for single-point correction, using one point as the baseline reference.

Reference range: Select for two-point correction, using a point on either side of the peak to calculate the baseline.

Generate pass/fail result: Select to create a pass/fail result that can be used in a Decision tile.
Peak Ratio Find the ratio of height between two peaks. Peaks can be calculated from zero absorbance units or from a corrected baseline.

Not corrected: The peak heights are measured from zero absorbance (or from 100% transmittance)

Single-point corrected: The peak height will be measured from the baseline at the wavenumber you entered.

Two-point corrected: A point on either side of the peak will be used to calculate the baseline.

Generate pass/fail result: Select to create a pass/fail result that can be used in a Decision tile.
Select spectrum Select the spectrum that will be used in the peak analysis. You can choose from spectra generated in the workflow or imported with the Load Spectrum tile.
Tile name Sets the name of the tile in the workflow canvas

Processing

The Processing tile includes several tools for processing spectral data, including subtraction, normalization, correlation, basic spectral math, and baseline correction.

Setting

Description

Subtraction Subtract one spectrum from another. Spectral subtraction is useful in many instances. For example, if you are measuring a sample that is dissolved in a solvent, you can subtract a reference spectrum of the pure solvent to remove any peaks from the solvent. You can also identify an unknown contaminant in your sample by subtracting a known reference material, leaving you with only the contaminant. You can then use a correlation search to identify the contaminant.
Sample spectrum The starting spectrum to which the operation will be applied.
Reference spectrum The reference that will be subtracted from the starting spectrum.
Subtraction type There are three types of subtraction available. Choose from subtraction by Factor, Pathlength, or Range.
Normalization Use Normalize to change the Y-axis scale of the selected spectra to a “normal” scale in which the Y values of the data points range from 0 absorbance units for the lowest point to 1 absorbance unit for the highest peak (for an absorbance-like spectrum) or from 10% to 100% transmittance (for a transmission-like spectrum). These normal scales are typical of spectra in commercial spectral libraries.

After a spectrum is normalized, you cannot use it for quantitative analysis unless you know the scaling factor and adjust the quantitative results accordingly.
Select spectrum The starting spectrum to which the operation will be applied.
Max range (cm-1) Use to set the range used in the normalization.
Min range (cm-1) Use to set the range used in the normalization.
Target value Target value is specified in absorbance units.
Correlation Returns the match value between the first and second spectrum. Like QCheck, the match value is given between 0.0 and 1.0, with 1.0 reflecting a perfect match.
First spectrum Select the starting spectrum that the second spectrum is being compared to.
Second spectrum Select a reference spectrum.
Spectral range Use the spectral range to exclude totally absorbing peaks from the correlation search.
Basics Apply an operation to a single spectrum.
Spectrum Select the spectrum to which the operation will be applied.
Operation Add
Subtract
Divide
Multiply
Factor Increases or decreases the amplitude of the spectrum so that it can be better compared to another spectrum
Baseline Correction Use to correct a baseline that is shifted.
Select spectrum Select a spectrum for which the baseline will be corrected.
Polynomial order Specify the polynomial order for the correction.
Tile name Sets the name of the tile in the workflow canvas

Repeat

Loop a portion of the workflow to repeat steps.

Setting

Description

Repeat times Sets the number of times that the looped portion of the workflow will repeat.
Tile name Sets the name of the tile in the workflow canvas

Report

Create a custom report that can be stored, archived, or printed. Reports generated in the workflow are available in the Reports section of the dashboard.

Setting

Description

Add image Add an image that the operator will see on the report screen during the workflow. Valid file types include:

.PNG
.JPG
.GIF
.BMP
Add text Use to add text. This is useful for providing instructions to the operator and for adding labels to text and numeric entry fields.
Add or remove document Provide a button that operators can click or touch to view a specified PDF.

After adding the document button, click the button to specify the PDF file.
Add spectrum Add a spectrum to the report. Select any spectrum generated or loaded earlier in the workflow.
Add value Add a value from another workflow tile to the report. For example, if the workflow included a measurement and a search, you can include data from the results of the search.
Add or remove print button With a print button, operators can print the report while viewing the report screen.
Tile name Sets the name of the tile in the workflow canvas

Search

Perform a correlation or a multi-component search.

Setting

Description

Available libraries Drag libraries from the Available Libraries column to the Selected Libraries to use them in the search.

Click Refresh to update the list of available libraries.
Search type Set the type of search that will be performed.

Correlation: Use to identify an unknown sample.

Number of results: Set the number of results that will be shown.

Multi-component: Use to identify the components of a sample. Number of components: Set the number of components that will be shown.
Spectral Ranges Add a start and end value for the region that will be searched.
Select spectrum Specify the spectrum that will be used in the search.
Tile name Sets the name of the tile in the workflow canvas

Selection

With a Selection tile, the operator chooses which path the workflow should follow.

Setting

Description

Add image Add an image that the operator will see on the selection screen during the workflow. Valid file types include:

.PNG
.JPG
.GIF
.BMP
Add text Use to add text. This is useful for providing instructions to the operator.
Add value Add a value from another workflow tile to the report. For example, if the workflow included a measurement and a search, you can include data from the results of the search.
Selection label Edit the selection label to change the text that appears on the workflow canvas.

Start

This is the first tile in every workflow. The Start tile is added to the workflow canvas automatically each time a new workflow is created.

Setting

Description

Workflow image Determines the image that is displayed when the workflow is run.

Accepts a file path to an image file. The following file types are valid:

.PNG
.JPG
.GIF
.BMP
Desired aspect ratio Specify an aspect ratio to optimize the appearance of the workflow when it is run. The aspect ratio should match the display used by the operator as closely as possible.

Examples:
4:3 for older computer monitors

16:9 is the standard for high-definition video and is common for current computer monitors Accepts the following: 1:1

4:3
5:4
16:9
16:10
3:2
2:1

Tag Spectrum

Apply a tag to spectra created during the workflow.

Setting

Description

Tag Apply a tag to a spectrum
Select spectrum Choose the spectrum to which the tag will be applied.
Tile name Sets the name of the tile in the workflow canvas

Template Report

Generate a report from a template. Reports generated in the workflow are available in the Reports section of the dashboard. Most of the settings for a template report depend on the template type that is selected.

Setting

Description

Template type Choose from the following template types:
  • ValPro style
  • Single spectrum
  • Multiple spectra
  • Search results
  • Single quantification
  • QCheck
  • Multiple run quantification
Automatically advance workflow after displaying report for 5 seconds If selected, the workflow will advance after displaying the report for 5 seconds. If not selected, the operator manually continues the workflow.
Generate pass/fail result If selected, specify text that will trigger a fail result. For example, if you specify “fail,” the template report tile will generate a fail result if the report includes the text “fail.”

TQ Analyst

Quantify the components of the sample using a specified quantification method.

Setting

Description

Quantification method Select a QNT file for the quantification method.
Select spectrum Select the spectrum that will be used for the quantification.
Tile name Sets the name of the tile in the workflow canvas