Professional Documents
Culture Documents
what is measurable
and make measurable
that which is not.
Galileo Galilei (1564-1642)
Reference Guide
Instrument Software
DMA 501 | DMA 1001 |
Lyza 5000 | TPO 5000
Disclaimer
This document may contain errors and omissions. If you discover any such errors, or if you would like to see
more information in this document, please contact us at our address below. Anton Paar assumes no liability
for any errors or omissions in this document.
Further information
Published and printed by Anton Paar GmbH, Austria
Copyright © 2020 Anton Paar GmbH, Graz, Austria
Address of the instrument producer: Anton Paar GmbH
Anton-Paar-Str. 20
A-8054 Graz / Austria – Europe
Tel: +43 (0) 316 257-0
Fax: +43 (0) 316 257-257
E-Mail: info@anton-paar.com
Web: www.anton-paar.com
Contents
1 About the Manual .................................................................................................................................. 5
2 Basic Operation and Input Devices ..................................................................................................... 6
2.1 Touchscreen ................................................................................................................................... 6
2.1.1 Onscreen Keyboard ................................................................................................................ 6
2.2 USB Mouse (Optional) .................................................................................................................... 7
2.3 USB Keyboard (Optional) ............................................................................................................... 7
2.4 USB Barcode Reader (Optional) ..................................................................................................... 7
3 Screens – Navigation, Information, Control ....................................................................................... 8
3.1 Functional Screen Elements ........................................................................................................... 8
3.1.1 Header .................................................................................................................................... 8
3.1.2 System Notifications ............................................................................................................... 8
3.1.3 Favorites Button ...................................................................................................................... 8
3.1.4 Action Boxes ........................................................................................................................... 8
3.2 Home Screen – Your Favorites ....................................................................................................... 9
3.3 Menu – All the Functions ................................................................................................................ 9
3.4 Spots ............................................................................................................................................. 10
3.5 Wizards ......................................................................................................................................... 10
3.6 Dashboards – the Measurement Stage ........................................................................................ 10
3.6.1 Managing Dashboards .......................................................................................................... 10
3.6.2 Widgets on a Dashboard ...................................................................................................... 11
3.7 Modal Messages ........................................................................................................................... 11
4 Basic Settings ..................................................................................................................................... 12
4.1 Language and Regional Settings .................................................................................................. 12
4.2 Time Settings ................................................................................................................................ 12
4.3 Display Brightness ........................................................................................................................ 12
4.4 Global Units .................................................................................................................................. 12
4.5 Automatic Sample Names ............................................................................................................ 12
4.6 More Settings ................................................................................................................................ 13
5 Hardware Configuration ..................................................................................................................... 14
5.1 Network Connection ...................................................................................................................... 14
5.2 Network Shares ............................................................................................................................ 14
5.3 Printers .......................................................................................................................................... 15
5.3.1 Network Printers ................................................................................................................... 15
5.3.2 USB Printers ......................................................................................................................... 15
5.3.3 Serial Printers ....................................................................................................................... 16
6 The Data Explorer ............................................................................................................................... 17
6.1 Comparing Data Sets .................................................................................................................... 17
6.2 Exporting or Printing Single Data Sets .......................................................................................... 18
6.3 Exporting or Removing Multiple Data Sets ................................................................................... 18
7 Reports ................................................................................................................................................ 19
7.1 Configuring Report Contents ........................................................................................................ 19
7.2 Report Templates ......................................................................................................................... 19
8 Images .................................................................................................................................................. 20
9 Custom Quantities .............................................................................................................................. 21
9.1 Custom Quantity Defined by a Formula ........................................................................................ 21
9.2 Custom Quantity Defined by a Table ............................................................................................ 22
9.3 Editing a Custom Quantity ............................................................................................................ 22
9.4 Removing a Custom Quantity ....................................................................................................... 22
10 System Security and User Management ......................................................................................... 23
10.1 Activating System Security ......................................................................................................... 23
10.2 Logging In/Out ............................................................................................................................ 23
10.3 Auto Login ................................................................................................................................... 23
XPAIB006EN-I 3
Contents
4 XPAIB006EN-I
1 About the Manual
XPAIB006EN-I 5
2 Basic Operation and Input Devices
Tap
Tap on any functional element, and it will do what-
ever its purpose is: a button will initiate an action, a
switch will change its state, a drop-down box will fold
out a selection list etc.
Tap on an item to select it.
Hold
Tap and hold your touch a little longer. Holding a Fig. 1: Example onscreen keyboards (English) –
screen element may pop up options depending on above: alphabetic | below: numerical
the context. E.g., on the onscreen keyboard (see
section 2.1.1), holding some keys will open a box • Tap on characters to enter them at the cursor
with more options to select from (if available). position in the input field.
• Some keys of the onscreen keyboard (e.g.
Drag upper row on the alphabetic keyboard) provide
multiple character options to select from:
Holding and dragging a screen element will move it
a. Hold the key until a character selection box
up, down, left, right, if the operation is available.
folds out (see example in fig. 2).
Slide
Slide a finger on the screen in one direction. The
operation is similar to dragging. Fig. 2: Example character selection box on “e” key
To access the dashboard, slide up the current b. Then tap on one of the keys in the selection
screen (provided it is not modal). To return, slide box to enter it at the cursor position in the
down the dashboard. input field.
To scroll information that doesn’t fit on the screen, Special characters on the alphabetic keyboard:
slide it up/down or left/right (if available). To scroll - @: Hold “1” key (top row) and select.
items in a list, slide up/down in the list. In these - $: Hold “4” key (top row) and select.
cases a slider will appear (and after some time
• Some keys have special functions. See table 1
disappear again) beside (for up/down) or below (for
for their meaning.
left/right) the text.
TIP: Sometimes it may not be clear whether por-
tions of an information are out of screen. Simply try
scrolling this part of the screen to make sure.
6 XPAIB006EN-I
2 Basic Operation and Input Devices
Table 1: Function keys on the onscreen keyboard 2.3 USB Keyboard (Optional)
Hides the onscreen keyboard.
(Tap on the input field to have it reappear.) IMPORTANT: Currently only English keyboards are
supported.
Switches between alphabetic keyboard
and numerical keyboard. If you connect a USB keyboard to one of the instru-
ment’s USB sockets (see manual of the instrument),
Shifts the next letter to upper case.
you can use it in addition to the touchscreen for data
(Disabled on the numerical keyboard.)
input.
Moves the cursor (entry point for the next The keyboard will be detected and installed auto-
character) left/right. matically when plugged in.
• Select any input field and type on the keyboard
Deletes the character left of the cursor. to enter text or numbers.
XPAIB006EN-I 7
3 Screens – Navigation, Information, Control
Action controls
3.1.2 System Notifications
Some actions open action controls. Multiple action
System notifications are collected in the header controls can be open at the same time.
under . A number beside the symbol shows the • An action control consists of three parts:
number of collected notifications. Colors indicate
the notification category.
Table 2: Notification categories 1 2 3
Error: A severe problem has occurred, Fig. 5: Example of an action control for sorting a list
which needs to be solved before you
1 Icon identifying the action control
continue with your measurements. 2 Control part defining the actual function
Warning: A minor problem (may be tempo- 3 Close button of the action control
rary) or a reminder requires your attention.
Information: Non-critical message from • Tap on the control part to configure the control
your instrument. function (further settings may fold out).
• Some action controls look like this:
• Tap to view all notifications.
• Tap on a notification to see all available details.
Fig. 6: Example of an action control for selecting and then
3.1.3 Favorites Button removing, exporting, or comparing the selected items
8 XPAIB006EN-I
3 Screens – Navigation, Information, Control
3.2 Home Screen – Your Favorites 3.3 Menu – All the Functions
2 5
3 4
1
1 2 3
4 6
The Home button on the instrument always • If you tap on a function in the list, you will be
brings you back to the home screen. Alternatively taken directly to the spot or to a list for further
tap BACK repeatedly. selections, depending on the function.
Although the instrument may come with a predefined • You can filter the list on the right by selecting a
set of standard favorites, you can completely define category on the left.
and arrange the favorites on the home screen as you Tap on the category again to reset the filter.
like: • To add/remove functions as favorites on the
• Hold a favorite on the home screen, then drag it home screen for quick access, select/deselect
to a different place. them in column 3, fig. 8 (see also section 3.1.3).
• Hold a favorite on the home screen, then
remove it (tap ).
• To add new favorites, tap where available.
New favorites are marked “New” on the home
screen until you first use them.
XPAIB006EN-I 9
3 Screens – Navigation, Information, Control
12 4
Usually one side of the red line is reserved for set- • Slide the top of the dashboards down to return
tings pertaining to the spot (6, fig. 9). Before you to the current screen.
start an operation, check if the settings are appropri- Or tap the button in the top left corner (5, fig. 10).
ate, and edit them if required. Spots will allow to edit
modifiable settings either directly or via spot actions.
3.6.1 Managing Dashboards
TIP: Be sure to scroll down the settings area to see
all available settings. Holding the name of a dashboard in the list of dash-
boards (3, fig. 10) allows to copy the dashboard
You can always switch to the dashboard (see
( ), to remove it ( ), or to edit its name ( ).
section 3.6) and back (12, fig. 9).
Spots can be added to your favorites on the home
screen for quick access (9, fig. 9).
10 XPAIB006EN-I
3 Screens – Navigation, Information, Control
IMPORTANT: To change the output quantities • Tap (3, fig. 11) to add a new widget.
shown on the dashboard, or to change the units of - Position the widget on the dashboard.
an output quantity, edit the widget’s properties. - Adjust its size.
Holding any part (widget or background) of the - Edit its properties to suit your requirements.
dashboard switches the dashboard into edit mode, Tap anywhere on the grid lines to leave the edit
see fig. 11. Note the grid lines used to arrange the mode and to return to normal display.
widgets.
XPAIB006EN-I 11
4 Basic Settings
4 Basic Settings
All settings in this section are accessed from the - If you have set up an automatic network
Settings screen: configuration, you can leave the Time
Servers input field empty.
• Tap Menu > Settings.
- If you have set up a manual network
There the settings are grouped thematically. configuration, or if you want to specify a
time server anyway:
- Specify the address(es) of your time
4.1 Language and Regional Settings server(s) in the Time Servers input field.
Put each time server in a new line.
• On the Settings screen, under System select Do not separate addresses by commas
Time & Language. or semicolons etc.
First of all you will want to set the system language d. It depends on your time server when the
so that you feel comfortable on the measuring system time will be synchronized. It may also
system: be necessary to restart the instrument.
Set the system time correctly so that the time Global units will be used as default units in the
stamps of measurements and system events are measuring system:
correct and traceable: 1. On the Settings screen, under System select
1. On the Settings screen, under System select Global Units.
Time & Language. 2. Then set the global units that you prefer.
2. Set Region and City to your time zone.
Daylight saving time will be calculated automat- 4.5 Automatic Sample Names
ically.
(Only Lyza 5000.)
TIP: The date and time formats are defined with the
Format setting, see section 4.1. You can set the instrument so that it generates
pattern-based automatic sample names.
• To set date and time manually:
- Set Date to the current date. 1. Activate the function:
- Set Time to the current time. a. On the Settings screen, under System select
• Alternatively, set date and time via time server: Sample Naming.
b. Switch Use Automatic Sample Naming to
a. Configure a network connection first, see “Yes”.
section 5.1.
b. Switch Use Time Server to “Yes”. 2. After the function has been activated, define a
The Time Servers input field replaces the pattern for the automatic sample names:
input fields Date and Time. - Tap Configure.
c. The Time Servers setting depends on your The current elements of the name pattern
network settings. are shown in an ordered list on the right,
which shows their position in the pattern.
12 XPAIB006EN-I
4 Basic Settings
XPAIB006EN-I 13
5 Hardware Configuration
5 Hardware Configuration
5.1 Network Connection TIP: If you are in doubt about the correct settings,
consult your network administrator.
If you want to access network ressources (like a 1. Configure a network connection first, see
network printer), you need to set up an Ethernet section 5.1.
connection first: 2. Tap Menu > Settings.
TIP: If you are in doubt about the correct settings, 3. On the Settings screen, under Network &
consult your network administrator. Connections select Network Shares.
1. Make sure that your instrument is connected to 4. Tap in the action box to add a new network
the network. share or tap on an existing network share to
2. Tap Menu > Settings. edit its settings.
3. On the Settings screen, under Network & 5. Switch Network Share to “Enabled” or
Connections select Ethernet. “Disabled”.
4. Switch Ethernet to “ON”. - “Enabled” makes the network share avail-
able for use.
The network configuration settings slide in. - “Disabled” temporarily disables the network
5. To edit an already defined configuration: share.
Scroll down to the end of the list and tap 6. Connection Type is currently fixed since only
Configure. Then scroll back up. CIFS shares (including SMB1 and SMB2) are
6. Use the Configuration switch to select supported at present.
- Automatic configuration (recommended) 7. Define a unique Display Name for the network
Use automatic configuration if your network share. You will later be able to identify it by this
server supports DHCP. registered name.
a. Scroll down to DNS Suffixes. 8. In the Server input field specify the full network
b. Enter one or more DNS suffixes in the proper path to the network share.
order (your domain names). A correct path begins with a double slash char-
- or Manual configuration acter.
Use manual configuration to set a fixed IP
Mind to use the correct slash characters for the
address for the instrument.
path. The instrument will not accept backslash
a. Set the IP address, the subnet mask, and
characters.
the gateway address according to your local
network. 9. Enter the correct authentication data for the
b. Set the primary (and secondary) DNS name network share in the Username and Password
server addresses. input fields.
c. Enter one or more DNS suffixes in the proper IMPORTANT: If you enter incorrect authentication
order (your domain names). data, you will later not be able to transfer data
7. Tap Connect. between the instrument and the network share.
If you experience problems connecting to the net- 10. Tap Test Connection to verify that the network
work, verify that your settings are correct. path is correct.
TIP: You cannot change the shown MAC address. 11. Tap Add or Save (if you have edited an existing
This is a unique address specific for your instrument. network share) to save the new settings.
After this you can use the network share as a storage
location identified by the registered display name.
5.2 Network Shares
If you experience problems writing to or reading
You can use network shares as storage locations. from the network share, verify that your settings are
To make them available for this purpose, register correct.
them on the instrument:
14 XPAIB006EN-I
5 Hardware Configuration
Table 3: Supported network printer models 1. Make sure that your printer is connected to one
of the USB sockets of your instrument and
• Minolta PagePro 6
switched on.
• all HP printer models up to (and including)
HPLIP version 3.16.5 listed in this table: 2. Tap Menu > Settings.
https://developers.hp.com/hp-linux-imaging- 3. On the Settings screen, under Hardware select
and-printing/supported_devices/index.html Printers.
4. Tap in the action box to add a new USB print-
1. Configure a network connection first, see er or tap on an existing USB printer to edit its
section 5.1. settings.
2. Make sure that your printer is connected to the 5. If you add a new USB printer:
network and switched on. Tap Add USB Printer.
3. Tap Menu > Settings. 6. Define a unique Printer Name for the USB print-
4. On the Settings screen, under Hardware select er. You will later be able to identify it by this
Printers. registered name.
5. Tap in the action box to add a new network 7. With the switch you can set the printer as the
printer or tap on an existing network printer to default printer.
edit its settings. 8. The field Available Printers should show the
6. If you add a new network printer: connected printer detected by the instrument.
Tap Add Network Printer. TIP: If the field Available Printers is empty, the
7. Define a unique Printer Name for the network instrument is not able to detect your printer.
printer. You will later be able to identify it by this • In this case contact your local Anton Paar repre-
registered name. sentative.
8. With the switch you can set the printer as the 9. From the Model list select a driver class support-
default printer. ing your printer.
9. From the Model list select a driver class support- 10. Tap Print Test Page to verify that the USB print-
ing your printer. er has been correctly registered, and that the
10. Specify the Hostname or IP of the network connection works.
printer. 11. Tap Create or Save (if you have edited an exist-
The name or address depend on your network ing USB printer) to save th new settings.
configuration. After this you can use the registered USB printer for
11. Tap Print Test Page to verify that the network printing on the instrument.
printer has been correctly registered, and that
the connection works.
12. Tap Create or Save (if you have edited an exist-
ing network printer) to save the new settings.
After this you can use the registered network printer
for printing on the instrument.
XPAIB006EN-I 15
5 Hardware Configuration
5.3.3 Serial Printers 5. From the Serial Port list select the serial port to
which your printer is connected (if there is any
(Only DMA 501/1001,TPO 5000.) choice).
Table 5: Supported serial printers 6. Tap Print Test Page to verify that the serial print-
er has been correctly registered, and that the
• Epson TM-U220D connection works.
(available from Anton Paar)
After this you can use the registered serial printer for
• Citizen CBM-910 Type II
printing on the instrument.
(available from Anton Paar)
• Epson TM-U330D (Chinese)
Deactivating the serial printer
1. Make sure that your printer is connected to the 1. Tap Menu > Settings.
COM/RS-232 serial port of your instrument and
2. On the Settings screen, under Hardware select
switched on.
Receipt Printer.
2. Tap Menu > Settings.
3. From the Receipt Printer list select (none).
3. On the Settings screen, under Hardware select
Receipt Printer. The serial port can now be used for other purposes,
e.g. RS-232 LIMS services.
4. From the Receipt Printer list select your printer
model.
16 XPAIB006EN-I
6 The Data Explorer
XPAIB006EN-I 17
6 The Data Explorer
18 XPAIB006EN-I
7 Reports
7 Reports
Results shown in the data explorer are presented in Defining or editing a report template
the form of reports, which can also be printed or
exported onto external storage. 1. Tap Menu > Settings.
2. On the Settings screen, under Reports select
Some instruments deliver reports in a fixed form,
Report Templates.
some allow to define the data that shall be included.
3. Tap in the action box to add a new report
template or tap on an existing report template
7.1 Configuring Report Contents to edit its settings.
(Only DMA 501/1001,TPO 5000.) The configuration wizard shows a preview of
your configuration on the right.
Reports are always generated according to the
current report configuration, which you can change 4. Specify a name for the report template.
at any time. 5. Specify any of the available options according
to your requirements. (The available options
1. Access the measurement or product settings:
depend on your instrument.)
- For measurement reports (if available):
IMPORTANT: If you want to include images like a
a. Tap Menu > Measurement.
company logo or a background image, you have to
b. Tap in the action box. add them first to the image repository on the instru-
- For product measurement reports ment, see section 8.
(if available):
- Company information may include a com-
a. Tap Menu > Products. pany logo, which you can select from the list
b. Open the particular product. of available images. The image will be scaled
c. Tap in the action box. proportionally to fit into the header of the
2. Under Report Configuration tap Configure. report.
- A background image may be selected from
The currently selected contents are shown in the list of available images. It will be scaled
an ordered list on the right. proportionally to fill the whole content area of
3. Configure the report contents: the report.
- To add further data, use the area on the left: - Activate GxP Compliant, if available, to in-
First select a data group in the selection box clude the specified number of signature lines.
on the top, then add data from the list below - Activate Extended Footer, if available, to in-
by tapping . clude the user who has generated the report
- Tap on any of the items in the list on the right in the footer.
to select it. You can then modify the displayed 6. Tap Save to save the report template.
properties of the item, change its position in
the list, or remove it from the list. Assigning a report template to a report
- Tap on a selected item again to deselect it.
category
4. Tap Save to save the report configuration.
You can assign different report templates to each of
5. Tap Save to save the measurement or product
the results categories like measurements, checks,
settings.
adjustments.
TIP: You can find measurement-specific parame-
1. Tap Menu > Data Explorer, then open the
ters, like date of measurement or sample name, in
particular results category (e.g. Measurements).
the data group “Measurement”.
2. Tap on one of the results.
3. Tap in the action box.
7.2 Report Templates
4. Select the appropriate report template from the
(Only Lyza 5000.) list.
Report templates allow to include company informa- 5. Tap Save.
tion in reports and to configure reports so that they The selected report template will be assigned to
meet certain formal requirements. the whole results category.
XPAIB006EN-I 19
8 Images
8 Images
(Only Lyza 5000.) Adding or removing images
You can upload your own images onto the instru- 1. Tap Menu > Settings.
ment for further use, e.g. to be included in reports.
2. On the Settings screen, under System select
The instrument’s image repository can hold up to 50 Images.
images, which qualify for upload if they meet the
You see thumbnails of the currently stored
following conditions:
images.
- image file format: .bmp, .jpg, .png 3. To add or remove images:
- image file size: < 300,000 bytes
- image size: longest side < 800 pixels - Tap in the action box to add an image.
- Tap below an image to remove it.
20 XPAIB006EN-I
9 Custom Quantities
9 Custom Quantities
(Only DMA 501/1001, TPO 5000.) • Quantities used in the formula are denoted Q1,
Q2, and so on. Case does not matter.
In addition to the measuring quantities already
provided by the instrument, you can define custom • Quantities have to be added to the formula,
quantities to serve your specific needs. before they can be used in it (see below).
For example, to have your measurement results TIP: The character serving as decimal separator in
displayed in a unit not natively supported on your numbers depends on your regional settings (see
instrument, just define a custom quantity doing the section 4.1).
conversion with a formula, and select the custom
quantity in a dashboard widget. To define the custom quantity
You can use custom quantities in exactly the same 1. Tap Menu > Quantities to open a list of
way as measuring quantities. Therefore you can all available quantities.
include a custom quantity in the definition of another
custom quantity. 2. Tap in the action box to add a custom quan-
tity.
You find all custom quantities that you have defined
3. Select Add Formula.
in the data group “Custom Quantities”.
4. On the spot for the definition of the custom quan-
tity, specify the name of the new quantity.
9.1 Custom Quantity Defined by You can also enter
a Formula - a description,
- a designation for the unit to be displayed
In this case, the custom quantity Qc is a function of with the value of the quantity,
one or more already defined quantities Q1, Q2, ...: - the number of decimal places to be dis-
played.
Qc = f (Q1, Q2, ...)
5. Specify an upper limit and a lower limit for the
The function is defined by the formula f. values of the custom quantity.
• You can use the following operators and If the value of the custom quantity exceeds
functions to compose the formula: these limits, the notification “Out of range” will
be displayed instead of a value.
Table 7: Available operators and functions
6. To enter the defining formula, tap into the
+ addition, unary plus (sign) Formula box and start typing the formula.
– subtraction, unary minus (sign) - Combine numerical constants and defined
quantities with the available operators and
* multiplication
functions (see table 7).
/ division - To add a quantity to the formula:
** exponentiation (powers) - Tap Add Quantity (above the keyboard).
- Select the desired Quantity after you have
sqrt() square root
selected the proper Group. Also select the
abs() absolute value (discards sign) correct Unit of the quantity, if applicable.
sin() - Tap Save.
cos() The added quantity with its denotation is
tan() shown in a list below the Formula box. You
trigonometric functions and inverse can now use the denotation in the formula.
asin()
acos() 7. Tap Save.
atan()
log()
logarithms to bases 10 and e
ln()
exp() exponential function
XPAIB006EN-I 21
9 Custom Quantities
22 XPAIB006EN-I
10 System Security and User Management
10.1 Activating System Security Fig. 13: Example user identification in the header
Before you can use any of the included features, Logging out
you need to activate system security: 1. To log out, tap on the user identification in the
1. Tap Menu > Settings. header (see fig. 13).
2. On the Settings screen, under System Security A control panel slides in showing the available
select Activation. user operations:
3. Set the switch System Security to “activated”.
4. Tap Restart.
The instrument will restart and present a login
screen.
After the first activation of system security, log in Fig. 14: Example control panel with user operations
with the default administrator account (see 2. Tap LOG OUT.
section 10.5) in order to set up your user and role
management. The login screen will appear.
IMPORTANT: When you activate system security, TIP: When you log out, operations that you have
RS-232 LIMS services will be deactivated. started will be stopped.
When system security is activated you can only get 1. Tap Menu > Settings.
access to the instrument by logging in. 2. On the Settings screen, under System Security
select Login Settings.
3. Switch Auto login to “activated”.
4. Select one of the users as the auto login user.
TIP: Be aware that anybody who has access to the
instrument will be granted the same permissions as
the auto login user.
XPAIB006EN-I 23
10 System Security and User Management
IMPORTANT: If an administrator with permission 2. On the Settings screen, under System Security
for user management has locked the instrument, select Login Settings.
only this administrator can unlock it again. 3. Now you can set your rules for user names
(length) and passwords (length, allowed /
Unlocking instrument/screen restricted / mandatory characters). Factory
presets are given in table 9.
• On the lock screen, enter the password of the - Only when you specify that passwords are
user shown, then tap Unlock. required, password rules will be enforced.
• You can also change to another user: - Whitelists define characters that are avail-
a. On the lock screen, tap . able for use.
b. Enter a user name and the corresponding - You can specify that and when the password
password, then tap Login. expires. After the set period passwords have
to be changed.
TIP: As long as an operation runs on the instrument, - Password history specifies how often you
only the user who has started the operation can have to change a password until you can
unlock the instrument/screen. use a former password again.
- You can specify that failed authentications
will be tracked. In this case a user account
10.5 User And Role Management will be deactivated after a specified number
of consecutive attempts to enter a wrong
The instrument comes with three preset user password.
accounts with different permissions according to
their assigned roles: TIP: Take measures to prevent that you end up with
all accounts with user management permission
Table 8: Factory default user accounts being deactivated due to failed authentication
attempts.
User name Password Role
IMPORTANT: Be aware that all unsaved data and
administrator administrator Administrators settings on the instrument will be lost if all users
operator operator Operators have locked themselves out. There is no backdoor.
service service Services IMPORTANT: Since login settings are not applied
retroactively:
TIP: We recommend to change the default pass- • Rules for the user name only hold for user
words when you set up your user management. accounts added after rule definition. Already
existing user accounts will not be affected.
TIP: Be aware that the default administrator has not
• If new password rules conflict with existing pass-
been granted all permissions.
words, affected users will be prompted to set a
The default accounts can be arbitrarily edited, even new password when they log in the next time.
removed. They cannot log in with their existing password.
24 XPAIB006EN-I
10 System Security and User Management
• Under Common settings you specify the name TIP: User names are not case sensitive, whereas
of the role and activate or deactivate the role. passwords are.
• Under Permissions you set the permissions for • Under Role assignment you can assign roles to
the role: activate or deactivate the checkboxes the user account: activate the checkboxes
beside the list of functions to grant or withdraw beside the list of roles (or deactivate a checkbox
a permission. to withdraw the role).
TIP: You cannot withdraw your own permission A user can be assigned multiple roles.
“System: Login Settings/Roles/Users” (if you have TIP: Alternatively you can assign a role to users in
been granted it). This prevents locking yourself out. the role management (see section 10.5.2).
• Finally tap Save to save all settings.
XPAIB006EN-I 25
10 System Security and User Management
10.5.4 Changing Your Own Password Table 10: Events logged in audit trail
instrument • start
Every user can change his own password:
system • backup
1. Tap on the user identification in the header (see • restore
fig. 13). • update (incl. attempt)
A control panel slides in showing the available • reset to factory settings
operations (see fig. 14). system settings • change settings
(incl. time, language)
2. Tap CHANGE PASSWORD.
system connectivity • create
3. Enter the old password. (incl. network, printers) • edit
4. Enter the new password and repeat it to confirm. • remove
• change settings
5. Tap Change.
system security • activate/deactivate
• change login settings
10.5.5 Forgotten Passwords audit trail • activate/deactivate
• export
An administrator who has the permission for user • remove
management can reset a forgotten password:
electronic signature • activate/deactivate
1. Tap Menu > Settings. • change settings
• signing steps
2. On the Settings screen, under System Security
select Users. user/role management • create
• edit
3. In user management, tap on the account of the • remove
user whose password you want to reset. • change settings
4. Tap Change password in the action box. user authentication • login (incl. attempt)
• logout
5. Set the new password and specify whether it
• change password
has to be changed on the next login.
measurement settings • create
6. Tap Change. (incl. products, checks, • edit
TIP: If the user account has been deactivated due to custom quantities, • remove
failed authentication attempts, the account has to be hardware settings) • change settings
re-activated (see section 10.5.3). measurements • start
(incl. checks, adjustments) • stop (incl. abortion)
• failed/applied/rejected
10.6 Audit Trail measurement reports • print
(incl. checks, adjustments) • export
Activation of system security automatically activates • remove
the audit trail. To manually activate the audit trail:
• The audit trail can hold up to 5000 entries.
1. Tap Menu > Settings.
• The system will warn you when the maximum
2. On the Settings screen, under System Security number of audit trail entries has been reached.
select Audit Trail.
• After the maximum number of audit trail entries
3. Switch Audit Trail to “activated”.
has been reached you cannot start any kind of
After activation of the audit trail the following events measurement (product, check, adjustment) until
in the measuring system are logged in the audit trail: you have exported and removed the existing
audit trail entries.
26 XPAIB006EN-I
10 System Security and User Management
10.6.1 Viewing And Commenting Use any of the commonly available MD5 hash
generators to verify the data integrity of the exported
Audit Trail Entries audit trail file:
1. In the data explorer, select Audit Trail. 1. Generate the MD5 hash value of the audit trail
file with the MD5 hash generator.
2. Tap on any entry in the numbered list of audit
trail entries to view it. 2. Compare the generated MD5 hash value with
the MD5 hash value in the checksum file. They
Audit trail comments should be equal.
XPAIB006EN-I 27
10 System Security and User Management
2
Substitute signing
3
• If you set Substitute signing to activated, signers 4
with the appropriate permissions can sign for
their role and lower-level roles in one go. 6
5
E.g., an approver can sign for all the other roles,
even if none of them has yet signed the report. Fig. 16: Example signing screen
With substitute signing, a comment is always
1 User name of the signer
mandatory, irrespective of how the switch
2 When substitute signing is activated, the
Comment required has been set. user may select his role for signing.
3 Password of the signer if it has been set as
10.7.2 Signing Rules 4
required
Comment if it has been set as required or,
in this case, mandatory anyway, because
• Every user can only sign a report with one role substitute signing is activated
(except when substitute signing is activated). 5 You can temporarily change the user for
• The signing sequence has to follow the signing here.
sequence of roles according to their level (as 6 Tap the button to conclude signing.
described in section 10.7.1).
You can temporarily change to another user on
• Only the user who has performed a measure-
the signing screen:
ment or check can sign as submitter.
a. On the signing screen, tap .
(When substitute signing is activated, signing
b. Enter a user name and the corresponding
with a higher-level role may include signing as
password, then tap Login.
submitter.)
The new signing screen reflects the role of
• Electronic signatures cannot be revoked. the user who is only temporarily logged in for
signing. The original user stays logged in.
4. Tap Sign.
28 XPAIB006EN-I
11 LIMS Services via RS-232 Serial Interface
XPAIB006EN-I 29
11 LIMS Services via RS-232 Serial Interface
Responses sent to the client after processing the command have the following form:
Examples:
GetInstrumentInfo
Resp GetInstrumentInfo: 0 (Ok) Data: Type="DMA 501"; Serial="12345687";
GetQuantityUnits: quantityID="M0009";
Resp GetQuantityUnits: 0 (Ok) Data: "[°C]";"[°F]";"[K]";
30 XPAIB006EN-I
11 LIMS Services via RS-232 Serial Interface
Code Description
0 OK
• Everything is in order / the command has been successfully processed / the instrument is idle.
–1 Too many commands are running
• Wait for a command to be processed and finished, before you send a new one.
–2 Parsing the command line failed
• Check the syntax of your command line.
–3 Unknown command
• See section 11.4 for an overview of the available commands.
–4 Invalid number of arguments
• The number of arguments specified for the command does not meet requirements.
See section 11.4 for the correct command syntax.
–5 Invalid argument
• Verify that the argument name and value are supported and valid.
–6 System not ready
• The command cannot be processed, because another operation is already running on the
instrument.
–7 Processing command failed
–8 Operation canceled
• The command has been canceled (by the Cancel command or by a user controlling the
instrument).
–9 No data
• No data found or available.
XPAIB006EN-I 31
11 LIMS Services via RS-232 Serial Interface
Example:
StartProductMeasurement: ProductId="f2210d84bf3f4523a71e847398f3b7fd";
SampleName="My Demo Sample";
GetMeasurementStatus
Resp GetMeasurementStatus: -6 (SystemNotReady)
Cancel
Resp Cancel: 0 (Ok)
GetMeasurementStatus
Resp GetMeasurementStatus: 0 (Ok)
GetHelp
Use the command to request a list of available
commands or to get information on a specific
command and its syntax.
Example:
GetHelp
Resp GetHelp: 0 (Ok) Data: *RS232 LIMS Services Commands:
** Cancel *Cancel running operation
** GetHelp *Get list of available commands or the description of a single
command
** GetInstrumentInfo *Get information about the instrument
** GetMeasurementData *Get measurement data
** GetMeasurementStatus *Get a value indicating whether a product
measurement is running
** GetProductName *Get name of specified product
** GetProducts *Get list of all available products
** GetProtocolVersion *Get the protocol version of the RS232 LIMS services
** GetQuantities *Get list of available quantities
** GetQuantityName *Get name of specified quantity
** GetQuantityUnits *Get available units of specified quantity
** GetReferenceDate *Get reference date used for GetData command.
** SetReferenceDate *Set reference date used for GetData command.
** SetTemperature *Set the cell temperature
** StartProductMeasurement *Start a measurement for a specified product.
32 XPAIB006EN-I
11 LIMS Services via RS-232 Serial Interface
GetHelp: GetProtocolVersion
Resp GetHelp: 0 (Ok) Data: GetProtocolVersion:
*Get the protocol version of the RS232 LIMS services
Usage: GetProtocolVersion
GetInstrumentInfo
Use the command to request the instrument’s type
and serial number.
Example:
GetInstrumentInfo
Resp GetInstrumentInfo: 0 (Ok) Data: Type="DMA 501"; Serial="12345687";
GetMeasurementData
Use the command to retrieve measurement results
from the data saved on the instrument. The output
depends on selected quantities and units, the
current reference date, and on the availability of
measurement data.
Example:
GetMeasurementData
Resp GetMeasurementData: 0 (Ok) Data: "11720";
"2018-01-07T12:49:08.9657960+01:00";"Île-de-France";"Croix";"0";"25.60";
"1.2346";
GetMeasurementData
Resp GetMeasurementData: 0 (Ok) Data: "11721";
"2018-01-07T12:49:27.8313800+01:00";"Montélimar";"Lanester";"0";"20.00";
"23.1200";
The simplest way to retrieve data is by using after switching on the instrument) – unless you
GetMeasurementData without arguments. have set the reference date differently with
SetReferenceDate.
In doing so repeatedly until error code –9 (no data)
is returned, you can retrieve one by one all data sets • If GetMeasurementData finds and delivers
that are newer than the initial reference date. measurement data, the reference date will
subsequently be set to the date and time of the
The concept of the reference date is basic for found measurement.
understanding how the command works:
This enables you to sequentially retrieve mea-
• You can set the reference date with the surement data.
command SetReferenceDate and request it
with the command GetReferenceDate. GetMeasurementData always delivers the oldest
set of measurement data that is newer than the
• The default reference date is the date and time refence date.
when the instrument has been turned on.
The data values are in accordance with the currently
Therefore, GetMeasurementData will only
selected quantities and units.
deliver measurement data of the day (or none if
you have not yet performed a measurement
XPAIB006EN-I 33
11 LIMS Services via RS-232 Serial Interface
Example:
GetMeasurementData:"P0001";"P0002";"M0005 [°F]";"M0017 [kg/m³]";
Resp GetMeasurementData: 0 (Ok) Data: "11720";
"2018-01-07T12:49:08.9657960+01:00";"78.08";"1234.6";
GetMeasurementData
Resp GetMeasurementData: 0 (Ok) Data: "11721";
"2018-01-07T12:49:27.8313800+01:00";"68.00";"23120.0";
SetReferenceDate: Date="2018-01-07T12:49:27+01:00";
Resp SetReferenceDate: 0 (Ok)
GetMeasurementData:"P0001";"P0002";"M0019";"M0034";"M0024";
Resp GetMeasurementData: 0 (Ok) Data: "11721";
"2018-01-07T12:49:27.8313800+01:00";"2.1000";"3.4000";"5.6000";
To retrieve specific quantities or units of a measure- • You can request a list of all available quantity
ment, specify a selection of quantity identifiers, identifiers with the command GetQuantities.
optionally followed by unit identifiers, with the • You can request a list of all available unit identi-
command GetMeasurementData. fiers for a specific quantity with the command
IMPORTANT: You can select up to 15 quantities GetQuantityUnits.
with one request. RS-232 LIMS services will remember your selection
TIP: Use SetReferenceDate followed by of quantities and units and will apply it (until you
GetMeasurementData with different quantity reset it) when you subsequently use the command
selections to retrieve additional quantities for the GetMeasurementData without arguments.
same measurement.
Example:
GetMeasurementData: ResetSelection
Resp GetMeasurementData: 0 (Ok)
GetMeasurementData: Header
Resp GetMeasurementData: 0 (Ok) Data: "P0001";"P0002";"P0003";"P0004";
"P0005";"M0005";"M0017";
GetMeasurementData: HeaderNames
Resp GetMeasurementData: 0 (Ok) Data: "Measurement Number";"Date of
Measurement";"Sample Name";"Product Name";"Status";"T (cell)";"Density";
GetMeasurementData: Units
Resp GetMeasurementData: 0 (Ok) Data: "[–]";"[–]";"[–]";"[–]";"[–]";"[°C]";
"[g/cm³]";
The command GetMeasurementData accepts
also options as arguments.
Do not combine options with the selection of quanti-
ties or units.
34 XPAIB006EN-I
11 LIMS Services via RS-232 Serial Interface
GetProductName
Use the command to request the name of the
product corresponding to a specific identifier.
Example:
GetProductName: ProductId="f2210d84bf3f4523a71e847398f3b7fd";
Resp GetProductName: 0 (Ok) Data: Name="Generic Liquids & Gases";
You may also use “all” as the argument to retrieve a
list of all available products (similar to the command
GetProducts), which includes names.
• An empty line marks the end of the list.
Example:
GetProductName: all
Resp GetProductName: 0 (Ok) Data:
"f2210d84bf3f4523a71e847398f3b7fd"="Generic Liquids & Gases";
"ac815f86a3474acc81f75b00372ecbf1"="Lubricants";
"1feb0d0eab9c4e51860926655ec3f8f6"="Acids and Bases";
"73b331c21c3a4807a715ee2c5e4e3a2f"="Cosmetics (homogeneous)";
"1bfb1f42ed80423294aa07618d8a34c3"="Cosmetics (inhomogeneous)";
"b1bf926ec76d48c69dc39c4b47c0f62c"="Crude Oil";
"721cb88aedb242e7bfc5a2ad11d992b3"="Fuel Oil";
"fc997314de304a3991d01c0ff0d09682"="Pharmaceuticals";
GetProducts
Use the command to request the unique identifiers
for all available products.
Use these identifiers for other commands like
GetProductName or
StartProductMeasurement.
Example:
GetProducts
Resp GetProducts: 0 (Ok) Data: "f2210d84bf3f4523a71e847398f3b7fd";
"ac815f86a3474acc81f75b00372ecbf1";"1feb0d0eab9c4e51860926655ec3f8f6";
"73b331c21c3a4807a715ee2c5e4e3a2f";"1bfb1f42ed80423294aa07618d8a34c3";
"b1bf926ec76d48c69dc39c4b47c0f62c";"721cb88aedb242e7bfc5a2ad11d992b3";
"fc997314de304a3991d01c0ff0d09682";
GetProtocolVersion
Use the command to request the version of the
communication protocol.
Example:
GetProtocolVersion
Resp GetProtocolVersion: 0 (Ok) Data: Version="1.0.0";
XPAIB006EN-I 35
11 LIMS Services via RS-232 Serial Interface
GetQuantities
Use the command to request the unique identifiers
for all available quantities.
Use these identifiers for other commands like
GetQuantityName or GetQuantityUnits.
Example:
GetQuantities
Resp GetQuantities: 0 (Ok) Data: "P0001";"P0002";"P0003";"P0005";"P0004";
"M0001";"M0002";"M0003";"M0004";"M0005";"M0006";"M0007";"M0008";"M0009";
"M0010";"M0011";"M0012";"M0013";"M0014";"M0015";"M0016";"M0017";"M0018";
"M0019";"M0020";"M0021";"M0022";"M0023";"M0024";"M0025";"M0026";"M0027";
"M0028";"M0029";"M0030";"M0031";"M0032";"M0033";"M0034";"M0035";"M0036";
"M0037";"M0038";"M0039";"M0040";"M0041";"M0042";"M0043";"M0044";"M0045";
"M0046";"M0047";"M0048";"M0049";"M0050";"M0051";"M0052";"M0053";"M0054";
"M0055";"M0056";"M0057";"M0058";"M0059";"M0060";"M0061";"M0062";"M0063";
"M0064";"M0065";"M0066";"M0067";"M0068";"M0069";"M0070";"M0071";"M0072";
"M0073";"M0074";"M0075";"M0076";"M0077";"M0078";"M0079";"M0080";"M0081";
"M0082";"M0083";"M0084";"M0085";"M0086";"M0087";"M0088";"M0089";"M0090";
"M0091";"M0092";"M0093";"M0094";"M0095";"M0096";"M0097";"M0098";"M0099";
"M0100";"M0101";"M0102";"M0103";"M0104";"M0105";"M0106";
GetQuantityName
Use the command to request the name of the
quantity corresponding to a specific identifier.
Example:
GetQuantityName: QuantityId="P0003";
Resp GetQuantityName: 0 (Ok) Data: Name="Sample Name";
You may also use “all” as the argument to retrieve a
list of all available quantities (similar to the command
GetQuantities), which includes names.
• An empty line marks the end of the list.
Example:
GetQuantityName: all
Resp GetQuantityName: 0 (Ok) Data:
"P0001"="Measurement Number";
"P0002"="Date of Measurement";
"P0003"="Sample Name";
"P0005"="Status";
"P0004"="Product Name";
"M0001"="T (Board)";
"M0002"="Hum. (Board)";
"M0003"="p (Board)";
36 XPAIB006EN-I
11 LIMS Services via RS-232 Serial Interface
GetQuantityUnits
Use the command to request the units available for
the quantity corresponding to a specific identifier.
Example:
GetQuantityUnits: QuantityID="M0009";
Resp GetQuantityUnits: 0 (Ok) Data: "[°C]";"[°F]";"[K]";
GetQuantityUnits: QuantityID="P0003";
Resp GetQuantityUnits: 0 (Ok) Data: "[-]";
GetReferenceDate
Use the command to request the current reference
date.
• See the description of the command
GetMeasurementData for an explanation of
the concept and function of the reference date.
Example:
GetReferenceDate
Resp GetReferenceDate: 0 (Ok) Data: Date="2018-01-07T12:49:27.8313800+01:00";
a. The reference date is delivered in ISO 8601 date/time format including time zone information.
SetReferenceDate
Use the command to set the reference date.
• See the description of the command
GetMeasurementData for an explanation of
the concept and function of the reference date.
Example:
SetReferenceDate: Date="2017-02-23T17:58:12.6035379+01:00";
Resp SetReferenceDate: 0 (Ok)
SetReferenceDate: now
Resp SetReferenceDate: 0 (Ok)
GetReferenceDate
Resp GetReferenceDate: 0 (Ok) Data: Date="2018-03-06T07:59:58.8137648+01:00";
a. The reference date has to be specified in ISO 8601 date/time format including time zone information.
b. You may also use “now” as the argument to set the reference date to the current date and time.
XPAIB006EN-I 37
11 LIMS Services via RS-232 Serial Interface
SetTemperature
Use the command to set the temperature of the
measuring cell.
Example:
SetTemperature: Temperature="30.0"
Resp SetTemperature: 0 (Ok)
a. If no unit is specified with the temperature value, the default unit [°C] is used.
b. You may specify one of the available units with the temperature value: [°C], [°F], [K].
StartProductMeasurement
Use the command to start and perform a measure-
ment for a product (specified by identifier).
Specify a sample name as the second argument.
IMPORTANT: Take care that you do not start a
measurement while another process is running on
the instrument (e.g. cleaning, adjusting, measuring).
Example:
StartProductMeasurement: ProductId="f2210d84bf3f4523a71e847398f3b7fd";
SampleName="My Demo Sample";
Resp StartProductMeasurement: 0 (Ok)
StartProductMeasurement: ProductId="f2210d84bf3f4523a71e847398f3b7fd";
SampleName="My Demo Sample";Temperature="68 [°F]";
Resp StartProductMeasurement: 0 (Ok)
a. The error code returned by RS-232 LIMS services indicates the status of the measurement after it
has finished:
Error code Measurement status when finished
0 The measurement has finished successfully or with warnings.
–7 The measurement has failed or has finished with errors.
–8 The measurement has been canceled by the command Cancel or by a user on
the instrument.
b. You may optionally set a temperature for the measurement, overriding the temperature defined in the
product settings.
- If no unit is specified with the temperature value, the default unit [°C] is used.
- You may specify one of the available units with the temperature value: [°C], [°F], [K].
38 XPAIB006EN-I
12 Backup / Restore Functions
XPAIB006EN-I 39
13 Software Maintenance
13 Software Maintenance
13.1 System Information 13.3 System Update
All detailed technical information, version numbers, TIP: Your local Anton Paar representative will
and serial numbers concerning your measuring inform you when a software update for your
system (including installed options), are listed in the measuring system is available.
system information:
TIP: You can download the latest instruction manual
1. Tap Menu > System Information. for your instrument from the respective product page
2. Scroll through the listed information: software, on www.anton-paar.com.
components, boards, modules, etc. TIP: Before you start the system update, make a
backup of the system, see section 12.
13.2 Diagnostics Package 1. Save the software update package in the root
directory of a USB memory device.
In case of problems you can greatly help The software update package is a file with a file
Anton Paar’s support team by providing a name extension “.aup”. Its file name usually
diagnostics package when asked for it. includes a version number that should be higher
than that of the software installed on your instru-
Here’s how to generate a diagnostics package:
ment.
1. Tap Menu > System Information. 2. Connect the USB memory device to one of the
2. Tap Save Diagnostics Package in the action USB sockets of your instrument.
box.
3. Select a storage location: a connected USB NOTICE
memory device or a registered network share. A failed system update may render your
instrument unusable.
4. Best leave the File Name as is.
Do not disconnect the USB memory device
5. Tap Save. during the update process.
40 XPAIB006EN-I
Appendix A: Software Versions
Software Date of
Remarks
version release
1.0.0 26.01.2018 First software version released
1.8.0 22.05.2018 New features: custom quantities, backup/restore, RS-232 LIMS services
1.8.1 27.07.2018 Improvements in the printout for Epson TM-U330D
3.0.0 19.02.2019 New features:
• system security incl. user/role management, audit trail, electronic
signature
• check execution reminder
• auto air check
• automatic data export
• density monitoring
3.1.0 08.07.2019 New features: support for the user interface languages Czech | French |
Italian | Japanese | Korean | Polish | Portuguese | Russian | Spanish
3.3.0 12.02.2020 New feature: precision indicator on density widget
“T(cell)” is now “T(block)”
XPAIB006EN-I 41