I added ADR docuements

1185ab69 · Youn Cadoret · 813304b8 · 1185ab69 · 1185ab69 · 1185ab69
Commit 1185ab69 authored 5 years ago by Youn Cadoret
--- a/EPD-ADR-Simulator/installation.md
+++ b/EPD-ADR-Simulator/installation.md
 ---
 title:  Installation Manual
-subtitle: ATC Simulator
+subtitle: ADR Simulator
-author: Wylem BARS
+author: Youn Cadoret
-function: Software Engineer
+function: Developer
-date: 19/04/2019
+date: 02/06/2019
-toolversion: 1.1.2
+toolversion: 1.2
-version: 0.01
+version: 1.0
-status: Draft
+status: To be reviewed
-reference: KER1-MAN-IHE-ATC_SIMULATOR_INSTALLATION-0_01
+reference: KER1-MAN-IHE-ADR_SIMULATOR_INSTALLATION-0_01
 customer: IHE-EUROPE
 ---
+# EPR ADR Provider MockUp
-# ATC Simulator - Installation & configuration
+## Overview
-## Source code
+The EPR ADR Provider MockUp is a SoapUI webservice (mock) that provides Authorization Decisions when requested.
-Sources of the tool are available on Inria's Gforge in the Gazelle project: 
+* default_wsdl_url: http://ehealthsuisse.ihe-europe.net:8091/adr-provider?wsdl
-[EPD (trunk)](https://scm.gforge.inria.fr/authscm/wbars/svn/gazelle/EPD/trunk).
+* default_path: /adr-provider
+* default_port: 8091
+* default_mock_name: AdrDecisionQuerySoapBinding_MockService
+* default_mock_path: /opt/simulators/epr-adr-provider-mockup
+* default_soapui_path: /usr/local/SmartBear/SoapUI-5.3.0/
+* default_soapui_mock_log: /var/log/soapui/epr-adr-provider.log
+* default_init.d: /etc/init.d/adrProviderMock
+* default_keystore_path: /opt/gazelle/cert/jboss.jks
-## Patient Audit Consumer 
-This project can be loaded on a Gazelle WebService tester instance. This way you will be able to launch a suite of requests from the simulator emulating 
+## Install SoapUI
-the Patient Audit Consumer actor of the CH:ATC profile.
-First you need to load the project in Gazelle WebService Tester. Then, check :
+[https://www.soapui.org/](https://www.soapui.org/)
-* The entire project
-* The NormalCases test suite
-* The ErrorCases test suite 
-This will allow the user to either launch a specific test suite or to launch both using the entire project. 
+## Install EPR Assertion Provider MockUp
-Then click on the Project name in the tree and check the __endpoint__ and __enPointAssertions__ properties. This will be useful to specify where your 
+### Get the Subversion project
-system is so the simulator can request it for Audit Events. 
-The click on each test case from the project and check all parameters. Then the user will be able to modify the request parameters send by the simulator to match 
-audit event from his Patient Audit Record Repository.
-## Patient Audit Record Repository
+```bash
+svn checkout https://scm.gforge.inria.fr/anonscm/svn/gazelle/EPD/trunk/epr-adr-provider-mockup/ $EPR_ADR_MOCK_DIR
+```
+### Install libraries required by SoapUI
+Copy the external jars (esapi, velocity and postgresql)
+```bash
+cp $EPR_ADR_MOCK_DIR/external_jar/esapi-2.1.0.1.jar $SOAPUI_INSTALL_DIR/lib/
+cp $EPR_ADR_MOCK_DIR/external_jar/velocity-1.7.jar $SOAPUI_INSTALL_DIR/lib/
+cp $EPR_ADR_MOCK_DIR/external_jar/postgresql-9.3-1102.jdbc4.jar $SOAPUI_INSTALL_DIR/lib/
+```
+### Prepare the database
+Database is not mandatory, but if not configured, it will raise log errors for each recieving request.
+```bash
+psql -U gazelle postgres
+> CREATE DATABASE "adr" OWNER gazelle ;
+> \q
+psql -U gazelle adr < $EPR_ADR_MOCK_DIR/sql/adr-schema.sql
+psql -U gazelle adr < $EPR_ADR_MOCK_DIR/sql/adr-import.sql
+```
+## Mock as a service
+### Prepare the init.d script
+Edit the init.d script `$EPR_ADR_MOCK_DIR/init.d/adrProviderMock` and set the following environment variables
+* SOAPUI_PATH => Path of SoapUI folder
+* SOAPUI_PROJECT_PATH => Path of SoapUI project script
+* SOAPUI_MOCK_NAME => Name of the SoapUI mock
+* SOAPUI_MOCK_PORT => Port of the SoapUI mock
+* SOAPUI_MOCK_ENDPOINT => Path of the SoapUI mock
+* SOAPUI_MOCK_LOG => Path where to publish log file
+### Declare the service
+Type the following commands register the init.d script as service
+```bash
+sudo cp $EPR_ADR_MOCK_DIR/init.d/adrProviderMock /etc/init.d/adrProviderMock
+sudo chmod u+x /etc/init.d/adrProviderMock
+sudo chmod 775 /etc/init.d/adrProviderMock
+```
+If you want the service to start at each machine start up
+```bash
+sudo update-rc.d adrProviderMock defaults
+```
+Be careful to allow the service to write logs into your target directory. As example
+```bash
+sudo mkdir /var/log/soapui
+sudo chmod 775 /var/log/soapui
+```
+### Start the mock
-First step to set up the Patient Audit Record Repository actor from the simulator is to checkout sources.
+To run the mock
-You can checkout the entire ATC simulator sources from the url [here](https://scm.gforge.inria.fr/authscm/wbars/svn/gazelle/EPD/trunk/ATC).
-For the Patient Audit Record Repository actor you will need three things : 
-* The SoapUI project __ATC/soapui/ATC-MockService-soapui-project.xml__
-* The folder __ATC/test_data/AuditEvent__ that contains all Audit Events known by the simulator.
-* The script __ATC/init.d/atcRecordRepositoryMock__ that will allow you to start/stop the mock project as a service on your platform
-Once you downloaded the ATC folder, you have all the data you need to run the Patient Audit Record Repository Mockup.
+```bash
+sudo /etc/init.d/adrProviderMock start
+```
+To stop the mock
+```bash
+sudo /etc/init.d/adrProviderMock stop
+```
-Simply modify __atcRecordRepositoryMock__ script properties :
+To get status of the mock
+```bash
+sudo /etc/init.d/adrProviderMock status
+```
-| **Property**                                 | **Description**                                       | **Example Value**                                                                              |
+## Troubleshouting
-|----------------------------------------------|---------------------------------------------------------|----------------------------------------------------------------------------------------------|
-| SOAPUI_PATH                    | Path to the SoapUI folder installed on your platform| /usr/local/SmartBear/SoapUI-5.3.0|
-| SOAPUI_PROJECT_PATH            | Path to the SoapUI project checked out from Inria's Gforge| /opt/simulators/ATC/soapui/ATC-MockService-soapui-project.xml|
-| SOAPUI_MOCK_NAME               | Name of the mock | PatientAuditRecordRepository|
-| SOAPUI_MOCK_PORT               | Port that will be used to access the Mock| 8096|
-| SOAPUI_MOCK_ENDPOINT           | Endpoint that will be used to reach the Mock| /atc-record-repository |
-| SOAPUI_MOCK_LOG                | Path to the log file for the Mock | /var/log/soapui/epr-atc-record-repository.log|
+You might need to install those following packets
+```bash
+sudo apt-get install -y libxrender1 libxtst6 libxi6
+```
-When the properties are modified to fit your platform, you can copy the script or create a symbolic link in __/etc/init.d__ folder to be able to use start 
+You might need to resolve errors when starting the mock
-and stop the mock as a service.
-You will then be able to use following commands to respectively start the Mock service, see its status and stop the service : 
 ```bash
- sudo service atcRecordRepositoryMock start
+sudo mv /root/.soapuios/ /root/.soapuios_old
- sudo service atcRecordRepositoryMock status
+```
- sudo service atcRecordRepositoryMock stop
-```
\ No newline at end of file
--- a/EPD-ADR-Simulator/release-note.md
+++ b/EPD-ADR-Simulator/release-note.md
 ---
-title: Release note
+title:  Release note
-subtitle: ATC Simulator
+subtitle: ADR Simulator
-toolversion: 1.1.2
+author: Youn Cadoret
-releasedate: 2019-04-10
+function: Developer
-author: Wylem BARS
+date: 02/06/2019
-function: Software Engineer
+toolversion: 1.2
-customer: IHE Europe
+version: 1.0
-reference: KER1-RNO-IHE-ATC_SIMULATOR
+status: To be reviewed
+reference: KER1-RNO-IHE-ADR_SIMULATOR
+customer: IHE-EUROPE
 ---
-# 1.1.2
-_Release date: 2019-04-10 _
-__Bug__
-* \[[ATCREPO-7](https://gazelle.ihe.net/jira/browse/ATCREPO-7)\] ATC Client simulator send "IHE- SAML" instead of "IHE-SAML"
-* \[[ATCREPO-8](https://gazelle.ihe.net/jira/browse/ATCREPO-8)\] Patient Audit Record Repository response contains not all request parameters
-* \[[ATCREPO-9](https://gazelle.ihe.net/jira/browse/ATCREPO-9)\] ATC Consumer endpoint include /ARRService and shouldn't
-* \[[ATCREPO-10](https://gazelle.ihe.net/jira/browse/ATCREPO-10)\] & should not be escaped inside date parameter
-# 1.1.1
-_Release date: 2019-04-03 _
-__Bug__
-* \[[ATCREPO-5](https://gazelle.ihe.net/jira/browse/ATCREPO-5)\] Handling of parameter "date=ge
-* \[[ATCREPO-6](https://gazelle.ihe.net/jira/browse/ATCREPO-6)\] ATC - Simulator ignores _format parameter, only responding with XML
-# 1.1.0
-_Release date: 2019-03-27 _
-__Story__
-* \[[ATCREPO-1](https://gazelle.ihe.net/jira/browse/ATCREPO-1)\] Update the mock to comply with the EPR 1.8 specification
-__Improvement__
-* \[[ATCREPO-2](https://gazelle.ihe.net/jira/browse/ATCREPO-2)\] Update the AuditMessage and AuditEvent messages
-# 1.0.2
-_Release date: 2019-02-15 _
-__Bug__
-* \[[ATCREPO-3](https://gazelle.ihe.net/jira/browse/ATCREPO-3)\] Mock not correctly handle request parameters
-__Improvement__
-* \[[ATCREPO-4](https://gazelle.ihe.net/jira/browse/ATCREPO-4)\] Replace regex with XMLHolder in assertion reading
--- a/EPD-ADR-Simulator/user.md
+++ b/EPD-ADR-Simulator/user.md