[Deprecated] SVSSimulator - Installation & Configuration

Warning: This documentation is out-dated, newest version of the documentation is available at https://gazelle.ihe.net/gazelle-documentation 

Sources & binaries

To get the name of the latest release, visit the SVS Simulator project in JIRA and consult the "Change log" section.

A maven artifact is published in our Nexus repository each time we release the application. You can use it, but be aware that the link to the database is hardly expressed within the artifact so you will have to use the same database name, hosted in the server running Jboss, and with the same owner (and password).

To get the artifact on Nexus browse: http://gazelle.ihe.net/nexus/index.html#nexus-search;gav~~SVSSimulator-ear~~~ and download the latest version.

If you rather want to build the project by yourself, you must checkout the latest tag and package it. You may want to create a new profile to customize your build.

1. Checkout the latest tag available on Inria’s forge: svn co https://scm.gforge.inria.fr/svn/gazelle/Maven/simulators/SVSSimulator/tags/SVSSimulator-$versionName

2. [Optional] Edit the pom.xml file and create a new profile

3. Package the application: mvn [-P profile] clean package

4. The EAR is available at SVSSimulator/SVSSimulator-ear/target/SVSSimulator.ear

Database configuration

If you use the artifact available on Nexus or if you have not change this parameter in the pom.xml file, create a database named svs-simulator, owned by the user gazelle.

$> createdb -U gazelle -E UTF8 svs-simulator

 

Deploy the application

Copy EAR to the deploy folder of JBoss (do not forget to change its name to SVSSimulator.ear)

Start Jboss ⇒ sudo service jboss start

Wait until the application has been completly deployed and configure the database running the SQL script for set-up.

Initialize the application

You first need to initialize the database with some data available in a SQL script. If you have checked out the project, the script is available in SVSSimulator-ear/src/main/sql/initial-import.sql

Otherwise, download it from Inria’s forge (See Sources section)

Before executing the script, open the file and checked the various preferences to be inserted in the app_configuration table, especially the cas_url, application_url and other preferences relative to the user authentication (see Application configuration section)

Finally, execute the script: 

$> >psql -U gazelle svs-simulator < initial-import.sql

To take those parameters into account, you need to restart either the whole Jboss ($>sudo service jboss restart), either only the application ($>touch OrderManager.ear in the deploy folder of Jboss)

Application configuration

Use the Administration menu, you will find a sub-menu entitied "Configure application preferences". The following preferences must be updated according to the configuration of your system. The table below summarizes the variables used by the OrderManager tool.

Variable

Description

Default value

application_issue_tracker_url

The URL of the bug tracking system where to post issues

http://gazelle.ihe.net/jira/browse/SVS

application_url

The URL used by any user to access the tool. The application needs it to build permanent links inside the tool

http://publicUrlOfJboss/SVSSimulator

cas_url

If you intent to use a CAS, put its URL here

https://gazelle.ihe.net/cas

application_works_without_cas

Tells the application how users are authenticated

True: all users are granted as admin

False: uses a CAS service to authenticate users

documentation_url

Where to find the user manual

http://gazelle.ihe.net/content/svs-simulator

esvs_xsd_location

URL of XSD schema ESVS-20100726.xsd

http://gazelle.ihe.net/xsd/svs/ESVS-20100726.xsd

ignore_validation_in_import

disable the XSD validation when importing value sets from XML files

false

ip_login

if the application is not linked to a CAS, you can choose to restraint the access to the administration sections of the application to a subset of IP addresses

true: only users whom IP address matches the regex set in ip_login_admin are granted as admin

false: no IP address check

ip_login_admin

regex to be matched by IP address of the users granted as admin

.* will grant every one as admin

link_repository_http

Endpoint to contact the SVS Repository - displayed to the user (HTTP binding)

http://gazelle.ihe.net/

link_repository_soap

Endpoint to contact the SVS Repository - displayed to the user (SOAP binding)

https://gazelle.ihe.net/SVSSimulator-ejb/ValueSetRepository_Service/ValueSetRepository_PortType?wsdl

message_permanent_link

Page which displays message details

https://gazelle.ihe.net/SVSSimulator/messages/messageDisplay.seam?id=

result_xsl_location

URL to access the XML stylesheet used to display HL7v2.x validation results

XSL location

svs_repository_url

URL of the Sharing Value Set Repository actor of the SVSSimulator

http://gazelle.ihe.net

svs_xsd_location

URL of XSD schema SVS.xsd

 http://gazelle.ihe.net/xsd/svs/SVS.xsd

Home page

The first time you access the application, you may notice that the home page of the tool is not configured. To set a title and a welcome message, log into the application with admin rights.

Note that you will have to set up this page for all the languages supported by the application.