Agilent RTEConceptsGuide A.01.04
Agilent RTEConceptsGuide A.01.04
Agilent RTEConceptsGuide A.01.04
Concepts Guide
Agilent Technologies
Notices
© Agilent Technologies, Inc. 2009-2011, Warranty receive no greater than Restricted Rights as
2012 defined in FAR 52.227-19(c)(1-2) (June
The material contained in this docu- 1987). U.S. Government users will receive
No part of this manual may be reproduced
ment is provided “as is,” and is sub- no greater than Limited Rights as defined in
in any form or by any means (including elec-
tronic storage and retrieval or translation
ject to being changed, without notice, FAR 52.227-14 (June 1987) or DFAR
into a foreign language) without prior agree- in future editions. Further, to the max- 252.227-7015 (b)(2) (November 1995), as
ment and written consent from Agilent imum extent permitted by applicable applicable in any technical data.
Technologies, Inc. as governed by United law, Agilent disclaims all warranties,
States and international copyright laws. either express or implied, with regard Safety Notices
to this manual and any information
Manual Part Number contained herein, including but not CAUTION
limited to the implied warranties of
G4635-90013 merchantability and fitness for a par- A CAUTION notice denotes a
ticular purpose. Agilent shall not be hazard. It calls attention to an
Edition liable for errors or for incidental or
consequential damages in connection
operating procedure, practice, or
04/2012
with the furnishing, use, or perfor- the like that, if not correctly per-
Printed in Germany
mance of this document or of any formed or adhered to, could
Agilent Technologies information contained herein. Should result in damage to the product
Hewlett-Packard-Strasse 8 Agilent and the user have a separate
76337 Waldbronn written agreement with warranty
or loss of important data. Do not
This product may be used as a com- terms covering the material in this proceed beyond a CAUTION
ponent of an in vitro diagnostic sys- document that conflict with these notice until the indicated condi-
tem if the system is registered with terms, the warranty terms in the sep- tions are fully understood and
the appropriate authorities and com- arate agreement shall control.
met.
plies with the relevant regulations.
Otherwise, it is intended only for gen- Technology Licenses
eral laboratory use. The hardware and/or software described in WA R N I N G
this document are furnished under a license
Software Revision and may be used or copied only in accor- A WARNING notice denotes a
dance with the terms of such license. hazard. It calls attention to an
This guide is valid for revision A.01.04 of
Agilent OpenLAB CDS.
Restricted Rights Legend operating procedure, practice,
If software is for use in the performance of a
or the like that, if not correctly
U.S. Government prime contract or subcon- performed or adhered to, could
tract, Software is delivered and licensed as result in personal injury or
“Commercial computer software” as
defined in DFAR 252.227-7014 (June 1995),
death. Do not proceed beyond a
or as a “commercial item” as defined in FAR WARNING notice until the indi-
2.101(a) or as “Restricted computer soft- cated conditions are fully under-
ware” as defined in FAR 52.227-19 (June
1987) or any equivalent agency regulation stood and met.
or contract clause. Use, duplication or dis-
closure of Software is subject to Agilent
Technologies’ standard commercial license
terms, and non-DOD Departments and
Agencies of the U.S. Government will
Concepts Guide
In This Guide...
In This Guide...
1 Overview
This chapter provides an overview of the possibilities of the Report Template
Editor.
3 Tables
This chapter describes the characteristics and usage of tables in RTE.
4 Matrices
This chapter describes the characteristics and usage of matrices in RTE.
5 Composite Groups
This chapter describes the characteristics and usage of Composite Groups in
RTE.
6 Images
This chapter describes the characteristics and usage of images in RTE.
7 Chromatograms
This chapter describes the characteristics and usage of chromatograms in
RTE.
Concepts Guide 3
In This Guide...
8 Calibration Curves
This chapter describes the characteristics and usage of calibration curves in
RTE.
9 Spectra
This chapter describes the characteristics and usage of spectra in RTE.
10 Charts
This chapter describes the characteristics and usage of charts in RTE.
11 Expressions
This chapter describes the characteristics and usage of expressions in RTE.
12 Calculation Variables
This chapter describes the characteristics and usage of calculation variables in
RTE.
17 Appendix
This chapter contains a list of all operators and functions available in the
Expression Editor.
4 Concepts Guide
Contents
Contents
1 Overview 9
Overview 10
Report Types 12
3 Tables 19
About Tables 20
Using Tables 21
About Table Groups 33
Using Table Groups 35
4 Matrices 37
About Matrices 38
About Matrix Groups 39
Using Matrices 42
5 Composite Groups 45
About Composite Groups 46
Using Composite Groups 47
6 Images 51
About Images 52
7 Chromatograms 53
About Chromatograms 54
Using Chromatograms 57
Concepts Guide 5
Contents
8 Calibration Curves 65
About Calibration Curves 66
Using Calibration Curves 68
9 Spectra 71
About Spectra 72
Using Spectra 75
10 Charts 77
About Charts 78
Using Charts 86
11 Expressions 91
About Expressions 92
Using Expressions 102
6 Concepts Guide
Contents
17 Appendix 145
Operators 147
Functions 149
Enumerations 155
Keys in Diagnostic Data 165
Concepts Guide 7
Contents
8 Concepts Guide
Concepts Guide
1
Overview
Overview 10
Report Types 12
Agilent Technologies 9
1 Overview
Overview
Overview
10 Concepts Guide
Overview 1
Overview
These templates are specifically designed for usage in BI Studio and contain most of the
NOTE advanced features that are not available in RTE.
Snippets
RTE provides various preconfigured report items — so-called snippets — that
you can use in your templates. The items are organized in folders that reflect
the content. The folders and subfolders under which the snippets are located
are determined by the snippet itself and cannot be changed.
Concepts Guide 11
1 Overview
Report Types
Report Types
Each template is of specific report type. Depending on this report type, the
template is connected to a particular database view. Therefore, different data
fields are available in a report template, depending on the report type. In
addition, RTE displays the report items differently depending on the report
type. The following report types are available:
• Single Injection: You can use any information associated with the sample
acquisition (sequences/samples/injections/instruments), the results
(signals/peaks/compounds/calibration curves), and the project
administration (file/project).
With this report type, RTE automatically creates a list of all injections in the
current data scope, and then shows the report items from the template
separately for each injection. Therefore, you do not need to worry about
repeating composite groups on injection IDs. On the other hand, you cannot
compare results from different injections in one table or matrix.
• Single Sequence Summary: You can use the same information as in a Single
Injection report.
With this report type, RTE automatically creates a list of all sequences in
the current data scope, and then shows the report items from the template
separately for each of the sequences. Therefore, you do not need to worry
about repeating composite groups on sequence IDs. On the other hand, you
cannot compare results from different sequences in one table or matrix.
• Cross-Sequence Summary: You can use the same information as in a Single
Injection report.
With this report type, the data is not automatically grouped. Therefore, you
must pay more attention to the grouping of your report items, but in return
you can create report items that compare data from different sequences.
12 Concepts Guide
Concepts Guide
2
Text Fields and Data Fields
About Text Fields and Data Fields 14
Using Fields 17
To adjust the width of the label part 17
To enter text directly 17
To add a line break 17
This chapter describes the characteristics and usage of text fields and data
fields in RTE.
Agilent Technologies 13
2 Text Fields and Data Fields
About Text Fields and Data Fields
Available fields
The assortment of data fields in the Report Items browser depends on the
following factors:
• The selected report type
• The chromatography data system
Field types
The Report Template Editor provides the following types of fields:
• Text fields are basically simple textboxes that can contain either static text
or dynamic expressions. Text fields are, for example, used to display static
headlines in a report template.
In the Report Items browser, you find the Text field in the Special Objects
category.
• Data fields are divided into two parts, label and value. The label contains a
static text, the value contains a dynamic expression. Data fields are
typically used to show specific data, for example the sequence name or the
sample name. You can, however, modify both label and value according to
your requirements.
In the Report Items browser, you find all available data fields in the Fields
category.
14 Concepts Guide
Text Fields and Data Fields 2
About Text Fields and Data Fields
• Custom fields are a special type of data field. You configure the custom
fields in the chromatography data system, for example, in the method
definition in ChemStation. Custom fields allow you to create customized
information (both labels and values) which belongs to a specific context, for
example, to a sample or to a compound. RTE allows you to perform
calculations with custom fields.
In contrast to the regular data fields, the label shown for custom fields is
not the data field name (e.g. Sample_CustomField01) but rather the
customized label information (e.g. "TabletWeight"). This is achieved by a
combination of the Trim, Choose, and Split functions in the expression for
the value. RTE automatically creates this expression.
You can configure both label and value in your chromatography data
system.
• Complex custom fields are data fields that do not contain a single value but
an entire XML structure. This XML structure contains various key/value
pairs. If you drag such a field to the template, a dialog asks you for the key
of the information you want to access. As a result, RTE creates a data field
where the label is the name of the complex custom field, and the value is
the specific value stored under the given key. This value is accessed with
the help of the
CFE function. RTE automatically creates this expression.
Concepts Guide 15
2 Text Fields and Data Fields
About Text Fields and Data Fields
16 Concepts Guide
Text Fields and Data Fields 2
Using Fields
Using Fields
To adjust the width of the label part, move the mouse over the boundary line
between label and value, and drag the line to the required width.
Concepts Guide 17
2 Text Fields and Data Fields
Using Fields
18 Concepts Guide
Concepts Guide
3
Tables
About Tables 20
Using Tables 21
To add and remove columns 21
To remove columns 22
To change the order of table columns 22
To adjust the column widths 22
To adjust the colors and fonts in a table 23
To highlight outliers using conditional formatting 24
To adjust the table borders 25
To change the column header 25
To create a line break in a table header 26
To create a second table row 26
To change the text alignment in a table 28
To adjust the number format in a table 28
To configure a table footer 29
To sort a table 29
To filter a table 30
To filter for peak area or area% 31
To repeat a table 32
About Table Groups 33
Using Table Groups 35
To configure a table group 35
Agilent Technologies 19
3 Tables
About Tables
About Tables
With tables, you can display results in a 2-dimensional format. Tables are
used, for example, to summarize the results of samples/sequences. The
amount of columns and the headlines are static, the number of rows
corresponds to the number of records in the dataset.
Basically, each table contains a specific dataset that is determined by the type
of the base template (see “Report Types” on page 12). Thus, without any
further configuration, the table would show one row for each record in the
dataset, where the records are unsorted, ungrouped, and unfiltered. In order
to organize and structure the data, you have the following options for
configuring a table:
• Repeat Table On: Display the table several times, where each table only
contains the data according to the value of specific key information. The
particular values (for example, compound names) are used as table
headers.
• Grouping: The detail rows are arranged according to the distinct values of a
given key information (for example, the distinct sample names).
• Sorting: The detail rows are sorted according to a given key information.
• Filtering: Exclude specific data from the table content.
• Area Rejection: Exclude information on peaks that are too small.
• Show Peak Types: Specify the type of peaks to be shown in a table (for
example, Identified Peaks or Unknown Peaks).
The table report items available in the Report Items browser are all
preconfigured in a specific way, so you can use them with only a few
adjustments.
20 Concepts Guide
Tables 3
Using Tables
Using Tables
Concepts Guide 21
3 Tables
Using Tables
To remove columns
In the Editing Pane:
1 In the Editing Pane, select the table column you want to delete.
2 Right-click the column, and select Delete Column from the context menu.
In the Table Properties dialog:
1 In the Table Properties, select the Columns page.
2 In the Table Layout, click the required column to select it.
3 Click .
The column is removed from the table.
22 Concepts Guide
Tables 3
Using Tables
Concepts Guide 23
3 Tables
Using Tables
3 Under Header Font Properties For All Columns, adjust the settings for the table
headers.
4 Save the settings.
To set colors and fonts manually for a specific column:
1 In Table Properties, select the Columns page.
2 Select the column for which you want to change the colors or fonts.
3 Click Column Properties.
The Column Properties dialog opens.
4 In Column Properties, select the Font page.
5 Adjust the settings for the table data and the table header.
6 Save the settings.
Compound_Amount > 4
24 Concepts Guide
Tables 3
Using Tables
Concepts Guide 25
3 Tables
Using Tables
26 Concepts Guide
Tables 3
Using Tables
We recommend using only one table details row for the first column, and adding a second
NOTE table row only to the other columns. This will make it easier to identify the table rows
belonging to each other in the generated report.
Concepts Guide 27
3 Tables
Using Tables
The Number Format section is only visible if the selected column contains numbers.
NOTE
28 Concepts Guide
Tables 3
Using Tables
If you add a summary calculation, the table will expand downwards in the generated
NOTE template. However, the layout of the report item is not automatically adjusted in the Editing
Pane! You need to resize the table layout to allow for the additional footer lines. Otherwise,
the subsequent report items may overlay the table footer in the generated template.
If a table column shows an expression that contains a calculation variable, you cannot add
NOTE a summary calculation for this column.
To sort a table
You can provide sorting expressions for any report item that lists multiple
pieces of information, such as tables or composite groups. This procedure
explains how to change the sorting expression for a table, but it basically
applies also to the other report items.
1 In the properties dialog, select the Sorting page.
2 In the Expression drop-down list, select the data field you want to use for
sorting.
Concepts Guide 29
3 Tables
Using Tables
buttons and .
To filter a table
If you want to create a table that shows only specific data, you need to filter
the table accordingly. This procedure shows you how to filter for a sample
name, sample type, or compound name.
1 In Table Properties, select the Filtering page.
2 In the Expression drop-down list, select the data field that you want to use
for filtering:
• Fields > Sample > NAME if you want to filter for a specific sample name
• Fields > Sample > TYPE if you want to filter for a specific sample type
• Fields > Compound > NAME if you want to filter for a specific compound
name
The correct name of the respective data field is shown with an equals sign
in front of it. For example: =Sample_Name.
3 In the Operation drop-down list, select Equals.
4 Select the Value field.
If you start typing, you replace the entire existing content of the field. If you
press F2, the cursor is shown, and you can edit the existing content.
30 Concepts Guide
Tables 3
Using Tables
In the Value field, text strings must be enclosed in quotes to be recognized as text. If you do
NOTE not add quotes, RTE adds them for you when you close the dialog.
Numbers are written without quotes.
If you filter for an enumeration, you must enter the required number in the Value field. See
NOTE “Enumerations” on page 155 for an overview of all enumerations.
For example:
• "Standard L1" as a sample name
• 1 as a sample type, in this case the calibration samples
• "TRAMADOL" as a compound name
6 Click OK to confirm the settings.
The table in the generated report now contains only the data that passed
the filter condition. As the editor uses built-in example data to preview the
table in the Editing Pane, this preview may show no contents at all.
Concepts Guide 31
3 Tables
Using Tables
=Peak_Area >= 3
=Peak_AreaPercent >= 3
After reloading a template in the Editing Pane, RTE may automatically map the filter
NOTE condition to the Area Rejection property. This happens, if you use the Greater Than (>) or
Equals (=) operators. The filter expression is then removed from the Filtering page and is
visible in the Peaks and Repeating page instead.
To repeat a table
This procedure shows you how to repeat a table on the compound name.
1 In Table Properties, select the Peaks and Repeating page.
2 In the Repeat Table On drop-down list, select Fields > Compound > NAME
The name of the according data field is shown, with an equals sign in front
of it: =Compound_Name.
3 Click OK to confirm the settings.
In the table preview in the Editing Pane, a headline is added for the
compound name. If you generate the report, the table will be repeated for
each compound name available in the current scope.
32 Concepts Guide
Tables 3
About Table Groups
With table groups, you can structure the detail rows of a table. You can define
specific header rows, and show footer rows with summary information
specifically for that group.
For example, if you used two detector wavelengths for signal detection, you get
two signals for each detected compound. In this case, you can create a table
group for the detector wavelengths in order to show all signals of one
wavelength under each other, with a group header above and a summarizing
footer below the details rows.
Usage of table groups is limited to max. three groups. The order of grouping is
defined by the position of the group in the list.
Two groups will be shown with header/footer lines in the report template, the
third group will only be used to organize the detail rows in the table.
Concepts Guide 33
3 Tables
About Table Groups
34 Concepts Guide
Tables 3
Using Table Groups
The sorting of table group data is only applied within each single group. The order of the
NOTE different groups in the table depends on the table sorting.
Concepts Guide 35
3 Tables
Using Table Groups
36 Concepts Guide
Concepts Guide
4
Matrices
About Matrices 38
About Matrix Groups 39
Using Matrices 42
To create a matrix 42
To sort a matrix 43
To adjust the column widths 44
Agilent Technologies 37
4 Matrices
About Matrices
About Matrices
If your data contains multiple signals, the matrix items in the Report Template Editor will
NOTE only show the main signal.
38 Concepts Guide
Matrices 4
About Matrix Groups
Row groups
Row groups define the data in the left part of the matrix. If a matrix contains
several row groups, there are several specific columns in this left part, where
each column is defined by its own row group. The following figure shows the
principle:
Gdl\gdje(/>c_ZXi^dcdgYZgcjbWZg
Gdl\gdje'/K^VacjbWZg
Gdl\gdje&/HVbeaZcVbZ
Concepts Guide 39
4 Matrices
About Matrix Groups
The number of row groups and the width of the corresponding columns is
defined by the snippet. You can not change these settings in the Report
Template Editor.
Column groups
The column group defines the data that makes up the columns in the right part
of the matrix. In some matrix snippets, you can adjust the value used to build
the columns. The following figure shows the principle:
8dajbc\gdje/8dbedjcYCVbZ
Data properties
The detail data is always displayed in the cells defined by the row groups and
column groups. The details cells can be split in order to show several different
values that belong to the same groups. These multiple details cells can be
shown either in columns (side by side) or in rows (on top of each other). The
layout type is defined by the snippet and can not be changed in the Report
Template Editor. The number of details cells and their content can be
configured in the matrix properties.
40 Concepts Guide
Matrices 4
About Matrix Groups
Concepts Guide 41
4 Matrices
Using Matrices
Using Matrices
To create a matrix
With the available matrix snippets, you can create overviews for different
scenarios:
• With the Compound Summary RT Amount snippet, you generate an overview of
the retention times and amounts for each detected compound. The
compounds are shown as columns; the sample names, vial locations, and
injection numbers are shown as rows. The snippet also contains summary
calculations in the footer (average, standard deviation, and relative
standard deviation).
• There are two Sample Summary snippets. With these snippets, you generate
an overview of the retention time and compound amount for each sample.
The sample names are shown as columns; the compound names and their
respective retention times are shown as rows.
42 Concepts Guide
Matrices 4
Using Matrices
To sort a matrix
There is no Sorting page available for the matrix itself. Any sorting information
must be provided separately for the respective row group or column group!
1 In the Matrix Properties, select the Grouping page.
2 To change the sort order of a row group, click Edit in the Rows section. To
change the sort order of a column group, click Edit in the Columns section.
For more information on row groups and column groups, see “About Matrix
Groups” on page 39.
3 Select the Sorting page.
4 In the Expression drop-down list, select the data field you want to use for
sorting.
For example, you can sort by the following expressions:
• Fields > Peak > RetentionTime if you want to sort by the retention time
• Fields > Sample > OrderNo if you want to sort by the order of the samples
in the sequence table
• Fields > Injection > OrderNo if you want to sort by the order in which the
injections took place
The correct name of the respective data field is shown with an equals sign
in front of it. For example: =Peak_RetentionTime.
5 In the Direction drop-down list, select whether you want to sort the entries
in an ascending or descending order.
Concepts Guide 43
4 Matrices
Using Matrices
6 If required, you can add expressions to sort by more than one field.
The sorting expressions will be applied from top to bottom.
7 If required, change the order of the sorting expressions with the arrow
buttons and .
44 Concepts Guide
Concepts Guide
5
Composite Groups
About Composite Groups 46
Using Composite Groups 47
To create a Composite Group 47
To repeat a composite group 48
To create a nested composite group 48
To filter a composite group 49
Agilent Technologies 45
5 Composite Groups
About Composite Groups
Save locally
If you save the composite group in the Report Template Editor, the composite
group is listed in the Report Items browser under the Composite Groups category.
You can then reuse it for other report templates.
The xml file associated to the composite group is saved in your local file
system, so that you can transfer the xml file to other computers and reuse the
composite group there as well. The location depends on the host application.
• In the context of ChemStation, the xml file is saved under C:\Documents and
Settings\[username]\Application Data\Agilent Technologies\Agilent ChemStation\
[version]\IntelligentReporter\CompositeGroups.
Repeat on
Composite groups can be repeated on a specific key information. The entire
group is then displayed several times - once for each value of the selected
information. For example, a group containing information on samples may be
repeated for each sample in a sequence.
Composite groups correspond to lists in Microsoft Business Intelligence
Studio.
46 Concepts Guide
Composite Groups 5
Using Composite Groups
Concepts Guide 47
5 Composite Groups
Using Composite Groups
Existing composite groups can not be overwritten. You must always provide a new name
NOTE when saving a composite group.
The new composite group is now available in the Report Items browser under
the Composite Groups category.
48 Concepts Guide
Composite Groups 5
Using Composite Groups
3 Select both the Sample_Type field and the previously prepared composite
group.
4 Create a new composite group containing the two selected items.
5 Repeat the new composite group on Sample_Type.
If you generate the report, the different sample types are shown as
headings. Under each sample type, the respective samples are listed.
Concepts Guide 49
5 Composite Groups
Using Composite Groups
50 Concepts Guide
Concepts Guide
6
Images
About Images 52
Agilent Technologies 51
6 Images
About Images
About Images
RTE offers you the possibility to add images, such as your company logo, to the
report template. Images are typically added to the report header, but you can
also place them in the report body or report footer.
You find the image items in the Report Items browser under the Special Objects
category. The default image is an Agilent logo, but you can change the image
source and also the image size in the Image Properties dialog. The file selection
dialog for the image source automatically opens when you drop the predefined
image item onto the template.
If you save a template in which you use an image item, this image is
automatically added to the Special Objects for the current template. Thus, if you
want to add the image also at a different place in the same template, you can
easily access the same image.
52 Concepts Guide
Concepts Guide
7
Chromatograms
About Chromatograms 54
Using Chromatograms 57
To show only specific samples or signals 57
To show only a specific sample type 58
To label also the missing compounds 59
To switch on/off peak labeling depending on the peak 59
To show only peaks with a certain minimum area 60
To scale on the peak height of a certain compound 60
To create a single peak plot 61
To create a multi page plot 62
To show an instrument curve 63
Agilent Technologies 53
7 Chromatograms
About Chromatograms
About Chromatograms
With chromatogram report items, you can print signals from the detectors of
the chromatographic system on the report. The report item shows the results
for all injections that are included in the selected data. There is at least one
signal per injection. If the detector was configured to give multiple
measurements, for example a diode-array or multi-wavelength detector, the
chromatogram accordingly contains multiple signals per injection.
The data shown in the chromatogram also depends on whether the chromatogram is
NOTE placed in a composite group and on the grouping and filtering of the composite group.
Depending on the configuration of the report item, the signals may be shown
in separate graphs, overlaid graphs, stacked graphs, or as Iso plots.
54 Concepts Guide
Chromatograms 7
About Chromatograms
Concepts Guide 55
7 Chromatograms
About Chromatograms
56 Concepts Guide
Chromatograms 7
Using Chromatograms
Using Chromatograms
=Sample_Name = "SSRSD1"
In order to compare the signals for two different samples, add a second
expression for the other sample name. The two expressions will automatically
be linked by Or. Alternatively, you can use the Containsoperator and a
wildcard in the Valuefield:
Specific signals If you want display only the signals from a specific detector, you can filter for
the detector name (here: DAD1). The detector name is usually contained in
the first characters of the signal name. Therefore you filter for all signals
where the relevant characters are contained in the signal name.
If you want to filter for one specific signal, use the complete signal name (here:
DAD1 A, Sig=270,8 Ref=500,100) in the filter expression.
Concepts Guide 57
7 Chromatograms
Using Chromatograms
To create a template with only one chromatogram for one sample type:
1 Add the Multi Signal Plot Overlaid snippet to the template.
2 Filter for the sample type, and if required, for a specific signal. For example,
the filter expression would be:
Sample_Type = 3
If you filter for an enumeration (such as Sample_Type), you must enter the required number
NOTE in the Value field. See “Enumerations” on page 155 for an overview of all enumerations.
58 Concepts Guide
Chromatograms 7
Using Chromatograms
The report item preview in the Editing Pane is based on built-in data, not on the actually
NOTE selected data. The labels for undetected compounds will therefore be visible only after
generating the report.
Expression Description
=Iif(UCase(Compound_Name)="TRAMADOL", Shows the label "*** Tramadol found ***" for the
"*** Tramadol found ***", "") Tramadol peak. All other peaks remain
unlabeled.
Concepts Guide 59
7 Chromatograms
Using Chromatograms
=Peak_AreaPercent > 5
Expression Description
60 Concepts Guide
Chromatograms 7
Using Chromatograms
If you want to create a single peak plot for only one compound, you can filter the composite
NOTE group for the required compound.
4 There are different ways to configure the Time Axis page. With the following
settings, the signal axis is labeled with absolute values, and the upper limit
in each graph will correspond to the height of each peak.
a Under Scaling, select All Time Axes with Same Scale, and select the Custom
scale check box.
b Enter the following expressions for the lower and upper limit of the time
axis:
Concepts Guide 61
7 Chromatograms
Using Chromatograms
When creating multi-page plots, carefully consider which option you select under Search
NOTE Scale Within for the scaling of the signal axis. If you select the Given Time Axis Range
option, you will obtain different signal axes for each separate plot.
62 Concepts Guide
Chromatograms 7
Using Chromatograms
In order to find out which other instrument curves are available, remove any filters in the
NOTE Instrument Curves page and preview the report. The available signal names are shown in a
legend.
Concepts Guide 63
7 Chromatograms
Using Chromatograms
64 Concepts Guide
Concepts Guide
8
Calibration Curves
About Calibration Curves 66
Using Calibration Curves 68
To create a calibration curve 68
To place multiple curves in a row 70
Agilent Technologies 65
8 Calibration Curves
About Calibration Curves
With calibration curves, you can place the visual presentation of the
calibration results on your report template. The graph shows the results for all
compounds and calibration samples that are included in the selected data.
In order to obtain a calibration curve, you must have configured the respective samples as
NOTE calibration samples in the sequence table, and you must have configured the calibration
table.
Depending on the configuration of the report item, the multiple curves may be
shown in separate, overlaid, or stacked graphs.
66 Concepts Guide
Calibration Curves 8
About Calibration Curves
Concepts Guide 67
8 Calibration Curves
Using Calibration Curves
• To show the calibration curves for single compound, you have the following
options:
• Add the Calibration Curves Overlaid snippet and filter the calibration curve
item for the required compound (for example,
Compound_Name="TRAMADOL"). Only one calibration curve will be
shown in the report.
• Add the Calib Curve Plot by Compound snippet. A composite group will be
shown that is repeated on the compound name.The composite group also
contains some more information on the calibration curve, such as the
formula or the correlation coefficient.
68 Concepts Guide
Calibration Curves 8
Using Calibration Curves
If a ChemStation data file was processed with a non-matching calibration table, the report
NOTE shows an empty calibration curve, and no peaks are identified. This happens if the
calibration table has been set up for one signal, but data have been recorded for a different
signal. Ensure that the signal description in the calibration table exactly matches the DAD
signal set up in the used method (for example, DAD1A 254,4 Ref 360,600).
Concepts Guide 69
8 Calibration Curves
Using Calibration Curves
70 Concepts Guide
Concepts Guide
9
Spectra
About Spectra 72
Using Spectra 75
Agilent Technologies 71
9 Spectra
About Spectra
About Spectra
With spectra report items, you can place the visual output of an optical 3D
detector (for example, a diode array detector) on your report template. The
spectra shown in the graph correspond to your selection of the positions in
each peak. You can extract spectra, for example, at the start, at the apex, or at
the end of a peak. In addition, you can filter the data shown in a spectrum
using the filter list.
Depending on the configuration of the report item, multiple spectra may be
shown in separate graphs, overlaid graphs, stacked graphs, or as Iso plots. If
there are spectra for different compounds, you can group the spectra by
compound name.
72 Concepts Guide
Spectra 9
About Spectra
Concepts Guide 73
9 Spectra
About Spectra
74 Concepts Guide
Spectra 9
Using Spectra
Using Spectra
With the available spectra snippets, you can create graphs for different
scenarios:
• The Spectra Plot snippet contains a plot where all available spectra are
shown in an overlaid format. By default, the spectra are grouped by peak,
and multiple spectra selected from the same peak are shown in an overlaid
graph.
Concepts Guide 75
9 Spectra
Using Spectra
• The Spectra Plot per Peak snippet is repeated by peak, that is, the entire
report item is displayed once for each peak in the generated report. You
cannot remove the repeating by peak in the report item properties. Multiple
spectra selected from the same peak are shown in an overlaid graph.
76 Concepts Guide
Concepts Guide
10
Charts
About Charts 78
Preparing the Data 80
Category Group 81
Series Group 85
Using Charts 86
To change the chart title and axes titles 86
To change the values plotted on the y-axis 86
To change the y-axis labels 86
To change the values plotted on the x-axis 87
To change the x-axis labels 87
To change the legend title 88
To change the series labels 88
To plot different y-values in the same chart 89
Agilent Technologies 77
10 Charts
About Charts
About Charts
Charts are very useful for graphic display of data. As in tables or matrices, you
can present aggregated data.
The following chart types are available in RTE:
• Line chart
With line charts you can visualize categorized data using a direct line to
connect the values. The category values are used to label the x-axis. For
example, you can categorize the data by the sample name, calibration level
or compound name. Different series of data are shown as several lines in
different colors.
Line - Simple and Line - Smooth:
• Column chart
Column charts are very similar to line charts. You can also visualize
categorized data, but the data is shown as column bars instead of being
connect with a line. The category values are used to label the x-axis. For
example, you can categorize the data by the sample name, calibration level
or compound name. Different series of data are shown as several bars in
different colors.
78 Concepts Guide
Charts 10
About Charts
• Scatter chart
In scatter charts, the location of the data points is determined by x and
y-values. The x-values are typically numeric values or date/time values. For
example, you can show the ratio of compound amount to peak area in an
accuracy plot.
Scatter - Simple, Scatter - Lines, and Scatter - Smooth Lines:
• Bubble chart
As in scatter charts, the location of the data points is determined by x and
y-values. In addition, the size of the bubbles is determined by a separate
numeric value.
Bubble:
Concepts Guide 79
10 Charts
About Charts
The data shown in the chart also depends on the report type and on whether the chart is
NOTE placed in a composite group:
• In Single Injection reports, the entire template content is repeated for each single
injection. It is therefore impossible to compare data from several injections in the same
chart with a Single Injection report.
• In composite groups you can group, sort, and filter the data that will be available in a
chart.
80 Concepts Guide
Charts 10
About Charts
• Which values do you want to plot on the y-axis? These values must be
numeric. We recommend using aggregating functions, as the category group
may contain multiple values.
• For scatter charts and bubble charts: Which values do you want to plot on
the x-axis? The x-values are typically numeric or date/time values. However,
it is also possible to plot text values on the x-axis.
For line and column charts, the category values are identical to the x-axis values. For
NOTE scatter and bubble charts, the category group only has an impact on the amount of
displayed data — the x-axis values are set separately and can differ from the category
values.
• Do you need to sort the data? We recommend using the same expression for
sorting and grouping the category group. In line and column charts, this
sorts the labels on the x-axis. For scatter charts using lines, the line
connects the data points in the order given by the category group.
• For bubble charts: Which value should influence the bubble size?
Category Group
For all chart types, the category group has an impact on the amount of
displayed data. You can choose a category group expression that groups
multiple subsets of data together. For example, if your data contains multiple
injections of the same sample, you can choose the sample name for the
grouping expression. The chart will then show only one data value for each
distinct sample, such as the average compound amount.
The impact of the category group on the x-axis labels depends on the chart
type:
• For line and column charts, the category values are identical to the x-axis
values.
• For scatter and bubble charts, the category group only has an impact on the
amount of displayed data — the x-axis values are set separately and can
differ from the category values.
Concepts Guide 81
10 Charts
About Charts
82 Concepts Guide
Charts 10
About Charts
Concepts Guide 83
10 Charts
About Charts
84 Concepts Guide
Charts 10
About Charts
Series Group
You can place several series of data in the same chart. For example, you may
want to create a chart that shows the stability of retention times over a set of
injections. If there are several compounds, you can show a separate line for
each compound. In this case, create a category group based on the injection
ID, and a series group which is grouped by the compound name. The result
may resemble the following line chart.
Y-value: =Peak_RetentionTime
Format code for y-axis label: F1
Category group expression: =Injection_ID
Category sorted by: =Injection_AcquiredDate
Series group expression: =Compound_Name
Concepts Guide 85
10 Charts
Using Charts
Using Charts
3 Click to move the selected expression to the active settings, which are
shown on the right side.
4 Select the previously used expression on the right side, and click to
remove it from the active settings.
5 Save the settings.
86 Concepts Guide
Charts 10
Using Charts
5 If you want to use a different format for the numbers defined by the y-value
expression, click fx to enter the required Format Code (see “Format
Codes” on page 100 ).
6 Save the settings.
Concepts Guide 87
10 Charts
Using Charts
5 The usage of the expression for x-axis labels depends on the type of
diagram:
• For line charts and column charts:
If you want to use different labels than the ones resulting from the
category group expression, click fx and enter the required expression in
the Expression Editor.
Use an expression that is based on an identifier equivalent to the
identifier of the category group expression. For example, if the category
is grouped on the sample ID, you could display the sample name.
Displaying the sequence name or the injection order number would lead
to ambiguous x-axis labels.
• For scatter charts and bubble charts:
If you want to use a different format for the numbers defined by the
x-value expression, click fx to enter the required Format Code (see
“Format Codes” on page 100).
6 Save the settings.
88 Concepts Guide
Charts 10
Using Charts
As multiple y-values are displayed the same way as multiple series values, using both
NOTE options at the same time may lead to an overcrowded chart.
4 Under Data Values/Select Y-Value, select the required data fields and click
to move them to the active settings.
5 If required: Under Data Values/Select X-Value, select the same number of data
fields as for the y-value. You can select the same x-value expression
multiple times. X-values are only available for Scatter and Bubble charts.
Concepts Guide 89
10 Charts
Using Charts
6 If required: Under Data Values/Select Size, select the same number of size
expressions as for the y-value. You can select the same size expression
multiple times. Size expressions are only available for Bubble charts.
7 Save the settings.
90 Concepts Guide
Concepts Guide
11
Expressions
About Expressions 92
Operators 93
Functions 94
Format Codes 100
Using Expressions 102
To filter data with varying notations (upper/lower case) 102
To filter empty fields 102
To repeat on sample names beginning with 103
To compare numbers using the Iif function 104
To show the type of injection 105
To filter for date and time 106
To calculate with a custom field 106
Relative Standard Deviation 107
To filter for similar names 107
To show only part of a value 108
Agilent Technologies 91
11 Expressions
About Expressions
About Expressions
Expressions are used to define the value of a data field or text field item, the
values shown in a table column, specific properties such as the background
color of an item, or for many other purposes. The most basic expression is a
reference to a specific data field, but expressions can also contain
mathematical functions on different data fields.
An expression always starts with an equals sign. The most basic expression is
one that refers to a specific data field, for example the sequence name:
=Sequence_Name.
However, you may need to create more complex expressions during template
development. For example, you may filter for sample names with a certain
prefix, compare numbers with a certain threshold value, or calculate one
value from another using a custom formula.
The Expression Editor, which is part of RTE, helps you build dynamic
expressions that include data fields and logical or mathematical functions.
All expressions are written in Microsoft Visual Basic. Therefore, you can use any function
NOTE available in Visual Basic. The only consequence may be that the Expression Editor shows a
red, serrated line, if the used functions are not modelled by RTE. In addition, the preview on
the report item in the properties dialog or in the Editing Pane may not be shown correctly.
However, when the report template is generated, the functions are nevertheless used
correctly.
For more information on Microsoft Visual Basic, refer to
http://msdn.microsoft.com/en-us/library/sh9ywfdk.aspx.
The notation of functions or data fields in the Expression Editor is not case-sensitive.
NOTE
92 Concepts Guide
Expressions 11
About Expressions
Operators
Arithmetic
Table 1 Arithmetic
Mod NUMBER1 Mod NUMBER2 Divides two numbers and returns only the remainder.
Comparison
Table 2 Comparison
Name Description
= Equal to
Like Compares two strings. The string to be compared with must contain wildcards:
• ? matches any single character.
• * matches any number of adjacent characters.
Concepts Guide 93
11 Expressions
About Expressions
Logical
Table 3 Logical
Name Description
Concatenation
Table 4 Concatenation
Name Description
Functions
Program Flow
Table 5 Program Flow
94 Concepts Guide
Expressions 11
About Expressions
Aggregate
Table 6 Aggregate
Avg Avg(FIELDNAME) Returns the average of all non-null values of the specified
field.
CountRows CountRows() Returns the number of rows, including rows with null
values.
Max Max(FIELDNAME) Returns the maximum value from all values of the
specified field.
Min Min(FIELDNAME) Returns the minimum value from all non-null values of the
specified field.
First First(FIELDNAME) Returns the first of the values of the specified field.
Last Last(FIELDNAME) Returns the last of the values of the specified field.
There is no specific function for the relative standard deviation. This must be manually
NOTE calculated as (Stdev/Avg*100).
Concepts Guide 95
11 Expressions
About Expressions
Aggregating functions always refer to all records in a scope and return only
one value. This value is either calculated from those records or selected
according to specific criteria. Therefore, aggregating functions are
automatically used, for example, for the creation of table headers or footers.
You can use aggregating functions if you need to summarize your data.
Math
Table 7 Math
Pow Pow(NUMBER, POWER) Returns a specified number raised to the specified power.
Conversion, Date/Time
Table 8 Conversion, Date/Time
96 Concepts Guide
Expressions 11
About Expressions
Now Now Returns a date value containing the current date and time
according to your system.
Text
Table 9 Text
Chr Chr(65) Returns the character associated with the specified ANSI
character code.
InStr InStr(HAYSTACK, NEEDLE) Returns an integer specifying the start position of the first
occurrence of one string (NEEDLE) within another
(HAYSTACK).
InStrRev InStrRev(HAYSTACK, Returns the position of the first occurrence of one string
NEEDLE) (NEEDLE) within another (HAYSTACK), starting from the
right end of the string.
Concepts Guide 97
11 Expressions
About Expressions
Table 9 Text
98 Concepts Guide
Expressions 11
About Expressions
Table 9 Text
Misc
Table 10 Misc
RowNumber RowNumber(SCOPE) or Returns a running count of all rows in the specified scope.
RowNumber(SCOPE, The scope can be given as single string (Scope as String)
COUNTGROUP) or in combination with the group number (Scope as String,
CountGroup as String).
Concepts Guide 99
11 Expressions
About Expressions
Format Codes
With Format Codes, you define the output format of numeric or date/time
values. You can either select one of the predefined Format Codes from the
given drop-down lists, or enter your own Format Code in the Expression
Editor.
F1 Show the number with 1 digit using the decimal point and group separator as
defined by the country settings.
F2 Show the number with 2 digits using the decimal point and group separator as
defined by the country settings.
F3 Show the number with 3 digits using the decimal point and group separator as
defined by the country settings.
h Hour (1—12)
hh Hour (01—12)
H Hour (1—24)
HH Hour (01—24)
m Minute (1—59)
mm Minute (01—59)
M Month (1—12)
MM Month (01—12)
ss Second (01—59)
tt AM/PM designator
YY Year (00—99)
The following table shows some examples of how the Format Code defines the
output format.
0.## 0.12
0.#### 0.123
0.0000 0.1230
F1 0.1
F2 0.12
2/27/2007 5:11:30 PM h tt 5 PM
For more information on the Format Codes, refer to the MSDN library
(http://msdn.microsoft.com/en-us/library/26etazsy(v=VS.100).aspx).
Using Expressions
The complete entry in the Filter page would look like this:
=UCase(Sample = "TRAMADOL"
_Name)
=Len(fieldname) > 0
=Len(fieldname) > 0
• Sample1; c
• Sample2; a
• Sample2; b
• Sample2; c
The next part of the expression must be a Choose function that always returns
the first element of a list:
Choose(1, [list] )
The list in this example is returned by the Split function:
=Choose(1, Split(Sample_Name, "_"))
This expression returns the following results:
• Sample1
• Sample1
• Sample1
• Sample2
• Sample2
• Sample2
If you use this expression to repeat the composite group, you will get only two
composite groups, as there are only two distinct values.
If you do not provide a specific time of day, the system assumes the time
#0:00:00#. Therefore, in order to filter for one entire day, you must filter for a
date range as follows.
Expression Result
=Sample_CustomField01 TabletWeight|1020
This filter returns all samples that contain "Sample" in their name.
The following wildcards are available:
• ? matches any single character.
• * matches any number of adjacent characters.
12
Calculation Variables
About Variables 110
Variable 111
Aggregator 111
Category Aggregator 112
Custom Extractor 114
Using Variables 117
To activate the use of variables 117
To create a variable based on summary calculation 117
To use a variable 118
To rename a variable 119
To use a variable with a unique key 120
To use an Aggregator 120
To use a Category Aggregator 122
To create an Aggregator based on a condition 123
To use a Custom Extractor 123
To find out the available keys for a complex custom field 125
About Variables
Variable
With Variable, you can store any single numerical value. This value is identified
by a unique name. You can provide either only a static name for the variable,
or use a dynamically generated key in addition (for example, the sample
name).
Example
The Variable AvgRetTime may contain the average retention time of a specific
compound found in a specific sample.
Aggregator
With Aggregator, you can store a collection of single values. The entire
collection is identified by a unique name. You can apply several aggregating
functions to the collection. It is not possible to select a single value from the
collection.
The Aggregator provides the following functions:
• Sum()
This function returns the sum of all values currently contained in the
collection.
• Avg()
This function returns the average of all values currently contained in the
collection.
• Stdev()
This function returns the standard deviation of all values currently
contained in the collection.
• Prsd()
Example
The AggregatorRetTimeSSRSD1 can contain all retention times of a compound
in different injections of the SSRSD1 sample. You can return the average
retention time with Avg(RetTimeSSRSD1), or the standard deviation with
StDev(RetTimeSSRSD1).
Example
The AggregatorAvgRetTimes can contain the average retention times of the
same compound in different samples. You can return the standard deviation
on the average values with StDev(AvgRetTimes).
Category Aggregator
With Category Aggregator, you can store a collection of collections. The entire
collection is identified by a unique name. You can apply several aggregating
functions to each of the contained collections. It is not possible to select a
single value from a specific collection.
The Category Aggregator provides the following functions (each function takes
into account only those values belonging to the currently active value of the
given data field):
• Sum([Field])
This function returns the sum of all values currently contained in the
collection.
• Avg([Field])
This function returns the average of all values currently contained in the
collection.
• Stdev([Field])
This function returns the standard deviation of all values currently
contained in the collection.
• Prsd([Field])
This function returns the relative standard deviation (Stdev/Avg*100) of all
values currently contained in the collection.
• Min([Field])
This function returns the lowest value currently contained in the collection.
• Max([Field])
This function returns the highest value currently contained in the
collection.
• Count([Field])
This function returns the number of elements in the collection.
• Clear([Field])
This function deletes all values from the collection. At the same time, it
returns the number of deleted values.
Example
A sample has been injected several times. One specific compound has been
detected in each injection. For each sample, a collection of the retention times
is created. These collections are addressed via the sample name. All of those
collections are contained in a Category Aggregator named CatRetentionTimes.
You can return the average retention time for each sample with
Avg(CatRetentionTimes(Sample_Name)). The argument in the brackets
defines the specific category, that is, the portion of values contained in
CatRetentionTimes to which the Avg function is applied.
You may use this expression, for example, in a composite group that is
repeated on the sample name. The average retention times are then
automatically calculated and shown for each sample name.
Custom Extractor
There are specific data fields that do not contain a single value but an entire
XML structure. This XML structure contains various key/value pairs, where
the exact keys and the values depend on the chromatography data system and
its configuration (see “Keys in Diagnostic Data” on page 115). With
CustomExtractor, you can store this XML structure. You can apply several
functions to access the single values.
The CustomExtractor provides the following functions:
• GetValue(name)
This function returns the value stored under the given name.
• GetNameValue(index)
This function returns a combination of key and value in the form Key=Value.
With index=0 the function returns the first key/value pair.
• GetValueByIndex(index)
This function returns the value of the name/value pair at the given position.
The first key/value pair is indexed by 0.
• Count()
This function returns the number of key/value pairs in the XML structure.
• Clear()
This function deletes the XML structure from the Custom Extractor and
returns the number 0.
Example
You can add an invisible text field to your template with the value
=Injection_DiagnosticData. If you save this value as a Custom Extractor named
CustDiagnosticData, you can subsequently access the start pressure of a
ChemStation LC measurement via the expression:
=CustDiagnosticData(GetValue("StartPressure")).
If you are not sure about the correct keys, see “To find out the available keys for a complex
NOTE custom field” on page 125.
ChemStation ChemStore
DAD1UVOnTime n/a
DAD1UVBurnTime n/a
DADVisOnTime n/a
DAD1VisBurnTime n/a
StartPressure BegPumpPres
StopPressure EndPumpPres
StartFlow BegPumpFlow
StopFlow EndPumpFlow
PumpType n/a
StartLeftTemp BegLTemp
StopLeftTemp EndLTemp
ChemStation ChemStore
StartRightTemp BegRTemp
StopRightTemp EndRTemp
AirTemp n/a
InjVolume n/a
ActInjVolume n/a
InjVolumeText n/a
ActInjVolumeText n/a
Using Variables
c On the Columns page, select the RT column and click Column Properties.
d On the Summary Calculations page, select the Averagefunction, and enter
VarAvgRT as the Variable Name.
e Confirm all settings.
f In the Editing Pane, resize the table so that it requires only minimal
space.
8 Prepare the second table to show the difference between retention time and
retention time average.
a Remove the Repeat On setting from the table.
b On the Columns page, add a Custom Field to the table layout.
c Move the new column to the right of the RT column and adjust its size.
d In the Column Properties of the new column, enter the following
expression as a value: =Peak_RetentionTime - VarAvgRT
e On the Format page, adjust the number format for the new column to
Number, 1234.00, and set Rounding to 4 decimal places.
f Confirm all settings and generate a preview.
The generated report will show the difference between the individual
retention times and the sequence average.
To use a variable
To create a variable:
1 Make sure that variables are activated in your report template (see “To
activate the use of variables” on page 117).
2 Add two text fields or a data fields to the template.
7 Make sure that the Variable option is selected, and enter a Calculation Variable
Name, for example VarAmountCorrected.
To rename a variable
3 Select the two text fields and click to create a composite group.
4 Repeat the composite group on Compound_Name.
5 In the first text field, enter a static text. For example, RT Average.
6 In the second field, enter an expression for the average retention time:
=Avg(Peak_RetentionTime)
7 Save the expression of the second field as a variable. Use the following
settings:
• Calculation Variables: Variable
• Calculation Variable Name: For example, VarRTAverage
• Unique Key Value: =Compound_Name
In the Unique Key Value setting, you must use the same value as you used for repeating the
NOTE composite group
To use an Aggregator
This example describes how to compare the average peak areas for two
different sets of samples (for example, calibration samples and checkout
samples, or samples with a name containing SampleA and samples with a
name containing SampleB).
3 In each table: Open the Column Properties dialog of the Area column, and save
the value as a variable. Use the following settings:
• Calculation Variables: Aggregator
• Calculation Variable Name: For example, AreaAggregator1 in the first
table, and AreaAggregator2 in the second table.
• Category: [None]
• Condition: [None]
To use the variables:
1 Underneath the two tables, create a text field with the following expression:
=Avg(AreaAggregator1) - Avg(AreaAggregator2)
Instead of the Avg function, you can also apply the Sum, Stdev, Prsd, Min,
Max, or Count function to the Aggregator variables.
Clear function
NOTE
If you create and use the Aggregator inside a composite group, use the Clear function at
the end of the group. Add two hidden text fields with the following expressions:
=Clear(AreaAggregator1)
=Clear(AreaAggregator2)
This clears all contents of the Aggregator, which ensures that the values are not mixed in
subsequent group repetitions.
For the Category setting, you must use the same value as in the Repeat On setting for the
NOTE tables.
4 Make sure that the CustomExtractor option is selected, and enter a Calculation
CustomExtractor Name, for example MyDiagnosticData.
In this example, your access the start pressure with the key StartPressure. See “Keys in
NOTE Diagnostic Data” on page 115 or “To find out the available keys for a complex custom
field” on page 125 for information on other available keys.
13
Report Template Audit Trail
About the Report Template Audit Trail 128
The Report Template Audit Trail provides a detailed list of all modifications of
a template. The list includes the following information:
• Template Version: Each time you save the template, the template version
increases by one.
• User Name: Name of the user who modified the template. The name is
provided by the operating system.
• Machine Name: Name of the PC on which the template was modified.
• Date Time: Date and time when the template version was saved.
• Audit Entry: Description of the modification.
The modifications are written to the Report Template Audit Trail when you
save the report template. Thus, the Report Template Audit Trail shows all
changes up to the last saving date.
14
Report Parameters
About Report Parameters 130
Using Report Parameters 131
To create a single report parameter 131
To create a multi-value report parameter 132
To calculate with a report parameter 133
With report parameters, you can make your report templates more dynamic.
There are two basic types of parameters:
• Interactive report parameters (default):
You need to provide these parameters each time before the report is
generated. An additional report parameter pane is shown at the top of the
report preview area, where you can enter the required values. When you
click View Report, the report is generated using the given parameters.
15
Document Map
About Document Map 136
Using Document Map 138
The document map offers you a list of bookmarks in the report preview. With
these bookmarks, you can easily jump to the page in the report that contains
the corresponding information. For example, the report contains a sequence
with 20 samples. Each sample has been injected several times, and for each
injection there is a results table. With the bookmarks in the document map,
you can directly jump to each specific injection.
You can create bookmarks for repeated tables or matrices: With these report
items, the document map expression is always the same as the repeat-on
expression.
In addition, you can specify bookmarks for other report items, such as text
fields or data fields, inside a repeated composite group. In most cases the
bookmark will reflect the value that you used to repeat the composite group.
However, you can also customize this expression according to your
requirements.
When you export a report to PDF that contains a document map, the
bookmarks will be available in PDF as well.
This example describes a sequence with several samples. Each sample has
been injected several times. The document map shows a bookmark for each
injection.
1 Create a new Single Sequence Summary template.
2 Add the following report items to your template and place them under each
other:
a The Sample_Name data field
b The Injection_DataFileName data field
c The Compound Results table
3 Select the Compound Results table and the Injection_DataFileName field, and
5 Select the composite group and the Sample_Name data field, and click to
create another, superordinate composite group.
6 Repeat the superordinate composite group on =Sample_Name.
7 Set the document map expression for the Sample_Name data field to
=Sample_Name.
8 Set the document map expression for the Injection_DataFileName field to
=Injection_DataFileName.
9 In the report preview, click on the Plus icon to expand the document map.
16
Locked/Unlocked Report Items
About locked/unlocked report items 142
To lock or unlock report items 143
You can only lock or unlock items if you have the Lock/unlock report item privilege in
NOTE Agilent OpenLAB Shared Services.
You can lock either single report items or composite groups containing
multiple report items. A locked item is protected against any modification.
What is possible with a locked item:
• View properties.
• Move the item inside the template.
What is impossible with a locked item:
• Modify properties.
• Remove the item from the template.
For example, you can lock a composite group containing complex calculations
that have been validated and approved. With the lock, you make sure that the
items are not changed by accident.
2 To unlock a locked item: Right-click the item and select Unlock from the
context menu. Alternatively, you can click the Unlock Report Item icon in the
toolbar: .
3 To lock an item: Right-click the item and select Lock from the context menu.
Alternatively, you can click the Lock Report Item icon in the toolbar:
The Lock and Unlock commands are only available if you have the required privilege in
NOTE Agilent OpenLAB Shared Services.
17
Appendix
Operators 147
Arithmetic 147
Comparison 147
Concatenation 148
Logical 148
Functions 149
Text 149
Conversion, Date/Time 151
Math 152
Program Flow 153
Aggregate 153
Misc 154
Enumerations 155
BaselineModel enumeration 155
BracketingMode enumeration 156
BracketingType enumeration 156
CalibPeakRole enumeration 157
CalibrationCurveOrigin enumeration 157
CalibrationCurveType enumeration 158
CompoundQuantitationType enumeration 158
CompoundType enumeration 159
InjectorPosition enumeration 159
InstrumentTechnique enumeration 159
PeakType enumeration 160
QuantificationMethod enumeration 161
ResponseFactorCalcMode enumeration 161
ResponseFactorUpdate enumeration 162
RetentionTimeUpdate enumeration 162
This chapter contains a list of all operators and functions available in the
Expression Editor.
Operators
Arithmetic
Table 19 Arithmetic
Mod NUMBER1 Mod NUMBER2 Divides two numbers and returns only the remainder.
Comparison
Table 20 Comparison
Name Description
= Equal to
Like Compares two strings. The string to be compared with must contain wildcards:
• ? matches any single character.
• * matches any number of adjacent characters.
Concatenation
Table 21 Concatenation
Name Description
Logical
Table 22 Logical
Name Description
Functions
Text
Table 23 Text
Chr Chr(65) Returns the character associated with the specified ANSI
character code.
InStr InStr(HAYSTACK, NEEDLE) Returns an integer specifying the start position of the first
occurrence of one string (NEEDLE) within another
(HAYSTACK).
InStrRev InStrRev(HAYSTACK, Returns the position of the first occurrence of one string
NEEDLE) (NEEDLE) within another (HAYSTACK), starting from the
right end of the string.
Table 23 Text
Table 23 Text
Conversion, Date/Time
Table 24 Conversion, Date/Time
Math
Table 25 Math
Pow Pow(NUMBER, POWER) Returns a specified number raised to the specified power.
Program Flow
Table 26 Program Flow
Aggregate
Table 27 Aggregate
Avg Avg(FIELDNAME) Returns the average of all non-null values of the specified
field.
CountRows CountRows() Returns the number of rows, including rows with null
values.
Max Max(FIELDNAME) Returns the maximum value from all values of the
specified field.
Min Min(FIELDNAME) Returns the minimum value from all non-null values of the
specified field.
Table 27 Aggregate
First First(FIELDNAME) Returns the first of the values of the specified field.
Last Last(FIELDNAME) Returns the last of the values of the specified field.
Aggregating functions always refer to all records in a scope and return only
one value. This value is either calculated from those records or selected
according to specific criteria. Therefore, aggregating functions are
automatically used, for example, for the creation of table headers or footers.
You can use aggregating functions if you need to summarize your data.
Misc
Table 28 Misc
RowNumber RowNumber(SCOPE) or Returns a running count of all rows in the specified scope.
RowNumber(SCOPE, The scope can be given as single string (Scope as String)
COUNTGROUP) or in combination with the group number (Scope as String,
CountGroup as String).
Enumerations
Some data fields contain specific numbers that stand for certain values. These
so-called enumerations typically represent all data that is shown in a
drop-down list in your chromatography data system.
Display enumerations
If you display these data fields in a data field, table column or matrix column,
the RTE automatically selects the text value that corresponds to the stored
number.
BaselineModel enumeration
Number Description
0 Unknown
1 Linear
2 Exponential
3 ExtendedExponential
BracketingMode enumeration
Number Description
0 None
1 Standard
2 StandardClearCalibration
3 StandardOverlap
4 OverallSequence
5 SequenceBackCalculation
BracketingType enumeration
Number Description
0 Undefined
1 Open
2 Close
3 Intermediate
CalibPeakRole enumeration
Number Description
0 None
1 Main
2 Qualifier
3 Ignore
4 NewMain
5 NewIgnore
6 DetectorMain
CalibrationCurveOrigin enumeration
Number Description
0 Undefined
1 Include
2 Force
3 Connect
CalibrationCurveType enumeration
Number Description
0 Undefined
1 Linear
2 Quadratic
3 Cubic
4 Exponential
5 Logarithmic
6 Power
7 AverageRF
8 Piecewise
9 Custom
CompoundQuantitationType enumeration
Number Description
0 Undefined
1 Area
2 Height
3 Count
CompoundType enumeration
Number Description
0 Unknown
1 Expected
2 UncalibratedExpected
3 PeakSum
4 Group
5 NotIdentifiedExpected
InjectorPosition enumeration
Number Description
0 Undefined
1 Front
2 Back
InstrumentTechnique enumeration
Number Description
0 Undefined
1 LiquidChromatography
2 GasChromatography
3 MassSpectrometry
4 CapillaryElectrophoresis
5 UVVis
6 MicroFluidics
PeakType enumeration
Number Description
0 Unknown
1 Tangent
2 Solvent
3 AreaSum
4 FrontShoulderDropLine
5 FrontShoulderTangent
6 Manual
7 ManualNegative
8 ManualNegativeShoulderDropLine
9 ManualNegativeShoulderTangent
10 ManualShoulderDropLine
11 ManualShoulderTangent
12 ManualTangentSkimExpo
13 ManualTangentSkimNewExpo
14 ManualTangentSkimNormal
15 Negative
16 NegativeShoulderDropLine
17 NegativeShoulderTangent
18 NormalPeak
19 RearShoulderDropLine
20 RearShoulderTangent
21 ReCalcSolventPeak
22 ShoulderDropLine
23 ShoulderTangent
24 TangentSkimExpo
Number Description
25 TangentSkimNewExpo
26 TangentSkimNormal
QuantificationMethod enumeration
Name Description
0 Undefined
1 Area%
2 ESTD
3 ESTD%
4 Height%
5 ISTD
6 ISTD%
7 Norm%
ResponseFactorCalcMode enumeration
Number Description
0 Undefined
1 AmountPerResponse
2 ResponsePerAmount
ResponseFactorUpdate enumeration
Number Description
0 Undefined
1 NoUpdate
2 Replace
3 Average
4 Bracketing
5 DeltaPercent
RetentionTimeUpdate enumeration
Number Description
0 Undefined
1 NoUpdate
2 Replace
3 Average
4 Bracketing
SampleContextIntegrity enumeration
Number Description
0 Undefined
1 Complete
2 Partial
SampleContextSource enumeration
Number Description
0 Undefined
1 Acquisition
2 Reprocessed
3 Virtual
SampleContextType enumeration
Number Description
0 Undefined
1 SingleSample
2 Sequence
SampleType enumeration
Number Description
0 Unspecified
1 Calibration
2 Checkout
3 Sample
4 Control
5 Blank
6 Ladder
7 SystemSuitability
SeparationMediumPosition enumeration
Number Description
0 Unknown
1 Front
2 Left
3 Rear
4 Right
If you are not sure about the correct keys, see “To find out the available keys for a complex
NOTE custom field” on page 125.
ChemStation ChemStore
DAD1UVOnTime n/a
DAD1UVBurnTime n/a
DADVisOnTime n/a
DAD1VisBurnTime n/a
StartPressure BegPumpPres
StopPressure EndPumpPres
StartFlow BegPumpFlow
StopFlow EndPumpFlow
PumpType n/a
StartLeftTemp BegLTemp
StopLeftTemp EndLTemp
StartRightTemp BegRTemp
StopRightTemp EndRTemp
AirTemp n/a
ChemStation ChemStore
InjVolume n/a
ActInjVolume n/a
InjVolumeText n/a
ActInjVolumeText n/a
Index
R V
relative standard deviation 95 val 96, 151
report template audit trail 127
report type 12 W
right 97, 149 wildcards 57, 93, 107, 147
rounding 28
round 96, 152 X
rownumber 97, 99, 149, 154 x-axis labels 87
rtrim 97, 149 x-axis 87
XML 114
S x-value 87
scatter chart 79
second row 26 Y
series group 85 y-axis labels 86
series label 88 year 96, 151
signal name 63
significant digits 28
split 97, 149
sqrt 96, 152
square root 96, 152
standard deviation 95, 153
stdevp 95, 153
stdev 95, 153
str 96, 151
sum 95, 153
T
table column 21, 22
table group 33, 35
table 20
today 96, 151
trim 97, 149
U
ucase 97, 102, 149
uppercase 102
upper 97, 97, 149, 149
In This Book
*G4635-90013*
*G4635-90013*
G4635-90013
Agilent Technologies