SUIT X-Class Installation & User Guide
Author: Olivier Kaulmann
Date: 22 – 06 – 2011
Version: 1.0
Document Information
Document type SUIT X-Class installation and user guide
Status Released
File Name SUIT_X-Class_Installation&User_Guide_v1.0.doc
Version History
Version Date Author Comments
1.0 22 – 06 - 2011 Olivier Kaulmann Release version for SUITv2.5
Information in this document is strictly confidential. It is intended for Sysmex employees. No part of this
document may be reproduced or transmitted to a third party, in any form or by any means, electronic or
mechanical, for any purpose, without the express written permission of Sysmex.
SUIT X-Class Installation & User Guide
Index
1 GENERAL....................................................................................................... 3
2 INSTALLATION OF SUIT X-CLASS V2.5 .......................................................... 4
2.1 BACKUP THE CURRENT SUIT FOLDER ............................................................................... 4
2.2 NEW SUIT X-CLASS V2.5 INSTALLATION ......................................................................... 4
2.3 SUIT V1.0.4.0, V1.0.11.0, V2.3.5.0, V2.4.0.0 VERSION UPGRADE TO V2.5.2.0 ................... 8
2.3.1 SUIT upgrade and version policy........................................................................... 8
2.3.2 SUIT X-CLASS v1.0 & v2.3 version upgrade ........................................................ 9
2.3.3 SUIT v2.4.0.0 upgrade procedure ....................................................................... 10
2.4 CONFIGURATION OF THE SUIT MANAGER ........................................................................ 15
2.4.1 Case: “other X-Class Analyzer » type.................................................................. 15
2.4.1.1 Connection to IPU ................................................................................................ 15
2.4.1.2 Connection to Host .............................................................................................. 16
2.4.1.3 Adjustment of the decimal point ........................................................................... 18
2.4.1.4 LIS mapping table ................................................................................................ 19
2.4.2 Case: “XE-5000 with SUIT ASTM to LIS” as analyzer type................................. 20
2.4.2.1 Connection to IPU ................................................................................................ 20
2.4.2.2 Connection to Host .............................................................................................. 20
2.4.2.3 Adjustment settings & LIS Tests .......................................................................... 20
2.4.3 Case: “XE-5000 with DPS to SIS” as analyzer type ............................................ 21
2.4.3.1 Connection to IPU ................................................................................................ 21
2.4.3.2 Connection to Hosts............................................................................................. 21
2.4.3.3 Adjustment settings & LIS Tests settings ............................................................ 21
2.5 PROFILE MANAGEMENT ................................................................................................... 22
3 SOFTWARE VERSION COMPATIBILITY MATRIX .................................................. 23
4 COMMUNICATION-SERVER ............................................................................ 24
5 TROUBLESHOOTING ...................................................................................... 28
Page 2 of 29 v1.0
SUIT X-Class Installation & User Guide
1 General
SUIT enables the smooth standard LIS connection for all current and future Sysmex
IPU based analysers. Changes at the LIS should be no longer required, except the
mapping of new parameters by the customer if necessary.
SUITv2.4 was intended for all IPU based analyzer i.e. for the haematology & Urine IPU
based analyzer.
In order to facilitate the SUIT installation we established two SUIT installation types
depending on the analyzer type:
- SUIT X-Class v2.5: This SUIT type is intended for all X-Class analyzer like XE5000,
XE2100, XE2100D, XT2000i, XT1800i, XT4000i, XS800i, XS1000i.
- SUIT UF v2.5: This SUIT type is intended only for the UF-500i & UF-1000i.
This document describes how to install and configure SUIT X-Class v2.5.2.0
The SUIT X-CLASS v2.5.2.0 will be installed from now on at all new “hematology” IPUs:
The SUIT X-CLASS v2.5.2.0 software can be downloaded or ordered from the SYSMEX
Europe non public web pages (NPPs): http://npp.sysmex-europe.com from the
subsection [Integrated Concept Solutions | Software ordering | SUIT X-CLASS ]
Please access the NPPs with your personal password.
Please refer the details of the SUIT X-CLASS v2.5 Product enhancement at the
SUIT X-CLASS release <SUIT X-CLASS v2.5.2.0_ReleaseNotes.DOC>.
This document can be downloaded from the NPPs from the subsection [Integrated
Concept Solutions | Support | download].
Page 3 of 29 v1.0
SUIT X-Class Installation & User Guide
2 Installation of SUIT X-CLASS v2.5
2.1 BackUp the current SUIT folder
Before you upgrade or un-install SUIT please perform a BackUP (copy) of the “SUIT”
folder located in C:\Program Files\Sysmex\ or “SUIT” folder located in C:\Sysmex\
2.2 New SUIT X-CLASS v2.5 Installation
Note: If you want to perform a new SUIT X-CLASS v2.5 installation on an IPU where an
older SUIT version was installed but you do not want to take over the configuration
settings from the older SUIT X-CLASS version, please proceed as follow:
o In case the IPU SW is running, please close the IPU application.
o In case the SUIT communication server it is running (started) , please shutdown it:
Right mouse click on the communication server icon which is located at the
windows taskbar and click “shutdown”
o Un-install the SUIT version through [Start Control Panel “Add or Remove
Programs”]
Remark: you are required to delete manually the complete folder “SUITonIPU” located
in C:\Program Files\Sysmex\ in case a SUIT v1.0.11.0 or SUIT v1.0.4.0 was installed.
Once this is performed you can install the SUIT X-CLASS v2.5.2.0 by double clicking the
SUIT_X-CLASS_v2.5.2.0_setup.exe file. . You require having
Administrator rights to be able to install SUIT X-CLASS. The following screen will appear:
Press “next” button to proceed the installation
Page 4 of 29 v1.0
SUIT X-Class Installation & User Guide
SUIT X-CLASS v2.5 offers 3 analyzer types. Please select the appropriate one and
press the “Next” button to proceed the installation.
See below some additional explanation to each SUIT X-CLASS analyzer type:
1. XE-5000 with SUIT ASTM to LIS
Select this analyzer type at SUIT X-CLASS if the XE-5000 will be directly connected to
the LIS. For this analyzer type SUIT X-CLASS requires the analyzer communication
format ASTM E1381-95/E1394-97. This format is available from the analyzer’s IPU
menu [Host setting | TCP/IP | format: select the ASTM E1381-95/E1394-97]. In case of
questions please ask you service representative.
2. XE-5000 with DPS to SIS:
Select this analyzer type at SUIT X-CLASS if the XE-5000 analyzer will be
connected to SIS.
For this analyzer type SUIT X-CLASS requires the analyzer communication host format
files DPS. The analyzer IPU configuration details are described at the “version upgrade
procedure” which is available from the NPPs from the subsection [Technical Information
Center | ECR / TB Database ECR308A074]. In case of questions please ask you
service representative.
3. Other X-Classes
Select this analyzer type at SUIT X-CLASS if the other X-series analyzer will be
connected to the LIS. In this case you must select the same analyzer ASTM
communication format as defined for analyzer type1 (ASTM E1381-95/E1394-97)
Page 5 of 29 v1.0
SUIT X-Class Installation & User Guide
Press the “Next” button to proceed the installation
Press the “Install” button to proceed the installation
Page 6 of 29 v1.0
SUIT X-Class Installation & User Guide
The installation is in progress, please wait a few moments
Press the button “Finish” to confirm the SUIT X-CLASS installation
Page 7 of 29 v1.0
SUIT X-Class Installation & User Guide
2.3 SUIT v1.0.4.0, v1.0.11.0, v2.3.5.0, v2.4.0.0 version upgrade to v2.5.2.0
2.3.1 SUIT upgrade and version policy
The SUIT upgrade and version policy is determined as follow:
With every new SUIT release older Versions of the SUIT Software might run out of
support. We determine three levels of a Version.
• Released: Means newest Software Version
• Phase-out: Means supported.
• End of life: Discontinued and no longer supported.
SUIT provides a wizard to facilitate the migration (version upgrade).
However, the wizard cannot support all version jumps and will only support declassified
software versions. End of life versions are not supported by the wizard. We strictly
recommend to perform a backup of the settings before you perform a version update.
A new SUIT configuration might be required in worst case if the IPU runs an end of life
version of the SUIT Software.
The table below details which version can be updated or not by the SUIT X-CLASS
wizard
SUIT Phases
Remark
version
Release Phase-out End of life
1.0.4.0 July 09
1.0.11.0 July 09
2.3 September 09
2.4 March 2009 Yes June 2012
SUIT X-class Only intended for hematology
June 2011 No
v2.5.0.2 IPU based analyzer
Page 8 of 29 v1.0
SUIT X-Class Installation & User Guide
2.3.2 SUIT X-CLASS v1.0 & v2.3 version upgrade
The SUIT v1.0 and v2.3 are end of life versions i.e. these versions are declassified.
These versions are not anymore supported. Please refer chapter 2.3.1. SUIT X-CLASS
upgrade and version policy
In case you want to upgrade these versions to SUIT X-CLASS v2.5.2.0 you have to proceed
as follow:
First backup the entire folder “SUIT” or “SUITonIPU” folder
Write down manually all configuration settings you made at the SUIT manager:
o SUIT’s IPU settings
o SUIT’s Host settings
o SUIT’s Result adjustment
1
o SUIT’s LIS Tests mapping
o For the SUIT installations which are configured with using single order (refer
details chapter 2.5) the customization have to be written down. After having
installed the new SUIT version, these configurations have to be key in.
De-install SUIT via the windows module: control panel “un-install/remove program”.
Delete the “SUIT” or “SUITonIPU” folder if it should still exist
Install SUIT X-CLASS v2.5.2.0 by following the description detailed at chapter 2.2
1
In SUIT v1.0 the LIS Tests mapping table was not available. If specific names were configured
at v1.0.4.0, there were made manually at the “SISProt.ini” file. The “SISProt.ini” file is located in
C:\Program Files\Sysmex\Cnf. Please write down the customized LIS tests names and key in
manually in SUITv2.5.2.0 Manager “LIS tests names”
Page 9 of 29 v1.0
SUIT X-Class Installation & User Guide
2.3.3 SUIT v2.4.0.0 upgrade procedure
Please find below how proceed for a SUIT v2.4.0.0 upgrade:
First perform a backup of the SUIT folder
In case the IPU SW is running, please close the IPU application
In case the SUIT communication server it is running (started) , please shutdown it:
Right mouse click on the communication server icon which is located at the
windows taskbar and click “shutdown”
Double click the SUIT X-CLASS v2.5.2.0_setup.exe file.
You must have Administrator rights to be able to install SUIT X-CLASS
The following screen will appear:
Please wait a few moments
Page 10 of 29 v1.0
SUIT X-Class Installation & User Guide
Case1: cancelling the SUIT X-CLASS upgrade
In case you want to cancel the SUIT X-CLASS upgrade, press the button “No”.
Following screen below appears:
Press the button “OK” to continue
Press the button “Finish” to confirm the interruption of the SUIT X-CLASS upgrade
Page 11 of 29 v1.0
SUIT X-Class Installation & User Guide
Case2: Proceed the SUIT X-CLASS version upgrade
In case you want to proceed the SUIT X-CLASS version upgrade press the button
“Yes”.
Press the button “Next” to proceed the installation
Page 12 of 29 v1.0
SUIT X-Class Installation & User Guide
Press the button “Next” to proceed the installation
Press the button “Next” to proceed the installation
Page 13 of 29 v1.0
SUIT X-Class Installation & User Guide
Please wait a few moments and press the button “Next” to proceed the installation
Press the button “Finish” to confirm the installation
Page 14 of 29 v1.0
SUIT X-Class Installation & User Guide
2.4 Configuration of the SUIT manager
The SUIT configuration is managed by the SUIT manager.
Please start the SUIT Manager by using the [Start-menu of windows | Programs | SUIT |
SUIT manager]
2.4.1 Case: “other X-Class Analyzer » type
The example below describes the configuration options which are available for the SUIT
X-CLASS analyzer type “Other X-Class Analyzer”.
2.4.1.1 Connection to IPU
The default settings defined for “IPU” can be used like they are. This online is always
working with TCP/IP in a “Server” Mode. Set your IPU to connect to host by using a
TCP/IP Connection with the port No: 5000.
If there is any reason to change the port, you have to change this at IPU and at SUIT X-
CLASS site
Page 15 of 29 v1.0
SUIT X-Class Installation & User Guide
2.4.1.2 Connection to Host
For a connection to Host you can choose between a serial or TCP/IP connection.
Case of serial connection to the host:
Configure the required serial parameters. These settings have to match with the ones of
the LIS
Case of a TCP/IP connection to the host:
Following configuration settings are available:
- Use SUIT ASTM Master or Slave:
From SUIT X-CLASS v2.4.0.0 a configuration allows how SUIT should react in case of
an ASTM ENQ collision. When both sides send an [ENQ] (called [ENQ] clash) the Slave
Computer side has priority over the Host Computer. The Slave Computer re-sends
[ENQ] 1 second later. The Host Computer must wait for 20 seconds to re-send
- Work mode: Client or Server mode
“Client” work mode: in case SUIT is configured to operate as “client” LIS has to operate
as “server”. LIS has to open a socket at the respective port and has to listen for
incoming connection-requests of SUIT.
“Server” work mode: in case SUIT is configured to operate as “server” LIS has to
operate as “client”. SUIT has to open a socket at the respective port and has to listen for
incoming connection-requests of LIS.
Page 16 of 29 v1.0
SUIT X-Class Installation & User Guide
- “Server Address” and “TCP Port”: definition of the server address & TCP port
Our recommendation is to set always a “Server Address”, even if “SUIT” is operating in
the “Server Mode”. This makes troubleshooting easier. For entering an address you
have to select the “Client Mode”. After finishing this step you can switch back to the
“Server Mode”.
Page 17 of 29 v1.0
SUIT X-Class Installation & User Guide
2.4.1.3 Adjustment of the decimal point
Unfortunately the IPU is sending all the results in a fixed unit even if you changed the
units to the customer demands. That means the result on the screen and at the online
can differ. To change this behaviour in order to have the same like SIS, you can
configure the possibility to set the decimal-point and the number of digits after the
decimal-point at the “Adjustment” option
Set the required multiplication-factor (e.g. 0.1 or 10) at the “Factor” Column.
Set the required number of digits after the decimal-point at the “Decimal” Column.
Page 18 of 29 v1.0
SUIT X-Class Installation & User Guide
2.4.1.4 LIS mapping table
This menu allows you to customize the default test names.
We recommend to use the default SYSMEX test codes.
If the LIS cannot manage some of the default test code (technical reason…) you can
customized the codes in this menu
Page 19 of 29 v1.0
SUIT X-Class Installation & User Guide
2.4.2 Case: “XE-5000 with SUIT ASTM to LIS” as analyzer type
The example below describes the configuration options which are available for the SUIT
X-CLASS analyzer type “XE-5000 with SUIT ASTM to LIS”.
2.4.2.1 Connection to IPU
The default settings defined for “IPU” can be used like they are. This online is always
working with TCP/IP in a “Server” Mode. Set your IPU to connect to host by using a
TCP/IP Connection with the port No: 5000.
If there is any reason to change the port, you have to change this at IPU as well at SUIT X-CLASS.
For this analyzer types following additional configuration settings are available:
- CM output folder: There you define the folder where the messages for the CM are
stored. CM required this information. You can brows by clicking the button
- Disable CM (Case Manager) extension: In case you have a XE-5000 and no CM
installed, you can disable sending the messages to the CM. Note: if you disable CM
extension and you have a CM installed, then the CM will never show cases.
2.4.2.2 Connection to Host
Please refer the chapter 2.4.1.2
2.4.2.3 Adjustment settings & LIS Tests
Please refer the chapter 2.4.1.3 & 2.4.1.4
Page 20 of 29 v1.0
SUIT X-Class Installation & User Guide
2.4.3 Case: “XE-5000 with DPS to SIS” as analyzer type
The example below describes the configuration options which are available for the SUIT X-
CLASS analyzer type “XE-5000 with DPS to SIS”.
2.4.3.1 Connection to IPU
The default settings defined for “IPU” can be used like they are. This online is always
working with TCP/IP in a “Server” Mode. Set your IPU to connect to host by using a
TCP/IP Connection with the port No: 5000.
If there is any reason to change the port, you have to change this at IPU as well at SUIT.
For this analyzer types following additional configuration settings are available:
- CM output folder: There you define the folder where the messages for the CM are
stored. CM required this information. You can brows by clicking the button
- Disable CM (Case Manager) extension: If you have a XE-5000 and no CM installed,
then you can disable sending the messages to CM. But keep in mind, if you disable
CM extension and you have a CM installed, then the CM will never show cases.
2.4.3.2 Connection to Hosts
Please refer the details chapter 2.4.2.2
2.4.3.3 Adjustment settings & LIS Tests settings
Please refer the chapter 2.4.1.3 & 2.4.1.4
Page 21 of 29 v1.0
SUIT X-Class Installation & User Guide
2.5 Profile management
More and more countries are ordering single parameter. The reason of that single order
parameter ordering is due to the “health insurance law” i.e. the laboratory will only get
paid for that parameter.
If the analyzers receive a single parameter order e.g. WBC, only the result of the
ordered parameter will be displayed at the IPU and reported to the LIS even the
analyzer performed a CBC measurement.
However theses customers want to see all parameters that the analyzer performed at
the IPU and not only the single ordered parameter.
SUIT v2.4.0.0 onwards offers a functionality “profile management” to extend the single
parameter to a profile.
With this functionality we would have following workflow:
LIS order e.g. a single parameter WBC
SUIT convert WBC into a profile CBC
The analyzer measure a CBC and report CBC
The customer can now verified all CBC results on the IPU display or on the IPU print
outs. In case of abnormality the customer can take the appropriate action like to
create at the LIS site the appropriate additional order...
This configuration setting is only available via an “ini” file setting change.
This “ini” file is located at the folder C:\Sysmex\SUIT\Cnf\ analyzer.ini.
In case you required modifying it, please first perform a copy (backup) of the original one.
To activate it, edit the .ini file corresponding to the IPU-specific protocol (one of the files
XE2100.ini or XE5000WithCM.ini)
Search the section [Send_Orders] and edit the functions named ORDERPROFILE for
the wanted profiles: change the INACTIVE flag into ACTIVE
…
[Send_Orders]
1=XEASTMFORMATCOMMENTS
2=XEASTMFIXOUTPATIENT
3=RESTORESPECINFO
4=ORDERPROFILE;INACTIVE;WBC;RBC;HGB;HCT;MCH;MCHC;MCV;PLT;P-
LCR;PCT;MPV;PDW;RDW-CV;RDW-SD
5=ORDERPROFILE;INACTIVE;NEUT#;NEUT%;LYMPH#;LYMPH%;MONO#;MONO%;EO#;EO%;
BASO#;BASO%;IG#;IG%
6=ORDERPROFILE;INACTIVE;RET#;RET%;IPF;HFR;LFR;MFR;RET-HE;IPF
7=ORDERPROFILE;INACTIVE;NRBC#;NRBC%
Page 22 of 29 v1.0
SUIT X-Class Installation & User Guide
3 Software version compatibility matrix
There is a dependency of several Software products and their respective version. For
instance the IPU is always installed together with SUIT X-CLASS and in the case of the
XE-5000 even together with the Case Manager. Therefore it is important to consider the
dependencies and the incompatibility of several software versions. The following
compatibility matrix shows all these dependencies.
Please refer the latest software compatibility matrix document at the NPPs
(1)
The SUIT v2.4 is in phase out.
(2)
The CM v3.0 is only compatible from SUIT X-CLASS v2.5.2.0 on. Please refer the details at the
CM v3.0 release notes.
(3)
In order to activate the “sample skipping functionality at IPU” some configuration settings have to
be done at the analyzer “ini” files. Please refer the details at IPU service manual.
Please read carefully the SUIT X-CLASS v2.5 release notes. The new versions are
mostly foreseen with important product enhancements.
Page 23 of 29 v1.0
SUIT X-Class Installation & User Guide
4 Communication-Server
The communication-server is started by the auto start-up functionality of Windows. It’s
represented by a cogwheel in the taskbar.
With a right-click at this icon you are able to shutdown the communication-server. But in
the daily work there’s no need to do this, the application will be closed by the regular
shutdown of Windows.
There’s a front-end for the communication-server, open this front-end by doing a
double-click on the cogwheel. Alternatively do a right-click and choose “Open”.
Several buttons are available. Two online and their status are displayed.
With these two buttons you can start and stop an online
Page 24 of 29 v1.0
SUIT X-Class Installation & User Guide
The “Reload”-Button will perform a reload of the configuration of “SUIT X-
CLASS on IPU” during runtime. Modified settings are taken over, but there
are not active, yet.
“SUIT X-CLASS on IPU” will mention if there was a change and is changing the status of the
affected online to “Reconfigured”.
Just click on this icon to take over the new configuration.
If the modifications of the settings are
requiring a restart of the online, “SUIT X-
CLASS on IPU” will ask for a confirmation to
do this. If there’s no need to restart the
online “SUIT X-CLASS on IPU” will activate
the modification directly.
Just refreshing the screen
This button will open a window with an error-list regarding the online.
If a new error is appearing, this window will pop up automatically. If the
problems are solved, the error-message will disappear and after the last
message disappeared the window will be closed automatically.
Page 25 of 29 v1.0
SUIT X-Class Installation & User Guide
This button will minimize this window. It’s also possible to close this window.
This will not affect the server itself!
This button will offer more information in this window.
E.g. Port-Settings of an online…
…, mapping of the online….
…,
Page 26 of 29 v1.0
SUIT X-Class Installation & User Guide
…., connection state including the history…
…, logfiles
Page 27 of 29 v1.0
SUIT X-Class Installation & User Guide
5 Troubleshooting
Q: I’ve changed the units for some parameters to fit the customer demands. The IPU is
working fine, the new units are adapted and displayed, but at LIS the old unit is still
received.
A: Unfortunately the IPU will always send the result in a kind of “standard-unit”. If you
change the unit(s) at the IPU, you’ve also set this at “SUIT X-CLASS” in order to get the
right reformatting of the result.
--------------------------------------------------------------------------------- -------------------------------------
Q: Sometimes the connection (network) to Host dropped down and the connection isn’t
re-established. After a restart of the Host-Online it’s ok. How can we improve this
situation?
A: “SUIT X-CLASS” is able to reconnect a broken connection automatically. It will try
this every 30 seconds. Unfortunately some LIS-Vendors are not able to do this. In a
Client- /Server-Connection the client is the active part to establish a connection. If your
LIS is able to work in a server-mode, let them work in a server-mode. In this case “SUIT
X-CLASS on IPU” has to work as client. For the most sites this should solve the
problem. If it persists, ask the LIS-Vendor to improve their driver.
----------------------------------------------------------------------------------------------------------------------
Q: The LIS-Online was restarted and we have no error-message at “SUIT X-CLASS”.
But no communication to LIS is has happened. A restart of “SUIT X-CLASS” will solve
this problem. What is the reason?
A: It’s quit hard in a TCP-connection to recognize if the counterpart is still there or not.
Since the TCP-connection is established we have an open socket and that’s we are
using to decide connected or not. Normally this socket has to be closed by the LIS-
Driver, but due to several circumstances this will not happen all the time. In this case no
error-message at “SUIT X-CLASS” will appear, but it has to. Otherwise the next
reconnect with the counterpart will fail. To force a disconnection for this situation we’ve
implemented the feature to reset a connection. Just do a click on this icon.
----------------------------------------------------------------------------------------- ---------------------------
Page 28 of 29 v1.0
SUIT X-Class Installation & User Guide
Q: I need support from Sysmex-Europe. Which files and information should I send to
you?
A: Create a compressed archive of the folder “SUIT X-CLASS” folder. Mention the time
and the affected samples in your mail. Attach the archive to you mail.
----------------------------------------------------------------------------------------------------------------------
Page 29 of 29 v1.0
