- Computers & electronics
- Software
- Computer utilities
- Database software
- Beckman Coulter
- CellaVision
- User manual
advertisement
CellaVision®
IT Configuration Guidelines
Software Version 7
CellaVision AB
Mobilvägen 12
SE-223 62 Lund
Sweden
+46 (0) 46 460 16 00 www.cellavision.com
CellaVision ® and DC-1 ® are registered trademarks of CellaVision AB.
All other trademarks used in this document are the property of their respective owners.
No part of this document or the products it describes may be reproduced or transmitted by any means or in any form without prior consent in writing from CellaVision AB.
Caution!
US federal law restricts this device to sale by or on the order of a physician (or properly licensed medical practitioner).
Note: Some products or features described in this manual may not be available in all markets.
Document: PM-10910-01
Revised: 2020-11-04
© CellaVision AB 2018-2020. All rights reserved.
Manufacturer Headquarters
CellaVision AB
Mobilvägen 12
SE-223 62 Lund
Sweden
Phone: +46 (0) 46 460 16 00
PM-10910-01
Revised: 2020-11-04
3
CONTENTS
1.3 CellaVision system overview
1.3.2 CellaVision Remote Review Software (optional)
1.3.3 CellaVision Server Software (optional)
1.4 System and database settings
3.3.2 Set up connection to LIS
4.2 Information flow – all analyzers connected to same LIS
4.2.1 Configuration checklist – all analyzers connected to same LIS
4.2.3 Set up connection to LIS – all analyzers connected to same LIS
4.3 Information flow – each analyzer connected to own LIS
4.3.1 Configuration checklist – each analyzer connected to own LIS
4.3.2 Set up connection to LIS – each analyzer connected to own LIS
5.3.1 Registry locations for CellaVision Remote Review Software product keys
5.3.2 Enable license forwarding
PM-10910-01
Revised: 2020-11-04
5
6.1 CellaVision Remote Review Software on PC
6.2 CellaVision Remote Review Software on Citrix® XenApp™ server
6.2.1 Configure Citrix® XenApp™ server
6.3 Command line options for CellaVision Remote Review Software
7.2 Calculate database storage capacity
7.3 Enable auto-delete for images and results
7.4.1 Set permissions to archive location
7.4.6 Move archive to new location
7.4.8 Archives from CellaVision DM Software earlier than version 6.0
8.1.2 Run online backup script
8.3 Database transaction logging
8.3.1 Restore database after LOGDB and TRANSDB are lost
8.3.2 Restore database after user databanks are lost
9.1 Change system serial number
9.4 Run external program from CellaVision software
9.5 Configure Network Communication
6 PM-10910-01
Revised: 2020-11-04
11 REQUIREMENTS AND SPECIFICATIONS
11.1.1 Hard drive configuration
11.1.3 Anti-virus software and Windows® security patches
11.2 CellaVision Server Software in server installation
11.3 CellaVision Remote Review Software in local installation
11.4 CellaVision Remote Review Software in Citrix® XenApp™ server installation
11.4.1 Tested XenApp™ server specifications
11.5 Monitor for system computer and review station
11.7 Network use and performance for review station
11.7.1 Open peripheral blood slide
PM-10910-01
Revised: 2020-11-04
7
1 Introduction
1 INTRODUCTION
This document describes common IT configuration issues when you use the CellaVision® product line. It also recommends best practices for selecting the most optimal installation procedures.
We assume that you are familiar with Windows® and know how to configure databases and servers. We recommend that service personnel and IT administrators familiarize themselves with the whole document.
1.1 Warnings and precautions
Carefully study the meaning of safety alerts in this manual.
Warning!
If you are not suitably trained or fail to follow the instructions provided in this manual, it may damage or deteriorate the system and cause misleading results or even injury.
1.1.1
Safety alerts
Make sure that you always read, understand, and follow all safety alerts that may appear in this manual.
Alerts Explanation
Can cause personal injury.
Warning!
Risk of infection.
Warning!
Can cause damage to the system.
Caution!
Can cause misleading results.
Important!
1.2 Scope
This document applies to:
PM-10910-01
Revised: 2020-11-04
9
1 Introduction l
Analyzers that run CellaVision DM Software version 7: o CellaVision DM1200 o CellaVision DM9600 o CellaVision DC-1 o
Automated Digital Cell Morphology Analyzer DI-60 l
Review stations that run: o
CellaVision Remote Review Software version 7 o DI Remote Review Software version 7 l
Servers that run CellaVision Server Software version 7
1.3 CellaVision system overview
This is a schematic overview of the components in the CellaVision® product line. Any digital morphology installation consists of at least one CellaVision® analyzer, but can include also more analyzers and other components. CellaVision® products that you can purchase separately, are underlined.
Main component
Subsidiary components
CellaVision analyzer l
DC-1 l
DM1200 l
DM9600 l
DI-60
System computer
CellaVision Peripheral Blood
Application
CellaVision DM Software
CellaVision Advanced
RBC Application (optional)
CellaVision Body Fluid
Application (optional)
Digital slides application
Database (option 1)
Server
(optional)
Review station
(optional)
Analyzer
CellaVision Server
Software
CellaVision Remote
Review Software
Database (option 2)
10 PM-10910-01
Revised: 2020-11-04
1 Introduction
1.3.1
CellaVision analyzer
A CellaVision® analyzer comes with a system computer. The system computer is a PC that runs
Windows® and the CellaVision DM Software. It is connected to the analyzer via an unshared Ethernet cable.
CellaVision analyzer
CDMS
System computer Analyzer
The CellaVision DM Software consists of applications that enable different types of analyses.
CellaVision Peripheral Blood Application
The CellaVision Peripheral Blood Application is intended for the differential count of white blood cells, characterization of red blood cell morphology, and platelet estimation. The analyzer automatically locates and presents images of blood cells on peripheral blood smears. The user then identifies and verifies the suggested classification for each cell according to type.
CellaVision Advanced RBC Application (optional)
The CellaVision Advanced RBC Application is an optional application that extends the red blood cell analysis functionality in the CellaVision Peripheral Blood Application.
CellaVision Body Fluid Application(optional)
The CellaVision Body Fluid Application is intended for the differential count of white blood cells in body fluid samples.
Digital Slides Application
The Digital Slides Application is used to capture digital images and create digital slides of custom-defined areas in interesting samples.
1.3.2
CellaVision Remote Review Software (optional)
A review station is any computer that runs the CellaVision Remote Review Software. Depending on edition, the CellaVision Remote Review Software can be installed either locally or accessed via a Citrix ®
XenApp™ server.
The review station is connected to one or more databases that are located either on the system computer or on a server that runs the CellaVision Server Software via LAN. It uses the same database as the analyzers.
The user can review and verify images, WBC pre-classifications, and RBC pre-characterizations from the analyzer or the review station.
The CellaVision Remote Review Software is available in these editions:
PM-10910-01
Revised: 2020-11-04
11
1 Introduction l
Professional Edition (1 user, hardware key) l
Team Edition (5 concurrent users, floating license) l
Group Edition (25 concurrent users, floating license) l
Enterprise Edition (75 concurrent users, floating license)
1.3.3
CellaVision Server Software (optional)
The CellaVision Server Software manages common databases and allows several analyzers and review stations to connect to and use those databases. This is an alternative to having the
CellaVision DM Software manage a database on the analyzer's system computer.
The CellaVision Server Software can support much larger databases than a system computer and is therefore recommended for larger laboratories. It is required for laboratories that have more than one analyzer and wish to use a common database.
1.3.4
Secure communication
All network communication between CellaVision® analyzers, the CellaVision Remote Review Software and the database is encrypted, which increases the protection of patient data from unauthorized parties.
The encryption method is TLS 1.2 (4096 bit key and SHA-512).
1.4 System and database settings
Settings that you change in the CellaVision DM Software, the CellaVision Remote Review Software, or the
CellaVision Server Software are either system specific (apply only to one specific analyzer, review station, or server) or database specific (apply to all systems that use that database).
Note: Depending on your analyzer type and your configuration, some settings may not be available.
12 PM-10910-01
Revised: 2020-11-04
1 Introduction
System settings
These settings affect only the specific analyzer, review station, or server where you do the changes.
On the Tools menu, click Settings to edit these settings: l
E-Mail l
Language l
Database l
Advanced RBC o
Size of RBC analysis region l
PLT o
PLT estimate factor l
BF analysis area
Start the DM Configuration Tool to edit the following: l
Laboratory name l
Truncate slide PID l
Configure image mode l
Configure WBC analysis start position l
Configure LIS l
Configure logging l
Configure network communication l
Change cell localization options
PM-10910-01
Revised: 2020-11-04
13
1 Introduction
Database settings
These settings affect all analyzers, review stations, and the server that use the same database.
On the Tools menu, click Settings to edit these settings: l
Users l
Analysis o
Default values o
Enable LIS o
Add processed slides to worklist o
Preload and lock slides that I add to worklist l
RBC pre-characterization l
Advanced RBC o
Enable RBC pre-characterization l
PLT o
Use only manual PLT concentration estimation o
Defaults for PLT tab o
Intervals for average PLTs/HPF value l
PB re-classification l
Report/sign o
Report template contents o
Active report template o
Default settings for sign dialogs l
Standard comments l
PB reference cells l
BF reference cells l
Archiving/auto-delete
Start the DM Configuration Tool to edit the following: l
LIS options l
Add/edit WBC class names l
Add/edit RBC morphologies l
Change cell counter options
14 PM-10910-01
Revised: 2020-11-04
l
Change extended LIS data options l
Include delimiter in standard comments l
Edit macrophage display name l
Change mark for pathology review options
1 Introduction
PM-10910-01
Revised: 2020-11-04
15
2 Installation preparations
2 INSTALLATION PREPARATIONS
This chapter provides an overview of what to consider before you set up the installation of one or more
CellaVision® analyzers.
Caution!
Always exit the CellaVision DM Software before you restart the analyzer or turn off the system computer. If you turn off the system computer abruptly, for example switch off the power supply or press and hold the power button, the database might become corrupted.
2.1 Laboratory size
Depending on the laboratory size (number of analyzers and CellaVision Remote Review Software users), you can use either a stand-alone installation or a server installation with the CellaVision Server Software.
If you use the CellaVision Server Software, you can connect the analyzers either to one common LIS server or to several individual LIS servers.
Laboratory size Type of installation
One analyzer.
Up to six simultaneous
CellaVision Remote
Review Software users.
Stand-alone installation.
The CellaVision DM Software on the system computer handles the database
(where images of scanned cells and other order data are stored). Review stations connect to the CellaVision DM Software to access the database.
For more information about the stand-alone installation, see 3 Stand-alone installation on page 21.
One analyzer.
More than six simultaneous
CellaVision Remote
Review Software users.
More than one analyzer.
Server installation with the CellaVision Server Software.
Analyzers and review stations connect to the server that runs the
CellaVision Server Software and share a common database.
For more information about the server installation, see 4 Server installation on page 27.
You can also set up several stand-alone installations. In that case, they each have their own database to which the review stations connect to individually.
Note: We recommend that you don't connect other analyzers to a stand-alone installation, that is, don't use the analyzer's system computer as a server for other analyzers. This can make the analyzer slow and sluggish.
Task
l
Determine if you want to use a stand-alone installation or a server installation with the
PM-10910-01
Revised: 2020-11-04
17
2 Installation preparations
CellaVision Server Software.
l
Determine if you want to connect the analyzers to one common LIS server or to several individual
LIS servers.
2.2 Database management
The database that contains the orders (images, results, and order data from processed slides) can store a limited amount of data. If you store too many orders in the database, the system can become slow and sluggish.
The storage capacity of the system computer is 20 GB and of the CellaVision Server Software 200 GB.
To prevent the database from growing too big, we recommend that you remove old orders at the same rate as new slides are processed. The system has a built-in auto-delete feature that allows you to do that.
However, a laboratory may require that orders are saved for a long time so the system also has an archiving feature that allows you to keep the orders forever. In this case, only the images are removed from the database and stored in a different location.
For more information about database size management and the auto-delete and archiving functions,
see 7 Database size management on page 53.
Tasks
l
Determine the required database storage capacity.
l
Determine how long to keep the signed orders. This may be regulated by laboratory policies or regulatory agencies.
l
Determine if additional storage capacity is required by performing calculations as described in 7
Database size management on page 53 .
l
Determine if you need to enable the auto-delete or archiving functions to keep the database size manageable.
l
Determine which backup method to use as described in 8 Backup and restore on page 67.
2.3 User accounts
You need to create user accounts with different access levels for everyone who needs access to an analyzer or a review station. User accounts are valid for the database where they were created. A user can log on to the database from any analyzer or review station that has a connection to that database.
User information can be fetched from an active directory. If you are logged on to the domain when you create a new user account, you can easily search for users in the active directory. A user can then choose to authenticate against the active directory at log on (with Windows® user name and password).
You can change the access level, full name, password, and email address for existing users at anytime, but you can't change the user name. You can also remove or deactivate a user account.
A user can start the CellaVision DM Software and select Start without logging on to log on to a database without a user name. In that case, no patient data is available but the user can still process slides and select whether to send the result to LIS.
18 PM-10910-01
Revised: 2020-11-04
2 Installation preparations
For more information on how to set up user accounts and access levels, see the Instructions for Use for your analyzer.
Tasks
l
Before you add a new user account, determine if you want to fetch user information from your active directory. This requires that the system computer is added to the domain.
l
Determine what user name to use when creating a user account since it is not possible to change the user name later.
PM-10910-01
Revised: 2020-11-04
19
3 Stand-alone installation
3 STAND-ALONE INSTALLATION
We recommend this installation configuration for laboratories with one analyzer and up to six simultaneous CellaVision Remote Review Software users.
3.1 Functional description
This chapter provides an overview of each component's function in a stand-alone installation.
l
The CellaVision DM Software installed on the analyzer's system computer manages the database and the connections to the review stations.
l
The CellaVision Remote Review Software installed on the review stations enables processed slide reviews and result verification. Review stations are connected to the system computer via an Ethernet network.
l
Unless single-user hardware keys are used, the CellaVision DM Software acts as a license server that manages and distributes software licenses to the CellaVision Remote Review Software clients.
l
If the archiving function is used, the CellaVision DM Software moves archived images to the archive and allows review stations to access them.
l
The system computer is connected to LIS.
l
Images and results are stored in a database located on the system computer.
l
The analyzer and the review stations must run the same version of the software.
PM-10910-01
Revised: 2020-11-04
21
3 Stand-alone installation
3.2 Information flow
This chapter provides an overview of the information flow in a stand-alone installation.
All network communication between CellaVision® analyzers, the CellaVision Remote Review Software and the database is encrypted, which increases the protection of patient data from unauthorized parties.
1. Patient data, including order ID and type of analysis, is entered to LIS.
2. A sample of blood is smeared and stained on a glass slide. The slide is labeled with a barcode that contains the order ID.
3. The analyzer reads the order ID from the slide.
4. The analyzer queries LIS for order data that matches the order ID.
5. The analyzer receives the order data, including patient data, from LIS.
6. Based on the order data, the analyzer scans and takes images of the slide, and performs preclassification of white blood cells and pre-characterization of red blood cell morphology.
7. The analyzer stores the patient data, the images, and the results from the pre-classification and precharacterization to the database on the system computer.
8. The CellaVision Remote Review Software on the review station fetches the images and the results from the pre-classification and pre-characterization from the database on the system computer.
9. The user verifies the results form the pre-classification and pre-characterization, and signs the order.
10. The CellaVision Remote Review Software on the review station connects to the
CellaVision DM Software on the analyzer to store the verified results to the database on the system computer.
22 PM-10910-01
Revised: 2020-11-04
3 Stand-alone installation
11. The system computer sends the verified results to LIS.
2. Sample
Patient
1. Patient
data
LIS
(middleware)
4. Query
5. Order data
8. Results
3. Slide
CellaVision analyzer
CDMS
System computer Analyzer
6. Images, pre-classification
7. Verification
Review stations
3.3 Configuration checklist
To configure a stand-alone installation: l
Set up the LIS connection as described in 3.3.2 Set up connection to LIS on the next page.
l
l
Set up the database backup as described in 8 Backup and restore on page 67.
l
PM-10910-01
Revised: 2020-11-04
23
3 Stand-alone installation
3.3.1
Configure firewall
Analyzers delivered with CellaVision DM Software version 6 or 7 pre-installed, have the firewall already configured.
Analyzers delivered with CellaVision DM Software version 5 pre-installed, require that the firewall is configured when upgrading to CellaVision DM Software version 7.
The CellaVision DM Software and the CellaVision Remote Review Software use network ports 40201 and
1360 to communicate with the server that runs the CellaVision Server Software. Make sure that any firewalls, routers, or other networking equipment allow the analyzers and review stations to communicate through these ports (using the TCP protocol).
CellaVision analyzer
Review stations
CDMS
System computer Analyzer
Firewall
Routers
Configure any firewall so that the services can communicate through the specified ports:
Service
CellaVision DM Software Service
C:\Program Files (x86)\CellaVision\BloodDifferential\bin
\CellaVision.CDMS.Service.Service.exe
Mimer SQL
C:\Program Files (x86)\Mimer SQL X.Y
\mimsrv.exe
C:\Program Files (x86)\Mimer SQL X.Y
\tcpsrv.exe
(Where X.Y
is the Mimer SQL version number.)
CellaVision Data Storage Service
(only for setup including the CellaVision Image Capture System)
C:\Program Files (x86)\CellaVision\Services
\CellaVision.Services.DataStorage.exe
Port
40201
1360
8734
Protocol
TCP
TCP
TCP
3.3.2
Set up connection to LIS
This chapter explains how to connect an analyzer to LIS in a stand-alone installation.
In this type of installation, the analyzer fetches patient and order data from LIS and, after analysis, returns verified and signed results to LIS. The review stations are connected to the analyzer via an
Ethernet network, but have no direct connection to LIS.
24 PM-10910-01
Revised: 2020-11-04
3 Stand-alone installation
To set up the LIS connection on the analyzer
1. Click the Start button, type dmconf , and then click DMConfiguration .
2. In the DM Configuration Tool dialog, type the service password cv2864400 , select Only machine settings in the list, and then click OK .
3. On the Tasks list, under Software , click Configure LIS .
4. Enter information for the LIS connection.
For more detailed information about the connection and how the analyzer interacts with LIS, see the
LIS Interface Manual.
5. Make sure that selection for Disable sending results to LIS is cleared.
6. If the CellaVision Body Fluid Application is installed on the analyzer, and the LIS interface has been updated to handle BF analysis, select Enable order requests for BF .
7. Click Submit .
8. Exit the DM Configuration Tool.
9. Start the CellaVision DM Software and log on as a user with access level administrator or service .
10. On the Tools menu, click Settings , and then click the Analysis tab.
11. Select Enable LIS .
12. Restart the CellaVision DM Software.
PM-10910-01
Revised: 2020-11-04
25
4 Server installation
4 SERVER INSTALLATION
We recommend this installation configuration for laboratories with more than one analyzer sharing the same database or more than six simultaneous CellaVision Remote Review Software users. This configuration uses the CellaVision Server Software.
To use either of these configurations, you need to install the CellaVision Server Software on a server that has at least one database created. All analyzers need to be connected to the database on that server.
4.1 Functional description
This chapter provides an overview of each component's function in a server installation.
l
CellaVision Server Software installed on the server, manages the database and connections to the analyzers and review stations.
l
CellaVision Remote Review Software installed on the review stations enables processed slide reviews and result verification.
l
CellaVision Server Software stores images and results from all analyzers and review stations in a database located on the server.
l
If the archiving function is used, CellaVision Server Software moves archived images to the archive and allows the analyzers and review stations to access them.
l
Unless single-user hardware keys are used, CellaVision Server Software acts as a license server that manages and distributes software licenses to CellaVision Remote Review Software clients.
l
The analyzers and review stations connect to CellaVision Server Software via an Ethernet network.
l
The analyzers are connected to LIS.
l
CellaVision Server Software can be connected to LIS if the analyzers are not connected to individual
LIS servers.
l
All analyzers, all review stations, and the server that runs CellaVision Server Software must run the same base version of the software, that is, have the same first two digits in the version number (for example 6.0.1 is compatible with 6.0.2).
4.2 Information flow – all analyzers connected to same LIS
This chapter provides an overview of the information flow in a server installation where all analyzers are connected to the same LIS. The installation setup includes one or more analyzers, CellaVision Server
Software on a server and CellaVision Remote Review Software.
All network communication between CellaVision® analyzers, the CellaVision Remote Review Software and the database is encrypted, which increases the protection of patient data from unauthorized parties.
PM-10910-01
Revised: 2020-11-04
27
4 Server installation
1. Patient data, including order ID and type of analysis, is entered to LIS.
2. A sample of blood is smeared and stained on a glass slide. The slide is labeled with a barcode that contains the order ID.
3. The analyzer reads the order ID from the slide.
4. The analyzer queries LIS for order data that matches the order ID.
5. The analyzer receives the order data, including patient data, from LIS.
6. Based on the order data, the analyzer scans and takes images of the slide, and performs preclassification of white blood cells and pre-characterization of red blood cell morphology.
7. The analyzer connects to CellaVision Server Software to store the patient data, the images, and the results from the pre-classification, and pre-characterization to the database on the server.
8. CellaVision Remote Review Software on the review station fetches the images and the results from the pre-classification and pre-characterization from the database on the server.
9. The user verifies the results form the pre-classification and pre-characterization, and signs the order.
10. CellaVision Remote Review Software on the review station connects to CellaVision Server Software to store the verified results to the database on the server.
11. CellaVision Server Software sends the verified results to LIS.
Note: Because the server is sending results to LIS, you must disable the analyzers from doing the same.
Patient
LIS *
(middleware)
2. Sample
9. Results
3. Slide
CellaVision analyzer 1,2,3 *
4. Query
5. Order data
6. Images, pre-classification
CDMS
System computer Analyzer
Server
CellaVision
Server
Software
Database
7. Images, pre-classification
8. Verification
* Each CellaVision analyzer communicates with the same LIS
Review stations
28 PM-10910-01
Revised: 2020-11-04
4 Server installation
4.2.1
Configuration checklist – all analyzers connected to same LIS
To configure a server installation with one or more analyzers where all analyzers are connected to the same LIS, and where the CellaVision Server Software and database run on a server: l
On the server, install the CellaVision Server Software as specified in its Installation Instructions.
l
If installed, configure any firewalls as described in 4.2.2 Configure firewall on the next page.
l
o
Set up the LIS connection on each analyzer.
o
Disable result sending to LIS on each analyzer.
o
Set up the LIS connection on the server that runs the CellaVision Server Software.
o
Enable LIS.
o
Set up connections from each analyzer to the server that runs the CellaVision Server Software.
l
Set up the server that runs the CellaVision Server Software to automatically delete or archive old
orders as described in 7 Database size management on page 53.
l
Set up the database backup as described in 8 Backup and restore on page 67.
l
PM-10910-01
Revised: 2020-11-04
29
4 Server installation
4.2.2
Configure firewall
The CellaVision DM Software and the CellaVision Remote Review Software use network ports 40201 and
1360 to communicate with the server that runs the CellaVision Server Software. Make sure that any firewalls, routers, or other networking equipment allow the analyzers, review stations, and the
CellaVision Server Software to communicate through these ports (using the TCP protocol).
CellaVision analyzer
CellaVision analyzer
Server
CellaVision
Server
Software
Database
CDMS
System computer Analyzer
Firewall
Routers
Review stations
Configure any firewall so that the services can communicate through the specified ports:
Service
CellaVision DM Software Service
C:\Program Files (x86)\CellaVision\BloodDifferential\bin
\CellaVision.CDMS.Service.Service.exe
Mimer SQL
C:\Program Files (x86)\Mimer SQL X.Y
\mimsrv.exe
C:\Program Files (x86)\Mimer SQL X.Y
\tcpsrv.exe
(Where X.Y
is the Mimer SQL version number.)
CellaVision Data Storage Service
(only for setup including the CellaVision Image Capture System)
C:\Program Files (x86)\CellaVision\Services
\CellaVision.Services.DataStorage.exe
Port
40201
1360
8734
Protocol
TCP
TCP
TCP
30 PM-10910-01
Revised: 2020-11-04
4 Server installation
4.2.3
Set up connection to LIS – all analyzers connected to same LIS
This chapter explains how to set up a connection to LIS in a server installation where several analyzers and the CellaVision Server Software are connected to the same LIS.
In this type of installation, each analyzer fetches patient and order data from LIS, but after analysis, only the CellaVision Server Software returns verified and signed results to LIS. The review stations and the analyzers are connected to the server that runs the CellaVision Server Software via an Ethernet network.
To set up a LIS connection where all analyzers are connected to same LIS: l
Set up the LIS connection on each analyzer.
l
Disable result sending to LIS on each analyzer.
l
Set up the LIS connection on the server that runs the CellaVision Server Software.
l
Enable LIS.
l
Connect each analyzer to the server that runs the CellaVision Server Software.
To be able to send data to LIS, the CellaVision Server Software needs to run and be logged on to the database. When started, the CellaVision Server Software automatically logs on to the last used database.
The CellaVision Server Software can only be logged on to one database at a time. This means that it can only send results from one database to LIS even if more than one databases exist on the server.
To set up the LIS connection on each analyzer
1. Click the Start button, type dmconf , and then click DMConfiguration .
2. In the DM Configuration Tool dialog, type the service password cv2864400 , select Only machine settings in the list, and then click OK .
3. On the Tasks list, under Software , click Configure LIS .
4. Enter information for the LIS connection.
For more detailed information about the connection and how the analyzer interacts with LIS, see the
LIS Interface Manual.
5. Select Disable sending results to LIS .
6. If the CellaVision Body Fluid Application is installed on the analyzer, and the LIS interface has been updated to handle BF analysis, select Enable order requests for BF .
7. Click Submit .
8. Exit the DM Configuration Tool.
9. Restart the CellaVision DM Software.
PM-10910-01
Revised: 2020-11-04
31
4 Server installation
To set up the LIS connection on the server that runs the
CellaVision Server Software
1. Click the Start button, type dmconf , and then click DMConfiguration .
2. In the DM Configuration Tool dialog, enter the service password cv2864400 , select Only machine settings in the list, and then click OK .
3. On the Tasks list, under Software , click Configure LIS .
4. Enter information for the LIS connection.
For more detailed information about the connection and how the analyzer interacts with LIS, see the
LIS Interface Manual.
5. Make sure that selection for Disable sending results to LIS is cleared.
6. Click Submit .
7. Exit the DM Configuration Tool.
8. Restart the CellaVision DM Software.
To enable LIS
Note: This database setting applies to all systems that use the database.
1. On the system computer of one of the analyzers, or on the server that runs the CellaVision Server
Software, log on to the database as a user with access level administrator or service .
2. On the Tools menu, click Settings , and then click the Analysis tab.
3. Select Enable LIS .
4. Exit the DM Configuration Tool.
5. Restart the CellaVision DM Software.
To connect each analyzer to the CellaVision Server Software and the database
1. Click the Start button, point to All programs , click CellaVision , right-click CellaVision DM
Software , and then click Run as administrator .
2. Log on to the factory default database ( serial-number DB ) with user name admin and password admin
You can also log on to any database that has the icon, but in that case you need to log on as a user with access level administrator or service .
3. On the Tools menu, click Settings , and then click the Database tab.
4. Click Connect .
32 PM-10910-01
Revised: 2020-11-04
4 Server installation
5. In the Connect to a database dialog, in the Database name field, enter the name of the database on the server that runs the CellaVision Server Software.
6. In the Description field, you can enter a description for the connection.
7. In the Remote computer field, enter the name or IP address of the server where the
CellaVision Server Software and the database are located.
If you don't know the name of the server, open the CellaVision Server Software, and then, on the
Help menu, click System information .
8. Click OK .
4.3 Information flow – each analyzer connected to own LIS
This chapter provides an overview of the information flow in a server installation where each analyzer is connected to its own LIS.
The installation setup includes one or more analyzers, the CellaVision Server Software and the
CellaVision Remote Review Software.
Analyzers using the same database can be connected to individual LIS servers. With this setup, each analyzer fetches their own results from the database and sends the results to its individual LIS server.
It is not possible to send CellaVision Image Capture System slides results to multiple LIS servers.
Note: If you want results to be sent to the LIS without having a specific user logged on, select Start without logging on when you start the CellaVision DM Software. This will allow results to be sent continuously without displaying patient information on the screen.
1. Patient data, including order ID and type of analysis, is entered to LIS.
2. A sample of blood is smeared and stained on a glass slide. The slide is labeled with a barcode that contains the order ID.
3. The analyzer reads the order ID from the slide.
4. The analyzer queries LIS for order data that matches the order ID.
5. The analyzer receives the order data, including patient data, from LIS.
6. Based on the order data, the analyzer scans and takes images of the slide, and performs preclassification of white blood cells and pre-characterization of red blood cell morphology.
7. The analyzer connects to the CellaVision Server Software to store the patient data, the images, and the results from the pre-classification, and pre-characterization to the database on the server.
8. The CellaVision Remote Review Software on the review station fetches the images and the results from the pre-classification and pre-characterization from the database on the server.
9. The user verifies the results form the pre-classification and pre-characterization, and signs the order.
10. The CellaVision Remote Review Software on the review station connects to the CellaVision Server
Software to store the verified results to the database on the server.
PM-10910-01
Revised: 2020-11-04
33
4 Server installation
11. The analyzer connects to the CellaVision Server Software to fetch the verified results, and sends them to LIS.
2. Sample
Patient
LIS
1,2,3, *
(middleware)
3. Slide
4. Query
9. Results
5. Order data
CellaVision analyzer 1,2,3 *
CDMS
6. Images, pre-classification
9. Results
Server
System computer
7. Images, pre-classification
CellaVision
Server
Software
8. Verification
Database
Analyzer
LIS C
(middleware)
* Each CellaVision analyzer communicates with its own LIS
Review stations
4.3.1
Configuration checklist – each analyzer connected to own LIS
To configure a server installation with one or more analyzers where each analyzer is connected to its own
LIS, and where the CellaVision Server Software and database run on a server: l
On the server, install the CellaVision Server Software as described in its Installation Instructions.
l
If installed, configure any firewalls as described in 4.2.2 Configure firewall on page 30.
l
o
Set up the LIS connection on each analyzer.
o
Set up connections from each analyzer to the server that runs the CellaVision Server Software.
o
Enable result sending to LIS on one analyzer.
l
Make sure that unique system serial numbers are assigned to each analyzer as described in 9.1
Change system serial number on page 85.
l
34 PM-10910-01
Revised: 2020-11-04
4 Server installation l
set up the database backup as described in 8 Backup and restore on page 67.
l
4.3.2
Set up connection to LIS – each analyzer connected to own LIS
This chapter explains how to set up a connection to LIS in a server installation where each analyzer is connected to its own LIS.
To set up a LIS connection where all analyzers are connected to own LIS: l
Set up the LIS connection on each analyzer.
l
Connect each analyzer to the server that runs the CellaVision Server Software.
l
Enable result sending to LIS on one analyzer.
l
Enable LIS.
Important!
All analyzers share the same database so you can't set individual database settings for them.
This applies to all settings under LIS Options , Change Extended LIS Data Options and
Include delimiter in Standard Comments . If you edit these settings from one analyzer using the DM Configuration Tool, the changes apply to all other analyzers in the network.
To set up the LIS connection on each analyzer
1. Click the Start button, type dmconf , and then click DMConfiguration .
2. In the DM Configuration Tool dialog, type the service password cv2864400 , select Only machine settings in the list, and then click OK .
3. On the Tasks list, under Software , click Configure LIS .
4. Enter information for the LIS connection.
For more detailed information about the connection and how the analyzer interacts with LIS, see the
LIS Interface Manual.
5. If the CellaVision Body Fluid Application is installed on the analyzer, and the LIS interface has been updated to handle BF analysis, select Enable order requests for BF .
6. Click Submit .
7. Exit the DM Configuration Tool.
8. Restart the CellaVision DM Software.
To connect each analyzer to the CellaVision Server Software and the database
PM-10910-01
Revised: 2020-11-04
35
4 Server installation
1. Click the Start button, point to All programs , click CellaVision , right-click CellaVision DM
Software , and then click Run as administrator .
2. Log on to the factory default database ( serial-number DB ) with user name admin and password admin
You can also log on to any database that has the icon, but in that case you need to log on as a user with access level administrator or service .
3. On the Tools menu, click Settings , and then click the Database tab.
4. Click Connect .
5. In the Connect to a database dialog, in the Database name field, enter the name of the database on the server that runs the CellaVision Server Software.
6. In the Description field, you can enter a description for the connection.
7. In the Remote computer field, enter the name or IP address of the server where the
CellaVision Server Software and the database are located.
If you don't know the name of the server, open the CellaVision Server Software, and then, on the
Help menu, click System information .
8. Click OK .
To enable result sending to LIS on one analyzer
Note: This database setting applies to all systems that use the database.
1. On the system computer of one of the analyzers, click the Start button, type dmconf , and then click
DMConfiguration .
2. In the DM Configuration Tool dialog, type the service password cv2864400 .
3. In the list, click the database that you want to configure, and then click OK .
4. Log on to the database as a user with access level administrator or service .
5. On the Tasks list, under Database , click LIS Options .
6. Select Enable analyzers to send their own processed slides to the LIS .
7. If the CellaVision Body Fluid Application is installed on the analyzer, and the LIS interface has been updated to handle BF analysis, select Enable order requests for BF .
8. Click Submit .
9. Restart the CellaVision DM Software.
To enable LIS
Note: This database setting applies to all systems that use the database.
36 PM-10910-01
Revised: 2020-11-04
4 Server installation
1. On the system computer of one of the analyzers, or on the server that runs the CellaVision Server
Software, log on to the database as a user with access level administrator or service .
2. On the Tools menu, click Settings , and then click the Analysis tab.
3. Select Enable LIS .
4. Restart the CellaVision DM Software or the CellaVision Server Software.
Note: When you select Enable analyzers to send their own processed slides to the LIS , each analyzer sends results to LIS even though Disable sending results to LIS is selected for each analyzer.
Note: If your network includes more than one database, you need to log on to each database and select
Enable analyzers to send their own processed slides to the LIS .
PM-10910-01
Revised: 2020-11-04
37
5 Software license management
5 SOFTWARE LICENSE MANAGEMENT
To run CellaVision software, you need a software license. There are different types of licenses and different ways to handle or register them. Under certain circumstances, there is also the option to share certain types of licenses. Read about the different types of licenses and familiarize yourself with those for the products that you have acquired.
The software license for the CellaVision® software is delivered either as a CellaVision® license key, a hardware key or a product key.
These software products use a CellaVision® license key (USB security key): l
CellaVision DM Software (CellaVision® DC-1 only)
These software products use a hardware key (USB or parallel port security key): l
CellaVision DM Software (all other CellaVision® analyzers) l
CellaVision CellaVision Advanced RBC Application l
CellaVision CellaVision Body Fluid Application l
CellaVision Remote Review Software, Professional Edition l
DI Remote Review Software
These software products use a product key (alphanumeric security key): l
CellaVision Remote Review Software, Group Edition l
CellaVision Remote Review Software, Team Edition l
CellaVision Remote Review Software, Enterprise Edition l
CellaVision Server Software
5.1 CellaVision® License key
You need a CellaVision® license key to run the CellaVision DM Software on the CellaVision® DC-1. You must transfer the license from the CellaVision® license key to the analyzer. Once transferred, you don't need to keep the CellaVision® license key as it can be used only once.
The CellaVision® license key is delivered as a USB security key.
To transfer the CellaVision® license key, follow the Installation Instructions delivered with the analyzer.
PM-10910-01
Revised: 2020-11-04
39
5 Software license management
5.2 Hardware key
You need to insert the hardware key into the system computer or the review station computer that runs the software. Each hardware key is coded for one specific software, and allows one instance of that software to run on the computer where it's inserted.
More than one hardware key can be used at the same time, for example to run the
CellaVision DM Software with the CellaVision Advanced RBC Application.
Hardware keys are delivered as USB or parallel port security keys and must remain inserted to run the software. You can stack parallel port hardware keys to allow for more than one hardware key to be connected to the computer.
These variants of hardware keys are used for the CellaVision® software:
Parallel port hardware key USB hardware key USB hardware key USB hardware key
5.3 Product key
If you install or upgrade to a software that uses a product key, you must register the product key with
CellaVision AB to get a software license.
The product key is a 30 character long alphanumeric security key found in the Software License
Certificate in the product box.
Where you register the product key is critical, so take this into account before you register. The product key is normally registered at the location of the processing database.
Important!
A license file is tied to the hardware fingerprint of the system computer or server where you register the product key. Once registered, you can't move the license or the license file to a different system computer or server.
The product key for the CellaVision Server Software must be registered on the server that runs the
CellaVision Server Software.
The CellaVision Remote Review Software license is a floating license, and allows a specified number of clients to connect to a database. The license is automatically distributed to clients when they log on to a database on a system computer, or on a database on a server that runs the CellaVision Server Software.
To register product keys, follow the Installation Instructions delivered with the software.
40 PM-10910-01
Revised: 2020-11-04
5 Software license management
5.3.1
Registry locations for CellaVision Remote Review
Software product keys
Where you register the CellaVision Remote Review Software product key depends on your CellaVision® product configuration. It is critical also for proper performance of the software. If you are unsure of where to register your product key, contact your local vendor before registering.
Stand-alone installation with one analyzer
In a stand-alone installation with one analyzer, register the product key for the CellaVision Remote
Review Software on the system computer. The system computer distributes available licenses to every
CellaVision Remote Review Software client that connects to a database on that system computer.
CellaVision analyzer
Remote Review
Software license
CellaVision
DM
Software
Database
CellaVision Remote
Review Software
CellaVision Remote
Review Software
CellaVision Remote
Review Software
Server installation with one or more analyzers
In a server installation where you have one or more analyzers connected to a server that runs the
CellaVision Server Software, register the product key for the CellaVision Remote Review Software on that server. The server distributes available licenses to every CellaVision Remote Review Software client that connects to a database on that server.
PM-10910-01
Revised: 2020-11-04
41
5 Software license management
CellaVision
Server
Software
Server
Remote Review
Software license
Database
CellaVision analyzer
CellaVision analyzer
CellaVision Remote
Review Software
CellaVision Remote
Review Software
CellaVision Remote
Review Software
You can install the CellaVision Remote Review Software on a Citrix® XenApp™ server. In that case, you must register the product key for the CellaVision Remote Review Software on the server that runs the
CellaVision Server Software.
Citrix
®
XenApp
™
server
CellaVision
Remote
Review
Software
CellaVision
Server
Software
Server
Remote Review
Software license
Database
CellaVision analyzer
CellaVision analyzer
XenApp ™ XenApp ™ XenApp ™
Citrix
®
XenApp ™
Review Station
Citrix
®
XenApp ™
Review Station
Citrix
®
XenApp ™
Review Station
License forwarding with multiple analyzers
Important!
You can't use license forwarding with a server that runs the CellaVision Server Software. You can use it only with system computers.
A system computer can use a software license located on another system computer. Both system computers can distribute the same license to the CellaVision Remote Review Software clients. This can be useful in installations with more than one analyzer. When you log on to a CellaVision® database, the service checks for available licenses on the system computer where your product key for the
CellaVision Remote Review Software is registered.
42 PM-10910-01
Revised: 2020-11-04
5 Software license management
For example, you can register a CellaVision Remote Review Software Enterprise Edition license that supports 75 concurrent users on one system computer, and then allow another system computer to distribute the license to the CellaVision Remote Review Software clients. This way, the CellaVision Remote
Review Software clients can connect to either analyzer as long as the total number of clients doesn’t exceed 75.
page. You also need to configure any firewalls as described in 4.2.2 Configure firewall on page 30.
CellaVision analyzer 1
Remote Review
Software license
CellaVision
DM
Software
Database
CellaVision analyzer 2
CellaVision
DM
Software
Database
CellaVision Remote
Review Software
CellaVision Remote
Review Software
CellaVision Remote
Review Software
CellaVision Remote
Review Software
CellaVision Remote
Review Software
Important!
The system computer that contains the license file must run and be reachable at all times. If the system computer is turned off, malfunctions, or is not reachable for some other reason, the CellaVision Remote Review Software clients can't log on and use the software.
This example shows a setup with two analyzers that both use the license file located on Analyzer 1. If the network connection between the analyzers is lost, the CellaVision Remote Review Software clients can still connect to Analyzer 1 but not to Analyzer 2.
CellaVision analyzer 2 CellaVision analyzer 1
Remote Review
Software license CellaVision
DM
Software
Database
CellaVision
DM
Software
Database
CellaVision Remote
Review Software
CellaVision Remote
Review Software
PM-10910-01
Revised: 2020-11-04
CellaVision Remote
Review Software
CellaVision Remote
Review Software
CellaVision Remote
Review Software
43
5 Software license management
If you use a Citrix® XenApp™ server for the CellaVision Remote Review Software and have multiple analyzers in your setup, register the product key for the CellaVision Remote Review Software on the
Citrix® XenApp™ server. When you log on to a CellaVision® database, the service checks for available licenses on the Citrix® XenApp™ server.
Citrix
®
XenApp
™
server
Remote Review
Software license CellaVision
Remote
Review
Software
CellaVision analyzer
CellaVision
DM
Software
Database
CellaVision analyzer
CellaVision
DM
Software
Database
XenApp ™ XenApp ™ XenApp ™
Citrix
®
XenApp ™
Review Station
Citrix
®
XenApp ™
Review Station
Citrix
®
XenApp ™
Review Station
To distribute available licenses from the Citrix® XenApp™ server, you need to configure the firewall on
the Citrix® XenApp™ server as described in 4.2.2 Configure firewall on page 30.
5.3.2
Enable license forwarding
Important!
You can't use license forwarding with a server that runs the CellaVision Server Software. You can use it only with system computers.
Important!
The system computer that contains the license file must run and be reachable at all times. If the system computer is turned off, malfunctions, or is not reachable for some other reason, the CellaVision Remote Review Software clients can't log on and use the software.
To enable license forwarding
1. Make sure that the computer where the product key is registered is on the same network as the computer that needs access to the software license.
44 PM-10910-01
Revised: 2020-11-04
5 Software license management
3. On the computer that needs access to the software license, log on with these credentials:
User name : administrator
Password : cv2864400
4. Open this file: C:\Program Files (x86)\CellaVision\BloodDifferential\bin\license.ini
If the file doesn’t exist, create it.
5. Edit the file using a text editor (for example Notepad): type the IP address or the computer name of the server or system computer where the software license is located, for example 143.48.4.19.
6. Save and close the file.
7. Restart the computer.
5.3.3
Back up license files
We recommend that you make a backup of the license files where the software licenses are stored. To achieve this, you can make regular backups of the system computer or the server that runs the
CellaVision Server Software, or make manual backups of the license files as described here.
To back up a license file
1. On the system computer or server where the software license is stored (the same location where the processing database is located), click the Start button, and then find and click License Registration
Tool .
2. Click Open license folder .
3. Copy the content of the license folder to a backup location.
PM-10910-01
Revised: 2020-11-04
45
6 Review stations
6 REVIEW STATIONS
This chapter explains how to install and configure review stations that run the CellaVision Remote Review
Software.
6.1 CellaVision Remote Review Software on PC
Install the CellaVision Remote Review Software on a local PC as specified in its Installation Instructions.
Important!
The CellaVision Remote Review Software must have the same version as the
CellaVision DM Software installed on the analyzers and the CellaVision Server Software installed on the server (if used).
You need a software license before you can use the CellaVision Remote Review Software. For more
information, see 5 Software license management on page 39.
If you can't log on to the connected database, disconnect and reconnect the database to make sure that the database name and the remote computer name or the database IP address settings are correct. Also make sure that any firewall on the system computer, or on the server that runs the CellaVision Server
Software, is configured as described in 4.2.2 Configure firewall on page 30.
To connect a review station to a system computer or a server that runs the CellaVision Server Software
Follow the instructions in the CellaVision Remote Review Software Installation Instructions.
To reconnect a review station to a system computer or a server that runs the CellaVision Server Software
1. On the review station, log on to Windows® as a user with administrator privileges.
2. Click the Start button, point to All programs , click CellaVision , right-click CellaVision DM
Software , and then click Run as administrator .
3. Log on to the database you created at installation with these credentials: l
User name: admin l
Password: admin
4. On the Tools menu, click Settings , and then click the Database tab.
5. In the Database list , click the database you want to disconnect, and then click Disconnect.
PM-10910-01
Revised: 2020-11-04
47
6 Review stations
6. In the “Do you want to the delete the connection to the database DatabaseName ?” message, click
Yes .
7. Click Connect .
8. In the Connect to a database dialog box, in the Database name text box, type the database name you want to connect to.
9. In the Description text box, you can type a descriptive text for the database connection.
10. In the Remote computer text box, type the computer name or IP address of the system computer, or the server that runs CellaVision Server Software, where the database is located, and then click OK .
If you don't know the name of the system computer or server, open the CellaVision DM Software or the CellaVision Server Software on that computer and then, on the Help menu, click System information .
To change an existing connection using Mimer Administrator
This is a workaround procedure for situations where, for some reason, you can’t log on to any local database.
1. On the review station, log on to Windows® as a user with administrator privileges.
2. Click the Start button, type mimer , and then click Mimer Administrator .
3. In the Mimer administrator window, click the Remote tab.
4. Right-click the database connection you want to repair, and then click Properties .
5. In the Remote Database Definition window, in the Database name text box, make sure that the name of the database it typed correctly.
6. In the Node name text box, make sure that the name or IP address of the system computer, or the server that runs the CellaVision Server Software, where the database is located, is typed correctly.
7. Click Test .
8. If you receive the “Successful connection established to database database name .” message, click
OK .
9. In the Remote Database Definition window, click OK .
48 PM-10910-01
Revised: 2020-11-04
6 Review stations
6.2 CellaVision Remote Review Software on Citrix
®
XenApp™ server
The CellaVision Remote Review Software Team, Group, and Enterprise editions are Citrix ® support distribution via a Citrix ® XenApp™ server.
Ready, and
Install the CellaVision Remote Review Software on a XenApp™ server as described in its Installation
Instructions, and make settings unique for the Citrix ® installation.
When installed on a XenApp™ server, the CellaVision Remote Review Software interacts with the
CellaVision Server Software or the analyzers in the same way as in a local PC installation.
Patient
2. Sample 3. Slide
CellaVision analyzer
CellaVision analyzer
4. Query
5. Order data
6. Images, pre-classification
CDMS
System computer Analyzer
LIS
(middleware)
9. Results
Server
CellaVision
Server
Software
Database
7. Images, preclassification
8. Verification
Citrix ® XenApp ™ server
XenApp ™
Remote Review Software
Review stations
PM-10910-01
Revised: 2020-11-04
49
6 Review stations
The review stations (XenApp™ clients) and the XenApp™ server are connected to the same Ethernet network as the CellaVision Server Software and the analyzers. The CellaVision Server Software and the analyzers handle the connection to LIS in the same way as in a local PC installation.
Query
CellaVision analyzer
CellaVision analyzer
Order data
CDMS
System computer Analyzer
LIS
(middleware)
Results
Server
CellaVision
Server
Software
Database
Citrix ® XenApp ™ server
XenApp ™
Remote Review Software
Via Ethernet network
ASTM (via serial or TCP/IP)
Review stations
6.2.1
Configure Citrix® XenApp™ server
When you have installed the CellaVision Remote Review Software on a Citrix ® XenApp™ server, configure it to be published as an Accessed from a server application. Set these values in Application properties :
Property
Server application type
Program path
Working directory
Client audio
Encryption
Printing
Value
Installed application
C:\Program Files (x86)\CellaVision\BloodDifferential\bin
\CellaClient.exe" -p:SOFTWARE\CellaVision\CBDSW –s
C:\Program Files (x86)\CellaVision\BloodDifferential\bin\
Legacy audio enabled
Basic
Allow this application to start without waiting for printers to be created
50 PM-10910-01
Revised: 2020-11-04
6 Review stations
Policy setting
Important!
Image compression reduces image quality and can cause the user to not see or to misinterpret important details in images. Make sure that image compression is disabled as described here.
In Citrix® Appcenter, browse to the used XenApp™ server, click Policies , and then click the User tab.
Add these settings to the policy for Citrix® XenApp™ versions 6.0 and 6.5: l
Heavyweight compression = Disabled (ICA\Visual Display\Still Images) l
Lossy compression level = Disabled (ICA\Visual Display\Still Images)
Add this setting to the policy for Citrix® XenApp™ version 7.x: l
Visual quality = Always Lossless
6.3 Command line options for CellaVision Remote
Review Software
These command line options can be used with the CellaVision Remote Review Software.
Type
-oid:"
-pid:" order ID " patient ID "
To
Start the CellaVision Remote Review Software, and then open the order with the specified order ID.
Start the CellaVision Remote Review Software, and then open the first order matching the specified patient ID.
Command line options are entered after the command to start the CellaVision Remote Review Software.
Example
"C:\Program Files (x86)\CellaVision\BloodDifferential
\bin\CellaClient.exe" -oid:" Order 1234 "
Note: When you have started the CellaVision Remote Review Software using command line options, you must log on to the database that contains the specified order. If you log on to a different database, no order is opened.
PM-10910-01
Revised: 2020-11-04
51
7 Database size management
7 DATABASE SIZE MANAGEMENT
This chapter explains how to set up a configuration that automatically keeps the database from growing too large.
7.1 Manage database size
The database where orders (images, results, and order data from processed slides) are stored should never grow larger than: l
200 GB for the CellaVision Server Software.
l
20 GB for a local database on a system computer.
Important!
Make sure that there is always free disk space available on the partition where the database is stored. If that partition becomes full, you can't use the analyzer anymore.
When you create a new database on a server that runs the CellaVision Server Software, or on a system computer, a certain amount of disk space is allocated (usually 20 GB). As the analyzers process slides, images and order data are stored in the database.
PM-10910-01
Revised: 2020-11-04
53
7 Database size management
When the allocated space is used up, the database engine starts to allocate more disk space to enable storage of data from further processed slides. As slide processing continues, also the database size continues to grow in size. This can make the analyzer slow and sluggish and, eventually, no disk space is left.
To keep the database from growing, set up a configuration to automatically remove data from the database at the same rate as new slides are processed.
You can set up a configuration to remove data from the database either using the auto-delete or the archiving function. The option to choose depends mainly on how many days the lab needs to save signed orders in the database.
Auto-delete
The easiest way is to set up a configuration to automatically delete signed orders from the database after a certain number of days.
After the time has passed, the signed order with order data and images is automatically deleted from the database.
The exact time varies depending on how many slides you process each day and what analyses you perform on the slides.
To calculate how many days the signed orders can be kept in the
database, see 7.2 Calculate database storage capacity on the facing page.
To enable auto-delete, see 7.3 Enable auto-delete for images and results on page 59.
Archiving
If the lab needs to keep signed orders in the database for a longer time, you can use the archiving function. This is more complicated to set up, but it allows you to keep signed orders with order data and images for as long as you can supply storage space.
When you use the archiving function, the order data always remains in the database, but images that belong to the order are moved to a different location. You can still open and view the order from the CellaVision Remote Review Software or the CellaVision DM Software.
To enable archiving, see 7.4 Enable image archiving on page 59.
54 PM-10910-01
Revised: 2020-11-04
7 Database size management
Tasks
l
Investigate how many days the lab needs to save signed orders in the database.
l
Estimate how many slides are processed each day.
l
Calculate if the database can save the signed orders for as long as the lab needs to or if you need to use the archiving function.
The maximum allowed size for the database is: o 200 GB for the CellaVision Server Software.
o 20 GB for a local database on a stand-alone system computer.
l
Enable either auto-delete or archiving.
o
To enable auto-delete, see 7.3 Enable auto-delete for images and results on page 59.
o
To enable archiving, see 7.4 Enable image archiving on page 59.
You can protect individual orders from being removed from the database. You can also manually export orders from the database. For more information, see the Instructions for Use for your analyzer.
If you let the database exceed the allowed size, you need to remove excess samples and compress the
database. For more information, see 7.5 Compress database on page 66.
7.2 Calculate database storage capacity
To configure the database size management correctly, you need to know how long the laboratory needs to keep signed orders (images, results, and order data from processed slides) in the database. You then need to estimate the daily throughput of the analyzer.
This table shows approximately how much data is added to the database for each processed slide, and how many orders you can store on a stand-alone analyzer, or on a server that runs the CellaVision Server
Software:
PM-10910-01
Revised: 2020-11-04
55
7 Database size management
Peripheral blood
l
CellaVision® DM1200
l
CellaVision® DM9600
l
Automated Digital Cell Morphology Analyzer DI-60
Analysis type
100 WBCs + RBC + PLT
200 WBCs + RBC + PLT
100 WBCs + Advanced RBC + PLT
200 WBCs + Advanced RBC + PLT
100 WBCs
200 WBCs
RBC + PLT
RBC only
PLT only
Data per slide
4 MB
7 MB
5 MB
8 MB
3 MB
6 MB
1 MB
1 MB
1 MB
Database capacity
Analyzer
1
(20 GB)
5 000 slides
Server
2
(200 GB)
50 000 slides
2 900 slides
4 000 slides
2 500 slides
6 700 slides
3 300 slides
20 000 slides
20 000 slides
20 000 slides
29 000 slides
40 000 slides
25 000 slides
67 000 slides
33 000 slides
200 000 slides
200 000 slides
200 000 slides
Peripheral blood
l
CellaVision® DC-1
Analysis type
100 WBCs + RBC + PLT
200 WBCs + RBC + PLT
100 WBCs
200 WBCs
RBC + PLT
RBC only
PLT only
Data per slide
16 MB
21 MB
5 MB
10 MB
11 MB
11 MB
11 MB
Database capacity
Analyzer
3
(20 GB)
1 200 slides
900 slides
4
Server
(200 GB)
12 000 slides
9 000 slides
4 000 slides
2 000 slides
1 800 slides
1 800 slides
1 800 slides
40 000 slides
20 000 slides
18 000 slides
18 000 slides
18 000 slides
1
Database located on the system computer
2
Using CellaVision Server Software
3
Database located on the system computer
4
Using CellaVision Server Software
56 PM-10910-01
Revised: 2020-11-04
7 Database size management
Body fluid
l
CellaVision® DM1200
l
CellaVision® DM9600
l
Automated Digital Cell Morphology Analyzer DI-60
Database capacity
Analysis type
100 WBCs
Data per slide
3 MB
Analyzer
(20 GB)
1
6 700 slides
Server
2
(200 GB)
67 000 slides
Overview image (6 mm, 10x)
Overview image (6 mm, 50x)
15 MB
130 MB
1 300 slides
150 slides
13 000 slides
1 500 slides
Calculate the daily contribution to the database:
Calculate if the database can store orders for as long as the laboratory requires: l
l
Enable archiving of orders as described in 7.4 Enable image archiving on page 59.
Example: a laboratory with one analyzer l
100 peripheral blood slides are processed each day.
l
100 WBCs and an RBC overview image are collected for each slide.
l
The analyzer is in operation 5 days a week.
l
The laboratory needs to have access to signed orders for 30 days.
l
The CellaVision DM Software manages the database located on the analyzer's system computer so the maximum database size is 20 GB.
Time until 20 GB is reached is 10 weeks, that is 70 days. This means that signed orders can be kept in the database for the required 30 days.
1
Database located on the system computer
2
Using CellaVision Server Software
PM-10910-01
Revised: 2020-11-04
57
58
7 Database size management
Recommended settings: l
Use the auto-delete function.
l
Set When signed orders are older than (days) to 30.
Signed orders older than 30 days are automatically deleted. The database won't grow in size because old orders are deleted at the same rate as new ones are processed.
For more information, see 7.3 Enable auto-delete for images and results on the facing page.
Example: a laboratory with five analyzers l
500 peripheral blood slides are processed each day (100 on each analyzer).
l
100 WBCs and an RBC overview image are collected for each slide.
l
The analyzers are in operation 5 days a week.
l
The laboratory needs to have access to signed orders for 60 days.
l
The CellaVision Server Software manages the database located on the server so the maximum database size is 200 GB.
Time until 200 GB is reached is 20 weeks, that is 140 days. This means that signed orders can be kept in the database for the required 60 days.
Recommended settings: l
Use the auto-delete function.
l
Set When signed orders are older than (days) to 60.
Signed orders older than 60 days are automatically deleted. The database won't grow in size because old orders are deleted at the same rate as new ones are processed.
For more information, see 7.3 Enable auto-delete for images and results on the facing page.
Example: a laboratory with five analyzers l
500 peripheral blood slides are processed each day (100 on each analyzer).
l
100 WBCs and an RBC overview image are collected for each slide.
l
The analyzers are in operation 5 days a week.
l
The laboratory needs to have access to signed orders for one year.
l
The CellaVision Server Software manages the database located on the server so the maximum database size is 200 GB.
PM-10910-01
Revised: 2020-11-04
7 Database size management
Time until 200 GB is reached is 20 weeks, that is 140 days. This means that signed orders can't be kept on the database for the required one year so old orders need to be archived after 140 days.
Recommended settings: l
Use the archiving function.
l
Set When signed orders are older than (days) to 140.
Images from signed orders older than 140 days are moved to the archive. Other order data remains in the database, and the orders can still be opened as before they were archived.
For more information, see 7.4 Enable image archiving below.
7.3 Enable auto-delete for images and results
If the laboratory doesn't require that signed orders are kept for a long time, select the auto-delete function.
On all databases where auto-delete is enabled, images and results of the oldest signed orders are automatically deleted.
For information on how long you can keep orders in the database when auto-delete is enabled, see 7.2
Calculate database storage capacity on page 55.
This is a database setting so you can change it from any system computer or from the CellaVision Server
Software. It affects all clients logged on to the database where the change is made, but it won’t affect any other databases.
If the laboratory wants to keep certain orders, you can protect them from being removed from the database. You can also manually export orders from the database to an export database. For more information about how to protect or export orders, see the Instructions for Use for your analyzer.
To set the auto-deletion of signed orders
1. On any of the analyzers or on the server, start the CellaVision DM Software or the CellaVision Server
Software and log on to the database as a user with access level administrator or service .
2. On the Tools menu, click Settings , and then click the Archiving/Auto-delete tab.
3. In the When signed orders are older than (days) text box, enter how many days you want to
4. Click Delete the orders , and then click Close .
7.4 Enable image archiving
If the laboratory requires that signed orders are kept for a long time, select the archiving function.
The archiving function moves the images of the oldest signed orders from the database to the specified location (typically on a server). No patient is stored on the archive.
PM-10910-01
Revised: 2020-11-04
59
7 Database size management
The archive can't locate on the system computer because the system computer does not have enough storage capacity.
The system computer, or the server that runs the CellaVision Server Software, that manages the database also manages the archiving. Since this is a database setting, you can change it from any system computer or from the CellaVision Server Software, it affects all clients that are logged on to the database where you change it but it doesn't affect other databases.
Important!
Backup the database and the archives at regular intervals. If the database is lost, you can no longer access images in the archive.
All information except images are kept in the database, and can still be searched and reported as before archiving. If a signed order is deleted, you can no longer access the archived images that belong to that order.
Only signed orders can be archived. Signed slides can't be archived if they belong to an order that isn’t signed.
Note: You can set the order to be signed when the slide is signed. For more information, see the
Instructions for Use.
To set the archiving of signed orders
1. On any of the analyzers or on the server, start the CellaVision DM Software or the CellaVision Server
Software and log on to the database as a user with access level administrator or service .
2. On the Tools menu, click Settings , and then click the Archiving/Auto-delete tab.
3. In the When signed orders are older than (days) text box, enter how many days you want to
keep the signed orders in the database before they are moved to the archive (as calculated in 7.2
Calculate database storage capacity on page 55).
4. Click Archive those orders .
5. In the Archive location text box, enter a path to the disk or server where you want to store the archived images. The archive can't be located on the system computer.
The path must be accessible from the system computer, or the server that runs the CellaVision Server
7.4.1
Set permissions to archive location
The account that runs CellaVision DM Software Service (Windows® Service Application component of the CellaVision DM Software and the CellaVision Server Software) must have Full control permission to the archiving location.
By default, CellaVision DM Software Service logs on as the Local System Account. This means that it can most likely archive to local devices, such as a secondary hard disk or an external hard disk.
To archive to a location where the Local System Account doesn’t have Full control permission, for example a network location, you can specify another user account that the CellaVision DM Software
60 PM-10910-01
Revised: 2020-11-04
7 Database size management
Service can use to log on. Make sure that this user is also a local administrator on the system computer or on the server that runs the CellaVision Server Software.
To change the user account that the CellaVision DM Software
Service uses to log on
1. On the system computer, or on the server that runs the CellaVision Server Software and where the database is located, click Start , type services.msc
, and then click services.msc
.
2. In the Services (Local) list, right-click CellaVision DM Software Service , and then click
Properties .
3. Click the Log On tab.
4. Click This account , click Browse , specify a user account in the Select User dialog box, and then click OK .
5. Type the password for the user account in the Password text box and in the Confirm password text box, and then click OK .
6. In the Services (Local) list, right-click CellaVision DM Software Service , and then click Restart .
7.4.2
Reduce archive size
To reduce the archive size, you can save fewer images in the archive. For example, you can choose to save 10 images per cell class and have the rest of the images deleted.
To select images to archive
1. On any of the system computers or on the server, start the CellaVision DM Software or the
CellaVision Server Software and log on to the database as a user with access level administrator or service .
2. On the Tools menu, click Settings , and then click the Archiving/Auto-delete tab.
3. Under Images to archive , choose what images and how many from each cell class you want to save in the archive.
PM-10910-01
Revised: 2020-11-04
61
7 Database size management
Peripheral blood cell images
Normal WBCs Abnormal WBCs
Segmented neutrophils
Eosinophils
Basophils
Lymphocytes
Monocytes
Band neutrophils
Promyelocytes
Myelocytes
Metamyelocytes
Immature eosinophils
Immature basophils
Promonocytes
Prolymphocytes
Blast cells
Lymphocytes, variant forms
Reactive lymphocytes
Abnormal lymphocytes
Plasma cells
Large granular lymphocytes
Hairy cells
Sezary cells
User defined WBCs
Body fluid cell images
WBCs
Neutrophils
Lymphocytes
Eosinophils
Macrophages
User defined WBCs
Other
Non-WBCs
Artefacts
Smudge cells
User defined Non-WBCs
Non-WBCs
Nucleated RBCs (NRBC)
Giant thrombocytes
Thrombocyte aggregation
Megakaryocytes
Smudge cells
Artefacts
User defined Non-WBCs
Other
Not classed
7.4.5
Open archived orders
You can open an archived order in the same way as you open a non-archived order. When you open an archived order, the CellaVision DM Software (stand-alone installation) or the CellaVision Server Software
(server installation) fetches the images that belong to that order from the archive. The
CellaVision DM Software or the CellaVision Server Software then sends the order, with order data and images, to the CellaVision Remote Review Software client.
62 PM-10910-01
Revised: 2020-11-04
7 Database size management
Server
CellaVision
Server
Software
Database
Archived order including images
Archived images
Review stations
Archive
The CellaVision Remote Review Software uses the same connection to the system computer or the server that runs the CellaVision Server Software to open both archived and non-archived orders so you don’t need any special configuration on the review stations to use the archiving function. The system computer, or the server that runs the CellaVision Server Software, manages all connections to the archive.
To find the images, the system computer, or the server that runs the CellaVision Server Software, goes through these locations in the given order:
1. The archive location that was used when the order was archived.
This is stored in the database together with the order data.
2. The archive location that is currently used.
3. The archiving locations specified in the Archiving Locations text file.
For more information, see 7.4.6 Move archive to new location below.
If the orders were archived with the CellaVision DM Software earlier than version 6.0, and the images
Archives from CellaVision DM Software earlier than version 6.0 on page 65.
7.4.6
Move archive to new location
If you want to move the archive to a new location, you need to configure the CellaVision Server Software or the CellaVision DM Software to find the archived images as described here.
To move the existing archive to a new location and start archiving new images there
1. To find the archive location, see 7.4.7 Back up archive on the next page.
2. Write down the path to the old location from the Archive location text box. You need this path later to locate and move the archived files.
PM-10910-01
Revised: 2020-11-04
63
7 Database size management
3. Enter the path to the new location in the Archive location
text box as described in To set the archiving of signed orders on page 60.
4. Exit the CellaVision Server Software or the CellaVision DM Software.
5. Move all content from the old location to the new location.
To keep the existing archive and start archiving new images to a new location
Enter the path to the new location in the Archive location
text box as described in To set the archiving of signed orders on page 60.
To move the existing archive to a new location and start archiving new images to the old location
Note: This only applies to archives created with CellaVision Server Software or CellaVision DM Software version 6 or later.
1. On the system computer, or the server that runs the CellaVision Server Software, where the database is located, open text file C:\Program Files
(x86)\CellaVision\BloodDifferential\bin\ArchivingLocations.txt
2. In the text file, enter the path to the location where you want to move the archive.
If you need to enter more than one path, make a new line for each path, for example:
\\fileserver01\CellaVisionDM\Archive\
\\fileserver02\CellaVisionDM\Archive\
\\fileserver03\CellaVisionDM\Archive\
3. Save the text file.
4. Move all content from the old location to the new location.
5. Restart the CellaVision DM Software and the CellaVision Server Software.
7.4.7
Back up archive
It’s important that to make regular backups of the archive. If the archive is lost, you can't open the archived orders anymore.
To back up the archive
Set regular backups of the contents in the archive location.
Note: Different databases may use different archive locations.
To find the archive location
1. On the system computer or the server, start the CellaVision DM Software or the CellaVision Server
Software and log on to the database as a user with access level administrator or service .
64 PM-10910-01
Revised: 2020-11-04
7 Database size management
2. On the Tools menu, click Settings , and then click the Archiving/Auto-delete tab.
3. The archive location is displayed in the Archive location text box.
Note: The archive location always points to the system computer (stand-alone installation), or the server that runs the CellaVision Server Software (server installation), that manages the database.
7.4.8
Archives from CellaVision DM Software earlier than version 6.0
In CellaVision DM Software versions earlier than 6.0, the archived images are stored in a Microsoft®
Access database format. Each archiving session generates new Microsoft® Access databases, with a maximum size of 1 GB each, on the specified media. The Access database file name consists of the creation date and an index number, for example 20141231_1556.mdb
. The file is stored in the specified location on a file server or is burned to a CD. The CellaVision DM Software automatically keeps track of the database where the images of each order are archived.
The file name and, if archiving to a file server, the absolute path to the archive are stored in the database for each archived order. Changing the archive location doesn't affect orders that are archived from
CellaVision DM Software version earlier than 6.0.
To access images archived from CellaVision DM Software earlier than version 6.0
To access archived images, the review station or the system computer must have access to the database where the images were originally stored. When you open an archived order, the absolute path stored in the database is used to find the archive database file. All review stations and system computers that need to access the archives must have a common path to the archive. The DACLs (Discretionary Access
Control List) for the archive must be configured accordingly.
CellaVision analyzer
\\server\folder\
CDMS
System computer Analyzer
CellaVision analyzer
Review Station
Archive
CDMS
System computer Analyzer
\\server\folder\
Review Station
PM-10910-01
Revised: 2020-11-04
65
7 Database size management
When you open an order that is archived to a file server from a system computer or a review station, it first attempts to find the archive in the absolute path that was stored in the database when the order was archived. For example, \\fileserver\folder\20141231_1556.mdb
If the attempt fails, you are prompted to specify a path to the archive. This path is saved locally so it is not updated in the database. The next time you try to open an archived order from the same system computer or review station, it attempts to find the archive both in the original path and in the path you specified the last time you opened the order.
Note: It is not possible to access directly the Microsoft® Access database that contains the archived images.
7.5 Compress database
When images are removed from the database either manually or through auto-delete or archiving, the database still allocates the same amount of drive space. You can free this drive space, that is, reduce the size of the file where the data is stored, by compressing the database.
When new slides are processed, the database first uses the space that is already allocated. Therefore, it is generally only necessary to compress the database when it exceeds the allowed size.
Note: You must also make sure that you have set to maintain the database size either through auto-delete or archiving.
Otherwise, the database might grow too large again.
You can also compress the database if you need to free up drive space.
Database size
Data
To compress a database
1. On the system computer or server where the database is located, start the CellaVision DM Software or the CellaVision Server Software.
2. Log on to another database, other than the one you want to compress, as a user with access level
Administrator or Service .
3. On the Tools menu, click Settings , and then click the Database tab.
4. In the Database list , click the database you want to compress, and then click Compress .
5. In the Compress database dialog, make sure that the value for Available on harddisk is at least the same as Original size .
6. Click Compress database .
If the disk is full, you can temporarily move the database to an external disk that has enough free space.
You then need to temporarily map the database to its new location using Mimer Administrator
( Start > Programs > Mimer SQL Engine ). Once you have compressed the database in its temporary location, move it back to its original location.
Note: Compressing the database can take some time, and you can't process slides during this time.
66 PM-10910-01
Revised: 2020-11-04
8 Backup and restore
8 BACKUP AND RESTORE
This chapter describes how to back up and restore databases. This is only covered from the point of view of the analyzer or the server that runs the CellaVision Server Software. Backing up files, that is, copying them from the system computer or the server that runs the CellaVision Server Software, to a different location using third party software or hardware is not covered.
We recommend that you always keep a backup of the databases and archives.
The way to set up the backup depends on: l
Where the database is located.
l
How important the images and results are.
l
How much data the laboratory can afford to lose in case of hard disk failure.
Back up the following: l
Databases l
Archives l
Software license files
You need to back up the databases and archives at regular intervals, but the software license files only once.
For information about how to back up the archives, see 7.4.7 Back up archive on page 64.
Note: When you have implemented a backup method, we recommended that you try to restore a copy of the database from a backup, and write down a routine on how to restore the database from a backup. This is to verify that you have tested the backup method, and have a restoration process in place should the need arise.
8.1 Database backup
Important!
Always keep the backup on a different physical disk, and preferably in a different physical location, than where the databank files are stored.
You can do database back up via: l
System backup that backs up the databank files from the host operating system. Use the host operating system tools or third party tools to copy the databank files to a different location. To keep the database consistent, stop the server that runs the CellaVision Server Software while the backup is performed.
PM-10910-01
Revised: 2020-11-04
67
8 Backup and restore l
Online backup that uses the SQL system management statements to back up the database. The main advantage of the online backup is that the backup is performed in the background while the database engine is running. So the server that runs the CellaVision Server Software can continue to operate and the database is accessible during the backup operation. For information about how to perform an
online backup, see 8.1.2 Run online backup script below.
We recommend that you schedule regular backups at a time of low workload. This is because the backup process can temporarily reduce the system performance.
By default, the database engine doesn’t store transaction logging so in the case of a disk failure, you can restore the database only to the time of the latest backup. If you need to restore data until the moment of disk failure, you must enable transaction logging (the LOG option) for the user databank. For more
information about transaction logging, see 8.3 Database transaction logging on page 74.
After the backup is performed, you should clear the updates logged for the databank from LOGDB. You should check the databanks with the databank check (DBC) utility to verify physical consistency. If you use the online backup script, this is done automatically. For information about how to use the DBC
utilty, see 8.4.3 Databank check utility on page 83.
8.1.1
Perform system backup
To perform a system backup, stop the Windows® Service Application (named MIMER -database_name ) that manages the database, and then copy the five databank files (.dbf) that contain the database. After this, restart the service.
To stop and start the service, you can use either the built-in functionality in Windows® (the Windows®
Service Application or the command-line tools) or the Mimer Administrator.
How you set up the system backup depends on your system configuration. For more information, refer to the documentation for your operating system and backup tool.
You can find full documentation for the Mimer SQL Engine on the Mimer developer website.
8.1.2
Run online backup script
CellaVision AB provides an example online backup script (online.bat) that is available at www.cellavision.com.
Important!
To prevent any data loss, always use the latest online backup script available at www.cellavision.com.
REM **********************Information**********************
REM This script will make an online backup of the CellaVision databases that you specify. It will create the folder
"BackupPath"\"MimerDatabaseName" and place the backed files there.
To use the online backup script, you need to specify these parameters in the script (online.bat):
68 PM-10910-01
Revised: 2020-11-04
8 Backup and restore l
MimerDatabaseName
Name of the database or databases that you want to back up separated with a comma (,) and without spaces.
Example
SET MimerDatabaseName= Database1 , Database2 l
BackupPath
Path to the location where you want to store the backup. Each database is backed up to a subfolder that has the same name as the database.
The location must exist and be on a local drive. For example, you can't use a Windows® File Sharing location.
The location must have free space that equals twice the database size.
The person who runs the backup script must have read and write privileges to the location.
If your system computer has both a solid state drive and a hard disk drive, we recommend that you use a location on the hard disk drive for the backup (drive D).
If your system computer has only a hard disk drive, you can use a location on drive E for the backup.
In that case, it is important that you copy the backup files to a different location.
Example
SET BackupPath=D:\ Backup l
LogFilePath
Path to the location where you want to store the log files that the backup script generates.
The location must exist and be on a local drive.
The person who runs the backup script must have read and write privileges to the location.
The log file name is named databasename _backup.log
Example
SET LogFilePath=D:\ Backup
Important!
Before using the backup script in a live production environment, test it on a copy of your database or on a temporary database. Make sure that both the backup and the restore functions work as intended. A faulty backup script can cause loss of data.
PM-10910-01
Revised: 2020-11-04
69
8 Backup and restore
To edit the backup script
Open online.bat in a text editor, and replace the placeholder parameters with the correct parameters for your installation.
Here is an extract from the online.bat file. The parameters to be changed are highlighted in italics .
Note: Do not edit the script in any other way.
REM ********************Configuration********************
REM MimerDatabaseName specifies each database to backup.
REM Separate each database with ',' use no spaces.
SET MimerDatabaseName= DatabaseName1 , DatabaseName2
REM BackupPath specifies the path where the backed files will be placed.
SET BackupPath= PathToBackuproot
REM LogFile specifies the path to the backup logfile.
SET LogFilePath= PathToBackuplog
REM ********************End config***********************
The online backup script creates a subfolder for each database in the BackupPath . It then creates a backup copy of each databank, but with file extension .bku instead of .dbf. For example, folder
D:\backup\DatabaseName\ contains databank files named sysdb.bku, ciimg.bku, and so on.
The online backup script always overwrites .bku files generated in the previous backup session. If you need to keep a backup history, you must copy the existing backup files (.bku) to a different location before you perform a new backup.
By default, the database engine doesn’t store transaction logging. This means that in case of disk failure, you can only restore the database to the time of latest backup. If you need to restore data until the moment of disk failure, you must enable transaction logging (the LOG option) for the user databank. For
more information about transaction logging, see 8.3 Database transaction logging on page 74.
8.1.3
Verify online backup
To verify that the online backup script functions correctly, you need to regularly review the log files.
The online backup script generates two log files: l
DatabaseName _backup.log
l
DatabaseName _dbc.log
Every time a backup is made, the result is appended to DatabaseName _backup.log. A simple log rotation scheme is implemented in the backup script, so when the DatabaseName _backup.log gets larger than
100 kB, it is renamed to DatabaseName _backup.bak, and any existing .bak file is overwritten.
The DatabaseName _dbc.log is overwritten at each backup session.
In the DatabaseName _backup.log, the last line provides the overall status of the database backup. It can read one of the following:
70 PM-10910-01
Revised: 2020-11-04
8 Backup and restore
**** BACKUP OF DatabaseName WERE SUCCESSFULL AT 2019-07-12 14:18:50.37
****
**** BACKUP OF DatabaseName ENDED WITH A WARNING AT 2019-07-12 14:18:50.37
****
**************** ERROR ABORTING BACKUP OF DatabaseName *****************
If the backup generates a warning or an error, view the log file to determine the cause.
If the database check (DBC marked in green in the below backup log) generates an error in the backup log, the DatabaseName _dbc.log may be of interest to service personnel.
PM-10910-01
Revised: 2020-11-04
71
8 Backup and restore
Example
************START BACKUP OF: DatabaseName AT 2019-07-12 14:18:48.84 *************
14:18:48.84 Verifying that no previous temporary backup directory exists.
14:18:48.84 No temp directory exists.
14:18:48.84 Check if it is possible to create/remove a temporary file/folder.
14:18:48.85 Successfully created a temporary file/folder.
14:18:48.85 Check if BSQL.EXE is in the path.
14:18:48.86 BSQL.EXE executed successfully.
14:18:48.86 Getting the Mimer database server version.
14:18:48.90 Mimer database server version=1000.022.
14:18:48.90 Successfully retreived the Mimer database server version.
14:18:48.90 Starting online backup.
14:18:49.40 Successfully commited the backup.
14:18:49.40 Running dbc to verify the integrity of each databank file.
14:18:49.40 dbc "D:\backup\ DatabaseName \tmp\ciimg.bku" "D:\logfiles\ DatabaseName _ dbc.log" "D:\backup\ DatabaseName \tmp\sysdb93.bku"
14:18:49.70 dbc "D:\backup\ DatabaseName \tmp\logdb.bku" "D:\logfiles\ DatabaseName _ dbc.log" "D:\backup\DatabaseName\tmp\sysdb93.bku"
14:18:49.72 dbc "D:\backup\ DatabaseName \tmp\sqldb.bku" "D:\logfiles\ DatabaseName _ dbc.log" "D:\backup\DatabaseName\tmp\sysdb93.bku"
14:18:49.74 dbc "D:\backup\ DatabaseName \tmp\sysdb93.bku" "D:\logfiles\ DatabaseName _ dbc.log" "D:\backup\ DatabaseName \tmp\sysdb93.bku"
14:18:50.30 dbc "D:\backup\ DatabaseName \tmp\transdb.bku" "D:\logfiles\ DatabaseName _ dbc.log" "D:\backup\DatabaseName\tmp\sysdb93.bku"
14:18:50.34 DBC successfully verified each file.
14:18:50.34 Deleting the previously backed files:"D:\backup\ DatabaseName \*.bku".
14:18:50.35 Successfully deleted the previously backed files.
14:18:50.35 Moving the temporary files from "D:\backup\ DatabaseName \tmp\*.bku" to
"D:\backup\ DatabaseName ".
14:18:50.35 Successfully moved the files.
14:18:50.35 Removing the temporary folder:"D:\backup\ DatabaseName \tmp".
14:18:50.37 Successfully removed the temporary folder.
****** BACKUP OF DatabaseName WERE SUCCESSFULL AT 2019-07-12 14:18:50.37 ********
8.2 Restore database
This chapter describes how to restore a database that was backed up without transaction logging.
Without the transaction logging data, you can restore the database only to the time of the latest backup.
72 PM-10910-01
Revised: 2020-11-04
8 Backup and restore
For information about how to restore a database that was backed up with transaction logging (LOG
Example
A complete back up is taken. The analyzer then runs until Disk 1 fails. You can restore the database to the time of the latest backup, but all other transactions (for example processed slides) done after that time are lost.
Time
Complete backup
Disk 1
SYSDB
CIIMG
LOGDB
TRANSDB
Transaction
Disk 1
Backup
Disk 2
Transaction Disk failure
Disk 1 Disk 1
To restore a database without transaction logging
1. Depending on what caused the failure, do one of the following: l
If the disk failed, change the disk.
l
If the database failed, delete the database. For more information, see the Instructions for Use for your analyzer.
2. To manage databases, start the CellaVision DM Software with access level administrator .
3. Create a new database with the same database name as before the disk failed. For more information, see the Instructions for Use for your analyzer.
4. To start Mimer Administrator, click the Start button, type Mimer , and then click Mimer
Administrator .
5. Right-click the database, and then click Stop server .
6. Open the folder that contains the new databank files (path to folder is displayed in the Home
Directory column).
7. In the home directory, delete all databank files (.dbf).
8. Copy the databanks from the backup to the home directory.
PM-10910-01
Revised: 2020-11-04
73
8 Backup and restore
9. Change the file name extension on the databanks from .bku to .dbf
10. Right-click the database, and then click Start server .
11. Restart the system computer or the server that runs the CellaVision Server Software.
8.3 Database transaction logging
If you need to be able to restore the database until the moment of failure, you must activate transaction logging (LOG option) for the CIIMG databank. You must also make sure that the LOGDB and TRANSDB databanks are stored in a different location, that is, on a different physical disk than the SYSDB and
CIIMG databanks.
Note: Do not move any databanks to the C drive. On the system computer, the C drive and the E drive are located on the same physical disc. Also, if the C drive becomes full, you can no longer use the analyzer.
Note:
Note: If you have activated transaction logging, you must use the online backup script regularly to back up the database. If you don't do this, the LOGDB will grow very big.
Some system computers have an extra physical disk (D drive). You can use this disk to store the LOGDB and TRANSDB.
For more information about databanks and databank files, see 8.4 Mimer SQL databanks on page 81.
When you have activated transaction logging, every transaction to the database since the last backup, is stored in the LOGDB and TRANSDB. The results of the transactions are stored in the CIIMG in the same way as when transaction logging is turned off.
In case of disk failure, you can restore the database from the latest backup together with either the
LOGDB and TRANSDB, or the SYSDB and CIIMG.
74 PM-10910-01
Revised: 2020-11-04
8 Backup and restore
Time
Complete backup
Disk 1
SYSDB
CIIMG
Disk 2
LOGDB
TRANSDB
Transaction
Disk 1
Disk 2
Disk 3
Backup
Transaction Transaction
Disk 1
Disk 2
Disk 1
Disk 2
For each transaction, redundant data is written to both Disk 1 and Disk 2.
PM-10910-01
Revised: 2020-11-04
75
8 Backup and restore
Example l
SYSDB and CIIMG are located on Disk 1.
l
LOGDB and TRANSDB are located on Disk 2.
l
A backup of all databanks is made to Disk 3.
l
After the backup, all transactions are logged to LOGDB on Disk 2 l
Disk 1 fails and all the databanks on that disk are lost.
Time
Complete backup
Disk 1
SYSDB
CIIMG
Disk 2
LOGDB
TRANSDB
Transaction
Disk 1
Disk 2
Disk 3
Backup
Transaction Disk failure
Disk 1
Disk 2
Disk 1
Disk 2
When Disk 1 fails, data on Disk 2 and Disk 3 can be used to restore the database.
Once you have changed Disk 1, you can use the backup on Disk 3 and the LOGDB and TRANSDB on
Disk 2 to recreate the lost databanks.
If Disk 2 fails instead, you can use the SYSDB and CIIMG on Disk 1 to restore the LOGDB and
TRANSDB once you have changed Disk 2.
For information about how to restore the database when LOGDB and TRANSDB databanks are lost,
see 8.3.1 Restore database after LOGDB and TRANSDB are lost on page 78.
To enable transaction logging
1. Click the Start button, type cmd and then click cmd.exe
.
2. In the command prompt, type BSQL database_name
76 PM-10910-01
Revised: 2020-11-04
8 Backup and restore
3. Log on to the database with these credentials: l
User name: SYSADM l
Password: n3u7r1
4. In the SQL command prompt, type ALTER DATABANK CIIMG TO LOG OPTION;
5. To verify, type SELECT DATABANK_NAME || '=' || DATABANK_TYPE FROM
SYSTEM.DATABANKS WHERE DATABANK_NAME='CIIMG';
If the operation is successful, the output is CIIMG=LOG
To move the LOGDB and TRANSDB to a different location
1. Click the Start button, type Mimer , and then click Mimer Administrator .
2. Right-click the database, and then click Stop server .
3. Open the folder that contains the databank files (path to folder is displayed in the Home Directory column).
4. Move the transdb.dbf and logdb.dbf files to the new location.
Note: The new location must be on a different physical disk. Do not move the files to the C drive.
Note: Compression of the database in the CellaVision DM Software doesn't work if LOGDB and
TRANSDB are moved to a different location.
5. Right-click the database, and then click Start server .
6. Click the Start button, type cmd and then click cmd.exe
.
7. In the command prompt, type BSQL database_name
8. Log on to the database with these credentials: l
User name: SYSADM l
Password: n3u7r1
9. When asked to redefine either of the databanks, press Y (yes).
10. When asked to create a new or alter the existing file name, press A (alter).
11. In the New filename prompt, type the complete path (including file name) to the file's new location.
For example:
F:\CellaVisionDM\db_log\transdb.dbf
12. Repeat the steps for the next databank file.
PM-10910-01
Revised: 2020-11-04
77
8 Backup and restore
8.3.1
Restore database after LOGDB and TRANSDB are lost
Example
In this example, a complete backup is made to Disk 3. After that, all transactions are written to the
CIIMG on Disk 1, and also logged to the LOGDB and TRANSDB on Disk2.
When Disk 2 fails, the LOGDB and TRANSDB are lost.
Once you have changed Disk 2, you can restore the LOGDB and TRANSDB using the CIIMG and
SYSDB on Disk 1.
Time
Complete backup
Disk 1
SYSDB
CIIMG
Disk 2
LOGDB
TRANSDB
Transaction
Disk 1
Disk 2
Backup
Disk 3
Transaction Disk failure
Disk 1
Disk 2
Disk 1
Disk 2
If Disk 2 fails, the LOGDB and TRANSDB can be recreated using data on Disk 1.
To restore a database when LOGDB and TRANSDB are lost
1. If the disk failed, change it.
2. On the new disk, create a folder where you want to store the LOGDB and TRANDB. Make sure that the path to the folder is exactly the same as before the disk failed.
3. Click the Start button, type Mimer , and then click Mimer Administrator .
4. Right-click the database, and then click Start server .
5. Click the Start button, type cmd and then click cmd.exe
.
6. In the command prompt, type BSQL database_name
78 PM-10910-01
Revised: 2020-11-04
8 Backup and restore
7. Log on to the database with these credentials: l
User name: SYSADM l
Password: n3u7r1
8. When asked to redefine either of the databanks, press Y (yes).
9. When asked to create a new or alter the existing file name, press C (create).
10. Accept the default size.
11. Repeat the steps for the next databank file.
12. Make a backup of the database.
8.3.2
Restore database after user databanks are lost
Caution!
When you restore the databanks as described here, make sure not to overwrite the LOGDB and TRANSDB as they are needed to recover the user databanks.
PM-10910-01
Revised: 2020-11-04
79
8 Backup and restore
Example
In this example, a complete backup is made to Disk 3. After that, all transactions are written to the
CIIMG on Disk 1, and also logged to the LOGDB and TRANSDB on Disk 2.
When Disk 1 fails, the SYSDB and CIIMG are lost.
Once you have changed Disk 1, you can restore the database from the time of the failure using the backup on Disk 3 and the LOGDB and TRANSDB on Disk 2.
Time
Complete backup
Disk 1
SYSDB
CIIMG
Disk 2
LOGDB
TRANSDB
Transaction
Disk 1
Disk 2
Backup
Disk 3
Transaction Disk failure
Disk 1
Disk 2
Disk 1
Disk 2
If Disk 1 fails, the database can be restored using log data on Disk 2 and the backup on Disk 3.
To restore a database when user databanks are lost or corrupted
1. If the disk failed, change it.
2. To manage databases, start the CellaVision DM Software with access level administrator .
3. Create a new database with the same database name as before the disk failed. For more information, see the Instructions for Use for your analyzer.
4. Click the Start button, type Mimer , and then click Mimer Administrator .
5. Right-click the database, and then click Stop server .
6. Open the folder that contains the new databank files (path to folder is displayed in the Home
Directory column).
7. In the home directory, delete all databank files (.dbf).
80 PM-10910-01
Revised: 2020-11-04
8 Backup and restore
8. Copy the CIIMG, SQLDB and SYSDB from the backup to the home directory.
Important!
Do not copy the LOGDB or TRANSDB.
9. Change the file name extension on the databanks from .bku to .dbf
10. Make sure that the LOGDB and TRANSDB are located in the same path as they were before the disk failure.
11. In Mimer Administrator, right-click the database, and then click Start server .
12. Click the Start button, type cmd and then click cmd.exe
.
13. In the command prompt, type BSQL database_name
14. Log on to the database with these credentials: l
User name: SYSADM l
Password: n3u7r1
15. When you log on, you get this output from BSQL:
MIMER/DB fatal error -16159 in function CONNECT…
16. To restore SYSDB, press Y (yes).
17. In the SQL command prompt, type ALTER DATABANK CIIMG RESTORE USING LOG;
18. In Mimer Administrator, right-click the database and click Stop server . Then right-click the database again, and click Start server . This restores the database from the time of the disk failure.
19. Make a backup of the database.
8.4 Mimer SQL databanks
This chapter describes how databases are stored on the system computer or the server that runs the
CellaVision Server Software.
The Mimer SQL Engine uses databank files (.dbf) to store the database and its content. Databank are physical files that store a collection of tables. There are two types of databanks: system and user.
System databanks are defined when the system is created. They contain system information that the database manager uses: l
SYSDB contains the data dictionary tables.
l
TRANSDB is used for transaction handling.
l
LOGDB is used for transaction logging.
l
SQLDB is used for transaction handling and for temporary storage of internal work tables.
User databank contains user tables, that is, order data, images, and results:
PM-10910-01
Revised: 2020-11-04
81
8 Backup and restore l
CIIMG
You can find full documentation for the Mimer SQL Engine on the Mimer developer website.
8.4.1
Databank location
By default, databank files are located under E:\ database_name \ on the system computer. You can choose a different location when you create a database or move one or more of the databank files to a different location. You can use Mimer Administrator and the BSQL command line tool to find the databank file location.
To locate databank files
1. Click the Start button, type Mimer , and then click Mimer Administrator .
2. In the Home Directory column, you can see the home directory for each database. The SYSDB is always stored in this directory.
3. Click the Start button, type cmd and then click cmd.exe
.
4. In the command prompt, type BSQL database_name
5. Log on to the database with the these credentials: l
User name: SYSADM l
Password: n3u7r1
6. In the SQL command prompt, type SELECT DATABANK_NAME || '=' || DATABANK_FILENAME
FROM SYSTEM.DATABANKS; . The location of each databank is displayed relative to the home directory.
Example
TRANSDB=transdb.dbf
the TRANSDB databank is located in the home directory.
TRANSDB=F:\CellaVisionDM\db_log\transdb.dbf
the TRANSDB databank is located in F:\CellaVisionDM\db_log\
TRANSDB=..\log\transdb.dbf
the TRANSDB databank is located in the folder log, one level up from the the home directory.
This is not recommended!
82 PM-10910-01
Revised: 2020-11-04
8 Backup and restore
8.4.2
Databank options
Databanks may be defined with LOG , TRANS or NULL options, which determine transaction handling and logging behavior: l
LOG — All operations on the databank are performed under transaction control. All transactions are logged.
l
TRANS — All operations on the databank are performed under transaction control. No transactions are logged.
l
NULL — All operations on the databank are performed without transaction control (even if they are requested within a transaction), and they are not logged.
Logging is set per databank and the default settings are: l
SYSDB = LOG l
TRANSDB = TRANS l
LOGDB = LOG l
SQLDB = WORK l
CIIMG = TRANS
To store transaction logging data, you can change the CIIMG (user databank) setting to LOG.
For more information about transaction logging, see 8.3 Database transaction logging on page 74.
8.4.3
Databank check utility
Databank check (DBC) is a command line utility that lets you check the physical structure of the databank files. We recommend that you run DBC after each backup to make sure that the backed up databanks are valid.
automatically.
Note: DBC checks only the physical condition of the databank. It doesn't detect informational errors such as data inconsistency or invalid data formats.
To check databanks with DBC
1. Open a command prompt, and go to the directory that contains the databank files you want to check.
In Mimer Administrator, the path to this folder is displayed in the Home Directory column.
If you want to run DBC on your backup, those databank files are in your backup directory.
Note: If you use database transaction logging, the LOGDB and TRANSDB are in a different directory than the Home Directory.
2. In the command prompt, type dbc databank_filename.dbf
. DBC checks the physical structure of the databank. If it's OK, you receive the "No errors found" message.
PM-10910-01
Revised: 2020-11-04
83
8 Backup and restore
3. Repeat the procedure for all databank files.
You can find full documentation for the Databank check utility (DBC) on the Mimer developer website.
84 PM-10910-01
Revised: 2020-11-04
9 System customization
9 SYSTEM CUSTOMIZATION
This chapter describes how to change certain advanced settings in your system setup. As a general rule, these settings should be made during installation or commissioning, and they shouldn't be changed once the system is up and running.
For information about settings that the user can change, see the Instructions for Use for your analyzer.
For more information about the following settings, see the LIS Interface Manual: l
Add/Edit WBC Class names l
Change Mark for Pathology Review Option l
Add/Edit RBC Morphologies l
Edit Macrophage display name l
Adjust total WBC (%) to exactly 100%
9.1 Change system serial number
The system serial number is set by default for your analyzer. If you change the system computer, you need to set the serial number. If you enable analyzers to send their own processed slides to the LIS, make sure that the system serial number is correct for each analyzer.
To change the system serial number
1. Click the Start button, type dmconf , and then click DMConfiguration .
2. In the DM Configuration Tool dialog, type the service password cv2864400 and click OK .
3. On the Tasks list, under Hardware , click System serial number .
4. In the System serial number text box, enter the serial number.
5. Click Submit .
6. Restart the CellaVision DM Software.
9.2 Change laboratory name
The laboratory name is a free-text metadata that is attached to each slide processed on the analyzer.
This information can be useful, for example, if you need to find slides processed in a specific lab.
Note: This is a local setting so you need to set it up separately on every analyzer where you want to use it.
PM-10910-01
Revised: 2020-11-04
85
9 System customization
To change the laboratory name
1. Click the Start button, type dmconf , and then click DMConfiguration .
2. In the DM Configuration Tool dialog, type the service password cv2864400 and click OK .
3. On the Tasks list, under Hardware , click Laboratory Name .
4. In the Laboratory Name text box, type the name you want to use.
5. Click Submit .
9.3 Change image mode
Image mode changes the visual appearance of peripheral blood images and body fluid images presented to the user. The pre-classification is not affected.
There are two types of image modes available: l
Standard Mode which gives generally colder colors.
l
Hedlund-Morell Mode which gives warmer and more rich colors with less noise. Normalization parameters are adapted to image content to provide maximum clarity to each part of the image.
Note: This is a local setting so you need to set it up separately on every analyzer where you want to use it.
To change the image mode type
1. Click the Start button, type dmconf , and then click DMConfiguration .
2. In the DM Configuration Tool dialog, type the service password cv2864400 and click OK .
3. On the Tasks list, under Software , click Configure Image Mode
4. Click the image mode type you want to use, and then click Submit .
9.4 Run external program from CellaVision software
You can set the CellaVision DM Software and the CellaVision Remote Review Software to run an external program, for example a web browser, to view additional patient or order information from a different source.
You can configure the program to start automatically when an order is opened, or add a button to the toolbar so that the user can start the program manually.
Note: This is a local setting so you need to set it up separately on every analyzer where you want to use it.
86 PM-10910-01
Revised: 2020-11-04
9 System customization
To configure the software to run an external program
Caution!
Do not change the .reg file in any other way than described in this procedure. When you run the .reg file, its content is written to the Windows® Registry. If you modify the Windows®
Registry incorrectly, it may case serious problems.
1. Log on to Windows® with these credentials:
User name: administrator
Password: cv2864400
2. Locate and make a copy of this file:
C:\Program Files (x86)\CellaVision\BloodDifferential\data\ExternalToolExample.reg
3. Give the copied file a descriptive name, for example PatientInfoViewer.reg
4. Open the .reg file in a text editor.
5. Change these values, and then save the .reg file:
Value
Name
FileName
Button
Description
Name of the button. This text is displayed as a tool tip.
Full path to the program you want to run.
Note: You must use escaped backslashes (that is, double backslashes \\) in the path.
0 - No button is added to the toolbar.
1 - Button is added to the toolbar.
AutoLaunch 0 - Program doesn't start automatically when an order is opened.
1 - Program starts automatically when an order is opened.
Parameters Command line options that are sent to the program.
For more information about parameters, see Parameters on the next page.
Example: Internet Explorer
In this example, a button is added to the toolbar in the CellaVision® software. When the user clicks the button, Internet Explorer opens a web page that shows data related to the order.
REGEDIT4
[HKEY_CLASSES_ROOT\Software\CellaVision\CBDSW\Components
\ExternalToolsClient\1]
"Name"=" Detailed Patient Info "
"FileName"=" C:\\Program Files\\Internet Explorer (x86) \\iexplore.exe
"
"Button"=dword:0000000 1
"AutoLaunch"=dword:0000000 0
PM-10910-01
Revised: 2020-11-04
87
9 System customization
"Parameters"=" http://hospital-intranet
/patient_view.aspx?order=%OrderId%
6. Double-click the .reg file, and when you receive the "Are you sure you want to continue?" message, click Yes .
7. When you receive the "The keys and values contained in C:\Program Files (x86)
\CellaVision\BloodDifferential\data\ YourRegistryFile .reg have been successfully added to the registry" message, click OK .
If you want to set up other systems or review stations, copy the .reg file to that computer and run it in the same way.
8. Start the CellaVision® software and verify that the external program launches as expected.
Parameters
You can send any command line options that the external program accepts. For more information about command line options, see the documentation for the program you want to use.
In the command line options, you can also use these variables:
%OrderId%
%PatientId%
Order ID of the order that is open when the user clicks the button.
Patient ID of the order that is open when the user clicks the button.
Note: The variables are case sensitive.
For example, to open web page "http://hospital-intranet/patient_view.aspx" in Internet Explorer with the order ID ( %OrderId% ) as parameter order , type in the parameters line as follows:
Example: Internet Explorer
"Parameters"=" http://hospital-intranet
/patient_view.aspx?order=%OrderId%
9.5 Configure Network Communication
Patient and order data is always encrypted when transferred between analyzers, review stations, and the database. To further protect the data, you can encrypt also the images. Image encryption can reduce network performance so it may take a longer time to open orders, especially with slower networks.
Image encryption is on by default but can turn it off.
To turn off image encryption
1. Turn off all review stations and analyzers (including system computers) before you change the setting.
88 PM-10910-01
Revised: 2020-11-04
9 System customization
2. On the computer that hosts the database, click the Start button, type dmconf , and then click
DMConfiguration .
3. In the DM Configuration Tool dialog, type the service password cv2864400 , and then click OK .
4. On the Tasks list, under Software , click Configure Network Communication .
5. Clear the selection for Encrypt images , and then click Submit .
6. Restart the computer.
PM-10910-01
Revised: 2020-11-04
89
10 Audit trail and usage log
10 AUDIT TRAIL AND USAGE LOG
The system continuously saves data from processed slides and stores it in a usage log. To view the log, start the CellaVision DM Software, click Tools , and then select View log .
Audit trail
l
User activity on a slide l
Setting is changed
Specification
This information is only accessible to users with access level administrator. Include dates and times for events that have occurred in the system, for example: l
Slide processing start l
Slide processing completion l
Hardware malfunctions
Statistics
Includes events that have occurred in the system, for example: l
Program installation dates and times l
Usage log modifications l
Number of successfully processed slides l
Number of failed slides l
Number of signed analyses l
Total processing time
PM-10910-01
Revised: 2020-11-04
91
11 Requirements and specifications
11 REQUIREMENTS AND SPECIFICATIONS
This chapter describes hardware and software requirements, system specifications, and performance data.
11.1 System computer
The system computer is delivered as a part of the analyzer.
Note: The system serial number is set by default. If you change the system computer, you need to use the DM Configuration Tool to update the system serial number.
11.1.1 Hard drive configuration
Depending on the system computer model, the main storage device is either a solid state drive or a hard disk drive. System computers with a solid state drive have an additional hard disk drive (D drive).
The main disk is divided into two partitions: C drive and E drive. The C drive contains the operating system (Windows®) and the CellaVision DM Software. The E drive should be used to store all databases
You can use the additional hard disk drive (D drive) for database backup, archiving, or extra storage.
Backup prevents loss of data in case of database failure or disk failure. If you need to protect data against other hazards, such as fire of theft, you must backup also to another location.
For more information on how to protect data, see 8 Backup and restore on page 67.
System computer
Solid state drive
C drive
Microsoft Windows
CellaVision DM Software
E drive
Databases
Hard disk drive
D drive
Backup (optional)
Archive (optional)
Optical drive
F drive
Schematic outline of drives and partitions on a system computer with a solid state drive and an additional hard disk drive.
Depending on the system computer model, the main storage device is either a solid state drive or a hard disk drive.
The main disk is divided into two partitions:
PM-10910-01
Revised: 2020-11-04
93
11 Requirements and specifications l
The C drive contains the operating system (Windows®) and the CellaVision DM Software.
l
The E drive (Windows 7) / D drive (Windows 10) should be used to store all databases unless they are
Backup prevents loss of data in case of database failure or disk failure. You can use the E drive (Windows
7) / D drive (Windows 10) for database backup. You can add an extra hard disk for database backup, archiving, and extra storage. Some system computers are delivered with an extra hard disk drive that is ready to use. If you need to protect data against other hazards, such as fire of theft, you must backup also to another location.
System computer
Hard disk drive
C drive
Microsoft Windows
CellaVision DM Software
D or E drive
Databases
Schematic outline of drives on a system computer.
11.1.2 Operating system
If you want to fetch user information from your active directory, you need to add the system computer to the domain.
Windows® 10
These analyzers support the BitLocker: l
CellaVision DM1200 l
CellaVision DM9600 l
Automated Digital Cell Morphology Analyzer DI-60
The system computer is configured with two user accounts with different permission levels: l
Administrator l
User
User name : administrator
Password : cv2864400
User name : cvuser
94 PM-10910-01
Revised: 2020-11-04
11 Requirements and specifications
Password : pass
The desktop contains a shortcut to the CellaVision DM Software.
To change the user, press Ctrl+Alt+Delete , and click Sign out . Select the desired user account and type the password.
To manage databases, you need to start the CellaVision DM Software with administrator privileges:
1. Log on as administrator on the system computer.
2. Right-click the CellaVision DM Software icon on the desktop, and select Run as administrator .
Windows® 7
The system computer is configured with a Windows® policy that restricts access to the operating system. When you start the system computer, Windows® automatically logs on to the default user account ( cvuser ), and starts the CellaVision DM Software. You can then log on to the desired database.
The system computer also has an administrator account. To log on with administrator privileges, use these credentials:
User name: administrator
Password: cv2864400
11.1.3 Anti-virus software and Windows® security patches
To install anti-virus software on the system computer, does not interfere with CellaVision DM Software or CellaVision Remote Review Software.
Configure firewall on page 30.
The system computer runs on Windows® 10 LTSB 2016, a locked version that is not possible to update.
You can install Windows security patches on the system computer.
11.1.4 User account control
User Account Control (UAC) is disabled on system computers that run Windows® 7.
11.2 CellaVision Server Software in server installation
These are the system requirements to run the CellaVision Server Software on a server:
PM-10910-01
Revised: 2020-11-04
95
11 Requirements and specifications
Specification
Server type
Operating system
Hardware configuration
Disk space
Disk speed
USB port
Disk encryption
Requirement
Physical or virtual server.
Windows® Server 2008 R2 (64 bit)
Windows® Server 2012 R2
Windows® Server 2016
Windows® Server 2019
According to the recommended system specification for the operating system.
200 GB for one database.
l
Another 200 GB for each additional processing database.
l
Another 20 GB to 200 GB for each scan database.
l
Minimum 1 GB for each export database.
l
Additional disks for backups and archives (if stored on the server).
See Hard disk data transfer rate below.
Access to a USB port if you install software from the CellaVision Software
Pack USB flash drive.
BitLocker supported on servers that run Windows® Server 2012 R2,
Windows® Server 2016, or Windows® Server 2019.
Note: Disk encryption may have a slight effect on system performance.
We recommend that you monitor the CPU performance on the server before and after you enable BitLocker.
Hard disk data transfer rate
The required hard disk data transfer rate depends on the number of analyzers and CellaVision Remote
Review Software users.
l
A setup with up to 10 analyzers and 10 simultaneous CellaVision Remote Review Software users requires approximately 70 IOPS (equivalent of a 7 200 RPM hard disk).
l
A setup with more analyzers and more CellaVision Remote Review Software users requires a higher data transfer rate (for example a RAID system or an SSD).
96 PM-10910-01
Revised: 2020-11-04
11 Requirements and specifications
Running 70 analyzers and 70 simultaneous CellaVision Remote Review Software users has been tested successfully on an SSD configuration capable of approximately 5 900 IOPS.
The IOPS values have been measured using Iometer version 2006.07.27 (http://www.iometer.org/) with these settings: l
100% 8k blocks l
67% reads l
100% random l
10 minutes duration
Note: The hard disk data transfer rate is also affected by the servers processing power, RAM, and so on.
11.3 CellaVision Remote Review Software in local installation
These are the system requirements to run the CellaVision Remote Review Software on a local PC:
Specification Requirement
Operating system Windows® 10 Pro and Enterprise editions
Windows® 8.1 Pro and Enterprise editions
Windows® 7 Professional, Enterprise and Ultimate editions
RAM
Disk space
Graphics RAM
Hardware configuration
Hardware license key port
USB port
Monitor
1 GB
1 GB
256 MB
According to the recommended system specification for the operating system.
Vacant USB port for hardware license key (for the CellaVision Remote Review
Software Professional Edition only).
Access to a USB port if you install software from the CellaVision Software Pack
USB flash drive.
See 11.5 Monitor for system computer and review station on page 99.
11.4 CellaVision Remote Review Software in Citrix®
XenApp™ server installation
These are the system requirements to run the CellaVision Remote Review Software in Citrix® XenApp™ server installation:
PM-10910-01
Revised: 2020-11-04
97
11 Requirements and specifications
Specification Requirement
Operating system
Windows® Server 2008 R2 (64 bit)
Windows® Server 2012 R2
Windows® Server 2016
Windows® Server 2019
6.0, 6.5, 7.x, 1912 LTSR, 1909, and 1906 Supported
XenApp™ versions
Disk space
Color depth
Hardware configuration
Network connection
Monitor
1 GB
At least 16-bit
According to the recommended system specification for the operating system.
High speed and low latency network connection between the XenApp™ server and the server that runs the CellaVision Server Software, or the system computer, hosting the database.
11.4.1 Tested XenApp™ server specifications
With 40 simultaneous users, the CPU usage was at 40% when tested on a virtual server set up of: l
Windows® 2008 R2 l
1 CPU with 4 cores l
16 GB RAM l
40 GB hard disk drive
Physical hardware: l
Dell PowerEdge R720xd l
1 Xeon E5-2665 @ 2.4 Ghz l
96 GB RAM
Application usage: l
100 WBC slides: 75 MB RAM per client l
200 WBC slides: 150 MB RAM per client
Memory use for the application is linear per client.
98 PM-10910-01
Revised: 2020-11-04
11 Requirements and specifications
11.5 Monitor for system computer and review station
We recommend that for system computers and review stations (including XenApp™ review stations), you use a high quality monitor of reputable brand with these specifications:
Specification Recommendation
Screen size
Resolution
Aspect ratio
Screen technology
Color
Mount
24 inch or larger
1920 × 1080 pixels or more
16:9
IPS or PLS
Color calibrated
Adjustable height and tilt
The system computer has these video outputs: l
VGA (VGA cable included) l
DisplayPort (DisplayPort to DVI-D cable included)
The embedded system computer in the CellaVision® DC-1 has these video outputs: l
DisplayPort l
HDMI
DisplayPort to DisplayPort or HDMI to HDMI cable recommended.
11.6 Network use for analyzer
An analyzer that has a throughput of 30 slides/hour (100 WBCs + Advanced RBC + PLT), sends each 5
MB record over a period of about 2 minutes. This results in an average network traffic load of less than
0.1 MB/s.
11.7 Network use and performance for review station
When a review station opens an order from the CellaVision Server Software, all images are copied to the
RAM on the review station. When the review is completed and the order is signed, a summary of the changes is sent back to the CellaVision Server Software. This data is then used to adjust the original record. The images are not sent back to the CellaVision Server Software.
For example, if a review is performed every two minutes, each record is 5 MB, and it takes about
10 seconds for each review station to open the record, the burst speed equals to 0.5 MB/s. The total traffic load depends on the type, use, and number of review stations.
The size of the images increases slightly for slides processed with the CellaVision Advanced
RBC Application.
PM-10910-01
Revised: 2020-11-04
99
11 Requirements and specifications
11.7.1 Open peripheral blood slide
The time it takes to open a slide depends on the bandwidth and latency between the CellaVision Remote
Review Software client and the server that runs the CellaVision Server Software or system computer that hosts the database.
If you run the CellaVision Remote Review Software on a Citrix® XenApp™ server, the time it takes to open a slide depends instead on the latency and bandwidth between the XenApp™ server and the server that runs the CellaVision Server Software, or the system computer, that hosts the database. Any latency between the XenApp™ server and the XenApp™ client can make the opening time longer.
Below is an indication of the average time it takes to remotely open a peripheral blood slide with 100
WBC, RBC, and PLT at various network speeds and latencies. The times increase slightly for slides processed with CellaVision Advanced RBC Application.
Note: To evaluate the latency of your network, always use the average value from at least 20 ping.
Average opening times with the CellaVision® DC-1:
Latency
Average time to open slide
100 Mbps 10 Mbps 3 Mbps 1.5 Mbps
0 ms
20 ms
2 s
4 s
40 ms
60 ms
9 s
11 s
100 ms 17 s
4 s
6 s
11 s
13 s
19 s
8 s
10 s
15 s
17 s
23 s
16 s
18 s
23 s
25 s
31 s
Average opening times with other CellaVision® analyzers:
Average time to open slide
Latency
100 Mbps 10 Mbps 3 Mbps 1.5 Mbps
0 ms
20 ms
1 s
2 s
40 ms 4 s
60 ms 5 s
100 ms 7 s
2 s
3 s
5 s
6 s
8 s
6 s
7 s
9 s
10 s
12 s
12 s
13 s
15 s
16 s
18 s
100 PM-10910-01
Revised: 2020-11-04
12 Troubleshooting
12 TROUBLESHOOTING
Issue
It takes a long time to open a slide from the
CellaVision Remote Review
Software.
It takes a long time (hours) to archive images.
Connection to the
CellaVision DM Software or the CellaVision Server
Software from the
CellaVision Remote Review
Software fails.
Cause
The review station has an old graphics driver. On-board graphic chips, such as the Intel GMA series, are sensitive to the driver used.
We recommended that you use a separate graphics adapter.
The network speed is only 10 Mbps. We recommend that you use a
100 Mbps switched Ethernet network.
There are too many simultaneous CellaVision Remote Review Software users reviewing slides from the CellaVision DM Software on the system computer. This limitation dependents on the used software version and on the connection bandwidth. Later software versions have a significantly better performance.
The database has corrupt orders. On the Tools menu, click Database
Analyzer , run the database analyzer and resolve corrupt orders.
Make sure you have typed in the correct database name and computer name (use an IP address if a DNS server is not used).
If you need to change the settings for an existing connection, see 6.1
CellaVision Remote Review Software on PC on page 47.
Make sure that the firewall software is correctly configured as
described in 4.2.2 Configure firewall on page 30.
Make sure that the CellaVision DM Software or the CellaVision Server
Software and the Mimer database service is started on the computer
where the database is located as described in 8.4 Mimer SQL databanks on page 81.
Make sure that you run the CellaVision Remote Review Software as a
Windows® administrator when you create a connection to a database.
PM-10910-01
Revised: 2020-11-04
101
Revision history
REVISION HISTORY
Revision 2020-11-04
Section
1.4 System and database settings on page 12
Change
Configure WBC analysis start position, added to the list under System settings.
7.2 Calculate database storage capacity on page 55
Analyzer-specific tables added for peripheral blood and body fluid analysis.
8.1.2 Run online backup script on page 68
Removed information about tested operating systems and revision date.
11.1.3 Anti-virus software and
Windows® security patches on page 95
Information added that Windows® 10 LTSB 2016 is a locked version that is not possible to update. Clarification that you can install Windows® security patches on the system computer.
Software in server installation on page 95
Windows® Server 2019 included as a supported operating system.
Citrix® XenApp™ server installation on page 97
Windows® Server 2019 included as a supported operating system. 1912
LTSR, 1909, and 1906 included as supported XenApp™ versions.
PM-10910-01
Revised: 2020-11-04
103
Revision history
Revision 2019-09-13
Section
1.4 System and database settings on page 12
Change
System and database settings restructured and updated.
Note added to indicate that some system settings may not be available due to analyzer type and configuration.
Under system settings, "PLT estimate factor", "Configure network communication" (image encryption), and "Change cell localization options" added.
Under database settings, other "PTL" related settings added, and "Custom reference cells" split to "PB reference cells" and "BF reference cells".
Information on auto-delete and archiving included in the introduction.
2.2 Database management on page 18
3.1 Functional description on page 21
5 Software license management on page 39
Note removed: “To enable review stations to connect to the analyzer, the system computer must be turned on . We recommend that you don't create new Windows® user accounts.”.
CellaVision license key added to list (to be used to run
CellaVision DM Software in CellaVision DC-1).
5.1 CellaVision® License key on page 39
New section added.
New USB hardware key image added.
104 PM-10910-01
Revised: 2020-11-04
Revision history
Section Change
New policy setting added for Citrix® XenAPP™ version 7.x.
8.1.2 Run online backup script on page 68
Important note added to highlight the importance of always using the latest online backup script from cellavision.com. Revision date for the latest online backup script and a LogFilePath example added.
8.1.3 Verify online backup on page 70
Dates and Mimer database server versions updated in examples to reflect the latest online backup script revision.
8.2 Restore database on page 72
Step added to restart the system computer or database server after restoring a database.
8.3 Database transaction logging on page 74
Notes added to highlight that databanks should not be moved to drive C, database can't be compressed if transaction logging is used, and compression of a database in CellaVision DM Software doesn't work if
LOGDB and TRANSDB are moved to a different location.
Specified the need to use the online back-up script if transaction logging is activated to prevent LOGDB from growing too large.
Revision 2018-12-20
Section
5.3.2 Enable license forwarding on page 44
Change
Instructions added on how to use a license from a different server or system computer.
PM-10910-01
Revised: 2020-11-04
105
Revision history
Revision 2018-10-11
Section Change
4.2.1 Configuration checklist – all analyzers connected to same LIS on page 29
Reference to CSS DVD removed as it is discontinued.
5 Software license management on page 39
Reference to DVD removed.
Review Software on PC on page 47
Reference to CRRS DVD removed as it is discontinued.
7.4.1 Set permissions to archive location on page 60
Updated that the account needs to have "Full control" permission to the archiving location.
Windows 10 section added.
11.1.2 Operating system on page 94
Software in server installation on page 95
USB port added.
Revision 2018-10-01
Section
5.3.2 Enable license forwarding on page 44
8.3 Database transaction logging on page 74
11.1.1 Hard drive configuration on page 93
Change
Clarified that license forwarding cannot be done between servers.
A note added to exaplin that it is not possible to compress a database when using transaction logging.
Content updated.
Revision 2018-01-08
Section
Whole document
106
Change
First revision.
PM-10910-01
Revised: 2020-11-04
Revision history
PM-10910-01
Revised: 2020-11-04
107
Glossary
GLOSSARY
A analysis
The overall process of using the system, including loading slides, processing slides, verification, signing, and reporting results.
anisocytosis
Variation in size among RBCs.
C
CCU
CellaVision Control Unit
CDMS
CellaVision DM Software. May also refer to
CellaVision Server Software.
characterization
To determine the morphology characteristics of an RBC sample. The result of the characterization is reported as grades.
confirm cell counter results
To confirm the cell counter results for WBC, RBC, or PLT instead of doing a full manual analysis.
When the user chooses to confirm cell counter results, only a confirmation flag for that result is sent to the LIS.
D
DACL
Discretionary Access Control List. An access control list that is controlled by the owner of an object and that specifies the access particular users or groups can have to the object.
duplicate slide differential
Two different persons sign one slide each in the order. The average result is presented.
G grade
A number representing the relative amount of cells of a certain type in an RBC sample.
grid square
A section of the PLT or RBC overview image.
H
HPF microscopic high power field
I in-vitro
Outside the living body; in an artificial environment.
IPS
In-Plane Switching, a screen technology for liquid crystal displays.
L
LIS
Laboratory Information System.
M
MGG
(May Grünwald Giemsa) a Romanowsky stain for blood smears.
mini map
An overview image of the analysis area.
PM-10910-01
Revised: 2020-11-04
109
Glossary multi-slide order
An order including more than one slide from one sample.
N non-WBC
Cells and objects identified as not being WBCs.
not classed
Cells and objects that the user cannot identify and wants to exclude from the differential count.
O order
An order contains patient data and the information about what type of analyses that are to be performed (for example WBC, RBC) on the slides belonging to that order. Each order is identified by its order ID and the concept of the order and the order ID is used throughout the entire analysis to keep track of patient data, images, results, and so on. An order is generally received from the LIS or created in CellaVision
DM Software.
order ID
Unique order identifier. There can be several slides with the same Order ID but with different slide numbers.
other
Cells that the user identifies as WBCs, but of a type other than those listed. Will be included in the differential count.
P pathology review
A function that allows you to mark any slide so that a pathologist can find and review it.
patient ID
A unique identifier for the patient.
pending order
An order manually added to the database, waiting to be processed.
PID
Positive Identifier. Generally refers to the barcode on the slide.
PLS
Plane to Line Switching, a screen technology for liquid crystal displays.
PLT
Platelet, thrombocyte.
PLT estimate
Estimation of the PLT concentration.
PLT estimate factor
A pre-determined factor to calculate the PLT estimate.
poikilocytosis
Presence of abnormally shaped red blood cells.
pre-characterization
The characterization that the system suggests for the RBC morphology of a sample.
pre-classification
The classification that the system suggests for each WBC.
processing slides
The sequence of events from when the system starts working with a slide until it is finished.
R
RBC
Red blood cell, erythrocyte.
re-classification
The user changes the pre-classification.
110 PM-10910-01
Revised: 2020-11-04
reference cells
A collection of WBCs with typical characteristics, available in the Peripheral Blood Application.
region of interest
A section of the scan overview image tagged by the user.
region of interest, body fluid
A section of the body fluid or scan overview image tagged by the user.
Romanowsky stain
An eosin-methylenblue solution for staining of blood smears. Wright and MGG are examples of different Romanowsky stains.
S server, database server
A server that runs CellaVision Server Software.
sign
The final confirmation of the analysis results before locking and reporting them.
slide ID
The barcode number on the slide (PID). Same as
Order ID.
slide number
A sequential number to identify each slide in a multi-slide order.
system computer
A PC running Microsoft® Windows® and
CellaVision DM Software. It is connected to the slide scanning unit via an unshared Ethernet cable.
U unidentified
Cells and objects which the system cannot preclassify.
Glossary user
The person who works with the system. Also referred to as operator.
V verification
The user's review of WBC, RBC, and PLT. For example re-classification and confirmation of
WBCs.
W
WBC
White blood cell, leukocyte.
Wright
A Romanowsky stain for blood smears.
Wright-Giemsa
A Romanowsky stain for blood smears.
PM-10910-01
Revised: 2020-11-04
111
Index
INDEX
A
B
C
CellaVision Advanced RBC Application 11
CellaVision Body Fluid Application 11
CellaVision Peripheral Blood Application 11
CellaVision Remote Review Software 10-11,
CellaVision Remote Review Software,
CellaVision Remote Review Software,
CellaVision Server Software 10, 12
Citrix server specifications 97
PM-10910-01
Revised: 2020-11-04
command line options, CellaVision Remote
Review Software 51 console user interface 51
D
disk speed 95-96 disk usage 53, 55, 66, 93, 95
E
F
firewall, stand-alone DM system 24
113
Index
G
H
I
hardware requirements, CellaVision Remote
hardware requirements, Citrix® XenApp™
hardware requirements, server 95
L
LIS connection, stand-alone DM system 24
M
monitor cable 99 monitor requirements 99
114
N
network performance 99 network usage 99
O operating system, CellaVision Remote Review
operating system, Citrix® XenApp™
P
R
review station, connect 47 review station, reconnect 47
S
server, software license 40-41, 45
PM-10910-01
Revised: 2020-11-04
Index
specifications, CellaVision Remote Review
Software 97 specifications, Citrix® XenApp™ server 97
stand-alone DM system configuration 23
system requirements, CellaVision Remote
system requirements, Citrix® XenApp™
system requirements, server 95
T
U
V
PM-10910-01
Revised: 2020-11-04
W
X
XenApp server specifications 97
115
Document: PM-10910-01
Revised: 2020-11-04
advertisement
Related manuals
advertisement