DG - 422 - Service - Manual
DG - 422 - Service - Manual
DG - 422 - Service - Manual
WEX
Service Manual
V1.0
i
INTRODUCTION 1
Chapter 1 3
Installation 3
COMPONENTS OF WEX 3
INSTALLING WEX 3
Minimum and recommended requirements 4
Directory structure 4
Registry structure 5
INSTALLING WEX TEMPLATES 5
Directory structure 6
Registry structure 6
INSTALLING W-8XT 6
Directory structures 7
Registry structure 7
MIGRATING WEX 8
Chapter 2 10
Uninstalling 10
WEX 10
WEX TEMPLATES 10
W-8XT 10
Chapter 3 11
Components of WEX 11
APPLICATIONS SERVER 11
Booting the applications server 12
Stopping the applications server 12
ACCESSING THE APPLICATIONS SERVER 12
DATABASE MANAGER 12
Installation 13
Administration 13
Database 14
Chapter 4 15
Configurations 15
BATCH LOADING CYCLE 15
CONFIGURATIONS THAT CAN BE PERFORMED FROM THE APPLICATION 16
CONFIGURATIONS THAT CANNOT BE PERFORMED FROM THE APPLICATION
17
Configuration of the WEX application 18
Configuration of access to the Diana System 18
Connection to the database 20
Template configuration 21
APPLICATION LOCALIZATION 21
Language determination 22
ACCESS TO WEX FROM OTHER COMPUTERS 22
Chapter 5 25
Logs 25
AUDIT TRAIL 26
Chapter 6 27
Templates 27
ADD TEMPLATE 27
DELETE TEMPLATE 27
ii
Chapter 7 29
Toubleshooting 29
iii
Introduction
INTRODUCTION
The WEX application has been designed as an extension of the Diana System,
mainly to add the following functions:
• Store the information on the batches processed by the Diana System in a
repository.
• Allow generation of reports on the batch information contained in the
repository.
1
WEX – Technical Manual
2
Uninstalling
Chapter 1
Installation
COMPONENTS OF WEX
Installation of the WEX application on a Diana System consists of the following items:
• WEX. This application will consolidate the data on the batches processed by
the Diana System and enable reports to be generated on these data.
• Wex Templates. A series of templates that will be available for generating
reports from the Diana System’s data.
• Wadiana 8.Extended (W-8XT). A desktop application that will enable
integration of the various components of the Diana System and access to the
WEX application.
INSTALLING WEX
WEX is installed by means of an installer which performs all the actions required to
install WEX in the machine.
WEX must be installed on a computer having the following features:
• Windows XP SP2 or higher, or Windows 2000 SP4 or higher installed.
• Diana System v3.2 or later versions installed.
• WEX Pack installed.
• Internet Explorer 6.x or 7.x installed
• Acrobat Reader 5.x or higher installed
3
WEX – Technical Manual
The installation must be carried out with a user having administrator privileges.
The admin user is created with the password expired, requiring entry of a new
password to enter the application.
The support user is created with the password without any expiry date.
Consequently, its password does not expire.
It is not necessary to reboot the computer after installing WEX provided that
installation has been performed without any application open that blocks any of the
items installed.
The table below gives the system requirements for installing the WEX program.
Minimum Recommended
RAM 1.25 GB 2 GB
Directory structure
During installation of WEX, the installer program asks the user for the installation
directory. By default, it shows “C:\Program files\Grifols\WEX”. This directory is
registered in the wex.settings.properties file in the property aplication.dirbase.
4
Uninstalling
Registry structure
The installer program creates the following registry structure within the key:
HKEY_LOCAL_MACHINE\SOFTWARE\Grifols\WEX
<Version of WEX installed>
General
Dirbase: Contains the WEX installation directory
The installation process copies the templates included in the installation program to
the WEX directory “Templates” so that they can be read and run from WEX.
After they have been installed, the WEX applications server must be powered down
and rebooted to load the new templates.
It will not be possible to install the WEX templates if WEX has not been installed
beforehand.
It is not necessary to reboot the computer when installing the WEX templates
provided that the installation has been performed without any application being open
that blocks any of the items installed.
1
WEX installation directory = directory where WEX has been installed. From now on, it will be called WEXDIR.
5
WEX – Technical Manual
Directory structure
Installation of the WEX templates leaves two subdirectories within the WEX
“Templates” directory:
Custom
This contains the specific templates not contained in the installation program.
Standard
This contains the templates that are included in the installation program.
The templates are installed in the WEX directory “Templates”. Each report consists
of:
• The directory with the templates. Each WEX template is a directory with the
template code as its name.
• A subdirectory with images from the template directory. It will store the images
used in the template.
• The template’s internal files. The files comprising the template.
Registry structure
The installer program creates the following registry structure within the key:
HKEY_LOCAL_MACHINE\SOFTWARE\Grifols\WEX Templates
<Version of WEX Templates installed>
INSTALLING W-8XT
6
Uninstalling
W-8XT enables all of the Diana System’s applications to be run with just one click,
simulating that all the programs are integrated. To do this, it opens a full-screen
window and runs the Diana System’s components on top of the window.
Each time the W-8XT window is pressed, it calls up all of the Diana System’s open
windows to bring them to the foreground (otherwise, the only window in the
foreground is the W-8XT window, which effectively conceals the other windows). To
do this, you must know the name of the windows comprising the Diana System.
These names are configured using the program “w8xt Config”.
It is not necessary to reboot the computer when installing WEXI provided that the
installation has been performed without any application being open that blocks any of
the items installed.
Directory structures
During the W-8XT installation process, the installer program asks the user for the
installation directory. By default, it shows “C:\Program files\Grifols\Wadiana
8.Extended”.
Registry structure
The installer program creates the following registry structure within the key:
HKEY_LOCAL_MACHINE\SOFTWARE\Grifols\WEXI
<Version of WEX Templates installed> Exe
DianaServer: Contains the value of the DianaServer executable file
Lector Contains the value of the Reader executable file
Listas Contains the value of the Lists executable file
Wadiana Contains the value of the Wadiana executable file
WEX Contains the value of the WEX executable file Path
DianaServer: Contains the value of the path of the DianaServer executable file
Lector Contains the value of the path of the Reader executable file
Listas Contains the value of the path of the Lists executable file
Wadiana Contains the value of the path of the Wadiana executable file
7
WEX – Technical Manual
WEX Contains the value of the path of the WEX executable file Title
Lector Contains the title of the window of the Reader executable file.
Default title Diana R. v2.16
Listas Contains the title of the window of the Lists executable file.
Default title Diana O. v2.12 --
Wadiana Contains the title of the window of the Wadiana executable file.
Default title WADiana C.
Diana Server Contains the title of the window that request the login/password
MIGRATING WEX
To install WEX, the WEX templates and the program W-8XT on another computer,
follow the steps below:
• Install WEX in the target computer.
• Install W-8XT in the target computer.
• Install WEX Templates in the target computer.
• Stop operation of the applications server in the source and target computers
(Apache Tomcat WEX).
• Stop operation of the database in the source and target computers
(PostgreSQL Database Server 8.3).
• Copy the database data directory from the source computer to the target
computer.
• Boot the applications server in the source and target computers.
• Boot the database server in the source and target computers.
• Uninstall W-8XT from the source computer.
• Uninstall WEX from the source computer.
8
Uninstalling
9
WEX – Technical Manual
Chapter 2
Uninstalling
To uninstall the various items comprising WEX, you must use the “Add/remove
programs” option in the control panel.
WEX
When uninstalling WEX, the user is asked whether he wishes to keep the database
that was installed previously. This enables the database to be kept with the data
used when running WEX.
The user created during installation of PostgreSQL (postgres user) is not uninstalled
automatically. The user must be uninstalled manually (user delete).
Note: If the postgres user created is not deleted, any subsequent installation of WEX
will fail during installation of postgres, as this installation will detect that the user
already exists and will abort the installation.
WEX TEMPLATES
Uninstalling the WEX templates also deletes the Templates directory created
previously together with its contents.
The Custom directory within Templates will not be deleted if there are new files
created in the directory.
W-8XT
Uninstalling W-8XT deletes the programs installed and removes the direct accesses
created in the Windows menu and the Start Menu.
10
Components of WEX
Chapter 3
Components of WEX
APPLICATIONS SERVER
To boot the WEX application, you must boot the applications server which contains it.
11
WEX – Technical Manual
To access the Tomcat administration console, use the Internet Explorer 6 browser
with the URL: http://localhost:8080
The Tomcat administration console enables performance of the service’s
administration tasks and also to start and stop the application, and load and unload
the application in the server.
DATABASE MANAGER
12
Components of WEX
The WEX installation process installs the manager and creates the Database that the
application will use.
The driver is installed as a Windows service and is configured to boot automatically
every time the computer is powered up.
The database server installed has the following features:
Installation
Administration
13
WEX – Technical Manual
Database
Coding UTF8
Tablespace tbls_wex
Owner wex
14
Logs
Chapter 4
Configurations
Before seeing the various configurations available, you must first understand the
batch loading process used. This is shown in the diagram below.
• Obtain modified files. The process accesses the Diana System’s batch
directory to identify the batch files that have been created or modified since
the last check.
15
WEX – Technical Manual
• Process batch files. The following actions are performed on the batch files
identified in the previous step:
o a format check is performed
o their contents are saved on the hard disc to release the files so that
they can continue to be used by the Diana System.
o a copy is made of the image files corresponding to the wells of the
batch processed.
• Obtain additional data. Additional data must be obtained to complete the
information existing in the batch file. Consequently, the following accesses are
performed:
o wex.dll – to obtain the interpretations of the technique run on the batch,
and the patient-related data from the samples processed in the batch.
o Suports.def – to obtain information about the cards used in the batch.
o Reactius.def – to obtain information about the reagents used in the
batch.
• Load batch data in DB. All the batch data compiled are kept in the database,
so that they can be used by the reports.
• Wait. The application waits a certain time to restart the entire batch load cycle.
The following section shows the WEX configurations that can be carried out through
the application.
Configuring these parameters does not require rebooting the applications server.
Barcode reuse
This parameter allows WEX to decide if the center that is generating the batches can
reuse sample’s barcodes, to act accordingly in batch files process.
This requires rebooting the batch loading process.
16
Logs
Number of tries
Number of incorrect retries allowed.
Password expiry period
Number of days after which the user password expires. The system will require
changing the password if this number of days after the last password change is
exceeded.
Timeout period
Expiry time of the WEX session (in seconds). WEX will close when this time has
elapsed.
wex.settings.properties WEXDIR/Tomcat/WEB-INF/WEX/classes
diana.settings.properties WEXDIR/Tomcat/WEB-INF/WEX/classes
version.properties WEXDIR/Tomcat/WEB-INF/WEX/classes
log4j.properties WEXDIR/Tomcat/WEB-INF/WEX/classes
17
WEX – Technical Manual
General configuration
aplication.locale.default – This property defines the language in which WEX will be
run. It is configured during installation of the program with the language used by the
Diana System or English if the Diana System’s language is not available in WEX.
aplication.dirbase – This property defines the application’s installation directory
(WEXDIR). This value is set in the WEX installation process.
Configuration of validations
The following properties parameterize the values referring to the validations
performed periodically by the application on the change of system date and the free
space available.
validadorEspacioDisco.tiempoEspera – This defines the number of seconds
between checks. The default setting is 60 seconds.
validadorEspacioDisco.unidadDisco – This defines on which disc drive the free
space available will be calculated. The default setting is ‘C:’
validadorEspacioDisco.minimoEspacioLibre – This defines the minimum free disc
space required and is expressed in MB. If no value is given, the validation will not be
performed.
The default minimum value specified in the user’s manual is 100MB.
The application interacts with the Diana System to obtain information on the batches
processed by the Diana System. The information is obtained by two means:
Reading the batch files generated by the Diana System.
Accessing via WEX.dll the information referring to interpretations of the batches.
This access is configured primarily from the file diana.settings.properties.
diana.dirbin – This property defines the Diana System Installation Directory. This
value is established in the WEX installation process by detecting configuration of the
Diana System’s installation.
18
Logs
Configuration of dll.
diana.dll.dir – This property defines the directory where the dll will be looked for,
with respect to the Diana System installation directory. The default setting is no
value.
diana.dll.name – This property defines the name of the file corresponding to the dll.
The default setting is ‘wex’.
diana.dll.dirwork – This property defines the dll’s working directory, with respect to
the Diana System installation directory. The default setting is ‘TandasWEXInterp’.
Other configurations
diana.date.format – This property defines the date format of the batch file, with the
Java format specified in :
“http://java.sun.com/j2se/1.4.2/docs/api/java/text/SimpleDateFormat.html#SimpleDat
eFormat(java.lang.String).”
The default setting is ‘dd-MM-yyyy HH:mm:ss’.
19
WEX – Technical Manual
The features of the connections pool are configured in the following properties:
o aplicacion.datasource.initialSize number of initial connections.
o aplicacion.datasource.maxActive maximum number of connections.
o aplicacion.datasource.maxIdle maximum number of free connections.
aplicacion.formatDateTimeBD – This property defines the date format in the
Database.
20
Logs
Template configuration
The templates used by the application are configured from the file
wex.settings.properties located in ‘[WEX Installation Directory]/Tomcat/WEB-
INF/WEX/classes’.
informes.directorioInformes – This property defines the directory where the report
templates are kept, with respect to the Diana System installation directory. The
default setting is ‘Templates’.
informes.pathInformes - This property defines the path of the standard templates
within the directory informes.directorioInformes. The default setting is ‘Standard’.
informes.directorioOutputInformes – This property defines the directory where
reports are generated, with respect to the directory aplication.dirbase. The default
setting is ‘Reports’.
informes.directorioImagenes – This property defines the directory where the
images of the wells for generating the reports are to be found, with respect to the
directory aplication.dirbase. The default setting is ‘Images’.
informes.directorioLogo – This property defines the directory where the logo that
will be shown in the reports (logo.jpg) is kept, with respect to the directory
aplication.dirbase. The default setting is ‘Templates’.
informes.showPrintedBy – This property controls if reports should show the user
who is printing the report. If the value is ‘yes’ the report shows the user.
APPLICATION LOCALIZATION
The language in which the application will be shown is defined in the property
aplicacion.locale.default defined in the file wex.settings.properties. It is set with the
locale code wished for the application.
The codes are specified as indicated in ISO 639:1988 (E/F) "Code for the
representation of names of languages". The complete list of codes can be found in:
http://ftp.ics.uci.edu/pub/ietf/http/related/iso639.txt
This locale determines what language the Wex application will try to use for the Web
application, Report generation, System alerts and Controlled errors.
To enable the application to determine the various literals in the locale specified,
literal files must be created for the locale in question. There is a locale-less file for all
21
WEX – Technical Manual
configuration files which contains the determination of the literals in English. This will
be used as default file if the files are not created for the locale configured or a key is
missing in any of the files.
The files corresponding to the various languages are:
interfaceWeb_[locale].properties – This contains the literals corresponding to the web
interface.
errorsWex_[locale].properties – This contains the error literals of the Wex application.
configWex_[locale].properties – This contains the literals referring to the date format
or other language-dependent configurations.
audit_[locale].properties – This contains the literals required to describe the system’s
audit inputs.
com.logister.wex.common.alertas.alertas_[locale].properties – This contains the
literals required to describe the system’s alert inputs.
Language determination
When the system has to locate a language file for the language selected, the rules
defined in : Class ResourceBundle are followed.
Basically, a file hierarchy is created as follows:
• name + "_" + language + "_" + country + "_" + variant
• name + "_" + language + "_" + country
• name + "_" + language
• name
When a certain translation key is requested, the system first looks in the most
specific file and, if it does not find the key in this file, it goes to successive files until
the key is found. As can be seen, if a key does not exist for the language configured,
the default option will be to show the key of the file nombre.properties, which, in our
case, must contain the keys with the translations in English (which is the default
language).
Access to the application via the web from another client computer is performed from
the browser using the application WEX.hta.
The file wex.hta must be copied to the desktop of the client computer and the
configuration must be edited to replace the address “localhost” with the address of
the server where the WEX application has been installed.
For this access to be operational, the client computer must have installed Microsoft
Internet Explorer 6.
22
Logs
The server computer being accessed must have port 8080 (HTTP) enabled as this is
the port through which the Tomcat applications server receives the requests.
23
Logs
Chapter 5
Logs
The application’s logs are managed by the component log4j, which enables
configuration of the output and granularity of an application’s log messages by
means of the configuration file log4j.properties located in:
[Wex Installation Dir.]/Tomcat/WEB-INF/WEX/classes/log4j.properties
The various output files are configured in this file so that they can be generated in the
directory [Wex Installation Dir.]/Traces.
The following appenders are defined in the configuration file:
o arrancar.log – The steps of the application’s boot process are recorded in
this file. It is useful for checking that the application has booted correctly
and which report templates it has been able to load. Configured for 1 x
10Mb rotating file.
o traces.log – All the application’s traces are recorded in this file. Configured
for 20 x 10Mb rotating files.
o errors.log – Only the application’s error traces are recorded in this file.
Configured for 10 x 10Mb rotating files.
o alertas.log – The various alerts launched in the application are recorded in
this file. Configured for 2 x 10 Mb rotating files.
o batch.log – The run traces corresponding to the batch loading process are
recorded in this file.
25
WEX – Technical Manual
The system configures on these appenders the loggers that will be output by each
one and at what trace level. The trace levels available, in order of increasing priority,
are:
o ALL: This is the lowest level and enables all the trace levels to be
displayed.
o DEBUG: At this level, useful information for debugging the application is
recorded.
o INFO: At this level, information on the application’s progress is recorded.
o WARN: At this level, information on potential error situations is recorded.
o ERROR: At this level, the error situations that may arise in the application
are recorded.
o FATAL: At this level, serious errors occurring in the application that prevent
the application from continuing are recorded.
o OFF: This level – which is the highest – disables the traces.
When a log is configured to a certain level, the traces corresponding to this level and
the next highest one are shown in the appender.
The main trace configurations on the appenders are:
log4j.rootLogger=INFO, AllTraces, ErrorTraces
log4j.logger.com.logister=INFO, WexTraces
log4j.logger.com.logister.wex.batch=DEBUG, BatchTraces
AUDIT TRAIL
The application generates files with the application’s audit trail in order to audit the
actions performed with the application.
These files are generated in the directory [Wex Installation Dir.]/Traces.
An audit file is generated for each day with the following format auditTrail.log. yyyy-
MM-dd.
Entries in this file have the following format:
[yyyy-MM-dd hh:mm:ss] – [user login] – [audit code] – [information]
26
Troubleshooting
Chapter 6
Templates
The system enables report templates to be installed and uninstalled separately from
the Wex version installed.
ADD TEMPLATE
DELETE TEMPLATE
To delete a report so that it is unavailable in the application, follow the steps below:
• Stop the application.
• Delete the folder with the code of the report template to be deleted from the
directory informes.pathInformes which is located in
informes.directorioInformes.
• Boot the application.
27
Troubleshooting
Chapter 7
Toubleshooting
The table below shows a range of incidents that may occur, the possible causes and
solutions.
29
WEX – Technical Manual
30