diff --git a/Assertion-Manager/installation.md b/Assertion-Manager/installation.md
index 6e862a2a5f737a7a94379ddcb61fbce7465fcf78..8ca44243996dd9d1efa1bcd21ad45fff852e53e7 100755
--- a/Assertion-Manager/installation.md
+++ b/Assertion-Manager/installation.md
@@ -6,13 +6,13 @@ function: Engineer
date: 17/01/2023
toolversion: 4.2.x
version: 1.02
-status: Approved document
+status: draft
reference: KER1-MAN-IHE-ASSERTION\_MANAGER\_INSTALLATION-1\_02
customer: IHE-EUROPE
---
# Purpose
-Here is a guide to help you installing Assertion Manager.
+Here is a guide to help you to install Assertion Manager.
# Minimal Requirements
@@ -24,21 +24,28 @@ Here is a guide to help you installing Assertion Manager.
To install those requirements you can refer to the documentation of installation of JBoss : [*General Requirements JBOSS 7*](https://gazelle.ihe.net/gazelle-documentation/General/jboss7.html)
-# Quick start
+## Sources & binaries
-Assertion manager has to be installed as a gazelle user on your server:
+Assertions Manager is an open-source project under Apache License Version 2.0 ([https://gazelle.ihe.net/content/license](https://gazelle.ihe.net/content/license)). Sources are available via Gitlab at [https://gitlab.inria.fr/gazelle/public/core/assertion-manager](https://gitlab.inria.fr/gazelle/public/core/assertion-manager).
+
+The latest public packaged release can be downloaded from our Nexus repository [https://gazelle.ihe.net/nexus/#nexus-search;quick~%20AssertionManagerGui.ear](https://gazelle.ihe.net/nexus/#nexus-search;quick~%20AssertionManagerGui.ear).
+
+
+### Database creation
+
+Your database must have a user **gazelle** :
+
+1. Connect to your database
```bash
-wget https://gitlab.inria.fr/gazelle/applications/test-design/AssertionManager/blob/master/install_assertion_manager_gui.sh
-chmod +x install_assertion_manager_gui.sh
-sudo install_assertion_manager_gui.sh
+psql -U gazelle
```
-It will:Â
+1. Execute the SQL statement to create the database.
-* Backup the previous EAR
-* Get the latest released version of Assertion Manager and deploy it in your JBoss server.
-* Create the database if it doesn't exist.
+```sql
+CREATE DATABASE "assertion-manager-gui" OWNER gazelle ENCODING 'UTF8' ;
+```
## Deployment
To deploy Assertion Manager:
@@ -50,9 +57,24 @@ For more informations about how to manage that externalization, please refer to
Datasource name : AssertionManagerBaseDS
-Database name : assertion-manager
+Database name : assertion-manager-gui
-## Insert configuration values
+### Application configuration
+
+1. Download the SQL scripts archive from our Nexus repository [https://gazelle.ihe.net/nexus/#nexus-search;quick~%20AssertionManagerGui.ear](https://gazelle.ihe.net/nexus/#nexus-search;quick~%20AssertionManagerGui.ear) (search for **AssertionManagerGui-ear-X.X.X-sql.zip**)
+
+1. Unzip the archive
+
+1. Edit the application_url value in init.sql.
+
+1. From the bash, update the application configuration by running :
+
+```bash
+psql -U gazelle assertion-manager-gui < schema-X.X.X.sql
+
+psql -U gazelle assertion-manager-gui < init-X.X.X.sql
+```
+Or
Configuration can be done through the Administration interface or with an sql script.
@@ -67,100 +89,39 @@ To restart the application, there are 2 options:
Here is the list of configuration variables that must be defined:Â
-| Variable| Default value| Description|
-|---------|--------------|------------|
-| application_url |http://server_domain:8080/AssertionManager| URL to reach the tool|
-| application_works_without_cas | true | Indicates authentication mechanism to use|
-| ip_login | true | Indicates authentication mechanism to use|
-| ip_login_admin | .\* | Pattern to grant users as admin based on their IP address|
-| cas_url | Not defined| URL of the CAS service|
-| upload_max_size | 100000000| Used to limit uploaded files size|
-| assertion_manager_rest_path_to_assertion | /testAssertion/assertion| do not change|
-| assertion_manager_rest_url | https://server_domain:8080/AssertionManagerGui/rest|  update server_domain:8080 to fit your needs.|
-| security-policies | true | Â Enable security features|
-| X-Frame-Options | SAMEORIGIN| Â https://developer.mozilla.org/en-US/docs/Web/HTTP/X-Frame-Options|
-| Cache-Control | private, no-cache, no-store, must-revalidate, max-age=0| Â https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers#Cache-control|
-| Strict-Transport-Security | max-age=31536000 ; includeSubDomains| Â https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers#Cache-control|
-| X-Content-Security-Policy | | https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers#Cache-control|
-| X-WebKit-CSP | Use X-Content-Security-Policy values | |
-| X-WebKit-CSP-Report-Only | Use X-Content-Security-Policy-Report-Only values | |
+| Variable| Default value | Description|
+|---------|----------------------------------------------------------------------------------------------------------------|------------|
+| application_url | http://server_domain:8080/AssertionManagerGui | URL to reach the tool|
+| upload_max_size | 100000000 | Used to limit uploaded files size|
+| assertion_manager_rest_path_to_assertion | /testAssertion/assertion | do not change|
+| assertion_manager_rest_url | https://server_domain:8080/AssertionManagerGui/rest |  update server_domain:8080 to fit your needs.|
+| security-policies | true | Â Enable security features|
+| X-Frame-Options | SAMEORIGIN | Â https://developer.mozilla.org/en-US/docs/Web/HTTP/X-Frame-Options|
+| Cache-Control | private, no-cache, no-store, must-revalidate, max-age=0 | Â https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers#Cache-control|
+| Strict-Transport-Security | max-age=31536000 ; includeSubDomains | Â https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers#Cache-control|
+| X-Content-Security-Policy | | https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers#Cache-control|
+| X-WebKit-CSP | Use X-Content-Security-Policy values | |
+| X-WebKit-CSP-Report-Only | Use X-Content-Security-Policy-Report-Only values | |
| X-Content-Security-Policy-Report-Only | default-src self \*.ihe-europe.net; script-src self unsafe-eval unsafe-inline ; style-src self unsafe-inline ; | Â https://developer.mozilla.org/en-US/docs/Web/Security/CSP/Using_Content_Security_Policy |
-| sql_injection_filter_switch | true | Â Enable sql injection filtering|
-| gazelle_test-management-url | https://server_domain:8080/gazelle/rest/ | points to gazelle test management rest interface|
-| application_documentation | https://gazelle.ihe.net/content/assertion-manager| |
-| documentation_url | https://gazelle.ihe.net/content/assertion-manager| |
-| application_release_notes_url | https://gazelle.ihe.net/jira/browse/AS#selectedTab=com.atlassian.jira.plugin.system.project%3Achangelog-panel | |
-| application_issue_tracker_url | https://gazelle.ihe.net/browse/EVSCLT| URL of the project in the issue tracking system |
-
-To insert values with an sql script, connect to the database :
-```bash
-su postgres
-psql assertion-manager-gui
-```
+| sql_injection_filter_switch | true | Â Enable sql injection filtering|
+| gazelle_test-management-url | https://server_domain:8080/gazelle/rest/ | points to gazelle test management rest interface|
+| application_documentation | https://gazelle.ihe.net/content/assertion-manager | |
+| documentation_url | https://gazelle.ihe.net/content/assertion-manager | |
+| application_release_notes_url | https://gazelle.ihe.net/jira/browse/AS#selectedTab=com.atlassian.jira.plugin.system.project%3Achangelog-panel | |
+| application_issue_tracker_url | https://gazelle.ihe.net/browse/EVSCLT | URL of the project in the issue tracking system |
+
+### SSO Configuration
+
+There are additional preferences to configure the SSO authentication.
+
+| Preference name | Description | Example of value |
+| ---------------- | ---------------------------------------------------------------------- | ---------------- |
+| **cas_enabled** | Enable or disable the CAS authentication. | true |
+| **ip_login** | Enable authentication by IP address matching `ip_login_admin` regex. | false |
+| **ip_login_admin** | Regex to authorize ip authentication if CAS authentication is disabled. | .* |
+
+For more documentation about SSO configurations, follow the link [here](https://gitlab.inria.fr/gazelle/public/framework/sso-client-v7/-/blob/master/cas-client-v7/README.md).
-Then copy paste the following script:
-```sql
-SET statement\_timeout = 0;
-SET lock\_timeout = 0;
-SET client\_encoding = 'UTF8';
-SET standard\_conforming\_strings = on;
-SET check\_function\_bodies = false;
-SET client\_min\_messages = warning;
-SET search\_path = public, pg\_catalog;
-SET default\_tablespace = '';
-SET default\_with\_oids = false;
---
--- Name: app\_configuration; Type: TABLE; Schema: public; Owner: gazelle; Tablespace:
---
-Â
-CREATE TABLE app\_configuration (
-Â Â id integer NOT NULL,
-Â Â value character varying(255),
-Â Â variable character varying(255)
-);
-
-ALTER TABLE public.app\_configuration OWNER TO gazelle;
-
---
--- Name: app\_configuration\_pkey; Type: CONSTRAINT; Schema: public; Owner: gazelle; Tablespace:
---
-
-ALTER TABLE ONLY app\_configuration
-ADD CONSTRAINT app\_configuration\_pkey PRIMARY KEY (id);
-
---
--- Name: variable\_unique; Type: CONSTRAINT; Schema: public; Owner: gazelle; Tablespace:
---
-
-ALTER TABLE ONLY app\_configuration
-ADD CONSTRAINT variable\_unique UNIQUE (variable);
-
---
--- Data for Name: app\_configuration; Type: TABLE DATA; Schema: public; Owner: gazelle
---
-
-INSERT INTO app\_configuration VALUES (1, 'false', 'ip\_login');
-INSERT INTO app\_configuration VALUES (2, '.\*', 'ip\_login\_admin');
-INSERT INTO app\_configuration VALUES (3, '100000000', 'upload\_max\_size');
-INSERT INTO app\_configuration VALUES (4, '/testAssertion/assertion', 'assertion\_manager\_rest\_path\_to\_assertion');
-INSERT INTO app\_configuration VALUES (5, 'https://server_domain:8080/AssertionManagerGui/rest', 'assertion\_manager\_rest\_url'); --update with your server domain example: https://gazelle.ihe.net/AssertionManagerGui/rest
-INSERT INTO app\_configuration VALUES (6, 'true', 'security-policies');
-INSERT INTO app\_configuration VALUES (7, 'SAMEORIGIN', 'X-Frame-Options');
-INSERT INTO app\_configuration VALUES (8, 'private, no-cache, no-store, must-revalidate, max-age=0', 'Cache-Control');
-INSERT INTO app\_configuration VALUES (9, 'max-age=31536000 ; includeSubDomains', 'Strict-Transport-Security');
-INSERT INTO app\_configuration VALUES (10, '', 'X-Content-Security-Policy');
-INSERT INTO app\_configuration VALUES (11, 'Use X-Content-Security-Policy values', 'X-WebKit-CSP');
-INSERT INTO app\_configuration VALUES (12, 'Use X-Content-Security-Policy-Report-Only values', 'X-WebKit-CSP-Report-Only');
-INSERT INTO app\_configuration VALUES (13, 'default-src self \*.ihe-europe.net; script-src self unsafe-eval unsafe-inline ; style-src self unsafe-inline ;', 'X-Content-Security-Policy-Report-Only');
-INSERT INTO app\_configuration VALUES (14, 'true', 'sql\_injection\_filter\_switch');
-INSERT INTO app\_configuration VALUES (15, 'https://server_domain:8080/AssertionManagerGui', 'application\_url'); --update with your server domain
-INSERT INTO app\_configuration VALUES (16, 'false', 'application\_works\_without\_cas');
-INSERT INTO app\_configuration VALUES (17, 'https://server_domain:8080/cas', 'cas\_url'); --update with your server domain
-INSERT INTO app\_configuration VALUES (18, 'https://server_domain:8080/gazelle/rest/', 'gazelle\_test-managment-url'); --update with your server domain
-INSERT INTO app\_configuration VALUES (19, 'https://gazelle.ihe.net/content/assertion-manager', 'application\_documentation');
-INSERT INTO app\_configuration VALUES (20, 'https://gazelle.ihe.net/content/assertion-manager', 'documentation\_url');
-INSERT INTO app\_configuration VALUES (21, 'https://gazelle.ihe.net/jira/browse/AS\#selectedTab=com.atlassian.jira.plugin.system.project%3Achangelog-panel', 'application\_release\_notes\_url');
-```
# Compile from sources
@@ -172,10 +133,7 @@ Assertion Manager is an open source project under Apache2 licence. The sources a
```bash
sudo apt-get install maven2 git
git clone https://gitlab.inria.fr/gazelle/applications/test-design/AssertionManager.git assertion-manager-gui
-git clone https://gitlab.inria.fr/gazelle/applications/test-design/AssertionManager.git assertion-manager
-cd assertion-manager
-mvn clean install
-cd ../assertion-manager-gui
+cd assertion-manager-gui
mvn clean package -U -Pproduction
```
@@ -189,7 +147,6 @@ su postgres
psql
postgres=\# CREATE USER gazelle;
postgres=\# ALTER USER gazelle WITH ENCRYPTED PASSWORD 'password';
-postgres=\# CREATE DATABASE "assertion-manager" OWNER gazelle ENCODING UTF-8;
postgres=\# CREATE DATABASE "assertion-manager-gui" OWNER gazelle ENCODING UTF-8;
postgres=\# \\q
exit
@@ -200,14 +157,10 @@ exit
Before compiling, go into gazelle-tm's directory and edit the file pom.xml. Open this file and adapt the properties of prod profile to your needs :
* jdbc.connection.url :Â jdbc:postgresql:assertion-manager-gui
-* jdbc.connection.url2 : jdbc:postgresql:assertion-manager
* jdbc.connection.user /Â jdbc.connection.password : credentials for database access
Then, create the EAR archive with the command line:
```bash
-cd assertion-manager
-mvn install
-cd ..
cd assertion-manager-gui
mvn clean package -Pproduction
```
diff --git a/Assertion-Manager/release-note.md b/Assertion-Manager/release-note.md
index c49d180c7c66f876f9bd3fd26e695b82162b5624..bfc4806bca65c8417782a41627eb5add3dd56f58 100755
--- a/Assertion-Manager/release-note.md
+++ b/Assertion-Manager/release-note.md
@@ -1,13 +1,34 @@
---
title: Release note
subtitle: Assertion Manager
-toolversion: 4.2.3
-releasedate: 2023-01-17
+toolversion: 5.0.0
+releasedate: 2024-02-06
author: Anne-Gaëlle BERGE
function: Software Engineer
customer: IHE Europe
reference: KER1-RNO-IHE-ASSERTION_MANAGER
---
+# 5.0.0
+_Release date: 2024-02-06_
+
+Context : Gazelle User Management Renovation step 2
+
+__Task__
+* \[[AM-295](https://gazelle.ihe.net/jira/browse/AM-295)\] Remove username display in GUI
+* \[[AM-296](https://gazelle.ihe.net/jira/browse/AM-296)\] Integrate new sso-client-v7
+
+# 4.2.5
+_Release date: 2023-10-19_
+
+__Bug__
+* \[[AM-293](https://gazelle.ihe.net/jira/browse/AM-293)\] Editing Assertions lead to an error page when saving
+
+# 4.2.4
+_Release date: 2023-04-18_
+
+__Bug__
+* \[[AM-292](https://gazelle.ihe.net/jira/browse/AM-292)\] Fix TOS popup
+
# 4.2.3
_Release date: 2023-01-17_
diff --git a/Authentication-Simulator/installation.md b/Authentication-Simulator/installation.md
index ff80aa294b1c0d73761901ae7e5b78420de34bb2..40da39debc7c95116edab746c7ccf30a9a587a48 100755
--- a/Authentication-Simulator/installation.md
+++ b/Authentication-Simulator/installation.md
@@ -15,7 +15,7 @@ customer: eHealth Suisse
## Sources & binaries
-Authentication Simulator is an open-source project under Apache License Version 2.0 ([https://gazelle.ihe.net/content/license](https://gazelle.ihe.net/content/license)). Sources are available via Subversion at [https://svn.ihe-europe.net/gazelle/Maven/simulators/authentication-simulator/](https://svn.ihe-europe.net/gazelle/Maven/simulators/authentication-simulator/).
+Authentication Simulator is an open-source project under Apache License Version 2.0 ([https://gazelle.ihe.net/content/license](https://gazelle.ihe.net/content/license)). Sources are available via Subversion at [https://gitlab.inria.fr/gazelle/public/simulation/authentication-simulator](https://gitlab.inria.fr/gazelle/public/simulation/authentication-simulator).
The latest public packaged release can be downloaded from our Nexus repository [https://gazelle.ihe.net/nexus/index.html#nexus-search;quick~authentication-simulator-ear](https://gazelle.ihe.net/nexus/index.html#nexus-search;quick~authentication-simulator-ear) (search for **authentication-simulator-X.X.X.ear**) for Authentication Simulator and [https://gazelle.ihe.net/nexus/index.html#nexus-search;quick~idp-adapter-ear](https://gazelle.ihe.net/nexus/index.html#nexus-search;quick~idp-adapte-ear) (search for **idp-adapte-X.X.X.ear**) for the IDP Adapter.
@@ -62,7 +62,7 @@ Authentication Simulator needs an another ear to parse the shibboleth logs. This
1. Unzip the archive
-1. Edit the application_url value in init.sql. You might also want to edit application_works_without_cas and the idp_adapter_wsdl_endpoint configurations.
+1. Edit the application_url value in init.sql. You might also want to edit the idp_adapter_wsdl_endpoint configuration.
1. From the bash, update the application configuration by running :
diff --git a/Authentication-Simulator/release-note.md b/Authentication-Simulator/release-note.md
index 46baebc74fc6b6dee1bdb778dede74c758e51598..e4f6b5b065ceee7f791c97fb631d5fc4245891e2 100755
--- a/Authentication-Simulator/release-note.md
+++ b/Authentication-Simulator/release-note.md
@@ -1,13 +1,20 @@
---
title: Release note
subtitle: Authentication Simulator
-toolversion: 0.1.2
-releasedate: 2020-01-14
+toolversion: 0.2.0
+releasedate: 2024-02-06
author: Youn Cadoret
function: Software Engineer
customer: IHE Europe
reference: KER1-RNO-IHE-AUTHENTICATION_SIMULATOR
---
+# 0.2.0
+_Release date: 2024-02-06_
+
+Context : Gazelle User Management Renovation step 2
+
+__Task__
+* \[[AUTH-25](https://gazelle.ihe.net/jira/browse/AUTH-25)\] Integrate new sso-client-v7
# 0.1.2
_Release date: 2020-01-14_
diff --git a/CDA-Generator/installation.md b/CDA-Generator/installation.md
index a17e820ada92db39ae73092d2e983e754672bf6e..1888ee1c8806f1cd37feea4d0ccb7e89104ab567 100755
--- a/CDA-Generator/installation.md
+++ b/CDA-Generator/installation.md
@@ -27,7 +27,7 @@ To install those requirements you can refer to the documentation of installation
## Quick start
1. CDAGenerator can be installed using gazelle user on your server:
-2. Checkout the sources of CDAGenerator : git clone https://gitlab.inria.fr/gazelle/applications/mixed/CDAGenerator.git CDAGenerator
+2. Checkout the sources of CDAGenerator : git clone https://gitlab.inria.fr/gazelle/public/validation/cda-generator.git CDAGenerator
3. Execute on the root of the project : `mvn clean install`
4. Create a database : cda-generator, in postgresql (createdb -U gazelle -EUTF8 cda-generator)
5. Copy the ear from CDAGenerator-ear/target/CDAGenerator.ear to /usr/local/jboss7/standalone/deployment/
@@ -175,17 +175,11 @@ INSERT INTO cmn\_application\_preference VALUES (28, 'java.lang.Boolean', '', 'i
INSERT INTO cmn\_application\_preference VALUES (48, 'java.lang.Boolean', '', 'cas\_enabled', 'true');
-INSERT INTO cmn\_application\_preference VALUES (47, 'java.lang.String', '', 'application\_works\_without\_cas', 'false');
-
-INSERT INTO cmn\_application\_preference VALUES (46, 'java.lang.String', '', 'cas\_url', '[*https://gazelle.ihe.net/cas/*](https://gazelle.ihe.net/cas/)');
-
INSERT INTO cmn\_application\_preference VALUES (47, 'java.lang.String', ' ', 'bbr_folder', '/opt/CDAGenerator/BBR/');
INSERT INTO cmn\_application\_preference VALUES (48, 'scorecard_root_oid', 'An OID with trailing DOT (.)', 'java.lang.String', 'The root OID for identifying scorecards');
INSERT INTO cmn\_application\_preference VALUES (49, 'scorecard_next_index', '1', 'java.lang.Integer', 'The next index to be used for identifying scorecards');
-
-
```
| **variable** | **Description** | **type** | **default**|
@@ -200,17 +194,23 @@ INSERT INTO cmn\_application\_preference VALUES (49, 'scorecard_next_index', '1'
| application\_name | application's name | java.lang.String | CDAGenerator |
| application\_profile | application's profile (always prod) | java.lang.String | prod |
| application\_url | application's URL | java.lang.String | https://gazelle.ihe.net/CDAGenerator |
-| application\_works\_without\_cas | cas configuration | java.lang.Boolean | false |
| application\_zone | application zone | java.lang.String | GMT+1 |
| assertion\_manager\_url | link to assertion manager | java.lang.String | https://gazelle.ihe.net/AssertionManagerGui |
| Cache-Control | Application should return caching directives instructing browsers not to store local copies of any sensitive data. | java.lang.String | private, no-cache, no-store, must-revalidate, max-age=0 |
-| cas\_enabled | Enables connecting using cas. If disabled, the application will use IP login if `ip_login` is set to true. | java.lang.Boolean | true |
-| cas\_url | cas url | java.lang.String | https://gazelle.ihe.net/cas |
| cda\_result\_detail | link to cda stylesheet result | java.lang.String | https://gazelle.ihe.net/EVSClient/xsl/schematronResultStylesheet.xsl |
| cda\_xsd | path to schema | java.lang.String | /opt/CDAGenerator/xsd/ihe\_lab/infrastructure/cda/LabCDA.xsd |
-| ip\_login | Enables the connection by IP. This can only be activated if cas is disabled. | java.lang.String | /opt/CDAGenerator/xsd/ihe\_lab/infrastructure/cda/LabCDA.xsd |
-| ip\_login\_admin | Regex IP needs to match to be connected to the application when IP login is enabled. Has no effect if cas is enabled. | java.lang.String | /opt/CDAGenerator/xsd/ihe\_lab/infrastructure/cda/LabCDA.xsd |
+## SSO Configuration
+
+There are additional preferences to configure the SSO authentication.
+
+| Preference name | Description | Example of value |
+| ---------------- | ---------------------------------------------------------------------- | ---------------- |
+| **cas_enabled** | Enable or disable the CAS authentication. | true |
+| **ip_login** | Enable authentication by IP address matching `ip_login_admin` regex. | false |
+| **ip_login_admin** | Regex to authorize ip authentication if CAS authentication is disabled. | .* |
+
+For more documentation about SSO configurations, follow the link [here](https://gitlab.inria.fr/gazelle/public/framework/sso-client-v7/-/blob/master/cas-client-v7/README.md).
## Compile
diff --git a/CDA-Generator/release-note.md b/CDA-Generator/release-note.md
index 7346f0088a5bf4aebead18601cb16f6535abee9f..94636209acda19aa5dc7a28ebf36c508dd4fd7e3 100755
--- a/CDA-Generator/release-note.md
+++ b/CDA-Generator/release-note.md
@@ -1,13 +1,29 @@
---
title: Release note
subtitle: CDA Generator
-toolversion: 2.2.6
-releasedate: 2022-01-24
+toolversion: 3.0.0
+releasedate: 2024-02-05
author: Anne-Gaëlle BERGE
function: Software Engineer
customer: IHE Europe
reference: KER1-RNO-IHE-CDA_GENERATOR
---
+# 3.0.0
+_Release date: 2024-02-05_
+
+__Improvement__
+* \[[CDAGEN-820](https://gazelle.ihe.net/jira/browse/CDAGEN-820)\] Integrate new sso-client-v7
+* \[[CDAGEN-821](https://gazelle.ihe.net/jira/browse/CDAGEN-821)\] Remove username display in GUI
+
+# 2.3.0
+_Release date: 2024-02-06_
+
+Context : Gazelle User Management Renovation step 2
+
+__Task__
+
+* \[[CDAGEN-820](https://gazelle.ihe.net/jira/browse/CDAGEN-820)\] Integrate new sso-client-v7
+
# 2.2.6
_Release date: 2022-01-24_
diff --git a/CH-IUA-Validator/installation.md b/CH-IUA-Validator/installation.md
index f816206491ee3710e745ce6e9b0b776bca88c9e4..98ee2609963a1d0e11cb6d0d74ac7a94b40b8341 100755
--- a/CH-IUA-Validator/installation.md
+++ b/CH-IUA-Validator/installation.md
@@ -27,7 +27,7 @@ To install those requirements you can refer to the documentation of installation
## Instructions
-Copy the chiua-validator-service.war into the "/usr/local/wildfly18/standalone/deployments" directory of your Wildfly server. Finally, start your server.
+Get the chiua-validator-service.war from https://gazelle.ihe.net/nexus/#nexus-search;quick~app.validator and copy it into the "/usr/local/wildfly18/standalone/deployments" directory of your Wildfly server. Finally, start your server.
Once the application is deployed, open a browser and go to http://yourserver/chiua-validator-service/ModelBasedValidationWSImpl?wsdl in order to check of the service is available.
diff --git a/CH-IUA-Validator/release-note.md b/CH-IUA-Validator/release-note.md
index bd3fec1e49d0c69a8cda9686a187dc54ddb2521e..1d5e3baca61b84470def50740e0809da4a83eb46 100755
--- a/CH-IUA-Validator/release-note.md
+++ b/CH-IUA-Validator/release-note.md
@@ -1,8 +1,8 @@
---
title: Release note
subtitle: CH:IUA Validator
-toolversion: 1.0.2
-releasedate: 2020-09-15
+toolversion: 1.0.3
+releasedate: 2022-09-06
author: Nicolas BAILLIET
function: Software Engineer
customer: IHE Europe
diff --git a/CTS/installation.md b/CTS/installation.md
deleted file mode 100755
index b5fdb4cc9c06d5d01b478f52263b03acf67d81c3..0000000000000000000000000000000000000000
--- a/CTS/installation.md
+++ /dev/null
@@ -1,451 +0,0 @@
----
-title: Installation Manual
-subtitle: Certification Testing System
-author: Anne-Gaëlle Bergé
-function: Quality Engineer
-date: 2020-05-25
-toolversion: 1.3
-version: 1.00
-status: Approved
-reference: KER2-MAN-IHE-CTS_1_3
-customer: Federal Office For Public Health
----
-
-# Introduction
-
-FOPH is responsible for providing this guide to the SIA laboratories along with the CTS image to be deployed in the lab.
-
-## Purpose
-
-The purpose of this document is to explain how to install, configure and check the installation of the virtual machine provided by FOPH for
-running SIA test sessions.
-
-## Scope
-
-This document and associated Certification Testing System are relevant to the Swiss Interoperability Assessment Scheme (SIAS) 1.3.
-It is intended to authorized laboratories that will run a SIA test session.
-
-## Virtual Machine characteristics
-
-| __Linux kernel__ | 4.9.0-9-amd64 |
-|-------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|
-| __Operating System__ | Debian GNU/Linux 9.12 (Stretch) |
-| __Allocated Base memory__ | 36 GB, 8 CPUs |
-| __Allocated disk space__ | 120 GB
-| __Virtual machine host name__ | The one provided when requesting a copy of CTS |
-| __Networking__ | How the virtual machine accesses the network must be configured according to your needs and requirements. However, we recommend using a bridge adapter. |
-| __Main user__ | gazelle (password : gazelle) is administrator/sudoer |
-| __Installed applications__ | Oracle Java 7 (/usr/lib/jvm/java-7-oracle), Java 8 (/usr/local/jdk1.8.0_121), java-1.7.0-openjdk-amd64 |
-| | Jboss server AS 7.2.0  (3 instances - locations : /usr/local/jboss7, /usr/local/jboss7-proxy, and /usr/local/jboss7-2) |
-| | Wildfly 10 AS |
-| | postgreSQL 9.6 (user : gazelle) |
-| | Apache 2 |
-| | exim 4 (SMTP server) |
-| | Tomcat8, Tomcat 7 |
-
-# Virtual Machine installation process
-
-## Installation
-
-You have been providing with a link to a qcow2 compressed file to be download and deployed in a QEMU virtualizer.
-
-## Check installation of the Virtual machine
-
-Once the machine is up and running, you should be able to access it in SSHÂ (access with public key only):
-
-```bash
-\#ssh gazelle@box\_ip
-```
-
-You must also be able to access the index from your favorite browser at __https://box\_ip__.
-
-Note that the following artifacts are being launch at start-up as docker containers:
-
-* Postgresql server;
-* Jboss and Wildfly servers (it may take a while);
-* Tomcat servers;
-* The SoapUI mocks.
-
-Accessing the home page and checking that the version number of the tools are displayed will tell you that the Jboss based applications are up and running.
-
-# Configuration
-
-## Applications' URLs and OIDs
-
-The testing environment provided to you has been set up for the URL you provided to FOPH when you requested a copy of the system. An OID was
-assigned to this instance of the CAS testing environment. If, for any reason, you need to update these values, a script is available and will
-update the URLs and/or OIDs defined in the database to meet the new URL and/or OID root. To do so, follow the steps below:
-
-1. SSH on the virtual machine
-2. Check you are in the following directory: /home/gazelle
-3. Edit file vm-packaging/update\_for\_distribution.sh (vim is installed)
-4. Update the value of BOX\_NEW\_URL, it shall match the URL your users will use to access the testing environment
-5. Update the value of BOX\_OLD\_URL, it shall match the URL of the previous installation
-5. Update the value of BOX\_NEW\_IP, it shall match the IP address of the Virtual Machine
-5. If desired, update the value of BOX\_NEW\_OID
-6. Save your changes
-
-7. Got to vm-packaging and run ./update\_for\_distribution.sh
-
-The script will restart the docker containers so that the tools will take the changes into account.
-
-## Port forwarding
-
-We recommend that you use a bridge to connect the virtual machine to your LAN. However, if you rather need to perform a network address translation (NAT), below is the list of ports which MUST be forwarded:
-
-* For Gazelle Security Suite: 20007, 20009, 20011, 20070, 3001, 3102, 3202
-* Apache server: 80 / 443 / 10443 if you use HTTPS
-
-Note that those ports are displayed to the user to facilitate the configuration of his/her system; then, it is a good practice to map the ports with the same number.
-
-## Installation of the machine certificate
-
-If the DNS entry was available when the CTS has been configured with your FQDN, a certificate has been requested to Letsencrypt and it has been installed.
-Otherwise, it is your responsibility to install a certificate for HTTPS accesses.
-
-The truststore of the jboss and tomcat servers need to access the truststore containing the certificate chain to the certificate used.
-The application servers installed on the machine are already configured to access the truststore.jks file located in the directory /opt/gazelle/cert.
-So updating that file with the correct chain of certificate is enough. The password of the truststore is set to « password ».
-If you change this password, you shall update the configuration of the Jboss7 and Tomcat application servers accordingly.
-
-### Generate certificates in GSS
-
-Log into Gazelle Security Suite and access PKI > Request a certificate.
-Fill out the form with the following parameters and hit “Requestâ€.
-* Certificate type: Client and Server
-* Key size: 4096
-* Common Name (CN) shall match the full qualifier domain name of the CTS environment.
-* Other mandatory parameters shall fill out to match your organization and country.
-* If the system under test supports SNI, you need to generate another certificate for the second
-hostname that can be used to reach your CTS environment.
-
-### Load the certificate on CTS
-
-In Gazelle Security Suite, go to PKI > Certificate certificates and access the details related to the certificates you have requested.
-From the top right corner of the page, download the certificate (PEM Format), the private key, and the keystore (JKS format) (Password : password, Alias :jboss).
-Copy those certificates in /opt/gazelle/cert on CTS.
-
-#### Configure simulators
-
-Replace /opt/gazelle/cert/jboss.jks by the previously downloaded keystore.
-
-#### ATNA SNI tests
-
-ATNA with SNI extension requires modifications to be performed on the initial library in order to adapt with the testing platform. By default, the library and its certificates are pointing on ehealthsuisse.ihe-europe.net platform.
-Pre-requisite: section "Generate certificates in GSS" has been completed and you have two new certificates.
-* Copy the certificates and private keys into the library’s folder (in /opt/simulators/atna-tls-testing-with-sni/certificates)
-* Edit the server SNI script (server-tls-1.0-sni.sh)
-* Replace the ehealthsuisse-simu .pem and .keycertificates by the certificates pointing on your testing platform (make sure to keep the “certificates/†mentions in front of the certificate names)
-* Replace the test-ihe-europe .pem and .key certificates by the certificates pointing on your second hostname
-* Save the script
-
-#### Apache configuration (port 10443)
-
-ehealthsuisse-simu.key and ehealthsuisse-simu.pem in /opt/gazelle/cert/simu-apache must be replaced by the certificate and the private key previously downloaded.
-
-#### IDP
-
-Enter the commands (enter 'password' when asked):
-```
-$> sudo su
-$> cd /etc/letsencrypt/live/<domainname>
- $> openssl pkcs12 -export -inkey privkey.pem -in cert.pem -certfile chain.pem -out cert.p12
-```
-
-Then replace idp-backchannel.p12 and idp-browser.p12 in /opt/shibboleth-idp/credentials by cert.p12
-Finally,restart docker :
-```
-$> sudo docker restart shibboleth-idp
-```
-
-Open docker log :
-
-```
-$> sudo docker logs shibboleth-idp
-```
-
-If there are errors you will need to restart apacheds then restart the IDP :
-
-```
-$> sudo service apacheds-2.0.0-M24-default stop
-$> sudo service apacheds-2.0.0-M24-default start
-$> sudo docker restart shibboleth-idp
-```
-
-#### Configure TLS simulators in GSS
-
-```
-psql -U gazelle gss -c "UPDATE tls_simulator SET certificate_id = <id_of_the_new_certificate> WHERE certificate_id = 23"
-```
-
-Where <id_of_the_new_certificate> is the id of the certificate created in the "Generate certificates in GSS" section of this document. This id is displayed in the GUI.
-
-#### Restart all docker
-
-```
-docker restart authentication-simulator ch-iua-validator epr-access-token-provider epr-adr-simulator epr-assertion-provider-simulator epr-atc-simulator epr-ppq-repository epr-restricted-metadata-update-update-document-set epr-restricted-metadata-update-responding-gateway epr-restricted-metadata-update-registry-stored-query epr-xca-responding-gateway epr-xds-registry gazelle-assertion-manager gazelle-autoheal gazelle-cda-generator gazelle-dds gazelle-documentation gazelle-evsclient gazelle-fhir-validator gazelle-front gazelle-hl7v2-validator gazelle-hpd-simulator gazelle-patient-manager gazelle-patient-registry gazelle-pixm-connector gazelle-reverse-proxy-apache2 gazelle-schematron-validator gazelle-security-suite gazelle-sso gazelle-sts gazelle-svs-simulator gazelle-tm gazelle-webservice-tester hapi-fhir-jpavalidator idp-adapter shibboleth-idp xdstar-client
-```
-
-# Check access to the tools
-
-From https://your\_box\_url, you should access the following page (Apache front-end) which lists the available applications, their links, and the links to their user manual.
-
-
-
-Check you have access to all the tools. When you access the tool for the first time, the loading of the page could appear to be quite long because
-the tool is being initialized.
-
-## Login
-
-A Central Authentication Service has been set installed and configured. You will be able to create new accounts. To access the tools for the first time,
-use the default account:
-
-__Username__: admin
-
-__Password__: 123456
-
-__Role__: admin\_role
-
-Once you have created your own account (with admin_role role at least) and make sure you disable the admin account or change its password.
-
-## Jboss management
-
-_jboss7_ can be replaced by jboss7-2, jboss7-proxy or wildfly 10 depending on the Jboss application server you need to start/stop/restart.
-
-| __Command__ | __Description__ |
-|--------------------------------------------------------|----------------------------------------------------------------------------------------------------------|
-| sudo service jboss7 start | Starts the Jboss7 default server (requires gazelle's password) |
-| sudo service jboss7 stop | Stops the Jboss7 process (requires gazelle's password) |
-| sudo service jboss7 restart | Stops the Jboss7 server and after a while starts it again (requires gazelle's password) |
-
-# Gazelle tools
-
-## User guides
-
-Documentation for the tools that are installed on the virtual machine can be found at YOUR_SERVER_URL/gazelle-documentation. On the home page, a direct
-link to each page of the manual is available (PDF icon).
-
-## Included tools
-
-The following tools are installed on the virtual machine:
-
-* __Gazelle Test Management (configured to work as Test Management and Gazelle Master Model)__ is the tool used during the connectathons. It is used to manage
-the users, the systems under test and the test sessions. SIA conformance tests are also stored in this tool.
-It embeds the SIA test cases and the IHE concepts.
-* __Patient Manager__ is a simulator which integrates the IHE profiles which deals with patient and encounter management (CH:PIXV3, CH:XCPD, and CH:PDQV3 are configured)
-* __SVS Simulator__ is a simulator for the SVS profile. It is used by the other applications of the Gazelle test bed as a value set repository.
-* __Gazelle HL7 Validator__ is a validation tool for HL7v3-based messages
-* __Assertion manager Gui__ gathers the assertions extracted from the IHE Technical Framework and EPR specifications
-* __XDSTools__ is aimed to test the systems implementing the XDS.b, XCA, XDS-I.b and XCA-I integration profiles
-* __Gazelle Security Suite__ gathers features to test the CH:ATNA integration profile
-* __Demographic Data Server__ is used to generate fake demographics for testing purposes
-* __EVS Client__ is the graphical interface to Gazelle validation services.
-* __Gazelle Webservice Tester__ has been designed with the purpose of executing SoapUI projects against the systems under test. It also stores the
-message exchanged between the systems under test and the SoapUI mocks
-* __Schematron Validator__ is a schematron-based conformance checker
-* __HPD Simulator__ emulates the CH:HPD actors and offers a validation service for the messages produced in the context of this profile
-* __XD\* Client__ offers validators for verifying the conformance of the XD* messages
-* __CDA Generator__ owns the validator for the CDA SDCO documents
-* __Gazelle FHIR Validator__ provides validators for the messages exchanged in the context of the CH:ATC profile
-* __Authentication Simulator__
-* __CAS__ service for singe-sign-on login
-* __Nagios__ is a service monitoring configured to check the availability of the tools installed in the virtual machine
-* A number of SoapUI mocks are also available, they emulates EPR actors playing the role of responder:
- * Assertion Provider
- * ADR Provider
- * PPQ Repository
- * Metadata Update Responder
- * ATC Patient Audit Record Repository
- * XDS Document Registry
- * XCA Responding Gateway
-* A library for TLS tests with SNI extension used to test authentication with this extension.
-
-The following binaries are deployed in the Jboss7-2: /usr/local/jboss7-2/standalone/deployments directory.
-
-| __Application__ | __Binary name__ | __version__ | __Database__ |
-|-------------------------|---------------------------|-------------|-------------------------|
-| Demographic Data Server | DemographicDataServer.ear | 4.2.2 | demographic-data-server |
-| EVS Client | EVSClient.ear | 5.12.1 | evs-client-prod
-| Gazelle Webservice Tester | gazelle-websesrvice-tester.ear | 1.7.1 | gazelle-webservice-tester |
-| Schematron Validator | SchematronValidator.ear | 2.5.0 | schematron-validator-prod |
-| Authentication Simulator | authentication-simulator.ear | 0.1.2 | authentication-simulator |
-
-
-The following binaries are deployed in Jboss 7-proxy server: /usr/local/jboss7-proxy/standalone/deployment/.
-
-| __Application__ | __Binary name__ | __version__ | __Database__ |
-|------------------------|---------------------------|-------------|-----------------------|
-| Assertion manager Gui | AssertionManagerGui.ear | 4.1.0 | assertion-manager |
-| Test Management | gazelle-tm.ear | 5.12.1 | gazelle |
-| Patient Manager | PAMSimulator.ear | 9.11.7 | pam-simulator |
-| SVS Simulator | SVSSimulator.ear | 2.3.0 | svs-simulator |
-| Gazelle HL7 Validator | GazelleHL7v2Validator.ear | 3.5.1 | gazelle-hl7-validator |
-| Gazelle Security Suite | gazelle-gss.ear | 6.2.4 | gss |
-
-The following binaries are deployed in Jboss 7 server: /usr/local/jboss7/standalone/deployment/.
-
-| __Application__ | __Binary name__ | __version__ | __Database__ |
-|------------------------|---------------------------|-------------|-----------------------|
-| CDA Generator | CDAGenerator.ear | 2.2.1 | cda-generator |
-| HPDSimulator | HPDSimulator.ear | 2.2.1 | hpd-simulator |
-| XDStarClient | XDStarClient.ear | 2.5.4 | xdstar-client |
-| IDP Adaptor | idp-adapter.ear | 0.1.1 | NO DB |
-
-
-The following binaries are deployed in tomcat 8 server: /var/lib/tomcat8/webapps/
-
-| __Application__ | __Binary name__ | __version__ | __Database__ |
-|-----------------|----------------------|-------------|--------------|
-| XDSTools7 | xdstools7.war | 7.2.8 | NO DB |
-| Apereo CAS | sso.war | | Connect to gazelle |
-
-The following binary is deployed in Wildfly 10 server: /usr/local/wildfly10/standalone/deployments
-
-| __Application__ | __Binary name__ | __version__ | __Database__ |
-|-----------------|----------------------|-------------|--------------|
-| Gazelle FHIR Validator | FhirValidator.ear | 3.0.3 | gazelle-fhir-validator |
-
-All the web services required by the applications are on the virtual machine. No access will be done to Gazelle’s servers.
-
-## Monitoring of services
-
-The test environment is delivered with Nagios3 tool configured to check the availability of the services available in the testbed. You will access it from the __Nagios Monitoring__ link of the home page.
-Default username and password have been set to nagiosadmin/gazelle.
-
-## Calibration
-
-For some applications, calibration scripts have been set up. To check the proper configuration of your environment or to check the environment is
-calibrated, you can access the administration page at YOUR_SERVER_URL/admin.php. Details on how it works are given at
-YOUR_SERVER_URL/gazelle-documentation/Gazelle-Calibration/user.html.
-
-# Backups
-
-The backup of the databases (and ONLY the databases) is performed automatically. In the home directory of gazelle (/home/gazelle) there is a folder
-called backup. In that folder there is a script called backup.sh which is executed once a day thanks to a cron
-
-```
-@daily /home/gazelle/backup/backup.sh
-```
-
-We use then logrotate in order to keep:
-
-* a back up for the last 7 days
-* a back up for the last 4 weeks
-* a back up for the last 12 months
-
-For each database we create
-
-* a dump,
-* a SQL dump of the definition,
-* a SQL dump of the data
-
-# Running a SIA testing session
-
-A number of pre-requisites are given below which will help the testing session manager to conduct correctly a SIA testing session.
-
-## Testing session definition
-
-The CTS is provided with a testing session entitled "Default CA Testing Session"; this includes all you need to run a session.
-If you need to create a new testing session, make sure that, when you define this new testing session, you include the list of integration profile
-to be tested. You shall also select “conformity assessment†as testing session type; this will allow the participants to see the tests defined for
-in SIAS.
-
-## Testing tools
-
-Conformity assessment testing is run against tools, some of them have to be declared as such in Gazelle Test Management.
-
-The "Defaut CA Testing Session" session includes those tools. To import them into a newly created testing session, you need to
-
-1. Go to Administration > Manage > Systems > System Management
-2. Click on “Import systems from a previous testing sessionâ€
-3. Select company with keyword = IHE
-4. Select the tools to import
-5. Click on Import
-
-
-## System acceptance
-
-To allow the SUT operator to see the tests to be performed for his/her system, you need to accept it in the testing session. To do so, go to
-Administration > Manage > Systems > System acceptance and hit the checkbox for the systems to be included in this testing session.
-
-## Testing against central services
-
-Testing of the UPI and CH:CPI profiles requires that the systems under test establish a connection respectively to ZAS and BIT central services. It is
-then the responsibility of the testing laboratory to contact those services to get the log of the exchanged messages in order to verify that the messages
-sent by the systems under test complies with EPR specifications.
-
-Please note that there is not legal agreement that bounds the SIA Laboratory with ZAS and BIT.
-
-The following sections give you guidance regarding the prerequisite to test against those services.
-
-### Testing UPI against ZAS
-
-The conformity assessment tests for the UPI profile are run against ZAS UPI service. Only members from the federal organizations are allowed to access the GUI of the UPI system where
-the logs of the testing reside. In other words, as a laboratory, you will not have a direct access to the messages exchanged between the system under test and the UPI service.
-One week in advance of the testing session, you are expected to notify ZAS that you are going to conduct a SIA test session and that you requested their help to fetch the test logs.
-
-During the execution of the conformity assessment tests for UPI, the SUT operators is requested to provide the demographics of the patients they used in the test steps. To help ZAS
-to gather the messages of relevance for you, please populate the spreadsheet "UPI\_Logs\_request\_to\_ZAS.xlsx" (available under the test data section of CTS).
-
-Once ZAS has gathered the message to you, they will send you the XML file along with the original spreadsheet updated with the file name. Upload the messages in the relevant test
-steps and ask the SUT operators to validate them using EVS Client.
-
-### Testing CH:CPI against BIT
-
-The conformity assessment tests for the CH:CPI profile are run against the BIT CPI Provider. Only members from the federal organizations are allowed to access the GUI of the CPI
-system where the audit logs of the testing reside. Also BIT CPI Provider requires an operational action to enable logging full traces (complete payload of messages). In other words,
-as a laboratory, you will not have a direct access to the messages exchanged between the system under test and the CPI Provider.
-
-One week in advance of the testing session, you are expected to notify BIT that you are going to conduct a SIA test session and that you requested their help to fetch the test logs.
-The day of the execution of CH:CPI, you must notify them the precise CH:CPI testing hours for enabling/disabling the traces. Once the testing over, you should receive from BIT the
-complete traces logged during the given hours. It is the lab's responsability to find the messages sent by the SUT and upload them in the relevant test step (SUT operators are
-requested to provide timestamp, IP/host and query information for helping this process).
-
-In case of technical issues (request from the SUT operator failing), BIT can be contacted to have a look at their monitoring interface. This interface provides summary information of
-request attempts and complete audit logs that can help troubleshooting faster. FOPH also have an access to this interface.
-
-### Testing TLS with SNI extension
-
-ATNA profile specification authorizes the use of SNI extension in TLS tests (multiple hostnames with one IP address). However, the current TLS simulator in GSS does not support this extension.
-This may cause a failure in TLS tests with systems requiring SNI. A temporary workaround with a tool dedicated to test that case has been set up.
-This tool is named "atna-tls-testing-with-sni" and its directory is located in "/opt/simulators".
-A README file has been created at root directory level to guide monitors through the testing process.
-
-Prior to perform this test, monitors must ask participants to provide them with an additional DNS entry specifically for SNI extension testing.
-As mentioned in SIA test cases in Gazelle Test Management, monitors are asked to provide the logs retrieved from the tool as evidence in test steps.
-
-# Annex : Cloning process
-
-The CTS is obtained from the Reference Environment 1.2.
-
-Clone the virtual machine of the reference environment. Start it
-
-Download the packaging scripts on the VM from the SVN repository : https://svn.ihe-europe.net/gazelle/scripts/vm-packaging/branches/CTS
-
-`svn checkout https://svn.ihe-europe.net/gazelle/scripts/vm-packaging/branches/CTS packaging-scripts/`
-
-There is two main scripts :
-- cleanup_data_for_distribution.sh : Delete all data not needed for the CTS
-- update_for_distribution.sh : Update all the URLs, IP address and OIDs
-
-Both need to be executed with root access (sudo).
-
-First, execute the clean up scripts :
-
-`sudo ./cleanup_data_for_distribution.sh`
-
-Before executing the second script, some parameters need to be updated. Open the update_for_distribution.sh and update the following properties :
-* BOX_NEW_URL= the url for the CTS VM
-* BOX_NEW_OID= the oid for the CTS VM
-* BOX_NEW_IP= the ip for the CTS VM
-* ADMIN_NAME= The admin name in Gazelle Test Management
-* ADMIN_TITLE= The admin title in Gazelle Test Management
-* ADMIN_EMAIL= The admin email in Gazelle Test Management
-
-The following properties should not be changed as they are the url of the reference environment (it always be https://ehealthsuisse.ihe-europe.net) and the old hostname :
-* BOX_OLD_URL
-* DEFAULT_BOX_HOSTNAME
-
-Save the file, then execute update_for_distribution.sh with sudo :
-
-`sudo ./update_for_distribution.sh`
diff --git a/CTS/media/home_page.png b/CTS/media/home_page.png
deleted file mode 100755
index 7bf6897d91702ebc0fa2aac99768db964efca45b..0000000000000000000000000000000000000000
Binary files a/CTS/media/home_page.png and /dev/null differ
diff --git a/DCC-validator/installation.md b/DCC-validator/installation.md
index 31c6c242cfc8f4000fb749716ae227992cee561b..43dc3ce01d158b94e8f932bb3a4e85c4b6a88056 100755
--- a/DCC-validator/installation.md
+++ b/DCC-validator/installation.md
@@ -2,8 +2,8 @@
title: Installation Manual
subtitle: DCC Validator
author: Malo Toudic
-releasedate: 05/04/2025
-toolversion: 1.0.x
+releasedate: 03/11/2023
+toolversion: 1.2.x
function: Developer
version: 0.01
status: Draft document
@@ -51,11 +51,12 @@ Define a resource in your server with name *java:/app/gazelle/dcc-validator/oper
This resource should refer to a deployment.properties file. This file shall contain the following properties :
-| Property Name | Description | Example value |
-| --- | --- | --- |
-| svssimulator.url | URL of Simulator | <http://localhost/SVSSimulator> |
-| truststore.path | Path of the truststore containing the trusted certificates that issues Digital covid certificates | /opt/dcc-validator/truststore.jks |
-| truststore.password | Password of the truststore containing the trusted certificates that issues Digital covid certificates | password |
+| Property Name | Description | Example value |
+| --- |-------------------------------------------------------------------------------------------------------|-----------------------------------|
+| svssimulator.url | URL of Simulator | <http://localhost/SVSSimulator> |
+| truststore.path | Path of the truststore containing the trusted certificates that issues Digital covid certificates | /opt/dcc-validator/truststore.jks |
+| truststore.password | Password of the truststore containing the trusted certificates that issues Digital covid certificates | password |
+| ddvcverifier_url | URL of the WHO DDVC verifier | http://localhost/verify |
#### Configure WildFly 18 for DCC Validator
diff --git a/DCC-validator/release-note.md b/DCC-validator/release-note.md
index 8fad9df4e8360498d057c035b55c3688373576e8..4f325a17287bad35726dfb219f7ee380e2d6d260 100755
--- a/DCC-validator/release-note.md
+++ b/DCC-validator/release-note.md
@@ -1,14 +1,23 @@
---
title: Release note
subtitle: Digital Covid Certificate validator
-toolversion: 1.0.0
-releasedate: 2022-04-05
+toolversion: 1.2.2
+releasedate: 2023-11-03
author: Malo Toudic
function: Software developer
customer: IHE Europe
reference: KER1-RNO-IHE-DCC_VALIDATOR
---
+# 1.2.2
+_Release date: 2023-11-03_
+
+__Story__
+* \[[DCC-20](https://gazelle.ihe.net/jira/browse/DCC-20)\] Make the DDVC verify url configurable
+
+__Problem__
+* \[[DCC-21](https://gazelle.ihe.net/jira/browse/DCC-21)\] Some DDVC QR CODE cannot be decoded
+
# 1.2.1
_Release date: 2022-11-29_
diff --git a/Datamatrix/Makefile b/Datamatrix/Makefile
new file mode 100755
index 0000000000000000000000000000000000000000..cbbc56c706e2a9d7c1b43999f7199c4c956757ea
--- /dev/null
+++ b/Datamatrix/Makefile
@@ -0,0 +1,3 @@
+SHELL := /bin/bash
+
+include ../Makefile.generic
diff --git a/Datamatrix/installation.md b/Datamatrix/installation.md
new file mode 100755
index 0000000000000000000000000000000000000000..d4eef60d78a48eca6ef3eb2e09258e7a4feb7f9b
--- /dev/null
+++ b/Datamatrix/installation.md
@@ -0,0 +1,12 @@
+---
+title: Installation Manual
+subtitle: Datamatrix
+author: Nicolas BAILLIET
+function: Developer
+date: 2023-10-24
+toolversion: 1.X.X
+version: 1.0
+status: Approved
+reference: KER1-MAN-ANS-DATAMATRIX_INSTALLATION
+customer: ANS
+---
diff --git a/Datamatrix/release-note.md b/Datamatrix/release-note.md
new file mode 100755
index 0000000000000000000000000000000000000000..d6a3b1ef8a20eb3d19a9c3cbb90ab092d09bff9b
--- /dev/null
+++ b/Datamatrix/release-note.md
@@ -0,0 +1,16 @@
+---
+title: Release note
+subtitle: Datamatrix
+toolversion: 1.0.1
+releasedate: 2023-10-24
+author: Nicolas BAILLIET
+function: Developer
+customer: ANS
+reference: KER1-RNO-ANS-DATAMATRIX
+---
+# 1.0.1
+_Release date: 2023-10-24_
+
+__Task__
+* \[[DATAMATRIX-1](https://gazelle.ihe.net/jira/browse/DATAMATRIX-1)\] IHM improvement - Size text area, Version number, user manual
+* \[[DATAMATRIX-2](https://gazelle.ihe.net/jira/browse/DATAMATRIX-2)\] C40 encoding and broken link
\ No newline at end of file
diff --git a/Datamatrix/user.md b/Datamatrix/user.md
new file mode 100755
index 0000000000000000000000000000000000000000..8327aa356667e6860b7cd56659e4744b612b7988
--- /dev/null
+++ b/Datamatrix/user.md
@@ -0,0 +1,12 @@
+---
+title: User Manual
+subtitle: Datamatrix
+author: Nicolas BAILLIET
+function: Developer
+releasedate: 2023-10-24
+toolversion: 1.X.X
+version: 1.02
+status: Draft
+reference: KER1-MAN-ANS-DATAMATRIX_USER
+customer: ANS
+---
\ No newline at end of file
diff --git a/Datamatrixins/release-note.md b/Datamatrixins/release-note.md
new file mode 100644
index 0000000000000000000000000000000000000000..62479a3f8aecea5005a65a5953aa6a2342ca3c75
--- /dev/null
+++ b/Datamatrixins/release-note.md
@@ -0,0 +1,17 @@
+---
+title: Release note
+subtitle: Datamatrixins
+toolversion: 1.0.1
+releasedate: 2023-11-14
+author: Clément LAGORCE
+function: Software Engineer
+customer: IHE Europe
+reference: KER1-RNO-IHE-DATAMATRIXINS
+---
+
+# 1.0.1
+_Release date: 2023-11-14_
+
+__Bug__
+* \[[HTTP-16](https://gazelle.ihe.net/jira/browse/HTTP-16)\] Release/Doc
+* \[[HTTP-43](https://gazelle.ihe.net/jira/browse/HTTP-43)\] Use new Validation API and Reports
\ No newline at end of file
diff --git a/Demographic-Data-Server/installation.md b/Demographic-Data-Server/installation.md
index 5c74140a949100b8d860c42fd8936025d66a1c45..1946449517703c16d1b34fa43832dbb80ce55797 100755
--- a/Demographic-Data-Server/installation.md
+++ b/Demographic-Data-Server/installation.md
@@ -14,12 +14,12 @@ customer: IHE-EUROPE
Demographic Data Server is a Maven project. Sources are available on the INRIA's Gitlab project at the following URL :
-[*https://gitlab.inria.fr/gazelle/applications/test-design/DemographicDataServer.git*](https://gitlab.inria.fr/gazelle/applications/test-design/DemographicDataServer.git)
+[*https://gitlab.inria.fr/gazelle/public/processing/demographic-data-server.git*](https://gitlab.inria.fr/gazelle/public/processing/demographic-data-server.git)
If you would like to checkout the sources on your system you might want to use the following git command, provided git is installed on your system.
```bash
-git clone https://gitlab.inria.fr/gazelle/applications/test-design/DemographicDataServer.git
+git clone https://gitlab.inria.fr/gazelle/public/processing/demographic-data-server.git
```
Note that the latest executable can be extracted from our nexus repository as well at :
@@ -86,10 +86,20 @@ Database name : demographic-data-server
|application_documentation | Link to the user guide | https://gazelle.ihe.net/gazelle-documentation/Demographic-Data-Server/user.html |
|application_mode | | full |
|application_url | URL to access the application | https://FQDN/DDS |
-|application_works_without_cas | Enable or disable the CAS authentication | true |
|DDS_domain | | DDS |
|DDS_OID | Unique identifier of the tool instance | 1.1.1.1.1.1.1.1.1.1.1.1 |
|hl7v3_sender_timeout | | 15000 |
-|ip_login_admin | Regex to authorize ip authentication if CAS authentication is disabled | .* |
|issue_tracker_url | Link to the issue reporter (JIRA) | https://gazelle.ihe.net/jira/browse/DDS |
|time_zone | Used to display date/time in the appropriate time zone | Europe/Paris |
+
+### SSO Configuration
+
+There are additional preferences to configure the SSO authentication.
+
+| Preference name | Description | Example of value |
+| ---------------- | ---------------------------------------------------------------------- | ---------------- |
+| **cas_enabled** | Enable or disable the CAS authentication. | true |
+| **ip_login** | Enable authentication by IP address matching `ip_login_admin` regex. | false |
+| **ip_login_admin** | Regex to authorize ip authentication if CAS authentication is disabled. | .* |
+
+For more documentation about SSO configurations, follow the link [here](https://gitlab.inria.fr/gazelle/public/framework/sso-client-v7/-/blob/master/cas-client-v7/README.md).
\ No newline at end of file
diff --git a/Demographic-Data-Server/release-note.md b/Demographic-Data-Server/release-note.md
index 3233cede2a9af3edffd04d76dae10d45ec5e1f8e..7b6693e78f7a83f18c397fa016a500e1ef51114a 100755
--- a/Demographic-Data-Server/release-note.md
+++ b/Demographic-Data-Server/release-note.md
@@ -1,16 +1,36 @@
---
title: Release note
-subtitle: Demographic Data Server - 4.3.2
-toolversion: 4.3.2
-releasedate: $versionObj.releaseDate
+subtitle: Demographic Data Server
+toolversion: 4.4.0
+releasedate: 2024-02-05
author: Anne-Gaëlle BERGE
function: Software Engineer
customer: IHE Europe
reference: KER1-RNO-IHE-DDS
---
+# 4.4.0
+_Release date: 2024-02-05_
+
+__Task__
+* \[[DDS-207](https://gazelle.ihe.net/jira/browse/DDS-207)\] Integrate new sso-client-v7
+
+# 4.3.4
+_Release date: 2023-04-14_
+
+__Bug__
+* \[[DDS-206](https://gazelle.ihe.net/jira/browse/DDS-206)\] Fix TOS popup
+
+# 4.3.3
+_Release date: 2023-02-13_
+
+__Bug__
+* \[[DDS-206](https://gazelle.ihe.net/jira/browse/DDS-206)\] Fix TOS popup
+
# 4.3.2
+_Release date: 2023-02-01_
+
__Bug__
-* \[[DDS-206](https://gazelle.ihe.net/jira/browse/DDS-206)\] Texte pour les cookies
+* \[[DDS-206](https://gazelle.ihe.net/jira/browse/DDS-206)\] Fix TOS popup
# 4.3.1
_Release date: 2022-01-19_
diff --git a/Dockerfile b/Dockerfile
index a85cd3d32dfc112095b2d9e8893151ea33146832..bbf297187617bb0cb51f3c05b9ba436e3f3c593c 100644
--- a/Dockerfile
+++ b/Dockerfile
@@ -1,9 +1,10 @@
# use an old version of Ruby
-FROM ruby:2.3.1 as builder
+FROM ruby:2.7.0 as builder
USER root
# non interactive
ARG DEBIAN_FRONTEND=noninteractive
+
# install utilities (gcc, ...)
RUN apt-get update && apt-get install -y \
wget curl sudo build-essential git git-svn \
@@ -15,7 +16,7 @@ WORKDIR /opt/jekyll-gazelle-documentation
# copy only Gemfile/Gemfile.lock
COPY _templates/jekyll-gazelle-documentation/Gemfile* /opt/jekyll-gazelle-documentation/
# install bundler with version specified in Gemfile.lock
-RUN gem install bundler -v 1.17.3
+RUN gem install bundler
# install gem dependencies provided in Gemfile.lock
RUN bundle install --deployment
diff --git a/EPR-ADR-Simulator/release-note.md b/EPR-ADR-Simulator/release-note.md
index 589cb28fb9716d3d36084f5fa388406da908b18a..ba4d1acf0e5de3dd6403b73cb7fe1587cc63fb7d 100755
--- a/EPR-ADR-Simulator/release-note.md
+++ b/EPR-ADR-Simulator/release-note.md
@@ -1,15 +1,22 @@
---
title: Release note
subtitle: ADR Simulator
-author: Youn Cadoret
+author: Youn Cadoret / Alexandre POCINHO
function: Developer
-releasedate: 2020-03-11
-toolversion: 1.3.6
+releasedate: 2023-06-13
+toolversion: 1.3.7
reference: KER1-RNO-IHE-ADR_SIMULATOR
customer: IHE-EUROPE
---
+# 1.3.7
+_Release date: 2023-06-13_
+
+__Task__
+* \[[ADRPROV-17](https://gazelle.ihe.net/jira/browse/ADRPROV-17)\] Update specification for CH:ADR Response
+
+
# 1.3.6
_Release date: 2020-03-11_
diff --git a/EPR-ADR-Simulator/user.md b/EPR-ADR-Simulator/user.md
index bce97a2f695aec5b78e026890220c620695d3f7d..3a30933485cd0ed888b0a97ab9c6c33892cefcfa 100755
--- a/EPR-ADR-Simulator/user.md
+++ b/EPR-ADR-Simulator/user.md
@@ -72,7 +72,7 @@ It requires TLS mutual authentication with testing certificate (from GSS PKI). [
</wsse:Security>
</soap:Header>
<soap:Body>
- <xacml-samlp:XACMLAuthzDecisionQuery InputContextOnly="false" ReturnContext="false" ID="\_682fee8b-46c0-442a-8c54-fd9d656412fc" Version="2.0" IssueInstant="2019-02-05T14:48:29Z" xmlns:xacml-samlp="urn:oasis:names:tc:xacml:2.0:profile:saml2.0:v2:schema:protocol" xmlns:xacml-context="urn:oasis:names:tc:xacml:2.0:context:schema:os" xmlns:hl7="urn:hl7-org:v3">
+ <xacml-samlp:XACMLAuthzDecisionQuery InputContextOnly="false" ReturnContext="false" ID="_682fee8b-46c0-442a-8c54-fd9d656412fc" Version="2.0" IssueInstant="2019-02-05T14:48:29Z" xmlns:xacml-samlp="urn:oasis:names:tc:xacml:2.0:profile:saml2.0:v2:schema:protocol" xmlns:xacml-context="urn:oasis:names:tc:xacml:2.0:context:schema:os" xmlns:hl7="urn:hl7-org:v3">
<xacml-context:Request>
<xacml-context:Subject>
<xacml-context:Attribute AttributeId="urn:oasis:names:tc:xacml:1.0:subject:subject-id" DataType="http://www.w3.org/2001/XMLSchema#string">
@@ -176,7 +176,7 @@ It requires TLS mutual authentication with testing certificate (from GSS PKI). [
</wsse:Security>
</soap:Header>
<soap:Body>
- <xacml-samlp:XACMLAuthzDecisionQuery InputContextOnly="false" ReturnContext="false" ID="\_682fee8b-46c0-442a-8c54-fd9d656412fc" Version="2.0" IssueInstant="2019-02-05T14:22:29Z" xmlns:xacml-samlp="urn:oasis:names:tc:xacml:2.0:profile:saml2.0:v2:schema:protocol" xmlns:xacml-context="urn:oasis:names:tc:xacml:2.0:context:schema:os" xmlns:hl7="urn:hl7-org:v3">
+ <xacml-samlp:XACMLAuthzDecisionQuery InputContextOnly="false" ReturnContext="false" ID="_682fee8b-46c0-442a-8c54-fd9d656412fc" Version="2.0" IssueInstant="2019-02-05T14:22:29Z" xmlns:xacml-samlp="urn:oasis:names:tc:xacml:2.0:profile:saml2.0:v2:schema:protocol" xmlns:xacml-context="urn:oasis:names:tc:xacml:2.0:context:schema:os" xmlns:hl7="urn:hl7-org:v3">
<xacml-context:Request>
<xacml-context:Subject>
<xacml-context:Attribute AttributeId="urn:oasis:names:tc:xacml:1.0:subject:subject-id" DataType="http://www.w3.org/2001/XMLSchema#string">
@@ -245,7 +245,7 @@ It requires TLS mutual authentication with testing certificate (from GSS PKI). [
</wsse:Security>
</soap:Header>
<soap:Body>
- <xacml-samlp:XACMLAuthzDecisionQuery InputContextOnly="false" ReturnContext="false" ID="\_682fee8b-46c0-442a-8c54-fd9d656412fc" Version="2.0" IssueInstant="2019-02-05T14:58:58Z" xmlns:xacml-samlp="urn:oasis:names:tc:xacml:2.0:profile:saml2.0:v2:schema:protocol" xmlns:xacml-context="urn:oasis:names:tc:xacml:2.0:context:schema:os" xmlns:hl7="urn:hl7-org:v3">
+ <xacml-samlp:XACMLAuthzDecisionQuery InputContextOnly="false" ReturnContext="false" ID="_682fee8b-46c0-442a-8c54-fd9d656412fc" Version="2.0" IssueInstant="2019-02-05T14:58:58Z" xmlns:xacml-samlp="urn:oasis:names:tc:xacml:2.0:profile:saml2.0:v2:schema:protocol" xmlns:xacml-context="urn:oasis:names:tc:xacml:2.0:context:schema:os" xmlns:hl7="urn:hl7-org:v3">
<xacml-context:Request>
<xacml-context:Subject>
<xacml-context:Attribute AttributeId="urn:oasis:names:tc:xacml:1.0:subject:subject-id" DataType="http://www.w3.org/2001/XMLSchema#string">
diff --git a/EPR-ATC-Simulator/installation.md b/EPR-ATC-Simulator/installation.md
index cd93d9f171196463e5d50fc1959e43b6ddc30fba..b1694c60237279b32c7d322158ab79afbedf6366 100755
--- a/EPR-ATC-Simulator/installation.md
+++ b/EPR-ATC-Simulator/installation.md
@@ -4,7 +4,7 @@ subtitle: ATC Simulator
author: Wylem BARS
function: Software Engineer
date: 06/11/2019
-toolversion: 1.3.x
+toolversion: 2.0.x
version: 1.01
status: Reviewed
reference: KER1-MAN-IHE-ATC_SIMULATOR_INSTALLATION-1_01
diff --git a/EPR-ATC-Simulator/release-note.md b/EPR-ATC-Simulator/release-note.md
index 81b1eeb425c099eedde4100d396f06dc34a509fd..f99dc7567f37f481eefbc9202aea4e764cbdabf0 100755
--- a/EPR-ATC-Simulator/release-note.md
+++ b/EPR-ATC-Simulator/release-note.md
@@ -1,14 +1,25 @@
---
title: Release note
subtitle: ATC Simulator
-toolversion: 1.3.4
-releasedate: 2020-10-18
+toolversion: 2.0.1
+releasedate: 2023-12-07
author: Youn Cadoret
function: Software Engineer
customer: IHE Europe
reference: KER1-RNO-IHE-ATC_SIMULATOR
---
+# 2.0.1
+_Release date: 2023-12-07_
+__Bug__
+* \[[ATCREPO-23](https://gazelle.ihe.net/jira/browse/ATCREPO-23)\] ATC Repository data need to be updated to be conform to the specification
+
+# 2.0.0
+_Release date: 2023-06-08_
+__Task__
+* \[[ATCREPO-22](https://gazelle.ihe.net/jira/browse/ATCREPO-22)\] Migrate from STU3 to R4
+
+
# 1.3.4
_Release date: 2020-10-08_
diff --git a/EPR-ATC-Simulator/user.md b/EPR-ATC-Simulator/user.md
index ebfd584003fd2f11ad815e79009df4e28b536667..201a0adc9d2f82340b455beef85cf1b853eb37ed 100755
--- a/EPR-ATC-Simulator/user.md
+++ b/EPR-ATC-Simulator/user.md
@@ -4,7 +4,7 @@ subtitle: ATC Simulator
author: Wylem BARS
function: Software Engineer
date: 06/11/2019
-toolversion: 1.3.x
+toolversion: 2.0.X
version: 1.01
status: Reviewed
reference: KER1-MAN-IHE-ATC_SIMULATOR_USER
@@ -30,7 +30,7 @@ As a Patient Audit Record Repository, your system can request Audit Events from
When acting as a Patient Audit Consumer, this simulator is able to send multiple requests to your SUT to test the handling of parameters :
* date
-* entity-id
+* entity.identifier
* entity-role
* subtype
* entity-type
diff --git a/EPR-Assertion-Provider-Simulator/installation.md b/EPR-Assertion-Provider-Simulator/installation.md
index 3488de4aab6c2be40830b5ebf523371a94fe3f82..d32fd82b430981289e66c157563844821f9c7e0d 100755
--- a/EPR-Assertion-Provider-Simulator/installation.md
+++ b/EPR-Assertion-Provider-Simulator/installation.md
@@ -4,7 +4,7 @@ subtitle: Assertion Provider Simulator
author: Youn Cadoret
function: Developer
date: 28/06/2019
-toolversion: 1.1.2
+toolversion: 1.3.0
version: 0.01
status: to be reviewed
reference: KER1-MAN-IHE-ASSERTION_PROVIDER_SIMULATOR_INSTALLATION_USER
diff --git a/EPR-Assertion-Provider-Simulator/release-note.md b/EPR-Assertion-Provider-Simulator/release-note.md
index 3bde9340f8218e46e70ac4aca1b0789854a007e3..7e92361af003dd8cf17b6f03a65c6b988a3f5627 100755
--- a/EPR-Assertion-Provider-Simulator/release-note.md
+++ b/EPR-Assertion-Provider-Simulator/release-note.md
@@ -1,15 +1,20 @@
---
title: Release note
subtitle: Assertion Provider Simulator
-toolversion: 1.2.0
-releasedate: 2021-09-14
+toolversion: 1.3.0
+releasedate: 2023-06-08
author: Malo TOUDIC
function: Software developer
customer: IHE-Europe
reference: KER1-RNO-IHE-ASSERTION_PROVIDER_SIMULATOR
---
+# 1.3.0
+_Release date: 2023-06-08_
-#1.2.0
+__Story__
+* \[[APS-17](https://gazelle.ihe.net/jira/browse/APS-17)\] CH New ordinance EPDBEP-89 Purpose of use DICOM_AUTO
+
+# 1.2.0
_Release date: 2021-09-14_
## Story
diff --git a/EPR-Assertion-Provider-Simulator/user.md b/EPR-Assertion-Provider-Simulator/user.md
index 7429663f0fda645c0964ae3662e68d00e9090401..a3765997a5346369842f81dfa1fedddbb620f228 100755
--- a/EPR-Assertion-Provider-Simulator/user.md
+++ b/EPR-Assertion-Provider-Simulator/user.md
@@ -4,7 +4,7 @@ subtitle: Assertion Provider Simulator
author: Youn Cadoret
function: Developer
date: 28/06/2019
-toolversion: 1.1.2
+toolversion: 1.3.0
version: 0.01
status: to be reviewed
reference: KER1-MAN-IHE-ASSERTION_PROVIDER_SIMULATOR_USER
diff --git a/EVS-Client/installation-v5.md b/EVS-Client/installation-v5.md
index 736346e0498dfd57848e674ba7652b6561313c83..af013eb13c5193f5db7b75a042bd05f88b624b14 100755
--- a/EVS-Client/installation-v5.md
+++ b/EVS-Client/installation-v5.md
@@ -3,8 +3,8 @@ title: Installation Manual (EVS v5)
subtitle: EVS Client
author: Eric Poiseau
function: IHE Europe Technical Project Manager
-date: 10/12/2019
-toolversion: 5.13.x
+date: 18/04/2023
+toolversion: 5.15.x
version: 1.03
status: Approved document
reference: KER1-MAN-IHE-EVS_CLIENT_INSTALLATION-1_03
@@ -20,7 +20,7 @@ External Validation Service Front-end is a Maven project which calls several the
Sources of this project are available on the INRIA GitLab; sources are managed using git. An anonymous access is available if you only want to checkout the sources (read-only access). If you intend to build the tool and to install it on your own server, we recommend you to use a tagged version; not the trunk which is the development branch.
```bash
-git clone --branch "TAG_VERSION" https://gitlab.inria.fr/gazelle/applications/test-execution/validator/EVSClient.git
+git clone --branch "TAG_VERSION" https://gitlab.inria.fr/gazelle/public/core/evs-client.git
```
To retrieve the current version of the tool, take a look into the release notes of the project in [*Jira*](https://gazelle.ihe.net/jira/browse/EVSCLT#selectedTab=com.atlassian.jira.plugin.system.project%3Achangelog-panel).
@@ -297,7 +297,7 @@ In case the service is not actually a service, but a tool on the server hosting
Jasper reports can be found in the EVS Client sources. To be able to use them to generate PDF validation reports, use the following command in the path defined by gazelle_home_path preference :
```bash
-git clone https://gitlab.inria.fr/gazelle/applications/test-execution/validator/EVSClient.git
+git clone https://gitlab.inria.fr/gazelle/public/core/evs-client.git
cd EVSClient/EVSClient-ear/src/main/dist/opt/EVSClient_prod/reports
```
diff --git a/EVS-Client/installation.md b/EVS-Client/installation.md
index decf9fb380bb6e7db1fcd34a6145ab4227f50e0f..200f04a8319f8a77f267a1501c2af1581bb56ef9 100755
--- a/EVS-Client/installation.md
+++ b/EVS-Client/installation.md
@@ -3,8 +3,8 @@ title: Installation Manual (including rest api)
subtitle: EVS Client
author: Cédric Eoche-Duval
function: Software Engineer at IHE Gazelle Team
-date: 2022/10/06
-toolversion: 6.1.x
+date: 2023/12/08
+toolversion: 6.4.x
version: 2.01
status: Approved document
reference: KER1-MAN-IHE-EVS_CLIENT_INSTALLATION-2_01
@@ -32,7 +32,7 @@ access is available if you only want to retrieve the sources (read-only access).
build the tool and to install it on your own server, we recommend you to use a tagged version.
```bash
-git clone --branch "TAG_VERSION" https://gitlab.inria.fr/gazelle/applications/test-execution/validator/EVSClient.git
+git clone --branch "TAG_VERSION" https://gitlab.inria.fr/gazelle/public/core/evs-client.git
```
To retrieve the current version of the tool, take a look into the release notes of the project in
@@ -79,6 +79,17 @@ Note: Initial application preferences values _(application_url, cas_enabled, ...
Default values could be found in `/opt/evs/preferences.properties`.</br>
If any of these variables is set, the corresponding preference in `preferences.properties` file will be overridden.
+### Configure SSO registration
+
+Since version **6.3.0**, EVSClient can register itself as a client of a SSO server. This is done by giving some environment variables to the application.
+
+| **Variable name** | **Description** | **Example of value** |
+|-----------------https://svn.ihe-europe.net/gazelle/validators/xds/xds-model-----|---------------------------------------------------------------------|-------------------------------------|
+| GZL_EVSCLIENT_K8S_ID | Describes the instance ID and the replica ID of the application. | gazelle-evsclient-6dfeeb5595-tl29k |
+
+[WARNING] There are additional required variables for registration of the proxy to the SSO server. Please refer to the
+[README.md in sso-client-v7](https://gitlab.inria.fr/gazelle/public/framework/sso-client-v7#client-registration).
+
### Data source
Since version **5.11.1**, data sources _(configuration file that indicates how to connect to the
@@ -549,20 +560,18 @@ Then repeat for all calling-tool registered:
## Dicom validator installation
-**OUT DATED Documentation to review.**
-**Not yet re-integrated in EVS 6.0.0.**
### Dicom3Tools
If a DICOM validation is wished, then Dicom3Tools needs to be installed on the host machine.
The following instructions are for a linux system based on the apt package system. Any other
-distribution may find instructions for installation of the tool from David Clunie. This is not the
+distribution may find instructions for installation of the tool from David Clunie (https://www.dclunie.com/dicom3tools.html). This is not the
scope of this document to provide installation instructions for all platforms.
```bash
-Â sudo apt-get install g++
-Â sudo apt-get install xutils-dev
+sudo apt-get install g++
+sudo apt-get install xutils-dev man-db
```
Download the last Dicom3tools
@@ -571,19 +580,16 @@ version [here](http://www.dclunie.com/dicom3tools/workinprogress/index.html) and
Go in the untar folder.
```bash
-Â ./Configure
+./Configure
+imake -I./config
make World
-sudo make World install
+make install
+make install.man
```
-Now, you need to make symbolic link in /opt/dicom3tools :
+In EVSClient, the validation service must be configured as follows:
-```bash
-sudo ln -s /usr/local/bin/dcdump dcdump
-sudo ln -s /usr/local/bin/dciodvfy dciodvfy
-cd ..
-sudo chown -R gazelle:gazelle dicom3tools/
-```
+
### Pixelmed
@@ -632,4 +638,4 @@ project [http://gazelle.ihe.net/jenkins/job/Pixelmed-jar/](http://gazelle.ihe.ne
## EVS API
-EVSClient API documentation is available at [https://app.swaggerhub.com/apis-docs/gazelletestbed/gazelle-evs_client_api/3.0#/](https://app.swaggerhub.com/apis-docs/gazelletestbed/gazelle-evs_client_api/3.0#/)
\ No newline at end of file
+EVSClient API documentation is available at [https://app.swaggerhub.com/apis-docs/gazelletestbed/gazelle-evs_client_api/3.0#/](https://app.swaggerhub.com/apis-docs/gazelletestbed/gazelle-evs_client_api/3.0#/)
diff --git a/EVS-Client/media/installation/dicom3tools-config.png b/EVS-Client/media/installation/dicom3tools-config.png
new file mode 100644
index 0000000000000000000000000000000000000000..00840dbf316ea76742078b8f0279f431f0a15ecf
Binary files /dev/null and b/EVS-Client/media/installation/dicom3tools-config.png differ
diff --git a/EVS-Client/pixelmed_and_dicom3tools.md b/EVS-Client/pixelmed_and_dicom3tools.md
index 9617326e5eaeed45741fbc52ccae175d56ca2db5..aa6f5afc56c1fc08068fd2665fa4d59eec432243 100755
--- a/EVS-Client/pixelmed_and_dicom3tools.md
+++ b/EVS-Client/pixelmed_and_dicom3tools.md
@@ -125,6 +125,11 @@ Example :
###### 1) Get dicom3tools_1.00.snapshot.XXX.tar.bz2
+- Install xutils-dev & man-db
+ ```
+ apt-get install xutils-dev man-db
+ ```
+
- Get the latest version of Dicom3tools with this link : https://www.dclunie.com/dicom3tools/workinprogress/index.html
- Unzip the folder and follow the INSTALL file instructions :
@@ -133,9 +138,12 @@ Example :
imake -I./config
make World
make install
+ make install.man
```
You should then get the binaries created in /usr/local/bin folder.
+For EVSClient V5 and prior:
+
- Create the /opt/dicom3tools folder
- Create symbolic links on dcdump and dciodvfy in this newly created folder.
@@ -144,4 +152,3 @@ You should then get the binaries created in /usr/local/bin folder.
ln -s /usr/local/bin/dcdump dcdump
ln -s /usr/local/bin/dciodvfy dciodvfy
```
-
\ No newline at end of file
diff --git a/EVS-Client/release-note.md b/EVS-Client/release-note.md
index d76fdf2af1bf06a14ea422ac6f96f4b9d376e29b..ee79aebd1506324c4f2356ef79ac63644f9c7e71 100755
--- a/EVS-Client/release-note.md
+++ b/EVS-Client/release-note.md
@@ -1,14 +1,113 @@
---
title: Release note
subtitle: EVS Client
-toolversion: 6.1.4
-releasedate: 2023-02-07
+toolversion: 7.0.0
+releasedate: 2024-02-06
author: Cédric Eoche-Duval
function: Software Engineer
customer: IHE Europe
reference: KER1-RNO-IHE-EVS_CLIENT
---
+# 7.0.0
+
+_Release date: 2024-02-06_
+
+Context : Gazelle User Management Renovation step 2
+
+__Task__
+* \[[EVSCLT-1190](https://gazelle.ihe.net/jira/browse/EVSCLT-1190)\] Integrate new sso-client-v7
+* \[[EVSCLT-1193](https://gazelle.ihe.net/jira/browse/EVSCLT-1193)\] Remove username display in GUI
+
+
+
+## Message-Content-Analyzer 4.0.0
+
+_Release date: 2024-02-06_
+
+Context : Gazelle User Management Renovation step 2
+
+__Task__
+* \[[MCA-127](https://gazelle.ihe.net/jira/browse/MCA-127)\] Integrate new sso-client-v7
+* \[[MCA-128](https://gazelle.ihe.net/jira/browse/MCA-128)\] Remove username display in GUI
+
+# 6.4.1
+
+_Release date: 2023-12-08_
+
+__Bug__
+* \[[EVSCLT-1188](https://gazelle.ihe.net/jira/browse/EVSCLT-1188)\] Rename Pixelmed SR Dose validator
+* \[[EVSCLT-1191](https://gazelle.ihe.net/jira/browse/EVSCLT-1191)\] Missing MCA Button for remote validation
+
+# 6.4.0
+_Release date: 2023-09-13_
+
+__Story__
+* \[[EVSCLT-1164](https://gazelle.ihe.net/jira/browse/EVSCLT-1164)\] Validation Service Client for EVS6
+
+__Bug__
+* \[[EVSCLT-1147](https://gazelle.ihe.net/jira/browse/EVSCLT-1147)\] Cannot download the validation report
+* \[[EVSCLT-1182](https://gazelle.ihe.net/jira/browse/EVSCLT-1182)\] Title of the validation page is not relevant
+* \[[EVSCLT-1183](https://gazelle.ihe.net/jira/browse/EVSCLT-1183)\] Does not display the eye icon if the user cannot be pointed to the location of the issue
+
+# 6.3.0
+_Release date: 2023-07-11_
+
+Step 1 of Gazelle User Management renovation.
+
+__Task__
+* \[[EVSCLT-1174](https://gazelle.ihe.net/jira/browse/EVSCLT-1174)\] [GUM] Integrate new sso-client-v7 to evs
+
+# 6.2.4 (SUPPORT)
+
+_Release date: 2023-09-05_
+
+__Bug__
+* \[[EVSCLT-1185](https://gazelle.ihe.net/jira/browse/EVSCLT-1185)\] Bugs correction in MCA
+* \[[EVSCLT-1186](https://gazelle.ihe.net/jira/browse/EVSCLT-1186)\] Bugs correction in X-val
+* \[[EVSCLT-1187](https://gazelle.ihe.net/jira/browse/EVSCLT-1187)\] Error on validation report
+
+Remarks : This version is a support version from 6.2.3. It DOES NOT support Gazelle User Management Feature and corrects some bugs presents in Message Content Analyzer (upgraded to 3.0.5 SUPPORT), Gazelle X Validation (upgraded to 2.0.5), Gazelle Assets (upgraded to 3.0.1).
+
+## Message-Content-Analyzer 3.1.0
+
+_Release date: 2023-07-11_
+
+Step 1 of Gazelle User Management renovation.
+
+Integration of new version (2.0.0) of sso-client-v7.
+
+# 6.2.3
+_Release date: 2023-06-06_
+
+__Bug__
+* \[[EVSCLT-1177](https://gazelle.ihe.net/jira/browse/EVSCLT-1177)\] Add description for HL7V2 reference standard
+* \[[EVSCLT-1178](https://gazelle.ihe.net/jira/browse/EVSCLT-1178)\] X-Val version update to 2.0.3
+
+__Story__
+* \[[EVSCLT-1176](https://gazelle.ihe.net/jira/browse/EVSCLT-1176)\] validation CDA EV6
+
+# 6.2.2
+_Release date: 2023-04-20_
+
+__Bug__
+* \[[EVSCLT-1173](https://gazelle.ihe.net/jira/browse/EVSCLT-1173)\] GITB validator integration broke other validators
+
+# 6.2.1
+_Release date: 2023-04-17_
+
+__Bug__
+* \[[EVSCLT-1162](https://gazelle.ihe.net/jira/browse/EVSCLT-1162)\] Map Gazelle HL7 Profile Exception as Unexpected Error in the report
+
+# 6.2.0
+_Release date: 2023-04-06_
+
+__Bug__
+* \[[EVSCLT-1170](https://gazelle.ihe.net/jira/browse/EVSCLT-1170)\] [EVS6] Fix TOS popup
+
+__Task__
+* \[[EVSCLT-1155](https://gazelle.ihe.net/jira/browse/EVSCLT-1155)\] Create GITB REST Client
+
# 6.1.4
_Release date: 2023-02-07_
@@ -19,7 +118,6 @@ __Bug__
* \[[EVSCLT-1139](https://gazelle.ihe.net/jira/browse/EVSCLT-1139)\] Standard Report - Remove CamelCase format
* \[[EVSCLT-1140](https://gazelle.ihe.net/jira/browse/EVSCLT-1140)\] Wrong DTD issue
-
# 6.1.3
_Release date: 2022-11-06_
@@ -27,7 +125,6 @@ __Bug__
* \[[EVSCLT-1131](https://gazelle.ihe.net/jira/browse/EVSCLT-1131)\] File too large slow down navigator
* \[[EVSCLT-1132](https://gazelle.ihe.net/jira/browse/EVSCLT-1132)\] Can't display Tree of the templates used in document
-
# 6.1.2
_Release date: 2022-10-24_
@@ -37,11 +134,9 @@ __Bug__
# 6.1.1
_Release date: 2022-10-20_
-
__Bug__
* \[[EVSCLT-1117](https://gazelle.ihe.net/jira/browse/EVSCLT-1117)\] Problem with afterMigrate script for dockerized environments
-
# 6.1.0
_Release date: 2022-10-19_
@@ -72,7 +167,6 @@ __Improvement__
* \[[EVSCLT-1101](https://gazelle.ihe.net/jira/browse/EVSCLT-1101)\] Style Sheet Vizualisation Application Preference
* \[[EVSCLT-1106](https://gazelle.ihe.net/jira/browse/EVSCLT-1106)\] eye in a validation report doesn't work with HPD validator
-
# 6.0.0
_Release date: 2022-06-09_
@@ -102,20 +196,33 @@ __Bug__
* \[[EVSCLT-1080](https://gazelle.ihe.net/jira/browse/EVSCLT-1080)\] [QUAL] analyse a file via validation EVS, don't return result when logged-in
* \[[EVSCLT-1083](https://gazelle.ihe.net/jira/browse/EVSCLT-1083)\] [QUAL] Fix menus order to be Alphabetic
+# 5.15.3
+_Release date: 2023-04-17_
+
+__Bug__
+* \[[EVSCLT-1157](https://gazelle.ihe.net/jira/browse/EVSCLT-1157)\] [EVS5] Fix TOS popup
+
+# 5.15.2
+_Release date: 2023-02-15_
+
+__Bug__
+* \[[EVSCLT-1157](https://gazelle.ihe.net/jira/browse/EVSCLT-1157)\] [EVS5] Fix TOS popup
+
# 5.15.1
- _Release date: 2023-02-02 00:00:00.0_
+_Release date: 2023-02-02_
+
__Bug__
-* \[[EVSCLT-1157](https://gazelle.ihe.net/jira/browse/EVSCLT-1157)\] Texte pour les cookies
+* \[[EVSCLT-1157](https://gazelle.ihe.net/jira/browse/EVSCLT-1157)\] [EVS5] Fix TOS popup
# 5.15.0
- _Release date: 2022-12-01_
+_Release date: 2022-12-01_
- Notice: This version is released to support QRCode validation that is currently not supported in EVSClient version >6.x
+Notice: This version is released to support QRCode validation that is currently not supported in EVSClient version >6.x
-__Bogue__
+__Bug__
* \[[EVSCLT-1130](https://gazelle.ihe.net/jira/browse/EVSCLT-1130)\] Correct bug in redirection from gazelle tm to EVSClient with QR COde validation
-__Tâche__
+__Task__
* \[[EVSCLT-1129](https://gazelle.ihe.net/jira/browse/EVSCLT-1129)\] Add new interface to QR Validation
# 5.14.4
diff --git a/EVS-Client/user-v5.md b/EVS-Client/user-v5.md
index 37b1b842cdee2639ae71f5134df6af3a1c74c9ef..1a3e716b3fc9407620bf2fc6c50107a4146a31c8 100755
--- a/EVS-Client/user-v5.md
+++ b/EVS-Client/user-v5.md
@@ -3,8 +3,8 @@ title: User Manual (EVS V5)
subtitle: EVS Client
author: Eric Poiseau
function: IHE Europe Technical Project Manager
-date: 14/01/2021
-toolversion: 5.13.x
+date: 18/05/2023
+toolversion: 5.15.x
version: 1.04
status: Approved document
reference: KER1-MAN-IHE-EVS_CLIENT_USER-1_04
diff --git a/EVS-Client/user.md b/EVS-Client/user.md
index ae820eab4fe571207b9a70699e435c51499985af..b969c1f0e26d08290a482b7fdb97c8cd3fcb4c46 100755
--- a/EVS-Client/user.md
+++ b/EVS-Client/user.md
@@ -1,10 +1,10 @@
---
title: User Manual
subtitle: EVS Client
-author: Philippe Daigremont
+author: Cédric Eoche-Duval
function: IHE Europe Technical Project Manager
-date: 06/10/2022
-toolversion: 6.1.x
+date: 08/12/2023
+toolversion: 6.4.x
version: 1.04
status: Approved document
reference: KER1-MAN-IHE-EVS_CLIENT_USER-1_04
diff --git a/EVS-Client/wsvalidation.md b/EVS-Client/wsvalidation.md
index 56afbf9dd06c9d9cc78ffb9cc802266b6a37a627..bcfa020e166f099bd02afd3f0132692daebf320e 100755
--- a/EVS-Client/wsvalidation.md
+++ b/EVS-Client/wsvalidation.md
@@ -3,8 +3,8 @@ title: Validation Webservice API
subtitle: EVS Client
author: Anne-Gaëlle BERGE
function: Software developer
-date: 4/11/2019
-toolversion: 5.12.x+
+date: 4/18/2023
+toolversion: 5.15.x+
version: 1.02
status: Approved document
reference: KER1-MAN-IHE-EVS_CLIENT_WSV-1_02
diff --git a/Gazelle-Communication-Tool/installation.md b/Gazelle-Communication-Tool/installation.md
index 38efe75d127c9bb23be4c198c0e582f8cde2a1d0..b885525631a91d11bde4788dd620cb90306a0361 100755
--- a/Gazelle-Communication-Tool/installation.md
+++ b/Gazelle-Communication-Tool/installation.md
@@ -98,8 +98,6 @@ Here is the list of configuration variables that must be defined:Â
| Gazelle communication tools enabled | true | |
| application_url | http://server_domain:8180/gazelle | URL to reach the tool |
| Gazelle communication tools URL | http://server_domain:8080/gazelle | URL to reach the communication tool |
-| application_works_without_cas | false | Indicates authentication mechanism to use |
-| cas_url | http://keycloak.localhost:28080/realms/gazelle/protocol/cas | URL of the CAS service |
| upload_max_size | 100000000 | Used to limit uploaded files size |
| assertion_manager_rest_url | https://server_domain:8180/gazelle/rest |  update server_domain:8080 to fit your needs. |
| security-policies | true | Â Enable security features |
@@ -111,6 +109,17 @@ Here is the list of configuration variables that must be defined:Â
| application_documentation | https://gazelle.ihe.net/content/gazelle | |
| documentation_url | https://gazelle.ihe.net/content/gazelle | |
+## SSO Configuration
+
+There are additional preferences to configure the SSO authentication.
+
+| Preference name | Description | Example of value |
+| ---------------- | ---------------------------------------------------------------------- | ---------------- |
+| **cas_enabled** | Enable or disable the CAS authentication. | true |
+| **ip_login** | Enable authentication by IP address matching `ip_login_admin` regex. | false |
+| **ip_login_admin** | Regex to authorize ip authentication if CAS authentication is disabled. | .* |
+
+For more documentation about SSO configurations, follow the link [here](https://gitlab.inria.fr/gazelle/public/framework/sso-client-v7/-/blob/master/cas-client-v7/README.md).
## Database configuration
To insert values with an sql script, connect to the database :
diff --git a/Gazelle-FHIR-Validator/installation.md b/Gazelle-FHIR-Validator/installation.md
index 9a835081f45b1e76c2a390fc1d9f624d3d9d0ada..f068298c3ab2f7d7987a16135816dcfc7c009adf 100755
--- a/Gazelle-FHIR-Validator/installation.md
+++ b/Gazelle-FHIR-Validator/installation.md
@@ -89,13 +89,10 @@ Under the Administration menu, you will find a sub-menu entitled "Configuration"
| application\_url |  The URL used by any user to access the tool. The application needs it to build permanent links inside the tool |  https://publicUrlOfJboss/GazelleFhirValidator |
| application_issue_tracker | Link to the issue tracker where users can report issues (used in the footer of the app) | https://gazelle.ihe.net/jira/browse/FHIRVAL |
| application_release_note_url | Link to the release note of the tool (used in the footer of the app) | https://gazelle.ihe.net/jira/browse/FHIRVAL |
-| application_works_without_cas | True = no login required to access the tool, event page with restricted access, False = use Gazelle SSO | false |
| contact_email | The email of the person to contact for any questions regarding the tool (used in the footer of the app) | |
| contact_name | Name of the person to contact for any questions regarding the tool (used in the footer of the app) | |
| contact_title | Function of the person to contact for any questions regarding the tool (used in the footer of the app) | |
| documentation_url | Link to the user manual (used in the footer of the tool) | https://gazelle.ihe.net/gazelle-documentation/Gazelle-FHIR-Validator/user.html |
-| ip_login | True = users with IP address matching ip_login_regex will be granted as admin | false |
-| ip_login_admin | regex to restrict access to a list of IP address | .* |
| NUMBER_OF_ITEMS_PER_PAGE | Default number of entries in tables | 20 |
| structure_definition_stylesheet_location | URL of the XSL used to display the structure definition | https://gazelle.ihe.net/xsl/fhir/structureDefinition.xsl |
| time_zone | Default time zone to be used to display dates and times | Europe/Paris |
@@ -103,6 +100,17 @@ Under the Administration menu, you will find a sub-menu entitled "Configuration"
| code_system_location | Where the tool accesses the code systems to be loaded | /opt/fhir-structure-definition/CodeSystem |
| ig_fhir_server_url | URL of the Fhir Server used for validation | http://localhost:8080/hapi-fhir-jpavalidator/fhir|
+## SSO Configuration
+
+There are additional preferences to configure the SSO authentication.
+
+| Preference name | Description | Example of value |
+| ---------------- | ---------------------------------------------------------------------- | ---------------- |
+| **cas_enabled** | Enable or disable the CAS authentication. | true |
+| **ip_login** | Enable authentication by IP address matching `ip_login_admin` regex. | false |
+| **ip_login_admin** | Regex to authorize ip authentication if CAS authentication is disabled. | .* |
+
+For more documentation about SSO configurations, follow the link [here](https://gitlab.inria.fr/gazelle/public/framework/sso-client-v7/-/blob/master/cas-client-v7/README.md).
## Managing validators
diff --git a/Gazelle-FHIR-Validator/user.md b/Gazelle-FHIR-Validator/user.md
index 84a3c1e38ea871668b8309e6a50a95ef3f9c37b2..a2d56e28c0a2007b7fd143a4800c5403e9f58038 100755
--- a/Gazelle-FHIR-Validator/user.md
+++ b/Gazelle-FHIR-Validator/user.md
@@ -26,7 +26,7 @@ The validation service is offered as a SOAP API. You can validate your messages
# Using the validation service
-A SoapUI project is available in the directory of the tool on Inria's forge. [SoapUI](https://gitlab.inria.fr/gazelle/validator/FhirValidator/-/tree/master/FhirValidator-ear/src/main/resources/soapui)
+A SoapUI project is available in the directory of the tool on Inria's forge. [SoapUI](https://gitlab.inria.fr/gazelle/public/validation/fhir-validator/-/tree/master/FhirValidator-ear/src/main/resources/soapui)
# Graphical user interface
diff --git a/Gazelle-HL7-Validator/installation.md b/Gazelle-HL7-Validator/installation.md
index 6a54a440c4d043497b93dbd9fd4a01ca3473eda5..769df729c07be4dae74521a539ae1e6e0c11706e 100755
--- a/Gazelle-HL7-Validator/installation.md
+++ b/Gazelle-HL7-Validator/installation.md
@@ -3,7 +3,7 @@ title: Installation Manual
subtitle: Gazelle HL7 Validator
author: Anne-Gaëlle Bergé
function: Engineer
-date: 19/07/2022
+date: 18/04/2023
toolVersion: 3.8.x
version: 1.04
status: Approved document
@@ -21,7 +21,7 @@ To get the artifact on Nexus browse [here](https://gazelle.ihe.net/nexus/#nexus-
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 gitlab: *git clone --branch "TAG_VERSION" https://gitlab.inria.fr/gazelle/applications/test-execution/validator/gazellehl7v2validator.git*
+1. Checkout the latest tag available on Inria’s gitlab: *git clone --branch "TAG_VERSION" https://gitlab.inria.fr/gazelle/public/validation/hl7v2-validator.git*
2. \[Optional\] Edit the pom.xml file and create a new profile
@@ -77,7 +77,7 @@ __IMPORTANT NOTICE__: Before to apply this script into your database, open it an
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). **Context path for deployment is /GazelleHL7Validator**.
+Before executing the script, open the file and checked the various preferences to be inserted in the app\_configuration table, especially the application\_url and other preferences relative to the user authentication (see Application configuration section). **Context path for deployment is /GazelleHL7Validator**.
Finally, execute the script:Â
@@ -132,7 +132,6 @@ Use the Administration menu, you will find a sub-menu entitled "Configure applic
|----------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------|
| application\_issue\_tracker\_url | The URL of the bug tracking system where to post issues | https://gazelle.ihe.net/jira/projects/HLVAL/summary |
| 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/GazelleHL7Validator |
-| cas\_url | If you intent to use a CAS, put its URL here | https://gazelle.ihe.net/cas |
| force\_stylesheet | HL7MessageProfiles and HL7 resources are XML files displayed with a stylesheet declared in the file and referenced on gazelle.ihe.net. To avoid cross-site references, most browsers do not follow those links and as a consequence do not display the XML file correctly. This property tells the tool to change the link to the stylesheet before sending the file to the client | true |
| gmm\_hl7messageprofile\_wsdl | Access Hl7MessageProfile webservice exposed by GMM (or TM configured to work also as GMM) | https://publicUrlOfJboss/gazelle-gmm-gazelle-tm-ejb/Hl7MessageProfile?wsdl |
| gmm\_iheconcepts\_wsdl | Access IHEConcepts web service exposed by GMM (or TM configured to work also as GMM) | http://131.254.209.12:8080/gazelle-gmm-gazelle-tm-ejb/IHEConcepts?wsdl |
@@ -154,6 +153,18 @@ Use the Administration menu, you will find a sub-menu entitled "Configure applic
| xsd\_directory\_location | where to find the XSD files for HL7v3 validation service | example : /home/gazelle/xsd/HL7V3/NE2008/multicacheschemas |
| xcpd\_plq\_xsd\_location | where to find the XSD files for XCPD/PLQ validation service | example : /home/gazelle/xsd/IHE/XCPD\_PLQ.xsd |
+# SSO Configuration
+
+There are additional preferences to configure the SSO authentication.
+
+| Preference name | Description | Example of value |
+| ---------------- | ---------------------------------------------------------------------- | ---------------- |
+| **cas_enabled** | Enable or disable the CAS authentication. | true |
+| **ip_login** | Enable authentication by IP address matching `ip_login_admin` regex. | false |
+| **ip_login_admin** | Regex to authorize ip authentication if CAS authentication is disabled. | .* |
+
+For more documentation about SSO configurations, follow the link [here](https://gitlab.inria.fr/gazelle/public/framework/sso-client-v7/-/blob/master/cas-client-v7/README.md).
+
# 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.
diff --git a/Gazelle-HL7-Validator/release-note.md b/Gazelle-HL7-Validator/release-note.md
index ce95fcf6267418af524fdabedce27c46831c7331..55e8fdf5768e89845d60415de932fc96cd8109ec 100755
--- a/Gazelle-HL7-Validator/release-note.md
+++ b/Gazelle-HL7-Validator/release-note.md
@@ -1,13 +1,47 @@
---
title: Release note
subtitle: Gazelle HL7 Validator
-toolversion: 3.8.2
-releasedate: 21/11/2022
+toolversion: 3.9.0
+releasedate: 2024-02-06
author: Anne-Gaëlle BERGE
function: Software Engineer
customer: IHE Europe
reference: KER1-RNO-IHE-GAZELLE_HL7_VALIDATOR
---
+
+# 3.9.0
+
+_Release date: 2024-02-06
+
+Context : Gazelle User Management Renovation step 2
+
+__Task__
+* \[[HLVAL-476](https://gazelle.ihe.net/jira/browse/HLVAL-476)\] Integrate new sso-client-v7
+
+# 3.8.5
+_Release date: 2023-08-03_
+
+__Bug__
+* \[[HLVAL-474](https://gazelle.ihe.net/jira/browse/HLVAL-474)\] Diplaying acute character in HL7v2 validation report
+
+__Improvement__
+* \[[HLVAL-475](https://gazelle.ihe.net/jira/browse/HLVAL-475)\] New mapping for GVT 1.6.3
+
+# 3.8.4
+_Release date: 2023-06-30_
+
+__Task__
+* \[[HLVAL-473](https://gazelle.ihe.net/jira/browse/HLVAL-473)\] Update NIST dependencies to latest Gazelle versions
+
+# 3.8.3
+_Release date: 2023-04-18_
+
+__Bug__
+* \[[HLVAL-467](https://gazelle.ihe.net/jira/browse/HLVAL-467)\] Fix TOS popup
+* \[[HLVAL-468](https://gazelle.ihe.net/jira/browse/HLVAL-468)\] Exceptions of type RE shall be reported as Warnings
+* \[[HLVAL-472](https://gazelle.ihe.net/jira/browse/HLVAL-472)\] Fix validation rules in the ANS validator
+* \[[HLVAL-469](https://gazelle.ihe.net/jira/browse/HLVAL-469)\] HL7 Validation reports needs to be ABORTED when ProfileExceptions are present
+
# 3.8.2
_Release date: 2022-11-21_
diff --git a/Gazelle-HL7-Validator/user.md b/Gazelle-HL7-Validator/user.md
index 582750c031b0410e2884507e72b3eac06530d08a..91031f45aa5887b638c991cead87c793356a4bbb 100755
--- a/Gazelle-HL7-Validator/user.md
+++ b/Gazelle-HL7-Validator/user.md
@@ -3,8 +3,8 @@ title: User Manual
subtitle: Gazelle HL7 Validator
author: Anne-Gaëlle Bergé
function: Engineer
-date: 19/07/2022
-toolversion: 3.7.x
+date: 18/04/2023
+toolversion: 3.8.x
version: 1.04
status: Approved document
reference: KER1-MAN-IHE-GAZELLE_HL7_VALIDATOR_USER-1_04
diff --git a/Gazelle-HL7V2-Simulators/Makefile b/Gazelle-HL7V2-Simulators/Makefile
new file mode 100755
index 0000000000000000000000000000000000000000..cbbc56c706e2a9d7c1b43999f7199c4c956757ea
--- /dev/null
+++ b/Gazelle-HL7V2-Simulators/Makefile
@@ -0,0 +1,3 @@
+SHELL := /bin/bash
+
+include ../Makefile.generic
diff --git a/Gazelle-HL7V2-Simulators/installation.md b/Gazelle-HL7V2-Simulators/installation.md
new file mode 100755
index 0000000000000000000000000000000000000000..94222a2b69bb52ea3fc2a6d567bae6f707a90fa4
--- /dev/null
+++ b/Gazelle-HL7V2-Simulators/installation.md
@@ -0,0 +1,38 @@
+---
+title: Installation Manual
+subtitle: Gazelle-Hl7-simulator
+author: CLaude LUSSEAU, Romuald DUBOURG
+function: Software Engineer
+date: 2023-14-08
+toolversion: 1.0.0
+version: 1.00
+status: draft
+reference:
+customer: IHE-EUROPE
+---
+# Purpose
+
+Here is a guide to help you install the Hl7-Simulator.
+
+# Deployment
+
+## Requirements
+* Java virtual machine : JDK 17
+
+
+## Installation
+First you should pull the project from:
+https://gitlab.inria.fr/gazelle/specific-tools/ans/ans-hl7v2-simulators.git
+then you can use quarkus with :
+``
+mvn clean package
+cd ans-hl7v2-simulators-ui
+mvn docker:start
+``
+Or
+you can use the application with
+``
+mvn clean install
+``
+
+It will start a container who will contain the gazelle-database needed as a database and a container with the application
diff --git a/Gazelle-HL7V2-Simulators/media/ConfigurationSUT_List.png b/Gazelle-HL7V2-Simulators/media/ConfigurationSUT_List.png
new file mode 100644
index 0000000000000000000000000000000000000000..43a4a1a33a29eb70c7db74e592044a277f67c7eb
Binary files /dev/null and b/Gazelle-HL7V2-Simulators/media/ConfigurationSUT_List.png differ
diff --git a/Gazelle-HL7V2-Simulators/media/Configuration_Button.png b/Gazelle-HL7V2-Simulators/media/Configuration_Button.png
new file mode 100644
index 0000000000000000000000000000000000000000..b0596f599fa75d7f84cecbe9463b3ce593b78f77
Binary files /dev/null and b/Gazelle-HL7V2-Simulators/media/Configuration_Button.png differ
diff --git a/Gazelle-HL7V2-Simulators/media/HL7V2Creator_TemplateDropdown.png b/Gazelle-HL7V2-Simulators/media/HL7V2Creator_TemplateDropdown.png
new file mode 100644
index 0000000000000000000000000000000000000000..bf149bdd3dc685317f2ad5614b22f442782e3f7f
Binary files /dev/null and b/Gazelle-HL7V2-Simulators/media/HL7V2Creator_TemplateDropdown.png differ
diff --git a/Gazelle-HL7V2-Simulators/media/HL7V2Creator_UI.png b/Gazelle-HL7V2-Simulators/media/HL7V2Creator_UI.png
new file mode 100644
index 0000000000000000000000000000000000000000..6e12633ade1862501273a767b898bea37adb5d72
Binary files /dev/null and b/Gazelle-HL7V2-Simulators/media/HL7V2Creator_UI.png differ
diff --git a/Gazelle-HL7V2-Simulators/media/HL7V2Home_UI.png b/Gazelle-HL7V2-Simulators/media/HL7V2Home_UI.png
new file mode 100644
index 0000000000000000000000000000000000000000..2c529bdc18b69cfe72f3ae65321b5edc02435faf
Binary files /dev/null and b/Gazelle-HL7V2-Simulators/media/HL7V2Home_UI.png differ
diff --git a/Gazelle-HL7V2-Simulators/media/HL7V2Manager_UI.png b/Gazelle-HL7V2-Simulators/media/HL7V2Manager_UI.png
new file mode 100644
index 0000000000000000000000000000000000000000..d772d3f1f6cbd65ed1490957bde53e0c62ee7eb9
Binary files /dev/null and b/Gazelle-HL7V2-Simulators/media/HL7V2Manager_UI.png differ
diff --git a/Gazelle-HL7V2-Simulators/media/HL7v2Creator_SelectDropdown.png b/Gazelle-HL7V2-Simulators/media/HL7v2Creator_SelectDropdown.png
new file mode 100644
index 0000000000000000000000000000000000000000..a325013cf61d908aaf900d9f628a77be68aa3862
Binary files /dev/null and b/Gazelle-HL7V2-Simulators/media/HL7v2Creator_SelectDropdown.png differ
diff --git a/Gazelle-HL7V2-Simulators/media/Preference_Button.png b/Gazelle-HL7V2-Simulators/media/Preference_Button.png
new file mode 100644
index 0000000000000000000000000000000000000000..0aeea9c1d43749059eed69765c2bb2554b42ef1a
Binary files /dev/null and b/Gazelle-HL7V2-Simulators/media/Preference_Button.png differ
diff --git a/Gazelle-HL7V2-Simulators/media/Preference_List.png b/Gazelle-HL7V2-Simulators/media/Preference_List.png
new file mode 100644
index 0000000000000000000000000000000000000000..6939df627dec4ccae8f552f511058e83e0516269
Binary files /dev/null and b/Gazelle-HL7V2-Simulators/media/Preference_List.png differ
diff --git a/Gazelle-HL7V2-Simulators/media/Template_Button.png b/Gazelle-HL7V2-Simulators/media/Template_Button.png
new file mode 100644
index 0000000000000000000000000000000000000000..0b366e001999b151f5b3d168451c7f2be72565fa
Binary files /dev/null and b/Gazelle-HL7V2-Simulators/media/Template_Button.png differ
diff --git a/Gazelle-HL7V2-Simulators/media/Template_List.png b/Gazelle-HL7V2-Simulators/media/Template_List.png
new file mode 100644
index 0000000000000000000000000000000000000000..99ab6b0d4217b89d59a8273e1eb9b4f0e63a8376
Binary files /dev/null and b/Gazelle-HL7V2-Simulators/media/Template_List.png differ
diff --git a/Gazelle-HL7V2-Simulators/release-notes.md b/Gazelle-HL7V2-Simulators/release-notes.md
new file mode 100644
index 0000000000000000000000000000000000000000..3d489a9579651e3f67334fbbf071cc51fd74916d
--- /dev/null
+++ b/Gazelle-HL7V2-Simulators/release-notes.md
@@ -0,0 +1,27 @@
+---
+title: Release note
+subtitle: HL7V2 Simulators
+author: Romuald DUBOURG, Claude Lusseau
+date: 30/01/2024
+toolversion: 1.2.0
+function: Software Engineer
+customer: ANS
+---
+
+# HL7Simulators 1.2.0
+_Release date: 2024-01-30_
+
+__Improvement__
+* \[[HLVSIM-29](https://gazelle.ihe.net/jira/browse/HLVSIM-29)\] Traduction text and docker image
+* \[[HLVSIM-30](https://gazelle.ihe.net/jira/browse/HLVSIM-30)\] Docker image can't write file
+* \[[HLVSIM-38](https://gazelle.ihe.net/jira/browse/HLVSIM-38)\] Release & Déploiement
+
+__Bug__
+* \[[HLVSIM-39](https://gazelle.ihe.net/jira/browse/HLVSIM-39)\] Problems with flywaydb migration
+
+# HL7Simulators 1.0.0
+_Release date: 2023-7-11_
+
+__Story__
+* \[[HLVSIM-1](https://gazelle.ihe.net/jira/browse/HLVSIM-1)\] Create Hl7V2 Simulators
+
diff --git a/Gazelle-HL7V2-Simulators/user.md b/Gazelle-HL7V2-Simulators/user.md
new file mode 100755
index 0000000000000000000000000000000000000000..0e9535b7f72fa4337d02334d5863fc3fa810a2f3
--- /dev/null
+++ b/Gazelle-HL7V2-Simulators/user.md
@@ -0,0 +1,143 @@
+---
+title: User Manual
+subtitle: Gazelle-Hl7-simulator
+author: CLaude LUSSEAU, Romuald DUBOURG
+function: Software Engineer
+date: 2023-14-08
+toolversion: 1.0.0
+version: 1.00
+status: draft
+reference:
+customer: IHE-EUROPE
+---
+
+# Application overview
+
+HL7V2Simulators is the part of the Gazelle platform dedicated to the simulation of Hl7v2 messages transmission.
+
+One simulator mimics the transmission of a Clinical Document Architecture (CDA) to a receiving application. The creator of the simulator expects to receive as many acknowledgments as requested by the message.
+
+Three simulator acts as a server with different charset handled. For every CDA messages received, they send back as many acknowledgments as requested in the message to their sender.
+
+Concerning HL7v2 simulators: the application also gathers the HL7 templates.
+
+# User interface
+
+As shown on picture below, the [User Interface] provides two simulators tools: **Creator** and **Managers**:
+
+
+
+**Creator** allows user to send HL7 messages to an receiving App:
+
+
+
+And **Managers** allows user to receive Hl7 messages from a creator:
+
+
+
+Both tools use templates included in the application or imported by user.
+
+
+## Browse Configuration SUT
+
+There are 10 fields that define a Configuration SUT:
+ - Name : Define the name of your configuration
+ - Host/ip: define the destination device of the message
+ - Port: Define on which port send the message on the destination device
+ - Application: Define the name of the application which you send the message it will help fulfill the message
+ - Facility: Define the name of the facility which you send the message it will help fulfill the message
+ - Owner: Show the creator of the configuration
+ - CompanyOwner: Show the company owner of the configuration, only user can see his company's not share configuration.
+ - isShare: Define if the configuration is share to others users. Only admin or people of the company can edit it.
+ - Charset: Define on a server it tells with which charset message should be sent and replied.
+ - isServerSide: Define if the configuration is for a server or a client
+
+
+Once connected with CAS(Central Authentication Service) Select option  of **HL7v2 simulators tool** menu.
+
+It will display the list of Configuration SUT :
+
+
+
+Only admin cans see all configuration but a lambda user can see his company configuration also either create, edit or delete one.
+
+## Browse Template
+
+There are 4 fields that define a template :
+ -Title : Define the title of the template
+ -isEnabled : Define if the template can be used in a message
+ -Filename : Define the name of the stocked file corresponding at the mustache template
+ -Description: Explain what is the purpose of the template ,or it's particularity
+
+
+Once connected with CAS(Central Authentication Service) Select option  of **HL7v2 simulators tool** menu.
+
+It will display the list of Template :
+
+
+
+All Template available are gathered in the tool. You can either create, edit or delete one.
+
+
+## Browse Preference
+
+There are 4 fields that define a preference:
+ - PreferenceName : define the name a of a preference
+ - ClassName: define the type of value contain by the preference
+ - PreferenceValue: define the value of a preference
+ - Description: describe how is use the preference
+
+Once connected with CAS(Central Authentication Service) Select option  of **HL7v2 simulators tool** menu.
+
+It will display the list of Preference :
+
+
+
+All Preference available are gathered in the tool. You can either create, edit or delete one.
+
+Preferences enable to custom the working of the application there are 5 things that can be custom.
+ Endpoint_Validator: The validation Endpoint to define which HL7 validator should be used.
+ UTF8_Manager_Name, UTF8_Manager_Host, UTF8_Manager_Application, UTF8_Manager_Facility, UTF8_Manager_Port :The configuration of the UTF-8 manager
+ I88591_Manager_Name, I88591_Manager_Host, I88591_Manager_Application, I88591_Manager_Facility, I88591_Manager_Port :The configuration of the 8859-1 manager
+ I885915_Manager_Name, I885915_Manager_Host, I885915_Manager_Application, I885915_Manager_Facility, I885915_Manager_Port :The configuration of the 8859-15 manager
+ Creator_Name, Creator_Host ,Creator_Application , Creator_Port:The configuration of the creator
+
+
+# Creator
+
+The Creator Simulator simulate the transmission of a Clinical Document Architecture (CDA) to a receiving application.
+
+There are two things that must be configured before sending a message.
+First a message should have a destination, so the creator need a Configuration SUT to be selected this will represent the destination where you want the message to be sent.
+It is possible to use default configuration ,but it can be custom on the preferences' menu.
+
+
+
+Second the message to be sand must be indicated for that a template must be selected.
+In the same idea as configurations. It is possible to use default template or add customs template with the template UI.
+Once the needed template is set it can be selected with dropdown on the creator UI.
+
+
+
+For sending the receiving application Configuration must have been insert in the configuration list.
+On the Creator GUI before sending, a Configuration Receiver and a Template must have been selected.
+Once the message is sent the message history print messages who have been sent and receive including ACK/NACK AND ZAM.
+
+
+
+## Managers
+
+There is a manager for each charsets UTF-8, 8859-1 et 8859-15.
+Managers are easier to use because it's just a server that can be started/stopped.
+For replying ZAM managers must have all required ZAM templates. See TEMPLATE section for details.
+For replying ZAM managers should also have the configuration SUT defined of the sender. Else managers cannot know where to send ZAM ( because ACK with HAPI is automatic).
+For starting servers managers just go to the Manager GUI and press the start button.
+Once servers are started they will try to parse every incoming messages and reply ACK/NACK AND corresponding ZAM.
+
+## Default Import
+
+-DEFAULT_ANS_TEMPLATES
+This variable can be set to true to have a group of messages example with a description that explain what they are use for.
+
+-DEFAULT_ANS_SERVERS
+This variable can be set to true to initialize default server of the application instead of created them manually
\ No newline at end of file
diff --git a/Gazelle-SSO/installation.md b/Gazelle-SSO/installation.md
index b4a20972d66e5e9137c07d5f0540a0eaf6bc3de1..d3a28590c76c5176b6638818861e27585abf78e4 100755
--- a/Gazelle-SSO/installation.md
+++ b/Gazelle-SSO/installation.md
@@ -1,28 +1,36 @@
---
title: Installation Manual
subtitle: Gazelle-SSO
-author: Eric Poiseau
+author: Valentin Lorand
function: Engineer
-date: 09/03/2018
+date: 26/06/2023
toolversion: N/A
-version: 1.03
+version: 1.04
status: Approved document
reference: KER1-MAN-IHE-SSO_INSTALLATION-1_03
customer: IHE-EUROPE
---
-# Introduction
+# [DEPRECATED] Apereo CAS 5.1.X Installation Manual
+
+{% capture sso_alert %}
+Gazelle SSO, formerly Gazelle CAS, is deprecated since 2023-07-17. The replacement is a new
+authorization server that is part of Gazelle User Management.
+<a href="https://doc-ihe.kereval.cloud/gazelle-applications/v/gazelle-user-management/">See its documentation</a>.
+{% endcapture %}
+
+{% include warning.html content=sso_alert %}
The purpose of this document is to guide you through the installation process of the Apereo CAS 5.1.X. This SSO is used by Gazelle tools to authenticate users.
-# Prerequisites
+## Prerequisites
Installation needs to be performed on a Debian linux __Stretch__ or newer. This is know to not work on jessie.
Apereo needs to be embedded into a Tomcat 8 server. Tomcat 8 runs under Java 8. Make sure you have zulu-8 installed.
-# Installation
+## Installation
-## Install tomcat 8
+### Install tomcat 8
```
apt-get install tomcat8
@@ -63,7 +71,7 @@ Probably you want to use AJP connector. You need to uncomment this line and cust
Also add `secretRequired="false"` in the AJP configuration.
-## Download and deploy Gazelle SSO
+### Download and deploy Gazelle SSO
```
cd /var/lib/tomcat8/webapps
diff --git a/Gazelle-STS/installation.md b/Gazelle-STS/installation.md
index a7e15aa1fbc1fc39c664d5277111c9ff56b95cdc..5cacb03e97a4bd3690aaca21bdaeaa36feeaf5c6 100755
--- a/Gazelle-STS/installation.md
+++ b/Gazelle-STS/installation.md
@@ -4,7 +4,7 @@ subtitle: Gazelle-STS
author: Cédric EOCHE-DUVAL
function: Engineer
date: 19/04/2017
-toolversion: 1.1.0
+toolversion: 1.3.1
version: 4.02
status: Approved document
reference: KER1-MAN-IHE-STS_INSTALLATION-4_02
diff --git a/Gazelle-STS/user.md b/Gazelle-STS/user.md
index 046ab3a5903e92cf828fa561be32c45506a15488..960ecf0e22e5ac417999dd67882c5051d5ab13b0 100755
--- a/Gazelle-STS/user.md
+++ b/Gazelle-STS/user.md
@@ -4,7 +4,7 @@ subtitle: Gazelle STS
author: Cédric EOCHE-DUVAL
function: Test Engineer
date: 04/07/2017
-toolversion: 1.1.0
+toolversion: 1.3.1
version: 2.03
status: Approved document
reference: KER1-MAN-IHE-STS_USER-2_03
diff --git a/Gazelle-Security-Suite/installation.md b/Gazelle-Security-Suite/installation.md
index add177278f655ed882065b7ebf4a1b2f7ae391cb..8c57ce36e655f812991af44aafbf199b778c2151 100755
--- a/Gazelle-Security-Suite/installation.md
+++ b/Gazelle-Security-Suite/installation.md
@@ -27,13 +27,13 @@ Since version 5.0.0 the tool is called Gazelle-Security-Suite and run on JBoss 7
# Sources & binaries
-Gazelle-Security-Suite is an open-source project under Apache License Version 2.0 ([https://gazelle.ihe.net/content/license](https://gazelle.ihe.net/content/license)). Sources are available via git at [https://gitlab.inria.fr/gazelle/applications/mixed/gazelle-atna.git](https://gitlab.inria.fr/gazelle/applications/mixed/gazelle-atna.git).
+Gazelle-Security-Suite is an open-source project under Apache License Version 2.0 ([https://gazelle.ihe.net/content/license](https://gazelle.ihe.net/content/license)). Sources are available via git at [https://gitlab.inria.fr/gazelle/public/core/security-suite.git](https://gitlab.inria.fr/gazelle/public/core/security-suite.git).
-The latest public packaged release can be downloaded from our Sonatype Nexus repository [https://gazelle.ihe.net/nexus/index.html#nexus-search;quick~gazelle-atna-ear](https://gazelle.ihe.net/nexus/index.html#nexus-search;quick~gazelle-atna-ear) (search for **gazelle-atna-X.X.X-gss.ear**).
+The latest public packaged release can be downloaded from our Sonatype Nexus repository [https://gazelle.ihe.net/nexus/index.html#nexus-search;quick~gazelle-security-suite-ear](https://gazelle.ihe.net/nexus/index.html#nexus-search;quick~gazelle-security-suite-ear) (search for **gazelle-security-suite-X.X.X-gss.ear**).
-**Important**, if you download the **ear** from Nexus it will have a name such as `gazelle-atna-ear-5.0.0-gss.ear`, then be sure to rename it to `gazelle-gss.ear` otherwise the deployment will fail.
+**Important**, if you download the **ear** from Nexus it will have a name such as `gazelle-security-suite-ear-5.0.0-gss.ear`, then be sure to rename it to `gazelle-gss.ear` otherwise the deployment will fail.
-If you need for any reason a more recent version (hotfix, experimental feature...), The public packaged application of our development trunk can be found at [https://gazelle.ihe.net/jenkins/job/gazelle-atna/ws/gazelle-atna-ear/target/gazelle-gss.ear](https://gazelle.ihe.net/jenkins/job/gazelle-atna/ws/gazelle-atna-ear/target/gazelle-gss.ear). This package can be unstable.
+If you need for any reason a more recent version (hotfix, experimental feature...), The public packaged application of our development trunk can be found at [https://gazelle.ihe.net/jenkins/job/gazelle-atna/ws/gazelle-security-suite-ear/target/gazelle-gss.ear](https://gazelle.ihe.net/jenkins/job/gazelle-atna/ws/gazelle-security-suite-ear/target/gazelle-gss.ear). This package can be unstable.
# Installation
@@ -43,7 +43,7 @@ If Gazelle Security Suite is already installed in your environment and you are l
## Bouncycastle
-Bouncycastle, as a security library, is very sensible to the classloader. This library is prepared during GSS build and available from our Nexus repository [https://gazelle.ihe.net/nexus/index.html#nexus-search;quick~gazelle-atna-ear](https://gazelle.ihe.net/nexus/index.html#nexus-search;quick~gazelle-atna-ear) (search for **gazelle-atna-X.X.X-lib.zip**)
+Bouncycastle, as a security library, is very sensible to the classloader. This library is prepared during GSS build and available from our Nexus repository [https://gazelle.ihe.net/nexus/index.html#nexus-search;quick~gazelle-security-suite-ear](https://gazelle.ihe.net/nexus/index.html#nexus-search;quick~gazelle-security-suite-ear) (search for **gazelle-security-suite-X.X.X-lib.zip**)
bcprov library must be installed as a module of the application server.
@@ -69,7 +69,7 @@ To check whether it's working, try to create a custom certificate with a key siz
Your database must have a user **gazelle**
-1. Download the SQL scripts archive from our Nexus repository [https://gazelle.ihe.net/nexus/index.html#nexus-search;quick~gazelle-atna-ear](https://gazelle.ihe.net/nexus/index.html#nexus-search;quick~gazelle-atna-ear) (search for **gazelle-atna-X.X.X-sql.zip**)
+1. Download the SQL scripts archive from our Nexus repository [https://gazelle.ihe.net/nexus/index.html#nexus-search;quick~gazelle-security-suite-ear](https://gazelle.ihe.net/nexus/index.html#nexus-search;quick~gazelle-security-suite-ear) (search for **gazelle-security-suite-X.X.X-sql.zip**)
1. Unzip the archive into a folder named `gss-sql`
@@ -128,7 +128,7 @@ Syslog needs some configuration files installed on the same machine GSS is runni
sudo mkdir /opt/syslog
```
-1. Download the syslog archive from our Nexus repository [https://gazelle.ihe.net/nexus/index.html#nexus-search;quick~gazelle-atna-ear](https://gazelle.ihe.net/nexus/index.html#nexus-search;quick~gazelle-atna-ear) (search for **gazelle-atna-X.X.X-syslog.zip**)
+1. Download the syslog archive from our Nexus repository [https://gazelle.ihe.net/nexus/index.html#nexus-search;quick~gazelle-security-suite-ear](https://gazelle.ihe.net/nexus/index.html#nexus-search;quick~gazelle-security-suite-ear) (search for **gazelle-security-suite-X.X.X-syslog.zip**)
1. Unzip the archive and copy every files into `/opt/syslog`
@@ -146,7 +146,7 @@ The update mechanism has changed at version 5.1.0. Be careful to strictly follow
_Reminder: Before version 5.0.0, Gazelle Security Suite was called Gazelle-ATNA-Tools._
-1. Download the new **ear** and its associated update SQL script from our Nexus repository [https://gazelle.ihe.net/nexus/index.html#nexus-search;quick~gazelle-atna-ear](https://gazelle.ihe.net/nexus/index.html#nexus-search;quick~gazelle-atna-ear) (search for **gazelle-atna-X.X.X-gss.ear** and **gazelle-atna-X.X.X-sql.zip**). Not each version has an update sql to execute.
+1. Download the new **ear** and its associated update SQL script from our Nexus repository [https://gazelle.ihe.net/nexus/index.html#nexus-search;quick~gazelle-security-suite-ear](https://gazelle.ihe.net/nexus/index.html#nexus-search;quick~gazelle-security-suite-ear) (search for **gazelle-security-suite-X.X.X-gss.ear** and **gazelle-security-suite-X.X.X-sql.zip**). Not each version has an update sql to execute.
1. Undeploy the old **ear** from JBoss by removing it from the deployment directory.
@@ -170,7 +170,7 @@ To update Gazelle-ATNA-tools 4.7.12 to Gazelle-Security-Suite 5.0.0 the process
1. Backup your database
-1. Download the new **ear** and all intermediate update SQL scripts from your old version (excluded) to your target version (included). Those scripts can be found in *https://gitlab.inria.fr/gazelle/applications/mixed/gazelle-atna/tree/master/gazelle-atna-ear/src/main/sql.*. Not each version has an update sql to execute.
+1. Download the new **ear** and all intermediate update SQL scripts from your old version (excluded) to your target version (included). Those scripts can be found in *https://gitlab.inria.fr/gazelle/public/core/security-suite/tree/master/gazelle-security-suite-ear/src/main/sql.*. Not each version has an update sql to execute.
1. Execute the update SQL scripts
@@ -182,17 +182,6 @@ Example (version number are hypothetical) : to update GSS from 5.1.0 to 5.1.5 yo
Application can be configured directly from the web interface. From the menu, go to Administration > Application preferences _(you need to be logged in as admin\_role)_.
-## GSS Double Central Authentication Service
-
-Basicaly one Gazelle Central Authentication Service provide user authentication for all Gazelle applications in a test bed. However we once had the need to connect one instance of GSS with two test beds. We implemented a feature to answer this need and decide to leave the option available for public. So GSS can be connected with two distinct Authentication Services and users are identified from two databases. GSS concatenate the username and the CAS key to preserve username uniqueness all over the application. Of course the second authentication channel is optional and can be turned off.
-
-Note that every configuration variable related to a user feature is then derivated in two versions and prefixed with **main\_** or **second\_**. It allows admin to configure options and services for the first or the second test bed.
-
-There is two files that need to be created in /opt/gazelle/cas :
-
-* file.properties : This is the configuration file for the main cas, used in all the other tools. It should be already present.
-* file_second_cas.properties : This is the configuration file for the second cas.
-
## Gazelle PKI specific considerations
PKI features of GSS require to define a certificate authority (CA) for :
@@ -223,7 +212,6 @@ If you import an existing CA, do not use a CA chained to an issuer publicly trus
| **application\_documentation** | The link to the user manual. | https://gazelle.ihe.net/content/gazelle-security-suite |
| **application\_issue\_tracker** | The link to the section of the issue tracker where to report issues about Gazelle-Security-Suite | https://gazelle.ihe.net/jra/browse/TLS |
| **application\_release\_notes** | The link to the application release notes | https://gazelle.ihe.net/jira/browse/TLS\#selectedTab=com.atlassian.jira.plugin.system.project%3Achangelog-panel |
-| **application\_works\_without\_cas** | Specifies if the Central Authentication Service (CAS) is used or not. If no CAS is used, property shall be set to true | true |
| **application\_url** | The URL used by any user to access the tool. The application needs it to build permanent links inside the tool | http://localhost:8080/gss |
| **assertion\_manager\_url** | To link tests and validators to assertions, you will need to deploy Assertion Manager in the test bed. Provide its URL here. | http://localhost:8080/AssertionManagerGui |
| **atna\_mode\_enabled** | Enable/disable Audit Trail features : ATNA-Questionnaire and Audit-Message validation. | true |
@@ -236,8 +224,6 @@ If you import an existing CA, do not use a CA chained to an issuer publicly trus
| **dicom\_xsd** | Absolute system path to the DICOM schema (Audit Message validation). | /opt/tls/dicom\_syslog\_ext\_us.xsd |
| **dcmdump_path** | Absolute system path to the dcmdump binary | /usr/bin/dcmdump |
| **evs\_client\_url** | The URL of the Gazelle EVSClient application. This is required to validate the messages captured by the proxy. | http://localhost:8080/EVSClient |
-| **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 | false |
-| **ip\_login\_admin** | Regex to be matched by IP addresses of the users granted as admin if "ip\_login" is set to "true" | .\* |
| **java\_cacerts\_truststore\_pwd** | GSS is also using the **cacerts** JVM truststore to validate certificates (located in ${JAVA\_HOME}/jre/lib/security/cacerts). Provide here its password. | changeit |
| **jms_communication_is_enabled** | Enable/disable JMS communication through the proxy. | false |
| **main\_cas\_keyword** | Key used to distinct authentication service (maximum length 8). | 1ST |
@@ -255,13 +241,7 @@ If you import an existing CA, do not use a CA chained to an issuer publicly trus
| **questionnaire\_display\_inbounds** | Enable/disable the *Inbound network communications* tab in ATNA Questionnaire | true |
| **questionnaire\_display\_outbounds** | Enable/disable the *Outbound network communications* tab in ATNA Questionnaire | true |
| **questionnaire\_display\_tls\_tests** | Enable/disable the *TLS Tests* tab in ATNA Questionnaire | true |
-| **rfc3881\_xsd** | Absolute system path to the RFC3881 schema (Audit Message validation). | /opt/tls/RFC3881.xsd |
-| **second\_cas\_enabled** | Enable/disable second CAS authentication. | false |
-| **second\_cas\_keyword** | Key used to distinct authentication service (maximum length 8). | null |
-| **second\_cas\_name** | Name of the authentication service displayed in the GUI. | null |
-| **second\_tm\_application\_url** | URL of Gazelle Test Management linked with the second CAS. | null |
-| **second\_tm\_message\_ws** | URL of the Messages web-service of Gazelle Test Management linked with the second CAS. | null |
-| **second\_tm\_pki\_admins** | List of PKI admins usernames in Gazelle Test Management linked with the second CAS (separated with a coma). They will receive a message alert each time a certificate is requested and require a manual validation. | null |
+| **rfc3881\_xsd** | Absolute system path to the RFC3881 schema (Audit Message validation). | /opt/tls/RFC3881.xsd | |
| **storage\_dicom** | Absolute path to the system folder used to store the DICOM datasets | /opt/tls/DICOM |
| **syslog_automatic_start_enabled** | Enable/disable automatic startup of Syslog simulators at application startup. | false |
| **syslog_collector_enabled** | Enable/disable Syslog simulator feature. | false |
@@ -273,3 +253,16 @@ If you import an existing CA, do not use a CA chained to an issuer publicly trus
| **xua\_mode\_enabled** | Enable/disable XUA assertions validator. | true |
| **xmldsig_core_schema_location** | URL to the XML schema for verifying ds:Signature element |https://gazelle.ihe.net/XSD/IHE/XUA/xmldsig-core-schema.xsd |
| **http_max_content_size** | The maximum size of http content that can be supported by the http proxy (the size is in MB) |16 |
+
+
+## SSO Configuration
+
+There are additional preferences to configure the SSO authentication.
+
+| Preference name | Description | Example of value |
+| ---------------- | ---------------------------------------------------------------------- | ---------------- |
+| **cas_enabled** | Enable or disable the CAS authentication. | true |
+| **ip_login** | Enable authentication by IP address matching `ip_login_admin` regex. | false |
+| **ip_login_admin** | Regex to authorize ip authentication if CAS authentication is disabled. | .* |
+
+For more documentation about SSO configurations, follow the link [here](https://gitlab.inria.fr/gazelle/public/framework/sso-client-v7/-/blob/master/cas-client-v7/README.md).
\ No newline at end of file
diff --git a/Gazelle-Security-Suite/release-note.md b/Gazelle-Security-Suite/release-note.md
index dbe7e7ed427709c09cbfe03b5fc1ef52b4804398..e268ca2c9944c59b52a0729c1e69bcf918757a86 100755
--- a/Gazelle-Security-Suite/release-note.md
+++ b/Gazelle-Security-Suite/release-note.md
@@ -1,15 +1,44 @@
---
title: Release note
subtitle: Gazelle Security Suite
-toolversion: 6.3.0
-releasedate: 2021-09-15
+toolversion: 7.0.0
+releasedate: 2024-02-05
author: Anne-Gaëlle BERGE
function: Software Engineer
customer: IHE Europe
reference: KER1-RNO-IHE-GSS
---
+
+# 7.0.0
+_Release date : 2024-02-06_
+
+Context : Gazelle User Management Renovation step 2
+
+__Task__
+* \[[GSS-593](https://gazelle.ihe.net/jira/browse/GSS-593)\] Integrate new sso-client-v7
+* \[[GSS-595](https://gazelle.ihe.net/jira/browse/GSS-595)\] Remove second CAS possibility
+
+__Improvement__
+* \[[GSS-594](https://gazelle.ihe.net/jira/browse/GSS-594)\] Display firstname and lastname instead of username.
+
+# 6.3.3
+_Release date : 2023-06-08_
+
+__Task__
+* \[[GSS-586](https://gazelle.ihe.net/jira/browse/GSS-586)\] XUA Validator - CH New ordinance EPDBEP-89 Purpose of use DICOM_AUTO
+
+# 6.3.2
+_Release date : 2023-06-05_
+
+__Story__
+* \[[GSS-585](https://gazelle.ihe.net/jira/browse/GSS-585)\] [DGSanté] Update certificates validator for wave 6
+
+__Task__
+* \[[GSS-584](https://gazelle.ihe.net/jira/browse/GSS-584)\] XUA Validator - CH New ordinance EPDBEP-145
+
+
# 6.3.1
-_Releae date : 2022-07-08_
+_Release date : 2022-07-08_
__Bug__
* \[[GSS-583](https://gazelle.ihe.net/jira/browse/GSS-583)\] Messages with only RSAKeyValue are faulting
@@ -20,7 +49,6 @@ _Release date: 2021-09-15_
__Story__
* \[[GSS-580](https://gazelle.ihe.net/jira/browse/GSS-580)\] XUA Validator - CH constraint on HomeCommunityID
-
# 6.2.7
_Release date: 2020-11-12_
diff --git a/Gazelle-Token-Service/installation.md b/Gazelle-Token-Service/installation.md
index cdadc2f14f992b1e3b5515790475c576b6d70db5..f191a7a2eb822458d1101fab507fc607f7357e30 100644
--- a/Gazelle-Token-Service/installation.md
+++ b/Gazelle-Token-Service/installation.md
@@ -15,7 +15,7 @@ customer: IHE-EUROPE
Gazelle Token Service is an open-source Java EE project used to calling various validation-services of e-Health standards.
-
+
## Get Gazelle-Token-Service
@@ -54,10 +54,10 @@ Each version of EVSClient is published in
### Pre-requisites
-Gazelle Token Service requires **JDK 11**, **JBoss AS 7.2.0-Final** **WildFly 18.0.1.Final**+ and **PostgreSQL**
+Gazelle Token Service requires **JDK 11**, **WildFly 26.1.2.Final**+ and **PostgreSQL**
to be run. Please refere to
-[General considerations for WildFly 18](https://gazelle.ihe.net/gazelle-documentation/General/wildfly18.html)
-to install WildFly 18 and setup a compliant environment.
+[General considerations for WildFly 26](https://gazelle.ihe.net/gazelle-documentation/General/wildfly26.html)
+to install WildFly 26 and setup a compliant environment.
### Create and initialize the database
@@ -74,33 +74,26 @@ If any of these variables is set, the corresponding preference in `preferences.p
Data sources _(configuration file that indicates how to connect to the
database)_ must be defined in the WildFly application server. More information about how to configure
data sources can be found here:
-[WildFly datasources](https://gazelle.ihe.net/gazelle-documentation/General/wildfly18.html#setup-datasources-for-gazelle-applications).
+[WildFly datasources](https://gazelle.ihe.net/gazelle-documentation/General/wildfly26.html).
-EVSClient will expect the JNDI datasource to be named: `java:jboss/datasources/GazelleTokenDS`.
+Gazelle Token will expect the JNDI datasource to be named: `java:jboss/datasources/GazelleTokenDS`.
A data source example and specific to Gazelle Token Service can be found in `gazelle-token-service-ear/src/main/datasource`
in the sources or in the archive `gazelle-token-service-ear-X.X.X-datasource.zip` that can be downloaded from
-[https://gazelle.ihe.net/nexus](https://gazelle.ihe.net/nexus/index.html#nexus-search;gav%7E%7EEVSClient-ear%7E%7E%7E).
+(https://gazelle.ihe.net/nexus/service/local/repositories/releases/content/net/ihe/gazelle/token/gazelle-token-service-ear/1.0.0/gazelle-token-service-ear-1.0.0-datasource.zip).
### File system
-
-A ZIP file is available at
-[https://gazelle.ihe.net/nexus/#nexus-search;quick~gazelle-token-service](https://gazelle.ihe.net/nexus/#nexus-search;quick~gazelle-token-service)
-(search for the last released **gazelle-token-service-ear-X.X.X-dist.zip**) that you can unzip in order to easily
-create all the required directories, starting at /opt.
-
-```bash
-wget -nv -O /tmp/gazelle-token-service-dist.zip "[*https://gazelle.ihe.net/nexus/service/local/repositories/releases/content/net/ihe/gazelle/gazelle-token-service-ear/X.X.X/gazelle-token-service-ear-X.X.X-dist.zip*](https://gazelle.ihe.net/nexus/service/local/repositories/releases/content/net/ihe/gazelle/EVSClient-ear/6.X.X/EVSClient-ear-6.X.X-dist.zip)"
-unzip /tmp/gazelle-token-service-dist.zip -d /
+Files system are located in /opt/gazelle-token.
+You should create the folder before launching the app.
+```
+sudo mkdir /opt/gazelle-token
```
### Single Sign On Installation
SSO installation is optional.
-Since version **5.13.0**, EVSClient needs a file to be integrated with the Gazelle SSO application.
-
-An instance of [Gazelle SSO](../Gazelle-SSO) must be deployed, the file `evs.properties`
+An instance of [Gazelle SSO](../Gazelle-SSO) must be deployed, the file `gazelle-token-service.properties`
shall be in `/opt/gazelle/cas` and must contain the following statements :
```properties
@@ -110,17 +103,17 @@ casLogoutUrl=https://<yourfqdn>/sso/logout
service=https://<yourfqdn>/gazelle-token-service
```
-_The truststore path must be the path referenced in `/etc/init.d/wildfly18`, in the option `OPT_SSL` and `-Djavax.net.ssl.trustStore`._
+_The truststore path must be the path referenced in `/etc/init.d/wildfly26`, in the option `OPT_SSL` and `-Djavax.net.ssl.trustStore`._
## Deployment
-Once you have retrieved the archive (see [Get EVSClient](#get-evsclient)), copy it to your JBoss7
-server in the `${JBOSS_DIR}/standalone/deployments` directory. The EAR copied in this folder MUST be
-named `evs.ear`.
+Once you have retrieved the archive, copy it to your wildfly26
+server in the `/usr/local/wildfly26/standalone/deployments` directory. The EAR copied in this folder MUST be
+named `gazelle-token-service.ear`.
```bash
-cp EVSClient-ear-X.X.X.ear /usr/local/wildfly-18.0.1.Final/standalone/deployments/gazelle-token-service-ear.ear
-sudo service wildfly18 start
+cp gazelle-token-service-ear-X.X.X.ear /usr/local/wildfly26/standalone/deployments/gazelle-token-service-ear.ear
+sudo service wildfly26 start
```
If you did not change any default configuration, Gazelle Token Service should be accessible at
diff --git a/Gazelle-Transformation-Service/installation.md b/Gazelle-Transformation-Service/installation.md
index fde20e3dd1df289be5eb386817fbf1cf1d34d5da..b3336533e31171a48dfc2423d351468a2bdf6f57 100755
--- a/Gazelle-Transformation-Service/installation.md
+++ b/Gazelle-Transformation-Service/installation.md
@@ -15,7 +15,7 @@ customer: IHE-EUROPE
# Sources & binaries
-Gazelle Transformation Service is an open-source project under Apache License Version 2.0 ([https://gazelle.ihe.net/content/license](https://gazelle.ihe.net/content/license)). Sources are available via Subversion at [https://svn.ihe-europe.net/gazelle/Maven/gazelle-transformation/](https://svn.ihe-europe.net/gazelle/Maven/gazelle-transformation/).
+Gazelle Transformation Service is an open-source project under Apache License Version 2.0 ([https://gazelle.ihe.net/content/license](https://gazelle.ihe.net/content/license)). Sources are available via git at [https://gitlab.inria.fr/gazelle/public/processing/transformation](https://gitlab.inria.fr/gazelle/public/processing/transformation).
# Gazelle Transformation Service installation and configuration
@@ -288,11 +288,19 @@ Use the Administration menu, you will find a sub-menu entitled "Configure applic
| application_release_notes_url | URL to the release note of the tool | https://gazelle.ihe.net/jira/projects/TRANSFOSRV?selectedItem=com.atlassian.jira.jira-projects-plugin:release-page&status=released|
| application_url | Complete URL of the tool | http://localhost:8580/transformation|
| application_url_basename | URL first resource to reach the tool | /transformation|
-| application_works_without_cas | Enable/disable CAS login | true|
| bin_path | File system path used by Gazelle Transformation | /opt/DaffodilTransformation/dfdl|
-| cas_url | URL of the Central Authentication Service | https://gazelle.ihe.net/cas|
| documentation_url | URL of the documentation | https://gazelle.ihe.net/gazelle-documentation/Gazelle-Transformation-Service/user.html|
-| ip_login | Enable/disable IP filtering for admin login (works only if CAS login disabled) | false|
-| ip_login_admin | Regular expresion for filtering IPs | .* |
| NUMBER_OF_ITEMS_PER_PAGE | Number of rows displayed by table pagination | 20|
| time_zone | Time Zone for display | Europe/Paris|
+
+# SSO Configuration
+
+There are additional preferences to configure the SSO authentication.
+
+| Preference name | Description | Example of value |
+| ---------------- | ---------------------------------------------------------------------- | ---------------- |
+| **cas_enabled** | Enable or disable the CAS authentication. | true |
+| **ip_login** | Enable authentication by IP address matching `ip_login_admin` regex. | false |
+| **ip_login_admin** | Regex to authorize ip authentication if CAS authentication is disabled. | .* |
+
+For more documentation about SSO configurations, follow the link [here](https://gitlab.inria.fr/gazelle/public/framework/sso-client-v7/-/blob/master/cas-client-v7/README.md).
\ No newline at end of file
diff --git a/Gazelle-Transformation-Service/release-note.md b/Gazelle-Transformation-Service/release-note.md
index f752efb11ebfdfd2e7d9bbe7fbfb7345b9972e61..226939b387a5a87c01a19dca7ec5102c319f851b 100755
--- a/Gazelle-Transformation-Service/release-note.md
+++ b/Gazelle-Transformation-Service/release-note.md
@@ -1,15 +1,21 @@
---
title: Release note
subtitle: Gazelle Transformation Service
-toolversion: 2.1.2
-releasedate: 2022-04-25
+toolversion: 2.2.0
+releasedate: 2024-02-06
author: Anne-Gaëlle BERGE
function: Software Engineer
customer: IHE Europe
reference: KER1-RNO-IHE-GAZELLE_TRANSFORMATION_SERVICE
---
-# 2.1.1
+# 2.2.0
+_Release date: 2024-02-06_
+
+__Task__
+* \[[TRANSFOSRV-74](https://gazelle.ihe.net/jira/browse/TRANSFOSRV-74)\] Integrate new sso-client-v7
+
+# 2.1.2
_Release date: 2022-04-25_
__Story__
diff --git a/Gazelle-User-Management/Makefile b/Gazelle-User-Management/Makefile
new file mode 100644
index 0000000000000000000000000000000000000000..aae7529ec7be99c42782fa86365ac546775f70db
--- /dev/null
+++ b/Gazelle-User-Management/Makefile
@@ -0,0 +1,3 @@
+SHELL := /bin/bash
+
+include ../Makefile.generic
\ No newline at end of file
diff --git a/Gazelle-User-Management/links.md b/Gazelle-User-Management/links.md
new file mode 100644
index 0000000000000000000000000000000000000000..c33d87033173ccce666c65bb547ccf30d776bb4f
--- /dev/null
+++ b/Gazelle-User-Management/links.md
@@ -0,0 +1,10 @@
+---
+title: Documentation
+subtitle: Gazelle User Management
+toolversion: 1.0.1
+releasedate: 2023-09-14
+author:
+---
+
+Gazelle User Management documentation is located
+on [https://doc-ihe.kereval.cloud/gazelle-applications/v/gazelle-user-management/](https://doc-ihe.kereval.cloud/gazelle-applications/v/gazelle-user-management/).
diff --git a/Gazelle-Webservice-Tester/installation.md b/Gazelle-Webservice-Tester/installation.md
index 09d1c054b7950aa7ef1a0182a59d9f9879d5b2df..82da0efd75764c9a13f32e9760a8ee5e8180ba18 100755
--- a/Gazelle-Webservice-Tester/installation.md
+++ b/Gazelle-Webservice-Tester/installation.md
@@ -3,9 +3,9 @@ title: Installation Manual
subtitle: Gazelle Webservice Tester
author: Malo TOUDIC
function: Software developer
-date: 05/03/2019
-toolversion: 1.7.x
-version: 1.02
+date: 2024-02-06
+toolversion: 2.0.0
+version: 2.0.0
status: Approved document
reference: KER1-MAN-IHE-GAZELLE_WEBSERVICE_TESTER_USER
customer: IHE-EUROPE
@@ -13,7 +13,7 @@ customer: IHE-EUROPE
# Sources & binaries
-Gazelle Webservice Tester (GWT) is an open-source project under Apache License Version 2.0 ([https://gazelle.ihe.net/content/license](https://gazelle.ihe.net/content/license)). Sources are available via Git at [https://gitlab.inria.fr/gazelle/applications/test-execution/simulator/gazelle-webservice-tester.git](https://gitlab.inria.fr/gazelle/applications/test-execution/simulator/gazelle-webservice-tester.git).
+Gazelle Webservice Tester (GWT) is an open-source project under Apache License Version 2.0 ([https://gazelle.ihe.net/content/license](https://gazelle.ihe.net/content/license)). Sources are available via Git at [https://gitlab.inria.fr/gazelle/public/simulation/webservice-tester.git](https://gitlab.inria.fr/gazelle/public/simulation/webservice-tester.git).
The latest public packaged release can be downloaded from our Nexus repository [https://gazelle.ihe.net/nexus/index.html#nexus-search;quick~gazelle-webservice-tester-ear](https://gazelle.ihe.net/nexus/index.html#nexus-search;quick~gazelle-webservice-tester-ear) (search for **gazelle-webservice-tester-X.X.X.ear**).
@@ -63,7 +63,7 @@ Database name : gazelle-webservice-tester
1. Unzip the archive into a folder named `gwt-sql`
-1. Edit the application_url value in init.sql. You might also want to edit application_works_without_cas.
+1. Edit the application_url value in init.sql.
1. From the bash, update the application configuration by running :
```bash
diff --git a/Gazelle-Webservice-Tester/release-note.md b/Gazelle-Webservice-Tester/release-note.md
index 7f8dbd0b4fc4dd2a7ac53d422b2c295b1ad3270c..028e06f89b990caef0ee681cb158f31c9bad77a6 100755
--- a/Gazelle-Webservice-Tester/release-note.md
+++ b/Gazelle-Webservice-Tester/release-note.md
@@ -1,13 +1,29 @@
---
title: Release note
subtitle: Gazelle Webservice Tester
-toolversion: 1.7.4
-releasedate: 2021-07-19
+toolversion: 2.0.0
+releasedate: 2024-02-02
author: Malo TOUDIC
function: Software developer
customer: IHE-Europe
reference: KER1-RNO-IHE-GAZELLE_WEBSERVICE_TESTER
---
+# 2.0.0
+_Release date: 2024-02-02_
+
+Context : Gazelle User Management Renovation step 2
+
+__Task__
+* \[[GWT-148](https://gazelle.ihe.net/jira/browse/GWT-148)\] Integrate new sso-client-v7
+* \[[GWT-149](https://gazelle.ihe.net/jira/browse/GWT-149)\] Remove username display in GUI
+
+# 1.8.0
+_Release date: 2023-09-21_
+
+__Improvement__
+* \[[GWT-146](https://gazelle.ihe.net/jira/browse/GWT-146)\] Display dump of dicom document when displaying WADO-RS response
+* \[[GWT-147](https://gazelle.ihe.net/jira/browse/GWT-147)\] Display response HTTP header
+
# 1.7.4
_Release date: 2021-07-19_
diff --git a/Gazelle-Webservice-Tester/user.md b/Gazelle-Webservice-Tester/user.md
index 96dc13e6d5be6ea944770e084f0f5d12a86a9eaa..e64a064cc74250b8ab24a3c022d69692e9ce5c11 100755
--- a/Gazelle-Webservice-Tester/user.md
+++ b/Gazelle-Webservice-Tester/user.md
@@ -4,7 +4,7 @@ subtitle: Gazelle Webservice Tester
author: Malo TOUDIC
function: Software developer
date: 05/03/2019
-toolversion: 1.7.x
+toolversion: 1.8.x
version: 1.02
status: Approved document
reference: KER1-MAN-IHE-GAZELLE_WEBSERVICE_TESTER_USER
diff --git a/Gazelle-X-Validator-Rule-Editor/installation.md b/Gazelle-X-Validator-Rule-Editor/installation.md
index ab1c987c3c9e35f04e989e552d5300a178f8e722..dd539ec7808b2d0b4029b4ec0e1d78967bdf88a8 100755
--- a/Gazelle-X-Validator-Rule-Editor/installation.md
+++ b/Gazelle-X-Validator-Rule-Editor/installation.md
@@ -80,10 +80,8 @@ Database name : gazelle-x-validator-rule-editor
| Preference name | Description | Default value |
|-----------------|-----------------------------------------|---------------------|
|application_url | URL to access the application | https://FQDN/GazelleXValidatorRuleEditor |
-|application_works_without_cas | Enable or disable the CAS authentication | true |
|assertion_manager_url | URL to the assertion manager tool instance | https://FQDN/AssertionManagerGui |
|documentation_url | Link to the user documentation | https://gazelle.ihe.net/gazelle-documentation/Gazelle-X-Validator-Rule-Editor/user.html |
-|ip_login_admin | Regex to authorize ip authentication if CAS authentication is disabled | .* |
|release_notes_url | Link to the issue reporter (JIRA) | https://gazelle.ihe.net/jira/browse/XVALEDIT#selectedTab=com.atlassian.jira.plugin.system.project%3Achangelog-panel |
|svs_repository_url | URL to the svs repository instance | - |
|ut_directory | | /opt/x_validation/ut_directory |
@@ -95,3 +93,15 @@ Database name : gazelle-x-validator-rule-editor
|xvalidator_directory | | /opt/x_validation |
|x_validator_root_oid | X val root OID | 1.1.1.1.1.1.1.1.1.1.1.1.1. |
|xvalidator_xsl_url | | https://FQDN/GazelleXValidatorRuleEditor/resources/stylesheet/gazelleXValidator.xsl |
+
+# SSO Configuration
+
+There are additional preferences to configure the SSO authentication.
+
+| Preference name | Description | Example of value |
+| ---------------- | ---------------------------------------------------------------------- | ---------------- |
+| **cas_enabled** | Enable or disable the CAS authentication. | true |
+| **ip_login** | Enable authentication by IP address matching `ip_login_admin` regex. | false |
+| **ip_login_admin** | Regex to authorize ip authentication if CAS authentication is disabled. | .* |
+
+For more documentation about SSO configurations, follow the link [here](https://gitlab.inria.fr/gazelle/public/framework/sso-client-v7/-/blob/master/cas-client-v7/README.md).
\ No newline at end of file
diff --git a/Gazelle-X-Validator-Rule-Editor/release-note.md b/Gazelle-X-Validator-Rule-Editor/release-note.md
index a8c4d19c83f86191c1f7844bf2eca1b63509067f..e07457e84a5e8fff64d7939eba0e20b04f7f1747 100755
--- a/Gazelle-X-Validator-Rule-Editor/release-note.md
+++ b/Gazelle-X-Validator-Rule-Editor/release-note.md
@@ -1,13 +1,22 @@
---
title: Release note
subtitle: Gazelle X Validator Rule Editor
-toolversion: 1.3.0
-releasedate: 2019-03-19
+toolversion: 2.0.0
+releasedate: 2024-02-02
author: Anne-Gaëlle BERGE
function: Software Engineer
customer: IHE Europe
reference: KER1-RNO-IHE-GAZELLE_X_VALIDATOR_RULE_EDITOR
---
+# 2.0.0
+_Release date: 2024-02-02_
+
+Context : Gazelle User Management Renovation step 2
+
+__Task__
+* \[[XVALEDIT-73](https://gazelle.ihe.net/jira/browse/XVALEDIT-73)\] Integrate new sso-client-v7
+* \[[XVALEDIT-74](https://gazelle.ihe.net/jira/browse/XVALEDIT-74)\] Remove username display in GUI
+
# 1.3.0
_Release date: 2019-03-19_
diff --git a/HPD-Simulator/installation.md b/HPD-Simulator/installation.md
index 9bfed861e71535a890b0a8e11ddc6d9ea9ac504e..1c2d4f3223c5077a898ff0cbd5ff123a0a5baeb1 100755
--- a/HPD-Simulator/installation.md
+++ b/HPD-Simulator/installation.md
@@ -17,7 +17,7 @@ The HPD Simulator has been developed in order to help users with testing their i
As mentioned in the user guide, the LDAP directory has not been fully developed by the team, it makes use of a 3rd party tool named ApacheDS. This server is open source, certified LDAPv3 and supports DSMLv2. It also embeds a Kerberos Server (which can be useful later if we need to provide tools for the EUA profile). We currently use ApacheDS 2.0.0-M14.
-The sources of the projects are available on [Inria's gitlab](https://gitlab.inria.fr/gazelle/applications/test-execution/simulator/HPDSimulator.git).
+The sources of the projects are available on [Inria's gitlab](https://gitlab.inria.fr/gazelle/public/simulation/hpd-simulator.git).
# Pre-requisites
@@ -130,7 +130,7 @@ Note that you may have to reset your connection to your server to see the newly
## Requirements
-The HPD Simulator tool is a Maven 3 project, sources are available on Inria’s gitlab at [*https://gitlab.inria.fr/gazelle/applications/test-execution/simulator/HPDSimulator.git*](https://gitlab.inria.fr/gazelle/applications/test-execution/simulator/HPDSimulator.git).
+The HPD Simulator tool is a Maven 3 project, sources are available on Inria’s gitlab at [*https://gitlab.inria.fr/gazelle/public/simulation/hpd-simulator.git*](https://gitlab.inria.fr/gazelle/public/simulation/hpd-simulator.git).
This application runs under JBoss 7.2.0-GA and uses a postgreSQL 9 database.
@@ -311,7 +311,6 @@ A subordinate node is reprensenting by the LDAPNode object which is composed of
|----------------------------------|------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------|
| application\_name | The name of the application | HPD Simulator |
| application\_url | URL to reach the tool | https://gazelle.ihe.net/HPDSimulator |
-| application\_works\_without\_cas | Indicates whether the users are authenticated using the CAS service or another mechanism | false |
| assertion\_manager\_url | Link to the Assertion Manager tool | https://gazelle.ihe.net/AssertionManagerGui |
| dsml\_xsl\_location | URL of the stylesheet used to display DSMLv2 messages | https://gazelle.ihe.net/xsl/dsmlStylesheet.xsl |
| ldap\_password | Password used to log onto the LDAP server (if authentication is required) | N/A (no authentication put in place) |
@@ -325,6 +324,18 @@ A subordinate node is reprensenting by the LDAPNode object which is composed of
| time\_zone | To display time in the appropriate time zone | Europe/Paris |
| xsd\_location | URI to access the DSMLv2 schema (used by validation service) | /opt/hpd/xsd/IHE/DSMLv2.xsd |
+# SSO Configuration
+
+There are additional preferences to configure the SSO authentication.
+
+| Preference name | Description | Example of value |
+| ---------------- | ---------------------------------------------------------------------- | ---------------- |
+| **cas_enabled** | Enable or disable the CAS authentication. | true |
+| **ip_login** | Enable authentication by IP address matching `ip_login_admin` regex. | false |
+| **ip_login_admin** | Regex to authorize ip authentication if CAS authentication is disabled. | .* |
+
+For more documentation about SSO configurations, follow the link [here](https://gitlab.inria.fr/gazelle/public/framework/sso-client-v7/-/blob/master/cas-client-v7/README.md).
+
# Configuration of the documentation for HPD Model-based validator
The administrator is able to configure the documentation of HPD constraints and rules
diff --git a/HPD-Simulator/release-note.md b/HPD-Simulator/release-note.md
index a0c7bd4964ec32ba6f9dea42dcb260a8a550d671..ca86604424664b5cb0fd8d7dfd11f498abd15986 100755
--- a/HPD-Simulator/release-note.md
+++ b/HPD-Simulator/release-note.md
@@ -1,13 +1,49 @@
---
title: Release note
subtitle: HPDSimulator
-toolversion: 2.4.1
-releasedate: 2022-02-07
+toolversion: 3.0.0
+releasedate: 2024-02-02
author: Malo TOUDIC
function: Software Developer
customer: IHE Europe
reference: KER1-RNO-IHE-HPD_SIMULATOR
---
+# 3.0.0
+_Release date: 2024-02-02_
+
+__Task__
+* \[[HPD-218](https://gazelle.ihe.net/jira/browse/HPD-218)\] Integrate new sso-client-v7
+* \[[HPD-219](https://gazelle.ihe.net/jira/browse/HPD-219)\] Remove username display in GUI
+
+# 2.4.5
+_Release date: 2023-12-08_
+
+__Bug__
+* \[[HPD-221](https://gazelle.ihe.net/jira/browse/HPD-221)\] [CH] Wrong value set IDs in HPD validation constraint
+
+# 2.4.4
+_Release date: 2023-12-07_
+
+__Bug__
+* \[[HPD-220](https://gazelle.ihe.net/jira/browse/HPD-220)\] [CH:HPD] UID Format: . and _ need to be added to the list of special characters that don't need to be escaped
+
+# 2.4.3
+_Release date: 2023-06-12_
+
+__Bug__
+* \[[HPD-217](https://gazelle.ihe.net/jira/browse/HPD-217)\] Timestamp validator RegEx error
+
+# 2.4.2
+_Release date: 2023-06-06_
+
+# All changes
+
+__Bug__
+* \[[HPD-215](https://gazelle.ihe.net/jira/browse/HPD-215)\] ch_hpd_014_Metadata_attributes is using the wrong value set OID
+
+__Improvement__
+* \[[HPD-214](https://gazelle.ihe.net/jira/browse/HPD-214)\] Update data & schema in CPI Simulator
+* \[[HPD-216](https://gazelle.ihe.net/jira/browse/HPD-216)\] [CH] Add validation contraint for the uid format
# 2.4.1
_Release date: 2022-02-07_
diff --git a/HTTP-Validator/Makefile b/HTTP-Validator/Makefile
new file mode 100644
index 0000000000000000000000000000000000000000..cbbc56c706e2a9d7c1b43999f7199c4c956757ea
--- /dev/null
+++ b/HTTP-Validator/Makefile
@@ -0,0 +1,3 @@
+SHELL := /bin/bash
+
+include ../Makefile.generic
diff --git a/HTTP-Validator/images/ValidationMenu.png b/HTTP-Validator/images/ValidationMenu.png
new file mode 100644
index 0000000000000000000000000000000000000000..e6a2ced7fe269787a7e81fa9080737da4900d8da
Binary files /dev/null and b/HTTP-Validator/images/ValidationMenu.png differ
diff --git a/HTTP-Validator/images/ValidationResultEVS.png b/HTTP-Validator/images/ValidationResultEVS.png
new file mode 100644
index 0000000000000000000000000000000000000000..81645cb31d9adacd08b35317dbdee48b7f764d1c
Binary files /dev/null and b/HTTP-Validator/images/ValidationResultEVS.png differ
diff --git a/HTTP-Validator/installation.md b/HTTP-Validator/installation.md
new file mode 100644
index 0000000000000000000000000000000000000000..50d08ad930af2ac304e2f711ba5c71428dd4769f
--- /dev/null
+++ b/HTTP-Validator/installation.md
@@ -0,0 +1,46 @@
+---
+title: User Manual
+subtitle: HTTP Validator
+author: Clément LAGORCE
+function: Software Engineer
+date: 22/08/2023
+toolversion: 0.3.0
+version: 1_03
+status: Reviewed
+reference: KER1-MAN-IHE-HTTP-VALIDATOR_USER-1_03
+customer: IHE-EUROPE
+---
+
+# Purpose
+
+Here is a guide to help you install the IUA-Simulator.
+
+# Deployment
+
+## Minimal requirements
+
+* Debian squeeze or ubuntu 12.04 64bits or higher with an Internet access.
+* Java virtual machine : JDK 17
+* Application server : Wildfly 27
+
+To install those requirements you can refer to the documentation of installation of Wildfly : [*General Requirements Wildfly 27*](https://docs.wildfly.org/27/Getting_Started_Guide.html)
+
+## Instructions
+
+Copy the http-validator.war into the "/usr/local/wildfly27/standalone/deployments" directory of your Wildfly server.
+
+You'll have to specify Environment variable before starting the server.
+Here are the mandatory environment variables to be able to deploy correctly the application :
+- GZL_PROFILE_REPOSITORY_PATH
+- GZL_PROFILE_CACHE_MAX_ELEMENTS
+- GZL_TOKEN_API_URL
+- APPLICATION_URL
+
+Then, the specified path for GZL_PROFILE_REPOSITORY_PATH variable need to point to an existing folder, if not, you'll have to create it.
+It is usually equals to /opt/http-validator/validationProfiles
+
+Finally, start your server.
+
+Once the application is deployed, open a browser and go to http://yourserver/http-validator/rest/metadata in order to check of the service is available.
+
+If the deployment is successful, you should receive a 200 Ok Response.
\ No newline at end of file
diff --git a/HTTP-Validator/release-note.md b/HTTP-Validator/release-note.md
new file mode 100644
index 0000000000000000000000000000000000000000..1338895453c55c45c6e6732b0508406c1f8d3678
--- /dev/null
+++ b/HTTP-Validator/release-note.md
@@ -0,0 +1,42 @@
+---
+title: Release note
+subtitle: HTTP Validator
+toolversion: 0.3.0
+releasedate: 2023-09-19
+author: Clément LAGORCE
+function: Software Engineer
+customer: IHE Europe
+reference: KER1-RNO-IHE-HTTP_VALIDATOR
+---
+
+# 0.3.0
+_Release date: 2023-09-19_
+
+__Story__
+* \[[HTTP-16](https://gazelle.ihe.net/jira/browse/HTTP-16)\] Release/Doc
+* \[[HTTP-43](https://gazelle.ihe.net/jira/browse/HTTP-43)\] Use new Validation API and Reports
+
+__Improvement__
+* \[[HTTP-40](https://gazelle.ihe.net/jira/browse/HTTP-40)\] CRLF Improvements
+
+# 0.2.0
+_Release date: 2023-02-22_
+
+__Story__
+* \[[HTTP-10](https://gazelle.ihe.net/jira/browse/HTTP-10)\] Support HTTP Header
+* \[[HTTP-11](https://gazelle.ihe.net/jira/browse/HTTP-11)\] Selector using EL expression
+* \[[HTTP-12](https://gazelle.ihe.net/jira/browse/HTTP-12)\] Support list of checker
+* \[[HTTP-13](https://gazelle.ihe.net/jira/browse/HTTP-13)\] Support Conditionality
+* \[[HTTP-14](https://gazelle.ihe.net/jira/browse/HTTP-14)\] Add needed Checkers
+* \[[HTTP-19](https://gazelle.ihe.net/jira/browse/HTTP-19)\] Security integration (gazelle-token-service)
+
+# 0.1.0
+_Release date: 2023-01-30_
+
+__Story__
+* \[[HTTP-3](https://gazelle.ihe.net/jira/browse/HTTP-3)\] Import a validation profile via API
+* \[[HTTP-4](https://gazelle.ihe.net/jira/browse/HTTP-4)\] Create model for validation profile (Minimal, V0.1)
+* \[[HTTP-5](https://gazelle.ihe.net/jira/browse/HTTP-5)\] Project creation
+* \[[HTTP-6](https://gazelle.ihe.net/jira/browse/HTTP-6)\] Engine (minimal, V0.1)
+* \[[HTTP-7](https://gazelle.ihe.net/jira/browse/HTTP-7)\] Create Webservice
+* \[[HTTP-8](https://gazelle.ihe.net/jira/browse/HTTP-8)\] Integrate into EVSClient
\ No newline at end of file
diff --git a/HTTP-Validator/user.md b/HTTP-Validator/user.md
new file mode 100644
index 0000000000000000000000000000000000000000..5cdf4f836de8e3c71e54192d036c04f7c201ab3b
--- /dev/null
+++ b/HTTP-Validator/user.md
@@ -0,0 +1,92 @@
+---
+title: User Manual
+subtitle: HTTP Validator
+author: Clément LAGORCE
+function: Software Engineer
+date: 21=2/08/2023
+toolversion: 0.3.0
+version: 1_03
+status: Reviewed
+reference: KER1-MAN-IHE-HTTP-VALIDATOR_USER-1_03
+customer: IHE-EUROPE
+---
+
+# Introduction
+This application has been developed with the purpose of validating any HTTP Message (Request or Response) in a full raw String format.
+- For an HTTP Request : The message is a String containing the HTTP Method, URI, Query parameters, HTTP Version and HTTP Headers.
+- For an HTTP Response : The message is a String containing the HTTP Version, the Status Code, the Reason Phrase and the HTTP Headers.
+
+Every message shall be formatted as specified in the [RFC 2616](https://www.rfc-editor.org/rfc/rfc2616) of the HTTP Protocol. This includes the double CRLF at the end of the HTTP Headers.
+
+As we can see in [Section 2.2](https://www.rfc-editor.org/rfc/rfc2616#section-2.2), [Section 5](https://www.rfc-editor.org/rfc/rfc2616#section-5) and [Section 6](https://www.rfc-editor.org/rfc/rfc2616#section-6), the HTTP message shall be provided to the tool with the following format :
+~~~text
+CRLF = CR LF
+CR = <US-ASCII CR, carriage return (13)>
+LF = <US-ASCII LF, linefeed (10)>
+SP = <US-ASCII SP, space (32)>
+
+Request = Method SP Request-URI SP HTTP-Version CRLF
+ *(( general-header
+ | request-header
+ | entity-header ) CRLF)
+ CRLF
+ [ message-body ]
+
+Response = HTTP-Version SP Status-Code SP Reason-Phrase CRLF
+ *(( general-header
+ | response-header
+ | entity-header ) CRLF)
+ CRLF
+ [ message-body ]
+~~~
+
+This tool provides a way to validate automatically any HTTP Message from any standard or profile that uses RestFul Web Services.
+The messages are validated against a configuration file called Validation Profile formatted in Json.
+
+## Purpose of the document
+This document is the Customer user manual for the Gazelle HTTP Validator module.
+
+## Scope of the document
+The scope of this document is limited to the usage of Gazelle HTTP Validator, how to create a Validation Profile and how to perform an HTTP Message validation.
+
+How to install, configure and maintain the tool is described in the Installation manual.
+
+## HTTP Validator Engine
+This part of the application is the validation Engine that will validate the HTTP message provided to the validator. It is directly connected to EVS Client.
+
+### EVSClient Validation
+The other way to perform HTTP message validation is by using EVSClient. A configuration shall be done in EVSClient in the same platform where HTTP-Validator is deployed.
+Once EVS is configured, this menu should appear at the top bar :
+
+The Validation Report is displayed in a similar manner as it is for other validators.
+Below is the result of the same HTTP message against the same Validation Profile as for the Rest API :
+
+
+# Tools needed
+
+## HTTP Validator Service
+
+### Sources and libraries
+The sources are available on Inria’s Gitlab in the Gazelle project : _https://gitlab.inria.fr/gazelle/applications/test-execution/validator/http-validator_
+
+Released binaries are available in the Gazelle Nexus repository at : _https://gazelle.ihe.net/nexus/#nexus-search;gav~~http-validator_
+
+### Issue tracker
+Issues and features requests shall be entered through the issue bug tracking system of the Gazelle platform, at _https://gazelle.ihe.net/jira/browse/HTTP_VAL_.
+
+## EVSClient
+
+### Sources and libraries
+The sources are available on Inria’s Gitlab in the Gazelle project : _https://gitlab.inria.fr/gazelle/applications/test-execution/validator/EVSClient_.
+
+Released binaries are available in the Gazelle Nexus repository at : _https://gazelle.ihe.net/nexus/index.html#nexus-search;gav~~EVSClient_
+
+### Issue tracker
+For an issue specific to the gazelle-x-validation module, please use the issue tracker at _https://gazelle.ihe.net/jira/browse/HTTP_VAL_. For an issue specific to the EVS Client, you can use _https://gazelle.ihe.net/jira/browse/EVSCLT_.
+
+## Gazelle Token Service
+
+### Sources and libraries
+The sources are available on Inria’s Gitlab in the Gazelle project : _https://gitlab.inria.fr/gazelle/applications/core/gazelle-token_.
+
+Released binaries are available in the Gazelle Nexus repository at : _https://gazelle.ihe.net/nexus/index.html#nexus-search;quick~gazelle-token_.
\ No newline at end of file
diff --git a/IUA-Simulator/.gitignore b/IUA-Simulator/.gitignore
new file mode 100644
index 0000000000000000000000000000000000000000..ea8c4bf7f35f6f77f75d92ad8ce8349f6e81ddba
--- /dev/null
+++ b/IUA-Simulator/.gitignore
@@ -0,0 +1 @@
+/target
diff --git a/IUA-Simulator/Makefile b/IUA-Simulator/Makefile
new file mode 100644
index 0000000000000000000000000000000000000000..cbbc56c706e2a9d7c1b43999f7199c4c956757ea
--- /dev/null
+++ b/IUA-Simulator/Makefile
@@ -0,0 +1,3 @@
+SHELL := /bin/bash
+
+include ../Makefile.generic
diff --git a/IUA-Simulator/installation.md b/IUA-Simulator/installation.md
new file mode 100644
index 0000000000000000000000000000000000000000..026ba53db1ed84729aa742517357fc7407a4aa8a
--- /dev/null
+++ b/IUA-Simulator/installation.md
@@ -0,0 +1,38 @@
+---
+title: Installation Manual
+subtitle: IUA Simulator
+author: Pierre-Marie VAN HOUTEGHEM, CLaude LUSSEAU
+function: Software Engineer
+date: 2023-04-05
+toolversion: 1.0.0
+version: 1.00
+status: To be reviewed
+reference: KER1-MAN-IHE-IUA-SIMULATOR_INSTALLATION-1\_01
+customer: IHE-EUROPE
+---
+# Purpose
+
+Here is a guide to help you install the IUA-Simulator.
+
+# Deployment
+
+## Minimal requirements
+
+* Debian squeeze or ubuntu 12.04 64bits or higher with an Internet access.
+* Java virtual machine : JDK 17
+* Application server : Wildfly 27
+* Keycloak server : Keycloak 20.0.3 and above
+
+To install those requirements you can refer to the documentation of installation of Wildfly : [*General Requirements Wildfly 27*](https://ehealthsuisse.ihe-europe.net/gazelle-documentation/General/wildfly26.html)
+
+## Instructions
+
+Copy the iua-simulator.war into the "/usr/local/wildfly27/standalone/deployments" directory of your Wildfly server.
+
+You'll have to specify Environment variable before starting the server.
+Those environment variable are needed for your iua-simulator to know how to access your keycloak installation and the clients to be called through ITI-71 transactions.
+Here is a list of everything needed to be setup before launching the application server. Finally, start your server.
+
+Once the application is deployed, open a browser and go to http://yourserver/iua-simulator/rest/ch/ping in order to check of the service is available.
+
+If the deployment is successful, you should receive a 200 Ok Response.
\ No newline at end of file
diff --git a/IUA-Simulator/release-note.md b/IUA-Simulator/release-note.md
new file mode 100644
index 0000000000000000000000000000000000000000..aac4d89a42d276f0333cb66a906a4a0bef2e9442
--- /dev/null
+++ b/IUA-Simulator/release-note.md
@@ -0,0 +1,15 @@
+---
+title: Release note
+subtitle: IUA Simulator
+toolversion: 1.0.0
+releasedate: 2023-04-20
+author: Pierre-Marie VAN HOUTEGHEM, Claude LUSSEAU
+function: Software Engineer
+customer: IHE Europe
+reference: KER1-RNO-IHE-IUA-SIMULATOR
+---
+# IUA Simulator
+_Release date: 2023-04-20_
+
+__Story__
+* \[[IUASIMU-1](https://gazelle.ihe.net/jira/browse/IUASIMU-1)\] ITI71 Simulator
\ No newline at end of file
diff --git a/IUA-Simulator/resources/iti-71.png b/IUA-Simulator/resources/iti-71.png
new file mode 100644
index 0000000000000000000000000000000000000000..5ae228d30843561381f9d316ecb7fca9e1516ce9
Binary files /dev/null and b/IUA-Simulator/resources/iti-71.png differ
diff --git a/IUA-Simulator/user.md b/IUA-Simulator/user.md
new file mode 100644
index 0000000000000000000000000000000000000000..38652144dbf7a1a3126ece4bfd3fb81be8f52da1
--- /dev/null
+++ b/IUA-Simulator/user.md
@@ -0,0 +1,261 @@
+---
+title: User Manual
+subtitle: IUA Simulator
+author: Pierre-Marie VAN HOUTEGHEM, Claude LUSSEAU
+releasedate: 2023-04-20
+toolversion: 1.0.0
+function: Software Engineer
+version: 1.00
+status: To be reviewed
+---
+
+## Table of content
+
+1. [IHE Profile](#ihe)
+ 1. [ITI-71](#ihe-iti-71)
+ 2. [ITI-72](#ihe-iti-72)
+ 3. [ITI-102](#ihe-iti-102)
+ 4. [ITI-103](#ihe-iti-103)
+2. [CH Profile](#ch)
+ 1. [ITI-71](#ch-iti-71)
+ 2. [ITI-72](#ch-iti-72)
+ 3. [ITI-102](#ch-iti-102)
+ 4. [ITI-103](#ch-iti-103)
+
+## IHE Profile <a name="ihe"></a>
+
+### ITI-71 <a name="ihe-iti-71"></a>
+
+
+
+The ITI-71 transaction is sent by the Authorization Client to the Authorization Server to retrieve an access Token to be used within requests to the Resource server.
+
+Two ways can be used to resolve this transaction, but the one used by this simulator is the Authorization Code grant type.
+The request must be sent to the /authorize endpoint, which look like this
+
+``` http
+{$simulator.endpoint}/iua-simulator/rest/ch/authorize?
+```
+
+The first Http Request is a GET containing the following parameters :
+
+| parameter |required/optional| description |
+|----------------------|----|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| response_type |required| The response format of the authorization method. Here must be code |
+| client_id |required| The ID, the client is registered at the IUA Authorization Server. |
+| redirect_uri |required| Used as callback URL, the IUA Authorization Server will send the authorization code to. The URL SHALL match one of the client’s pre-registered redirect URIs. |
+| state |required| An unguessable value used by the client to track the state between the authorization request and the callback. |
+| scope |required| Attributes the app claims |
+| code_challenge |required| Transformed version of code_verifier with code_challenge_method |
+| code_chalenge_method |required| SHALL be “S256â€. |
+
+This request must be sent to the /authorize endpoint of the authorization server.
+This means the request should look like something like this :
+
+``` http
+HTTP GET {$simulator.endpoint}/iua-simulator/rest/ch/authorize?
+ response_type=code
+ &client_id=ch-iua-client
+ &state=helloFromChIua
+ &resource=ihe.pixm.net
+ &code_challenge=fDH8WRQ-vp-6dU6_llO2Fa7wHYSoiKOWoDNxl_u0TLg
+ &code_challenge_method=S256
+ &redirect_uri={$simulator.endpoint}/iua-simulator/rest/ch/callback
+ &scope=profile
+ HTTP 1.1
+```
+Following this request, you will receive an Authorization Code in a JSON formatted response.
+
+Using the Authorization client, you will then need to do a second Request:
+
+| parameter | required/optional | description |
+|---------------|----------------------------------|---------------------------------------------------------------------------------------------------------|
+| client_id | required in Authorization header | The ID the client is registered at the IUA Authorization Server. |
+| client_secret | required in Authorization header | The secret to access the client |
+| redirect_uri | required | The URI to redirect the apps user agent to. Must be the same as in the first request |
+| grant_type | required | Value shall be “authorization_codeâ€. |
+| code | required | The authorization code we retrieved through the previous request |
+| code_verifier | required | The original code verifier string, the non-hashed version of the code_challenge from! the first request |
+
+This request is a Post sent to the /token endpoint of the authorization server.
+Those arguments must therefore be contained in a body as an *application/x-www-form-urlencoded* content-type, and encoded in UTF-8
+Finally both *client_id* and *client_secret* must be encapsulated in the base HTTP Authorization header.
+
+This means the request should like something like this :
+
+``` http
+HTTP POST {$simulator.endpoint}/iua-simulator/rest/ch/token HTTP 1.1
+Authorization: Basic vsdvZRTYHQS51SgvtsqeGFs62
+Content-Type: application/x-www-form-urlencoded
+
+grant_type=authorization_code
+&code=13fER1Gqe2FshWDRwg
+&redirect_uri={$simulator.endpoint}/iua-simulator/rest/ch/callback
+&code_verifier=-5Q635ku8ER2pfGeuDagpsk40
+```
+
+As a response to this, you should receive a JSON containing the access_token. You can use resources such as [jwt.io](#https://jwt.io)
+to verify the content of your access_token.
+
+This access_token can now be used by the user to access resource servers or for other transactions.
+### ITI-72 <a name="ihe-iti-72"></a>
+Coming soon
+### ITI-102 <a name="ihe-iti-102"></a>
+Coming soon
+### ITI-103 <a name="ihe-iti-103"></a>
+
+The ITI-103 transaction is usually sent by the Resource Server to the Authorization Server to retrieve information relative to the the endpoints and token format created by the authorization server.
+
+``` http
+HTTP GET {$simulator.endpoint}/iua-simulator/rest/ihe/.well-known HTTP 1.1
+```
+
+Here is a list of the properties that should be accessible through this call, and their meaning.
+
+| Name | Required/Optional/Conditional ? | Description |
+|-|-|-|
+| issuer | required | The Authorization Server's issuer identifier, which is a URL that uses the "https" scheme and has no query or fragment components.|
+|authorization_endpoint | required | Authorization Server's Authorization endpoint as used for the "authorization code" flow.|
+|token_endpoint | required | Authorization Server's Authorization token endpoint location.|
+|jwks_uri | conditional | URL of the Authorization Server's JWK Set |
+|scopes_supported | optional | The list of scopes supported by the Authorization Server. Note this transaction does not define the scopes. Authorization Servers may opt to publish a subset of the scopes usable.|
+|response_types_supported | required | As the implicit grant flow is not supported in OAuth2.1, the response types should not include the value "token". Authorization Servers shall include the response type "code". Authorization Servers supporting [OpenId Connect] or other standards may include other token types, such as "id_token".|
+|grant_types_supported | required | A JSON array listing the type of grants supported toward the token endpoint. The list shall include the values "client_credentials", and "authorization_code". Authorization Servers supporting refresh tokens shall include "refresh-token". Authorization Servers supporting the JWT grant shall include "urn:ietf:params:oauth:grant-type:jwt-bearer".Authorization Servers supporting the SAML grant shall include "urn:ietf:params:oauth:grant-type:saml2-bearer". Authorization Servers supporting other types of grants should provide additional values to this list representing those grant types.|
+|token_endpoint_auth_methods_supported | optional | JSON array containing a list of client authentication methods supported by this token endpoint. When provided, this list shall include "client_secret_basic".|
+|introspection_endpoint | conditional |URL of the Authorization Server's OAuth 2.0 introspection endpoint. This claim must be provided by Authorization Servers supporting the Token Introspection Option.|
+|introspection_endpoint_auth_methods_supported | conditional | JSON array containing a list of client authentication methods supported by the introspection endpoint. This claim must be provided by Authorization Servers supporting the Token Introspection Option. As the introspect option mandates support for Resource Server bearer access tokens, this claim must include the "Bearer" value. Other authentication methods (e.g., "client_secret_basic") are allowed when supported by the Authorization Server.|
+|access_token_format | optional | JSON string defining the format of the access token as provided by the Authorization Server. This allows Resource Servers to learn about methods of verification. Authorization Servers supporting the JWT Token Option shall set this claim value to "ihe-jwt". Authorization Servers supporting the SAML Token Option shall set this claim value to "ihe-saml". Authorization Servers providing tokens that are non-parsable shall set this value to "opaque". Authorization Servers supporting access tokens in other structured formats may use alternative format identifiers.|
+
+## CH Profile <a name="ch"></a>
+
+### ITI-71 <a name="ch-iti-71"></a>
+
+
+
+The ITI-71 transaction is sent by the Authorization Client to the Authorization Server to retrieve an access Token to be used within requests to the Resource server.
+
+Two ways can be used to resolve this transaction, but the one used by this simulator is the Authorization Code grant type.
+The request must be sent to the /authorize endpoint, which look like this
+
+``` http
+{$simulator.endpoint}/iua-simulator/rest/ch/authorize?
+```
+
+The first Http Request is a GET containing the following parameters :
+
+| parameter |required/optional| description |
+|----------------------|----|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| response_type |required| The response format of the authorization method. Here must be code |
+| client_id |required| The ID, the client is registered at the IUA Authorization Server. |
+| redirect_uri |required| Used as callback URL, the IUA Authorization Server will send the authorization code to. The URL SHALL match one of the client’s pre-registered redirect URIs. |
+| state |required| An unguessable value used by the client to track the state between the authorization request and the callback. |
+| scope |required| Attributes the app claims |
+| aud |required| The audience URL the token will be used for. |
+| launch |optional| If present, the launch parameter indicates that the app (or the view) was launched from an EHR or mHealth App context which has already been authorized to access the Swiss EPR (e.g. SMART on FHIR based primary system). |
+| code_challenge |required| Transformed version of code_verifier with code_challenge_method |
+| code_chalenge_method |required| SHALL be “S256â€. |
+
+This request must be sent to the /authorize endpoint of the authorization server.
+This means the request should look like something like this :
+
+``` http
+HTTP GET {$simulator.endpoint}/iua-simulator/rest/ch/authorize?
+ response_type=code
+ &client_id=ch-iua-client
+ &state=helloFromChIua
+ &resource=ihe.pixm.net
+ &code_challenge=fDH8WRQ-vp-6dU6_llO2Fa7wHYSoiKOWoDNxl_u0TLg
+ &code_challenge_method=S256
+ &redirect_uri={$simulator.endpoint}/iua-simulator/rest/ch/callback
+ &scope=profile
+ &aud=http://pixmResourceServerURL.ch
+ &launch=azerty
+ HTTP 1.1
+```
+
+The scope request inside this request shall only contain permitted arguments :
+
+| scope parameter | Optionnality (Basic/Extended) | description |
+|-|-------------------------------|-|
+|launch| Optionnal/Required |Permission to obtain launch context when the app is launched from an EHR. Required for apps or views launched from an EHR or a mHealth App which was authorized before.|
+|purpose_of_use| Optionnal/Required |Value taken from code system 2.16.756.5.30.1.127.3.10.5 of the CH: EPR value set.|
+|subject_role| Optionnal/Required |Only the values for the Role of Healthcare Professionals, Assistants, Patients and Representatives are allowed.|
+|person_id| Optionnal/Required |EPR-SPID identifier of the patient’s record and the patient assigning authority formatted in CX syntax.|
+|principal| Optionnal/Optionnal |Name of the healthcare professional an assistant is acting on behalf of.|
+|principal_id| Optionnal/Optionnal |GLN of the healthcare professional an assistant is acting on behalf of.|
+|group| Optionnal/Optionnal |Name of the organization or group an assistant is acting on behalf of.|
+|group_id| Optionnal/Optionnal |OID of the organization or group an assistant is acting on behalf of.|
+|access_token_format| Optionnal/Optionnal |Either ihe-jwt or ihe-saml as value. Will return this token_flavor. If scope is not provided defaults to ihe-jwt.|
+
+Following this request, you will receive an Authorization Code in a JSON formatted response.
+
+Using the Authorization client, you will then need to do a second Request to the following URL:
+
+``` http
+{$simulator.endpoint}/iua-simulator/rest/ch/token?
+```
+
+| parameter | required/optional | description |
+|---------------|----------------------------------|---------------------------------------------------------------------------------------------------------|
+| client_id | required in Authorization header | The ID the client is registered at the IUA Authorization Server. |
+| client_secret | required in Authorization header | The secret to access the client |
+| redirect_uri | required | The URI to redirect the apps user agent to. Must be the same as in the first request |
+| grant_type | required | Value shall be “authorization_codeâ€. |
+| code | required | The authorization code we retrieved through the previous request |
+| code_verifier | required | The original code verifier string, the non-hashed version of the code_challenge from! the first request |
+
+This request is a Post sent to the /token endpoint of the authorization server.
+Those arguments must therefore be contained in a body as an *application/x-www-form-urlencoded* content-type, and encoded in UTF-8
+Finally both *client_id* and *client_secret* must be encapsulated in the base HTTP Authorization header.
+
+This means the request should like something like this :
+
+``` http
+HTTP POST {$simulator.endpoint}/iua-simulator/rest/ch/token HTTP 1.1
+Authorization: Basic vsdvZRTYHQS51SgvtsqeGFs62
+Content-Type: application/x-www-form-urlencoded
+
+grant_type=authorization_code
+&code=13fER1Gqe2FshWDRwg
+&redirect_uri={$simulator.endpoint}/iua-simulator/rest/ch/callback
+&code_verifier=-5Q635ku8ER2pfGeuDagpsk40
+```
+
+As a response to this, you should receive a JSON containing the access_token. You can use resources such as [jwt.io](#https://jwt.io)
+to verify the content of your access_token.
+
+This access_token can now be used by the user to access resource servers or for other transactions.
+___
+## ITI-72 <a name="ch-iti-72"></a>
+
+Coming soon
+
+___
+## ITI-102 <a name="ch-iti-102"></a>
+
+Coming soon
+
+___
+## ITI-103 <a name="ch-iti-103"></a>
+
+The ITI-103 transaction is usually sent by the Resource Server to the Authorization Server to retrieve information relative to the the endpoints and token format created by the authorization server.
+
+``` http
+HTTP GET {$simulator.endpoint}/iua-simulator/rest/ch/.well-known HTTP 1.1
+```
+
+Here is a list of properties that should be accessible through this transaction :
+
+| Name | Required/Optional/Conditional ? | Description |
+|-|-|-|
+| issuer | required | The Authorization Server's issuer identifier, which is a URL that uses the "https" scheme and has no query or fragment components.|
+|authorization_endpoint | required | Authorization Server's Authorization endpoint as used for the "authorization code" flow.|
+|token_endpoint | required | Authorization Server's Authorization token endpoint location.|
+|jwks_uri | conditional | URL of the Authorization Server's JWK Set |
+|scopes_supported | optional | The list of scopes supported by the Authorization Server. Note this transaction does not define the scopes. Authorization Servers may opt to publish a subset of the scopes usable.|
+|response_types_supported | required | As the implicit grant flow is not supported in OAuth2.1, the response types should not include the value "token". Authorization Servers shall include the response type "code". Authorization Servers supporting [OpenId Connect] or other standards may include other token types, such as "id_token".|
+|grant_types_supported | required | A JSON array listing the type of grants supported toward the token endpoint. The list shall include the values "client_credentials", and "authorization_code". Authorization Servers supporting refresh tokens shall include "refresh-token". Authorization Servers supporting the JWT grant shall include "urn:ietf:params:oauth:grant-type:jwt-bearer".Authorization Servers supporting the SAML grant shall include "urn:ietf:params:oauth:grant-type:saml2-bearer". Authorization Servers supporting other types of grants should provide additional values to this list representing those grant types.|
+|token_endpoint_auth_methods_supported | optional | JSON array containing a list of client authentication methods supported by this token endpoint. When provided, this list shall include "client_secret_basic".|
+|introspection_endpoint | conditional |URL of the Authorization Server's OAuth 2.0 introspection endpoint. This claim must be provided by Authorization Servers supporting the Token Introspection Option.|
+|introspection_endpoint_auth_methods_supported | conditional | JSON array containing a list of client authentication methods supported by the introspection endpoint. This claim must be provided by Authorization Servers supporting the Token Introspection Option. As the introspect option mandates support for Resource Server bearer access tokens, this claim must include the "Bearer" value. Other authentication methods (e.g., "client_secret_basic") are allowed when supported by the Authorization Server.|
+|access_token_format | optional | JSON string defining the format of the access token as provided by the Authorization Server. This allows Resource Servers to learn about methods of verification. Authorization Servers supporting the JWT Token Option shall set this claim value to "ihe-jwt". Authorization Servers supporting the SAML Token Option shall set this claim value to "ihe-saml". Authorization Servers providing tokens that are non-parsable shall set this value to "opaque". Authorization Servers supporting access tokens in other structured formats may use alternative format identifiers.|
\ No newline at end of file
diff --git a/Makefile b/Makefile
index 7fcba3d2f2daefa1063824e8612d1853421e769c..6265050ebdf8dfe258ff14c2fbfa34f1cc4840e6 100755
--- a/Makefile
+++ b/Makefile
@@ -7,6 +7,18 @@ TEMPLATE_JEKYLL = _templates/jekyll-gazelle-documentation
DOCS := $(filter-out _templates/,$(DOCS))
DOCS := $(filter-out target/,$(DOCS))
+# Répertoire source où se trouvent les fichiers Markdown
+SOURCE_DIR := $(CURDIR)
+
+# Récupère tous les fichiers Markdown récursivement dans SOURCE_DIR
+MARKDOWN_FILES := $(shell find $(SOURCE_DIR) -type f -name "*.md")
+
+# Génère la liste des répertoires uniques où se trouvent les fichiers Markdown
+DIRS := $(sort $(dir $(MARKDOWN_FILES)))
+
+# Remplace l'extension .md par .pdf pour les fichiers cibles
+PDF_FILES := $(patsubst $(SOURCE_DIR)/%.md,$(OUTPUT_FOLDER)/%.pdf,$(MARKDOWN_FILES))
+
all: clean jekyll $(DOCS)
$(DOCS): force | $(OUTPUT_FOLDER)
@@ -20,7 +32,6 @@ $(OUTPUT_FOLDER):
# launch jekyll serve to preview website with jekyll server
view: jekyll
- cp $(OUTPUT_FOLDER)/jekyll-gazelle-documentation/index-default.html $(OUTPUT_FOLDER)/jekyll-gazelle-documentation/index.html
cd $(OUTPUT_FOLDER)/jekyll-gazelle-documentation/ && bundle exec jekyll serve
# Create documentation website with jekyll
@@ -38,7 +49,7 @@ init_jekyll_folder:
cd $(OUTPUT_FOLDER)/jekyll-gazelle-documentation/ && bundle
setup:
- sudo apt-get install make git git-svn texlive-xetex pandoc ruby-dev
+ sudo apt-get install git git-svn texlive-xetex pandoc ruby-dev
sudo gem install bundler
# copy markdown sources to jekyll foler
@@ -54,14 +65,16 @@ copy_docs_to_target:
# copy markdown sources to jekyll foler
copy_source_to_jekyll:
@for a in $(DOCS); do \
- if [ -d $$a ]; then \
- echo "copy folder $$a to $(OUTPUT_FOLDER)/jekyll-gazelle-documentation/"; \
- cp -r $$a $(OUTPUT_FOLDER)/jekyll-gazelle-documentation/; \
- fi; \
- done;
- @echo "Done!"
+ if [ -d $$a ]; then \
+ echo "copy folder $$a to $(OUTPUT_FOLDER)/jekyll-gazelle-documentation/"; \
+ cp -r $$a $(OUTPUT_FOLDER)/jekyll-gazelle-documentation/; \
+ fi; \
+ done;
+ cp $(OUTPUT_FOLDER)/jekyll-gazelle-documentation/index-default.html $(OUTPUT_FOLDER)/jekyll-gazelle-documentation/index.html
+ @echo "Done!"
.PHONY: clean
+
clean:
-rm -rf $(OUTPUT_FOLDER)
@for a in $(DOCS); do \
@@ -71,3 +84,13 @@ clean:
fi; \
done;
@echo "All clear!"
+
+# Règle par défaut pour générer tous les PDF. Attention avec les tableaux il peut y avoir des problèmes de rendu voir README
+pdf-gen: $(PDF_FILES)
+
+# Règle pour convertir un fichier Markdown en PDF
+$(OUTPUT_FOLDER)/%.pdf: $(SOURCE_DIR)/%.md
+ @mkdir -p $(@D) # Crée le répertoire cible s'il n'existe pas
+ cd $(dir $<) && pandoc $< -N -s --toc --pdf-engine=xelatex -o $(SOURCE_DIR)/$@
+
+
diff --git a/Order-Manager/installation.md b/Order-Manager/installation.md
index 5122871fb24aff8d586f90085bf7aadd5d05cae4..4fd2b04b136439f6ea2d143998a036c14b7525c1 100755
--- a/Order-Manager/installation.md
+++ b/Order-Manager/installation.md
@@ -23,9 +23,9 @@ If you rather want to build the project by yourself, you must checkout the lates
Checkout the latest tag available on Inria’s gitlab:
```bash
-git clone https://gitlab.inria.fr/gazelle/applications/test-execution/simulator/order-manager.git
+git clone https://gitlab.inria.fr/gazelle/public/simulation/order-manager.git
cd order-manager
-git checkout tags/OrderManager-<version>
+git checkout <version>
```
1. \[Optional\] Edit the pom.xml file and create a new profile
@@ -89,7 +89,7 @@ Database name : order-manager
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 OrderManager-ear/src/main/sql/import.sql
-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)
+Before executing the script, open the file and checked the various preferences to be inserted in the app\_configuration table, especially the application\_url and other preferences relative to the user authentication (see Application configuration section)
Finally, execute the script:
```bash
@@ -109,8 +109,6 @@ Use the Administration menu, you will find a sub-menu entitied "Configure applic
| application\_issue\_tracker\_url | URL of the helpdesk or project for Order Manager in your bug tracker tool | [*Link to jira*](https://gazelle.ihe.net/jira/browse/OM)|
| application\_release\_note\_url | URL to the release note in JIRA (or elsewhere) | [*Link to JIRA*](https://gazelle.ihe.net/jira/browse/OM)|
| 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/OrderManager |
-| application\_works\_without\_cas | Tells the application how users are authenticated | True: all users are granted as admin<br>False: uses a CAS service to authenticate users|
-| cas\_url | If you intent to use a CAS, put its URL here | https://gazelle.ihe.net |
| contact\_email | The email address of the person to be contacted by the user in case help is needed | - |
| contact\_name | The name of the person to be contacted by the user in case help is needed | - |
| contact\_title | The title of the person to be contacted by the user in case help is needed | - |
@@ -124,8 +122,6 @@ Use the Administration menu, you will find a sub-menu entitied "Configure applic
| eye\_order\_hierarchy\_location | Location of the XML file used to perform the matching between orders and procedures/protocols in the context of the Eyecare workflow profile | [*Default file*](https://gazelle.ihe.net/examples/orderHierarchy-EYE2012.xml)|
| gazelle\_hl7v2\_validator\_url | URL of the Gazelle HL7 Validator tool | [Gazelle HL7 Validator](https://gazelle.ihe.net/GazelleHL7Validator)|
| hl7v2\_xsl\_location | URL to access the XML stylesheet used to display HL7v2.x validation results| [*XSL location*](https://gazelle.ihe.net/xsl/hl7Validation/resultStylesheet.xsl)|
-| 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<br>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 |
|laboratory_enabled | Enabled/Disabled the Laboratory entry in the menu | true |
|message_permanent_link | Permanent link to message details | http://publicUrlOfJboss/OrderManager/messages/MessageDisplay.seam?id=
|NUMBER_OF_ITEMS_PER_PAGE | Default number of rows to be displayed in tables | 20 |
@@ -144,6 +140,18 @@ Use the Administration menu, you will find a sub-menu entitied "Configure applic
| wlmscpfs\_port | the port on which the worklist listens to | 12345 |
| worklists\_basedir | where to store worklists for retrieve by dcmtk |/opt/worklists|
+### SSO Configuration
+
+There are additional preferences to configure the SSO authentication.
+
+| Preference name | Description | Example of value |
+| ---------------- | ---------------------------------------------------------------------- | ---------------- |
+| **cas_enabled** | Enable or disable the CAS authentication. | true |
+| **ip_login** | Enable authentication by IP address matching `ip_login_admin` regex. | false |
+| **ip_login_admin** | Regex to authorize ip authentication if CAS authentication is disabled. | .* |
+
+For more documentation about SSO configurations, follow the link [here](https://gitlab.inria.fr/gazelle/public/framework/sso-client-v7/-/blob/master/cas-client-v7/README.md).
+
### HL7v2.x responders
From the Administration > HL7 Responders configuration page, you will be able to configure each actor of the tool playing the role of a responder in a HL7-based transaction. An entry in this table consists in the receiving application and facility and the port on which it listens to incoming messages. You can also configure the encoding for receiving message (always ER7 for IHE) as weel as the transport protocol to be used (always MLLP for IHE). If you are using HL7 over HTTP, you will be asked to provide the URL of the endpoint instead of the IP address/port couple.
diff --git a/Order-Manager/release-note.md b/Order-Manager/release-note.md
index 33d6794fd132647b64ee35987314e7e990f44722..2e8190a2dffabdc60c9191a2e24b0d0e37913fa5 100755
--- a/Order-Manager/release-note.md
+++ b/Order-Manager/release-note.md
@@ -1,13 +1,22 @@
---
title: Release note
subtitle: Order Manager
-toolversion: 5.3.2
-releasedate: 2021-11-23
+toolversion: 6.0.0
+releasedate: 2024-02-05
author: Anne-Gaëlle BERGE
function: Software Engineer
customer: IHE Europe
reference: KER1-RNO-IHE-ORDER_MANAGER
---
+# 6.0.0
+_Release date: 2024-02-05_
+
+Context : Gazelle User Management Renovation step 2
+
+__Task__
+* \[[OM-367](https://gazelle.ihe.net/jira/browse/OM-367)\] Integrate new sso-client-v7
+* \[[OM-368](https://gazelle.ihe.net/jira/browse/OM-368)\] Remove username display in GUI
+
# 5.3.2
_Release date: 2021-11-23_
diff --git a/Patient-Manager/installation.md b/Patient-Manager/installation.md
index dfe44a3228755f1adecb985ab0dbca4ec2cf215a..58fb517b0375c55210b32c994fe5255f27228e28 100755
--- a/Patient-Manager/installation.md
+++ b/Patient-Manager/installation.md
@@ -28,7 +28,7 @@ If you have your own CAS service, you need to package your own version of the to
1. Checkout the last tagged version available in Gazelle sources repository ($versionName will depend of the release you want to checkout)
```bash
- git clone https://gitlab.inria.fr/gazelle/applications/test-execution/simulator/Patient-Manager.git
+ git clone https://gitlab.inria.fr/gazelle/public/simulation/patient-manager.git
cd PAMSimulator
git checkout tags/PAMSimulator-$versionName
```
@@ -94,7 +94,7 @@ For more informations about how to manage that externalization, please refer to
6. If you do not intent to use any CAS service, execute the following SQL command
- `update app\_configuration set value = 'true' where variable = 'application\_works\_without\_cas';`
+ `update app\_configuration set value = 'true' where variable = 'cas\_enabled';`
7. Finally, open your favorite browser (please avoid usage of IE), and go to
@@ -178,7 +178,6 @@ Under the Administration menu, you will find a sub-menu entitled "Configure appl
|  application\_namespace\_id |  Defines the namespaceID of the issuer of the identifiers generated by the tool |  IHEPAM |
| Â application\_universal\_id | Â Defines the universal ID of the issuer of the identifiers generated by the tool. It's formatted as an OID and shall be unique across all instances of PatientManager tool | Â a uniquely defined OID |
| Â application\_universal\_id\_type | Â Defines the type of universal id | Â ISO |
-| cas\_url | URL of the SSO service | https://gazelle.ihe.net/cas |
| Â create\_worklist\_url | Â The URL of the OrderManager instance you may use to create DICOM worklists | Â *OrderManager on Gazelle* |
| default\_pdq\_domain | For PDQv3, defines if we use SeHE or ITI rules | ITI |
| hl7v3\_organization\_oid | OID of the organization issuing/receiving HL7v3 messages | a uniquely defined OID |
@@ -198,9 +197,6 @@ Under the Administration menu, you will find a sub-menu entitled "Configure appl
| Â sending\_application | Used to populate MSH-3 field of the HL7 messages produced by the tool | PAMSimulator
| Â sending\_facility | Â Used to populate MSH-4 field of the HL7 messages produced by the tool | Â Â IHE |
| Â time\_zone | Â Defines which time zone to use to display dates and timestamps | Â Europe/Paris |
-| Â 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 |
-| ip\_login | whether to enable or not the authentication by IP address | false |
-| ip\_login\_admin | if ip\_login = true, a regex to grant users with admin role according to their IP addresses | .\* |
| Â dds\_ws\_endpoint | Â Location of the Demographic Data server WSDL | Â *DDS WS on Gazelle* |
| Â gazelle\_hl7v2\_validator\_url | Â URL of the Gazelle HL7 Validator tool | Â https://gazelle.ihe.net/GazelleHL7Validator |
| Â svs\_repository\_url | Â URL of the Sharing Value Set Repository actor of the SVSSimulator | Â https://gazelle.ihe.net |
@@ -225,6 +221,18 @@ Under the Administration menu, you will find a sub-menu entitled "Configure appl
| path_to_keystore | Absolute path of the keystore (used when the SOAP header contains a signature) | |
| private_key_alias | Alias of the private key in the keystore (used when the SOAP header contains a signature) | |
+## SSO Configuration
+
+There are additional preferences to configure the SSO authentication.
+
+| Preference name | Description | Example of value |
+| ---------------- | ---------------------------------------------------------------------- | ---------------- |
+| **cas_enabled** | Enable or disable the CAS authentication. | true |
+| **ip_login** | Enable authentication by IP address matching `ip_login_admin` regex. | false |
+| **ip_login_admin** | Regex to authorize ip authentication if CAS authentication is disabled. | .* |
+
+For more documentation about SSO configurations, follow the link [here](https://gitlab.inria.fr/gazelle/public/framework/sso-client-v7/-/blob/master/cas-client-v7/README.md).
+
## HL7v2.x responders
From the Administration/HL7 Responders configuration page, you will be able to configure each actor of the tool playing the role of a responder in a HL7-based transaction. A configure consists in the receiving application and facility and the port on which it listens to incoming messages. The IP address is not used by the server but must be set properly so that the users can configure their systems under test to communicate with the tool. DO NOT update the other parameters; it would prevent the tool from working correctly.
diff --git a/Patient-Manager/release-note.md b/Patient-Manager/release-note.md
index 6b2c5f0c9d79c6fb9cce91ef5108a9bd55570f5c..2ca9ec4c5a938ee28891c5079778fccd076017f9 100755
--- a/Patient-Manager/release-note.md
+++ b/Patient-Manager/release-note.md
@@ -1,16 +1,45 @@
---
title: Release note
subtitle: PatientManager
-toolversion: 9.16.4
-releasedate: 2023-02-02 00:00:00.0
+toolversion: 10.0.0
+releasedate: 2024-02-06
author: Anne-Gaëlle BERGE
function: Software Engineer
customer: IHE Europe
reference: KER1-RNO-IHE-PATIENT_MANAGER
---
+# 10.0.0
+_Release date: 2024-02-06_
+
+Context : Gazelle User Management Renovation step 2
+
+__Task__
+* \[[PAM-775](https://gazelle.ihe.net/jira/browse/PAM-775)\] Integrate new sso-client-v7
+* \[[PAM-776](https://gazelle.ihe.net/jira/browse/PAM-776)\] Remove username display in GUI
+
+# 9.16.7
+_Release date: 2023-08-21_
+
+__Bug__
+* \[[PAM-773](https://gazelle.ihe.net/jira/browse/PAM-773)\] PAM automaton crash at startup
+
+# 9.16.6
+_Release date: 2023-04-14_
+
+__Bug__
+* \[[PAM-769](https://gazelle.ihe.net/jira/browse/PAM-769)\] Fix TOS popup
+
+# 9.16.5
+_Release date: 2023-03-08_
+
+__Bug__
+* \[[PAM-772](https://gazelle.ihe.net/jira/browse/PAM-772)\] PDC and PEC Simulator throws an error when the patient doesn't have an Identity Reliability Code
+
# 9.16.4
+_Release date: 2022-02-02_
+
__Bug__
-* \[[PAM-769](https://gazelle.ihe.net/jira/browse/PAM-769)\] Texte pour les cookies
+* \[[PAM-769](https://gazelle.ihe.net/jira/browse/PAM-769)\] Fix TOS popup
# 9.16.3
_Release date: 2022-05-19_
diff --git a/Patient-Manager/user.md b/Patient-Manager/user.md
index 41cb8bbee9f46d633bf2e9fd1ca1da4185042852..7875ec1156ac5c1c6ab76d2f8b53aced57c785f9 100755
--- a/Patient-Manager/user.md
+++ b/Patient-Manager/user.md
@@ -643,30 +643,30 @@ The Patient Manager is able to act as a Patient Demographics Supplier for the Pa
The table below gathers the parameters the simulator is able to map to its database to perform the query and send back the batch of corresponding patients. Note that when several parameters are provided, the AND operator is used to build the database query; the "\*" wildcard is supported to substitute zero or more characters. The returned patients are those owned by the Patient Demographic Supplier actor. To consult the list of available patients, see [*https://gazelle.ihe.net/PatientManager/patient/allPatients.seam?actor=PDS*](https://gazelle.ihe.net/PatientManager/patient/allPatients.seam?actor=PDS)Â . Note that only the subset of active patients is queried.
-| **HL7 FIELDÂ ** | **Â ELEMENT NAME** | Â **JAVA OBJECT / ATTRIBUTE (indicative)**Â | **Â SQL CLAUSEÂ ** | **Â EXTRA INFO** |
-|----------------|----------------------------------------------------------------------|--------------------------------------------|-------------------------------------------------------|--------------------------------|
-| **PID.3** | Patient Identifier List | patient.patientIdentifiers | like (ignores case) | also filter according to QPD-8 |
-| **PID.3.1** | Patient Identifier List (ID Number) | patientIdentifer.fullPatientId | like (ignores case), MatchMode = START | |
-| **PID.3.4.1** | Patient Identifier List (Assigning Authority - namespace ID) Â | Â patientIdentifier.domain.namespaceIDÂ | domain namespaceID like (ignores case)Â | |
-| **PID.3.4.2** | Patient Identifier List (Assigning Authority - universal ID) | patientIdentifier.domain.universalID | Â domain universal ID like (ignores case)Â | |
-| **PID.3.4.3** | Patient Identifier List (Assigning Authority - universal ID Type) |  patietnIdentifier.domain.universalIDType |  domain universal ID type  like (ignores case) | |
-| **PID.3.5** | Patient Identifier List (Identifier Type Code) | patientIdentifier.identifierTypeCode | like (ignores case) | |
-| **PID.5.1.1 ** | Patient Name (family name/surname) | patient.lastName | like (ignores case) | |
-| **PID.5.2** | Patient Name (given name) | patient.firstName | like (ignores case) | |
-| **PID.7.1** | Date/Time of Birth | patient.dateOfBirth | between 'date 0:00 am' to 'date 11:59 pm' | date format : yyyyMMddHHmmss |
-| **PID.8** | Administrative Sex | patient.genderCode | equals | Gender code (F, M ...) |
-| **PID.11.1** | Patient Address (Street) | patient.street | like (ignores case) | |
-| **PID.11.3** | Patient Address (City) | patient.city | like (ignores case) | |
-| **PID.11.4** | Patient Address (State) | patient.state | like (ignores case) | |
-| **PID.11.5** | Patient Address (Zip Code) | patient.zipCode | like (ignores case) | |
-| **PID.11.6** | Patient Address (Country Code) | patient.countryCode | like (ignores case) | iso3 |
-| **PID.18** | Patient Account Number | patient.accountNumber | like (ignores case) | |
-| **PID.18.1** | Patient Account Number  (ID Number) | patient.accountNumber | like (ignores case), MatchMode = START | |
-| **PID.18.4.1** | Patient Account Number  (Assigning Authority - namespace ID) | patient.accountNumber |  like (ignores case) %^^^value, MatchMode = START | |
-| **PID.18.4.2** | Patient Account Number  (Assigning Authority - universal ID) | patient.accountNumber | like (ignores case) %^^^%&value, MatchMode = START | |
-| **PID.18.4.3** | Patient Account Number  (Assigning Authority - universal ID Type)   | patient.accountNumber |  like (ignores case) %^^^%&%&value, MatchMode = START | |
-| **PID.6.1.1** | Mother's maiden name (last name) | patient.mothersMaidenName | like (ignores case) | |
-| **PID.13.9** | Phone Number - Home (any text) | patient.phoneNumber | like (ignores case) | |
+| **HL7 FIELDÂ ** | **Â ELEMENT NAME** | Â **JAVA OBJECT / ATTRIBUTE (indicative)**Â | **Â SQL CLAUSEÂ ** | **Â EXTRA INFO** |
+|--------------------|----------------------------------------------------------------------|--------------------------------------------|-------------------------------------------------------|--------------------------------|
+| **PID.3** | Patient Identifier List | patient.patientIdentifiers | like (ignores case) | also filter according to QPD-8 |
+| **PID.3.1** | Patient Identifier List (ID Number) | patientIdentifer.fullPatientId | like (ignores case), MatchMode = START | |
+| **PID.3.4.1** | Patient Identifier List (Assigning Authority - namespace ID) Â | Â patientIdentifier.domain.namespaceIDÂ | domain namespaceID like (ignores case)Â | |
+| **PID.3.4.2** | Patient Identifier List (Assigning Authority - universal ID) | patientIdentifier.domain.universalID | Â domain universal ID like (ignores case)Â | |
+| **PID.3.4.3** | Patient Identifier List (Assigning Authority - universal ID Type) |  patietnIdentifier.domain.universalIDType |  domain universal ID type  like (ignores case) | |
+| **PID.3.5** | Patient Identifier List (Identifier Type Code) | patientIdentifier.identifierTypeCode | like (ignores case) | |
+| **PID.5.1.1 ** | Patient Name (family name/surname) | patient.lastName | like (ignores case) | |
+| **PID.5.2** | Patient Name (given name) | patient.firstName | like (ignores case) | |
+| **PID.7.1** | Date/Time of Birth | patient.dateOfBirth | between 'date 0:00 am' to 'date 11:59 pm' | date format : yyyyMMddHHmmss |
+| **PID.8** | Administrative Sex | patient.genderCode | equals | Gender code (F, M ...) |
+| **PID.11.1** | Patient Address (Street) | patient.street | like (ignores case) | |
+| **PID.11.3** | Patient Address (City) | patient.city | like (ignores case) | |
+| **PID.11.4** | Patient Address (State) | patient.state | like (ignores case) | |
+| **PID.11.5** | Patient Address (Zip Code) | patient.zipCode | like (ignores case) | |
+| **PID.11.6** | Patient Address (Country Code) | patient.countryCode | like (ignores case) | iso3 |
+| **PID.18** | Patient Account Number | patient.accountNumber | like (ignores case) | |
+| **PID.18.1** | Patient Account Number  (ID Number) | patient.accountNumber | like (ignores case), MatchMode = START | |
+| **PID.18.4.1** | Patient Account Number  (Assigning Authority - namespace ID) | patient.accountNumber |  like (ignores case) %^^^value, MatchMode = START | |
+| **PID.18.4.2** | Patient Account Number  (Assigning Authority - universal ID) | patient.accountNumber | like (ignores case) %^^^%&value, MatchMode = START | |
+| **PID.18.4.3** | Patient Account Number  (Assigning Authority - universal ID Type)   | patient.accountNumber |  like (ignores case) %^^^%&%&value, MatchMode = START | |
+| **PID.6.1.1** | Mother's maiden name (last name) | patient.mothersMaidenName | like (ignores case) | |
+| **PID.13.9** | Phone Number - Home (any text) | patient.phoneNumber | like (ignores case) | |
Table 1 PDQ - PDS - ITI-21 query parameters
diff --git a/Patient-Manager/user.md~ b/Patient-Manager/user.md~
new file mode 100755
index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391
diff --git a/Patient-Registry/installation.md b/Patient-Registry/installation.md
index 253e5c3fa9546b0ab5fb176d4d8699ba5a6b6ca6..3dfe0a6a5e958107b6ae76dbd1107b0036dcc680 100755
--- a/Patient-Registry/installation.md
+++ b/Patient-Registry/installation.md
@@ -1,9 +1,9 @@
---
title: Installation Manual
subtitle: Patient Registry
-author: Franck Desaize
-releasedate: 12/07/2021
-toolversion: 2.0.x
+author: Franck Desaize, Alexandre POCINHO
+releasedate: 2024-02-02
+toolversion: 2.2.x
function: Developer
version: 0.01
status: Draft document
@@ -11,91 +11,90 @@ reference: KER1-MAN-IHE-PATIENT_REGISTRY_INSTALLATION-0_01
customer: IHE-EUROPE
---
-# Patient Registry
+# Patient Registry suite installation
-The Patient Registry project is dedicated to the management of patient demographics and identifiers test data.
+## Patient Registry (PATREG)
+
+The Patient Registry project is dedicated to the management of patient demographics and identifiers test data.
It will embed connectors such as FHIR PDQm, PIXm or PAM.
-## Sources & binaries
+### Sources & binaries
The sources are accessible here: [https://gitlab.inria.fr/gazelle/applications/test-execution/simulator/patient-registry](https://gitlab.inria.fr/gazelle/applications/test-execution/simulator/patient-registry)
-Bugs and issue tracking are accessible here : [https://gazelle.ihe.net/jira/projects/PATREG](https://gazelle.ihe.net/jira/projects/PATREG). The name
-of the latest release, can be obtained in the "Releases" section.
+Bugs and issue tracking are accessible here : [https://gazelle.ihe.net/jira/projects/PATREG](https://gazelle.ihe.net/jira/projects/PATREG). The name of the latest release, can be obtained in the "Releases" section.
To get official artifact (binaries), search for `patient-registry` in IHE Nexus : [https://gazelle.ihe.net/nexus](https://gazelle.ihe.net/nexus/#nexus-search;quick~patient-registry)
and select the **patient-registry.jar** artifact for download.
-## Installation
+### Installation
-### Patient Manager dependency
+#### Patient Manager dependency
-Patient Registry depends currently on the database of Patient Manager. Only patients created/managed in Patient Manager will be accessible in the
-Patient Registry Search API.
+Patient Registry depends currently on the database of Patient Manager. Only patients created/managed in Patient Manager will be accessible in the Patient Registry Search API.
Please follow [Patient Manager installation process](/gazelle-documentation/Patient-Manager/installation.html).
Patient Registry needs at least Patient Manager version 9.11.6.
-### Application server
+#### Application server
-Patient registry need to be deployed on Widlfly-18. Please read first the documentation on how to install and configure this server for Gazelle
-applications : [general considerations for WildFly 18](/gazelle-documentation/General/wildfly18.html)
+Patient registry need to be deployed on Widlfly-18.
+Please read first the documentation on how to install and configure this server for Gazelle
+applications : [general considerations for WildFly 18](https://gazelle.ihe.net/gazelle-documentation/General/wildfly18.html)
-### Database
+#### Database configuration
-Patient registry is using Patient Manager's database. It only needs a datasource connection declared in wildfly 18.
-See [Setup datasources for gazelle applications](/gazelle-documentation/General/wildfly18.html#setup-datasources-for-gazelle-applications)
+Patient registry is using Patient Manager's database. It only needs a datasource connection declared in wildfly 18.
+See [Setup datasources for gazelle applications](https://gazelle.ihe.net/gazelle-documentation/General/wildfly18.html#setup-datasources-for-gazelle-applications)
**Datasource name** : `patientRegistryDS`
-
+
**Database name** : `pam-simulator`
-### Deployment
+#### Deployment
-Copy the **jar** artifact app.patient-registry-service-X.X.X.jar in the deployment folder of the wildfly installation under the name
+Copy the **jar** artifact app.patient-registry-service-X.X.X.jar in the deployment folder of the wildfly installation under the name
**patient-registry.jar**. This is important for the path on which Patient Registry's web services will be exposed.
-```
+```bash
cp app.patient-registry-service-X.X.X.jar /usr/local/wildfly18/standalone/deployments/patient-registry.jar
-```
+```
Start wildfly. The API can be accessed at (depending on your configured host and port)
-For Patient processing Service :
- * GITB Processing Service : [GET http://localhost:8380/patient-registry/CrossReferenceService/xref-processing-service?wsdl ](http://localhost:8380/patient-registry/PatientProcessingService/patient-processing-service?wsdl )
+For Patient processing Service :
+
+* GITB Processing Service : GET <http://localhost:8380/patient-registry/PatientProcessingService/patient-processing-service?wsdl>
+
+For CrossReference Processing Service :
+
+* GITB Processing Service : GET <http://localhost:8380/patient-registry/CrossReferenceService/xref-processing-service?wsdl>
-For CrossReference Processing Service :
- - GITB Processing Service : [GET http://localhost:8380/patient-registry/CrossReferenceService/xref-processing-service?wsdl ](http://localhost:8380/patient-registry/CrossReferenceService/xref-processing-service?wsdl )
-# PDQm Connector
+## PDQm Connector
-PDQm Connector is a connector for Patient Registry. It is dedicated to interface FHIR requests defined in PDQm standard to and the
+PDQm Connector is a connector for Patient Registry. It is dedicated to interface FHIR requests defined in PDQm standard to and the
Patient Registry API for patient demographics and identifiers test data management.
-## Sources & binaries
+### Sources & binaries (PDQm)
The sources are accessible here: [https://gitlab.inria.fr/gazelle/applications/test-execution/simulator/pdqmsimulator](https://gitlab.inria.fr/gazelle/applications/test-execution/simulator/pdqmsimulator)
Bugs and issue tracking are accessible in the same project as the Patient Registry :
-[https://gazelle.ihe.net/jira/projects/PATREG](https://gazelle.ihe.net/jira/projects/PATREG).
+[https://gazelle.ihe.net/jira/projects/PATREG](https://gazelle.ihe.net/jira/projects/PATREG).
The name of the latest release, can be obtained in the "Releases" section.
To get official artifact (binaries), search for `pdqm-connector-service` in IHE Nexus : [https://gazelle.ihe.net/nexus](https://gazelle.ihe.net/nexus/#nexus-search;quick~pdqm-connector-service)
and select the **pdqm-connector.war** artifact for download.
-## Installation
-
-### Patient Manager dependency
+### Installation (PDQm)
-PDQm Connector, as Patient Registry, depends currently on the database of Patient Manager. It will use it to save transaction exchanged between SUTs and
-the simulator. Please follow [Patient Manager installation process](/gazelle-documentation/Patient-Manager/installation.html).
+#### Patient Manager dependency (PDQm)
-PDQm Connector needs at least Patient Manager version 9.11.6.
+Same as [Patient Manager Dependency for PATREG](#patient-manager-dependency)
-PDQm also needs Patient Registry to be installed.
-With connector version 1.0.x, you will need Patient Registry version 1.0.x.
+**AND** PDQm also needs Patient Registry to be installed with connector version >1.0.x, you will need Patient Registry version >1.0.x.
-
-### Operational Preferences
+#### Operational Preferences (PDQm)
PDQm connector defines mandatory Operational Preferences that you will have to define in your Application server.
To know how to do that, see [General considerations for WildFly 18](/gazelle-documentation/General/wildfly18.html)
@@ -105,125 +104,143 @@ Define a resource in your server with name *java:/app/gazelle/pdqm-connector/ope
This resource should refer to a deployment.properties file. This file shall contain the following properties :
| Property Name | Description | Example value |
-| patientregistry.url | URL of the Patient Registry Processing Service used to manage patients. | http://localhost:8580/patient-registry/patient-registry/PatientProcessingService/patient-processing-service?wsdl|
-
-### Application server
+|--------------|-----------|------------|
+| patientregistry.url | URL of the Patient Registry Processing Service used to manage patients. | <https://example.com/patient-registry/patient-registry/PatientProcessingService/patient-processing-service?wsdl>|
-Patient registry need to be deployed on Wildfly-18. Please read first the documentation on how to install and configure this server for Gazelle
-applications : [General considerations for WildFly 18](/gazelle-documentation/General/wildfly18.html)
+#### Application server (PDQm)
+PDQm need to be deployed on Wildfly-18. Please read first the documentation on how to install and configure this server for Gazelle applications : [General considerations for WildFly 18](/gazelle-documentation/General/wildfly18.html)
-#### Configure WildFly 18 for PDQm Connector
+##### Configure WildFly 18 f(PDQm)
Install factories module
-1. Stop wildfly and go to
-```bash
-sudo mkdir -p /usr/local/wildfly18/modules/system/layers/base/net/ihe/gazelle/factories/main
-cd /usr/local/wildfly18/modules/system/layers/base/net/ihe/gazelle/factories/main
-```
+1. Stop wildfly and go to:
-2. Download module `factories.jar`
-```bash
-sudo wget https://gazelle.ihe.net/wildfly18/factories.jar
-```
+ ```bash
+ sudo mkdir -p /usr/local/wildfly18/modules/system/layers/base/net/ihe/gazelle/factories/main
+ cd /usr/local/wildfly18/modules/system/layers/base/net/ihe/gazelle/factories/main
+ ```
-3. Create `module.xml` file
-```xml
-<?xml version="1.0" encoding="UTF-8"?>
-<module xmlns="urn:jboss:module:1.1" name="net.ihe.gazelle.factories">
- <resources>
- <resource-root path="factories.jar"/>
- </resources>
- <dependencies>
- <module name="javax.api"/>
- <module name="javax.transaction.api"/>
- <module name="javax.servlet.api" optional="true"/>
- </dependencies>
-</module>
-```
+2. Download module `factories.jar`:
-4. Add `jboss:jboss-admin` rights
-```bash
-sudo chown jboss:jboss-admin *
-sudo chmod 775 *
-```
+ ```bash
+ sudo wget https://gazelle.ihe.net/wildfly18/factories.jar
+ ```
+
+3. Create `module.xml` file:
+
+ ```xml
+ <?xml version="1.0" encoding="UTF-8"?>
+ <module xmlns="urn:jboss:module:1.1" name="net.ihe.gazelle.factories">
+ <resources>
+ <resource-root path="factories.jar"/>
+ </resources>
+ <dependencies>
+ <module name="javax.api"/>
+ <module name="javax.transaction.api"/>
+ <module name="javax.servlet.api" optional="true"/>
+ </dependencies>
+ </module>
+ ```
+
+4. Add `jboss:jboss-admin` rights:
+
+ ```bash
+ sudo chown -R jboss:jboss-admin .
+ sudo chmod -R 775 .
+ ```
5. Stop Wildfly and edit standalone.xml in `/usr/local/wildfly18/standalone/configuration` ; add the factories binding in the naming subsystem :
-Replace this property `${DEPLOYMENT_PROPERTIES}` with your own path to the deployment property, which is stored in the pdqm-connector project : ``pdqm-connector/pdqm-connector-service/src/main/resources/deployment.properties``
+Replace this property `${DEPLOYMENT_PROPERTIES}` with your own path to the deployment property, which is stored in the pdqm-connector project : `pdqm-connector/pdqm-connector-service/src/main/resources/deployment.properties`
```xml
-<subsystem xmlns="urn:jboss:domain:naming:2.0">
- <bindings>
- <object-factory name="java:/app/gazelle/pdqm-connector/operational-preferences" module="net.ihe.gazelle.factories" class="net.ihe.gazelle.factories.PropertiesFactory">
- <environment>
- <property name="path" value="${DEPLOYMENT_PROPERTIES}"/>
- </environment>
- </object-factory>
- </bindings>
- <remote-naming/>
-</subsystem>
+ <subsystem xmlns="urn:jboss:domain:naming:2.0">
+ <bindings>
+ <object-factory name="java:/app/gazelle/pdqm-connector/operational-preferences" module="net.ihe.gazelle.factories" class="net.ihe.gazelle.factories.PropertiesFactory">
+ <environment>
+ <property name="path" value="${DEPLOYMENT_PROPERTIES}"/>
+ </environment>
+ </object-factory>
+ </bindings>
+ <remote-naming/>
+ </subsystem>
```
-### Database
+#### Database configuration (PDQm)
-PDQm is using Patient Manager's database. It only needs a datasource connection declared in wildfly 18.
-See [Setup datasources for gazelle applications](/gazelle-documentation/General/wildfly18.html#setup-datasources-for-gazelle-applications)
+Same as [Database for PATREG](#database-configuration) **EXCEPT FOR** :
-
-**Datasource name** : `pdqmConnectorDS`
-
+**Datasource name** : `pdqmConnectorDS`
**Database name** : `pam-simulator`
-### Deployment
+#### Deployment (PDQm)
-Copy the **war** artifact pdqm-connector-X.X.X.war in the deployment folder of the wildfly installation under the name
-**pdqm-connector.war**. This is important for the path on which connector's web services will be exposed.
+Copy the **war** artifact `pdqm-connector-X.X.X.war` in the deployment folder of the wildfly installation under the name `pdqm-connector.war`
+This is important for the path on which connector's web services will be exposed.
-```
+```bash
cp pdqm-connector-X.X.X.war /usr/local/wildfly18/standalone/deployments/pdqm-connector.war
-```
+```
Start wildfly. The API can be accessed at (depending on your configured host and port)
- * Retrieve : [GET http://localhost:8480/pdqm-connector/Patient/{id}](http://localhost:8480/pdqm-connector/Patient/{id})
- * Search : [POST http://localhost:8480/pdqm-connector/Patient](http://localhost:8480/pdqm-connector/Patient)
-# PIXm Connector
+* Retrieve : GET <https://www.example.com/pdqm-connector/Patient/{id}>
+* Search : POST <https://www.example.com/pdqm-connector/Patient>
+
+## PIXm Connector
PIXm Connector is a connector for Patient Registry. It is dedicated to interface FHIR requests defined in PIXm standard to and the
Patient Registry API for patient demographics and identifiers test data management.
-## Sources & binaries
+### Sources & binaries (PIXm)
-The sources are accessible here: [https://gitlab.inria.fr/gazelle/applications/test-execution/simulator/pixm-connector](https://gitlab.inria.fr/gazelle/applications/test-execution/simulator/pixm-connector.)
+The sources are accessible here: <https://gitlab.inria.fr/gazelle/applications/test-execution/simulator/pixm-connector>.
Bugs and issue tracking are accessible in the same project as the Patient Registry :
-[https://gazelle.ihe.net/jira/projects/PATREG](https://gazelle.ihe.net/jira/projects/PATREG).
+<https://gazelle.ihe.net/jira/projects/PATREG>.
The name of the latest release, can be obtained in the "Releases" section.
-To get official artifact (binaries), search for `pixm-connector` in IHE Nexus : [https://gazelle.ihe.net/nexus](https://gazelle.ihe.net/nexus/#nexus-search;quick~pixm-connector-service)
+To get official artifact (binaries), search for `pixm-connector-service` in IHE Nexus : [https://gazelle.ihe.net/nexus](https://gazelle.ihe.net/nexus/#nexus-search;quick~pixm-connector-service)
and select the **pixm-connector.war** artifact for download.
-## Installation
+### Installation (PIXm)
+
+#### Patient Manager dependency (PIXm)
-### Patient Manager dependency
+Same as [Patient Manager dependency for PATREG](#patient-manager-dependency)
-PIXm Connector, as Patient Registry, depends currently on the database of Patient Manager. It will use it to save transaction exchanged between SUTs and
-the simulator. Please follow [Patient Manager installation process](/gazelle-documentation/Patient-Manager/installation.html).
+PIXm also needs Patient Registry to be installed:
-PIXm Connector needs at least Patient Manager version 9.11.6.
+|PIXm version|PATREG version|
+|:---:|:---:|
+|`1.0.0`|`2.0.0`|
+|`2.0.0`|`2.1.0`|
+|`3.0.0`|`2.2.0`|
-PIXm also needs Patient Registry to be installed.
-With connector version 1.0.x, you will need Patient Registry version 2.0.x.
+#### Matchbox and Http-Validator dependencies (PIXm)
+Since `3.0.0` PIXm needs two deployed applications for validation:
-### Operational Preferences
+* HTTP-validator with the install documentation [here](https://gitlab.inria.fr/gazelle/public/validation/http-validator/-/blob/06997c194efc0f775d9af1c2aa7ae49e13d4d06d/documentation/installation.md).
+* Matchbox with the install documentation [here](https://github.com/ahdis/matchbox/blob/29da3b9dfec2334ceb031346ef12d0e08a626122/README.md)
+
+#### Operational Preferences
PIXm connector defines mandatory Operational Preferences that you will have to define in your Application server.
To know how to do that, see [General considerations for WildFly 18](/gazelle-documentation/General/wildfly18.html)
+/!\ Since `3.0.0` PIXm connector needs to be installed in Wildfly version that supports `JDK 17`. But the tutorial remains the same as Wildfly 18.
+
+|PIXm version|JDK version|Wildfly version|
+|:---:|:---:|:---:|
+|`1.0.0`|11|18.0.1.Final|
+|`2.0.0`|11|18.0.1.Final|
+|`3.0.0`|17|30.0.1.Final|
+
Define a resource in your server with name *java:/app/gazelle/pixm-connector/operational-preferences*.
+
```xml
<subsystem xmlns="urn:jboss:domain:naming:2.0">
<bindings>
@@ -237,74 +254,57 @@ Define a resource in your server with name *java:/app/gazelle/pixm-connector/ope
</subsystem>
```
-Replace this property `${DEPLOYMENT_PROPERTIES}` with your own path to the deployment property file.
+Replace this property `${DEPLOYMENT_PROPERTIES}` with the path to the `deployment.properties` file (like `/opt/pixm-connector/deployment.properties`)
-This resource should refer to a deployment.properties file. This file shall contain the following properties :
+This file shall contain the following properties :
-| Property Name |Â Description |Â Example valueÂ
-| patientregistry.url | URL of the Patient Registry Processing Service used to manage patients. | http://localhost:8580/patient-registry/PatientProcessingService/patient-processing-service?wsdl
-| xrefpatientregistry.url | URL of the CrossReference Processing Service used to XReference. | http://localhost:8580/patient-registry/CrossReferenceService/xref-processing-service?wsdl |
+|Property Name| Description | Example value |
+|:---:|:---:|:---:|
+| patientregistry.url | URL of the Patient Registry Processing Service used to manage patients.| <https://example.com/patient-registry/PatientProcessingService/patient-processing-service?wsdl>|
+| xrefpatientregistry.url | URL of the CrossReference Processing Service used to XReference. | <https://example.com/patient-registry/CrossReferenceService/xref-processing-service?wsdl> |
-### Application server
+Since version `3.0.0` PIXm needs:
-Patient registry need to be deployed on Wildfly-18. Please read first the documentation on how to install and configure this server for Gazelle
-applications : [General considerations for WildFly 18](/gazelle-documentation/General/wildfly18.html)
+* endpoints for matchbox and http-validator
+* profiles id (URL + headers validation with http-validator)
+* profile canonical url (body validation with Matchbox FHIR)
+|Property Name| Description | Example value |
+|:---:|:---:|:---:|
+|APP_HTTP_VALIDATOR_SERVER|Endpoint of HTTP-Validator|<https://www.example.com/http-validator>|
+|PROFILE_ID_CREATE_UPDATE_DELETE_ITI_104|Profile ID for ITI-104|IHE_ITI-104-PatientFeed_Query|
+|PROFILE_ID_POST_ITI_83|Profile ID for POST ITI-83|IHE_ITI-83_POST_PIXm_Query|
+|PROFILE_ID_GET_ITI_83|Profile ID for GET ITI-83|IHE_ITI-83_GET_PIXm_Query|
+|APP_IG_FHIR_SERVER|Endpoint for Matchbox|<https://www.example.com/matchboxv3/fhir>|
+|PIXM_PATIENT_PROFILE|Canonical URL for PIXm Patient Profile|<https://profiles.ihe.net/ITI/PIXm/StructureDefinition/IHE.PIXm.Patient>|
+|PIXM_PARAMETERS_PROFILE|Canonical URL for PIXm Paramaters Profile|<https://profiles.ihe.net/ITI/PIXm/StructureDefinition/IHE.PIXm.Query.Parameters.In>|
-#### Configure WildFly 18 for Pixm Connector
+#### Application server (PIXm)
-Install factories module
+Same as [Application Server (PDQm)](#application-server-pdqm) for both Wildfly 18 and Wildfly 30.
-1. Stop wildfly and go to
-```bash
-sudo mkdir -p /usr/local/wildfly18/modules/system/layers/base/net/ihe/gazelle/factories/main
-cd /usr/local/wildfly18/modules/system/layers/base/net/ihe/gazelle/factories/main
-```
+#### Deployment (PIXm)
-2. Download module `factories.jar`
-```bash
-sudo wget https://gazelle.ihe.net/wildfly18/factories.jar
-```
+Copy the **war** artifact `pixm-connector-X.X.X.war` (< 3.0.0) or `pixm-connector-service-X.X.X.war` (>= 3.0.0) in the deployment folder of the wildfly installation under the name
+`pixm-connector.war`.
+This is important for the path on which connector's web services will be exposed.
-3. Create `module.xml` file
-```xml
-<module xmlns="urn:jboss:module:1.1" name="net.ihe.gazelle.factories">
- <resources>
- <resource-root path="factories.jar"/>
- </resources>
- <dependencies>
- <module name="javax.api"/>
- </dependencies>
-</module>
-```
+Before `3.0.0`:
-4. Add `jboss:jboss-admin` rights
```bash
-sudo chown jboss:jboss-admin *
-sudo chmod 775 *
+cp pixm-connector-X.X.X.war /usr/local/wildfly18/standalone/deployments/pixm-connector.war
```
+Since `3.0.0`:
-### Database
-
-PIXm is using Patient Manager's database. It only needs a datasource connection declared in wildfly 18.
-See [Setup datasources for gazelle applications](/gazelle-documentation/General/wildfly18.html#setup-datasources-for-gazelle-applications)
-
-
-**Datasource name** : `pixmConnectorDS`
-
-**Database name** : `pam-simulator`
-
-### Deployment
-
-Copy the **war** artifact pixm-connector-X.X.X.war in the deployment folder of the wildfly installation under the name
-**pixm-connector.war**. This is important for the path on which connector's web services will be exposed.
-
+```bash
+cp pixm-connector-service-X.X.X.war /usr/local/wildfly30/standalone/deployments/pixm-connector.war
```
-cp pixm-connector-X.X.X.war /usr/local/wildfly18/standalone/deployments/pixm-connector.war
-```
-Start wildfly. The API can be accessed at (depending on your configured host and port)
-* ITI-83 : [GET http://localhost:8580/pixm-connector/fhir_ihe/Patient/$ihe-pix?sourceIdentifier={sourceIdentifier}(&targetSystem={targetsystem,...})(&_format=json)](http://localhost:8580/pixm-connector/fhir_ihe/Patient/$ihe-pix?sourceIdentifier={sourceIdentifier}(&targetSystem={targetsystem,...})(&_format=json))
+Start wildfly.
+
+The API can be accessed at (depending on your configured host and port):
-* ITI-93 : shall be reachable to perform a feed. Create and Delete method have been implemented.
\ No newline at end of file
+* ITI-104 : PUT/DELETE <https://example.com/pixm-connector/fhir/Patient?identifier=patient.system%7Cpatient.id>
+* ITI-83 : GET <https://example.com/pixm-connector/fhir/Patient/$ihe-pix?sourceIdentifier=patient.system%7Cpatient.id&targetSystem=targetSystem>
+* Capability statement : <https://example.com/pixm-connector/fhir/metadata>
diff --git a/Patient-Registry/release-note.md b/Patient-Registry/release-note.md
index 073874fa98b237981ad9a0c1857bc59e36414ee7..435f5bd56ef2ad9ab47cea6267fa480a28d83513 100755
--- a/Patient-Registry/release-note.md
+++ b/Patient-Registry/release-note.md
@@ -1,14 +1,28 @@
---
title: Release note
subtitle: PatientRegistry
-toolversion: 2.1.0
-releasedate: 2021-09-10
-author: Franck Desaize
+toolversion: 2.2.0
+releasedate: 2024-01-31
+author: Franck Desaize / Alexandre POCINHO
function: Software Engineer
customer: IHE Europe
reference: KER1-RNO-IHE-PATIENT_MANAGER
---
+# PIXm Connector 2.0.0
+_Release date: 2024-02-02_
+
+__New Feature__
+* \[[PATREG-220](https://gazelle.ihe.net/jira/browse/PATREG-220)\] Implementation of ITI-104
+* \[[PATREG-221](https://gazelle.ihe.net/jira/browse/PATREG-221)\] Validation Feature w/ Matchbox
+* \[[PATREG-222](https://gazelle.ihe.net/jira/browse/PATREG-222)\] Validation Feature w/ HTTP-Validator
+* \[[PATREG-223](https://gazelle.ihe.net/jira/browse/PATREG-223)\] Upgrade to Java 17 and Jakarta
+
+# Patient Registry 2.2.0
+_Release date: 2024-01-31_
+__Epic__
+* \[[PATREG-216](https://gazelle.ihe.net/jira/browse/PATREG-216)\] [CH] Adaptation of the new PIXm specifications
+
# PIXm Connector 2.0.0
_Release date: 2021-09-10_
diff --git a/Patient-Registry/user.md b/Patient-Registry/user.md
index 63c98011fce9c24d8521b5a937efb1e0cb06aeff..66e6ca31074d256ca1a082523412e614d1181ce5 100755
--- a/Patient-Registry/user.md
+++ b/Patient-Registry/user.md
@@ -1,391 +1,227 @@
---
title: User Manual
subtitle: Patient Registry
-author: Franck Desaize
-releasedate: 2021-07-09
-toolversion: 2.1.x
+author: Alexandre POCINHO
+releasedate: 2024-02-02
+toolversion: 3.0.0
function: Engineer
version: 0.1
status: validated
---
-# Introduction
-The Patient Registry Tool
+# Patient Registry Tool suite
-# Pixm Connector
+Outline:
----
-### Prerequisites
-- Java 11 with maven.
-- WildFly 18.
----
-### Build project locally
+- [PIXm Connector Component](#pixm-connector-component)
-After cloning this repository to your local installation launch
+ - [Overview](#overview)
+ - [Validation Process](#validation-process)
+ - [ITI-83 Request cross reference identifiers](#request-a-patient-cross-reference-on-a-specific-target-identifier-iti-83)
+ - [ITI-104 Request on Patient Resources](#requests-on-patient-resources-iti-104)
+ - [Create/Update](#createupdate)
+ - [Merge duplicated patient](#merge-for-resolving-duplicated-patient)
+ - [Delete patient](#delete-one-or-more-patients)
+ - [Errors returned](#errors-returned)
-```bash
- > mvn clean install
-```
+## PIXm Connector Component
-from the project root directory.
+### Overview
+Here is a quick overview of the available functionality from PIXm connector
-The artifact pixm_fhir_server.war will be created in target/ directory.
+| Operation | HTTP Methods | URL to call | Entry parameter | Returned value |
+|--------------------------------|--------------|--------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------|------------------------------------------|
+| Create/Update Patient | PUT | ```https://example.com/pixm-connector/fhir/Patient?identifier=patient.system%7Cpatient.id``` | ITI-104 Patient identifier | ITI-104 FHIR Patient |
+| Delete Patient | DELETE | ```https://example.com/pixm-connector/fhir/Patient/?identifier=patient.system%7Cpatient.id``` | ITI-104 Patient identifier | / |
+| Merge Patient | PUT | ```https://example.com/pixm-connector/fhir/Patient/?identifier=patient.system%7Cpatient.id``` | ITI-104 Patient identifier w/ patient.link to Patient to keep | ITI-104 FHIR Patient |
+| Check Cross Referenced Patient | GET | ```https://example.com/pixm-connector/fhir/Patient/$ihe-pix?sourceIdentifier=patient.system%7Cpatient.id&targetSystem=targetSystem``` | A Patient sourceIdentifier and a TargetDomain | ITI-83 FHIR Parameters with X-ref values |
+Capability statement of the application can be found with : <https://example.com/pixm-connector/fhir/metadata>
----
-### Deploy on WildFly server
+As described in [HAPI FHIR resources](https://hapifhir.io/hapi-fhir/docs/server_plain/rest_operations_operations.html), some strings are automatically escaped when the FHIR server parses URLs:
-After building the project through Maven, the artifact created just has to be added to your local WildFly installation in the folder
-```bash
- {$wildfly.home}/standalone/deployments
-```
+|Given String|Parsed as|
+| :---: | :---: |
+|\||%7C|
+|=>=|=%3E%3D|
+|=<=|=%3C%3D|
+|=>|=%3E|
+|=<|=%3C|
----
-### Request a Patient on a specific Target Identifier
+### Validation process
-Once the project deployed on your WildFly, you can now call it to request a cross Referenced Patient in the Patient Registry.
+Each operation implies a validation of requests for both `ITI-104` and `ITI-83` transactions.
+Validation is done by calling:
-Parameters allowed are :
+- [HTTP Validator](https://gitlab.inria.fr/gazelle/applications/test-execution/validator/http-validator) for URL and Headers.
+- [Matchbox](https://www.matchbox.health/) for Body with FHIR Resource.
-- The Patient Identifier and the Target System attributed to this identifier
-- The Target System you want the cross reference from.
-- The format returned.
+Both validators allow to perform validation and have high customization if specifications changed for both transactions without refactoring pixm-connector application.
+An error during validation process will result with an OperationOutcome with error `400 Bad Request` with issues describing where it failed.
-Cardinality for these parameters will be described in each profile since it's the main difference between each.
+### Request a Patient Cross Reference on a specific Target Identifier (ITI-83)
-### IHE Profile
+- [IHE Specifications](https://profiles.ihe.net/ITI/PIXm/ITI-83.html)
-The URL to call is
-```http
- {wildfly18.address}/pixm_fhir_server/fhir_ihe/Patient/$ihe-pix
-```
+Request a cross-referenced Patient is possible thanks to the `$ihe-pixm`.
+Parameters allowed are :
-|Parameter name|Cardinality|Parameter Type|Description|
-|--------------|-----------|--------------|-----------|
-|sourceIdentifier|1..1|Token|The Patient identifier search parameter that will be used by the Patient Identifier Cross-reference Manager to find cross matching identifiers associated with the Patient Resource
-|targetSystem|0..*|uri|The target Patient Identifier Assigning Authority from which the returned identifiers should be selected.|
-|_format|0..1|mime-type|The requested format of the response. Accepted values : JSON and XML|
+- The Patient Identifier and the Target System attributed to this identifier as `sourceIdentfier`
+- The Target System you want the cross-reference from as `targetSystem`.
+- The format returned as `_format`: **xml** or **json**.
-### CH Profile
+The URL to call is:
-The URL to call is
```http
- {wildfly18.address}/pixm_fhir_server/fhir_ch/Patient/$ihe-pix
+ GET https://example.com/pixm-connector/fhir/Patient/$ihe-pix
```
-
-|Parameter name|Cardinality|Parameter Type|Description|
-|--------------|-----------|--------------|-----------|
-|sourceIdentifier|1..1|Token|The Patient identifier search parameter that will be used by the Patient Identifier Cross-reference Manager to find cross matching identifiers associated with the Patient Resource
-|targetSystem|1..2|uri|The target Patient Identifier Assigning Authority from which the returned identifiers should be selected.|
-|_format|0..1|mime-type|The requested format of the response. Accepted values : JSON and XML|
-
For example :
-Given the Patient with the ID 69420 in the Target System 1.3.6.1.4.1.21367.13.20.3000
-And you want the cross referenced patient in the target system 1.3.6.1.4.1.21367.13.20.1000
+Given the Patient with the `id=69420` with the `system=urn:oid:1.3.6.1.4.1.21367.13.20.3000` as `sourceIdentifer=system|id`
+And you want the cross-referenced patient in the `targetSystem=1.3.6.1.4.1.21367.13.20.1000`
+And you want the returned response as a `json`.
The corresponding url will be :
-```http
- {wildfly18.address}/pixm_fhir_server/fhir_ihe/Patient/$ihe-pix?sourceIdentifier=urn:oid:1.3.6.1.4.1.21367.13.20.3000|69420&targetSystem=urn:oid:1.3.6.1.4.1.21367.13.20.1000
-```
-
----
-### Error returned
-Malformed requests can cause different types of error, here is a quick overview of how to troubleshoot them :
-
-- An error 400 Bad Request is returned when the source domain given within the source identifier parameter is not recognized by the Patient Registry as an asigning authority.
-In the case of our request above, the value "urn:oid:1.3.6.1.4.1.21367.13.20.3000" is not a valid source domain able to register Patients
-
-Common mistakes with the source domain include :
-- Forgetting the namespace in front of the adress (urn:oid:)
-- Malformed source domain.
-The source domain can have the form of an url
```http
-sourceIdentifier=https://your.domain|id
-```
-or of an adress, which must follows the pattern x.x.x.x.x.x.x.x.x.x
-```http
-sourceIdentifier=urn:oid:x.x.x.x.x.x.x.x.x.x|id
+ https://example.com/pixm-connector/fhir/Patient/$ihe-pix?sourceIdentifier=urn:oid:1.3.6.1.4.1.21367.13.20.3000|69420&targetSystem=urn:oid:1.3.6.1.4.1.21367.13.20.1000&_format=json
```
---
-- An error 403 Forbidden is returned when a target domain given in the target system parameter is not recognized by the Patient Registry.
-In the case of our request above, the value "urn:oid:1.3.6.1.4.1.21367.13.20.1000" is not recognized as a valid target domain containing Patients.
+### Requests on Patient resources (ITI-104)
-Common mistakes with the target system are the same as the aformentioned error 400 since the target system and the source domain have the same representation.
+- [IHE Specifications](https://profiles.ihe.net/ITI/PIXm/ITI-104.html)
---
-- An error 404 Not Found is returned when the patient identifier given within the source identifier parameter is not recognized by the Patient registry.
-In the case of our request above, the value "69420" is not a valid Identifier linked to an existing Patient.
+#### Create/Update
+Link: <https://profiles.ihe.net/ITI/PIXm/ITI-104.html#2310441-add-or-revise-patient>
-## PIXm Feed
+PIXm connector accepts the creation of a Patient in the Patient Manager.
+Although a Patient could be created without any information in the HL7 model, PIXm connector will only allow a Patient
+to be created with minimum and/or mandatory information to permits cross-reference thanks to validation with Matchbox.
-The simulator PIXm has been upgraded. It's now able to perform feed on Xreference Manager for CH profiles. Two methods are available for Swiss implementation.
-* **Create** : PIXm Simulator is able to handle create query. Using Bundle and Patient FHIR resources. (See documentation in the project for more information)
-* **Delete** : PIXm Simulatir is able to handle delete query. Using Bundle and Patient FHIR resources. (See documentation in the project for more information)
+The Resource could not be parsed or failed basic FHIR validation rules.
+In the case of an error `400 Bad Request` or `422 Unprocessable Entity` being returned,
+please check the following guidelines to verify your query.
-## CREATE METHOD :
-__________________________________________________________________
-Send the following REST Request
-#### Bundle Resource :
- POST : {serverAdress}/ch_fhir/Bundle/
+Create/Update request is done through a FHIR conditional update mechanism ([cond-update](http://hl7.org/fhir/http.html#cond-update)) where the patient identifier has to be given as following.
+```http
+ PUT https://example.com/pixm-connector/fhir/Patient/identifier=urn:oid:1.3.6.1.4.1.21367.13.20.1000|IHERED-m94
+```
-With a prefilled body as following for Bundle:
+With body :
+
+```json
-```json
{
- "resourceType" : "Bundle",
- "id" : "BundlePIXmFeed",
- "meta" : {
- "profile" : [
- "http://fhir.ch/ig/ch-epr-mhealth/StructureDefinition/ch-pixm-bundle"
- ]
- },
- "type" : "message",
- "entry" : [
- {
- "fullUrl" : "http://example.com/fhir/MessageHeader/1",
- "resource" : {
- "resourceType" : "MessageHeader",
- "id" : "1",
- "text" : {
- "status" : "generated",
- "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative</b></p><p><b>event</b>: <code>urn:ihe:iti:pmir:2019:patient-feed</code></p><h3>Destinations</h3><table class=\"grid\"><tr><td>-</td><td><b>Endpoint</b></td></tr><tr><td>*</td><td><a href=\"http://example.com/patientEndpoint\">http://example.com/patientEndpoint</a></td></tr></table><h3>Sources</h3><table class=\"grid\"><tr><td>-</td><td><b>Endpoint</b></td></tr><tr><td>*</td><td><a href=\"http://example.com/patientSource\">http://example.com/patientSource</a></td></tr></table><p><b>focus</b>: <a href=\"#Bundle_abc\">See above (Bundle/abc)</a></p></div>"
- },
- "eventUri" : "urn:ihe:iti:pmir:2019:patient-feed",
- "destination" : [
- {
- "endpoint" : "http://example.com/patientEndpoint"
- }
- ],
- "source" : {
- "endpoint" : "http://example.com/patientSource"
- },
- "focus" : [
- {
- "reference" : "Bundle/abc"
- }
- ]
- }
- },
- {
- "fullUrl" : "http://example.com/fhir/Bundle/abc",
- "resource" : {
- "resourceType" : "Bundle",
- "id" : "abc",
- "type" : "history",
- "entry" : [
- {
- "fullUrl" : "http://example.com/fhir/Patient/PatientPIXmFeed",
- "resource" : {
- "resourceType" : "Patient",
- "id" : "PatientPIXmFeed",
- "text" : {
- "status" : "generated",
- "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative</b></p><p><b>id</b>: PatientPIXmFeed</p><p><b>meta</b>: </p><p><b>identifier</b>: Medical record number = 8734</p><p><b>name</b>: Franz Muster , Muster </p><p><b>gender</b>: male</p><p><b>birthDate</b>: 1995-01-27</p></div>"
- },
- "contained" : [
- {
- "resourceType" : "Organization",
- "id" : "org1",
- "identifier" : [
- {
- "system" : "${system}",
- "value" : "${value}"
- }
- ],
- "address" : [
- {
- "use" : "work",
- "line" : [
- "Doktorgasse",
- "2"
- ],
- "city" : "Musterhausen",
- "postalCode" : "8888",
- "country" : "CH"
- }
- ]
- }
- ],
- "identifier" : [
- {
- "type" : {
- "coding" : [
- {
- "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
- "code" : "MR"
- }
- ]
- },
- "system" : "${#system}",
- "value" : "${#value}"
- }
- ],
- "name" : [
- {
- "family" : "${#name.family}",
- "given" : [
- "${#name.given}"
- ]
- },
- {
- "family" : "${#name.family}",
- "_family" : {
- "extension" : [
- {
- "url" : "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier",
- "valueCode" : "BR"
- }
- ]
- }
- }
- ],
- "gender" : "${#gender}",
- "birthDate" : "${#birthDate}",
- "managingOrganization" : {
- "reference" : "#org1"
- }
- },
- "request" : {
- "method" : "POST",
- "url" : "Patient"
- },
- "response" : {
- "status" : "200"
- }
- }
- ]
- }
- }
+ "resourceType" : "Patient",
+ "id" : "Patient-MaidenAlice-Red",
+ "meta" : {
+ "profile" : [
+ "https://profiles.ihe.net/ITI/PIXm/StructureDefinition/IHE.PIXm.Patient"
]
- }
-```
+ },
+ "text" : {
+ "status" : "generated",
+ "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p style=\"border: 1px #661aff solid; background-color: #e6e6ff; padding: 10px;\"><b>ALICE MOHR </b> female, DoB: 1958-01-30 ( id:\u00a0IHERED-m94)</p><hr/><table class=\"grid\"><tr><td style=\"background-color: #f3f5da\" title=\"Record is active\">Active:</td><td colspan=\"3\">true</td></tr></table></div>"
+ },
+ "identifier" : [
+ {
+ "system" : "urn:oid:1.3.6.1.4.1.21367.13.20.1000",
+ "value" : "IHERED-m94"
+ }
+ ],
+ "active" : true,
+ "name" : [
+ {
+ "family" : "MOHR",
+ "given" : [
+ "ALICE"
+ ]
+ }
+ ],
+ "gender" : "female",
+ "birthDate" : "1958-01-30"
+}
+```
+
+If the patient exists then it is updated otherwise it is created.
+The response will return the updated/created patient.
-## CREATE METHOD :
-__________________________________________________________________
+---
-#### Patient Resource :
+#### Merge for resolving duplicated patient
-Send the following REST Request
+Link : <https://profiles.ihe.net/ITI/PIXm/ITI-104.html#2310442-resolve-duplicate-patient>
- POST : {serverAdress}/ch_fhir/Patient/
+The merge method allows the user to merge two patients together if two registered patients represent the same people.
+This action is **irreversible** as it deactivates a resource making it only readable and immutable.
+The request is a PUT method with the Patient to deactivate with a `activate: false` attribute and a `link` field with identifier for the kept patient resource.
-With a prefilled body as following :
+```http
+PUT http://example.org/fhir/Patient?identifier=urn:oid:1.3.6.1.4.1.21367.13.20.1000|IHERED-m94 HTTP/1.1
+Accept: application/fhir+json
+Content-Type: application/fhir+json
+```
-```json
+```json
{
- "resource" : {
- "resourceType" : "Patient",
- "id" : "PatientPIXmFeed",
- "text" : {
- "status" : "generated",
- "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative</b></p><p><b>id</b>: PatientPIXmFeed</p><p><b>meta</b>: </p><p><b>identifier</b>: Medical record number = 8734</p><p><b>name</b>: Franz Muster , Muster </p><p><b>gender</b>: male</p><p><b>birthDate</b>: 1995-01-27</p></div>"
- },
- "contained" : [
- {
- "resourceType" : "Organization",
- "id" : "org1",
- "identifier" : [
- {
- "system" : "${system}",
- "value" : "${value}"
- }
- ],
- "address" : [
- {
- "use" : "work",
- "line" : [
- "Doktorgasse",
- "2"
- ],
- "city" : "Musterhausen",
- "postalCode" : "8888",
- "country" : "CH"
- }
- ]
- }
- ],
- "identifier" : [
- {
- "type" : {
- "coding" : [
- {
- "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
- "code" : "MR"
- }
- ]
- },
- "system" : "${#system}",
- "value" : "${#value}"
- }
- ],
- "name" : [
- {
- "family" : "${#name.family}",
- "given" : [
- "${#name.given}"
- ]
- },
- {
- "family" : "${#name.family}",
- "_family" : {
- "extension" : [
- {
- "url" : "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier",
- "valueCode" : "BR"
- }
- ]
+ "resourceType": "Patient",
+ "identifier": [
+ {
+ "system": "urn:oid:1.3.6.1.4.1.21367.13.20.1000",
+ "value": "IHERED-m94"
+ }
+ ],
+ "active": false,
+ "name": [
+ {
+ "family": "MOHR",
+ "given": [
+ "MAIDEN"
+ ]
+ }
+ ],
+ "gender": "female",
+ "birthDate": "1958-01-30",
+ "link": [
+ {
+ "other": {
+ "identifier": {
+ "system": "urn:oid:1.3.6.1.4.1.21367.13.20.1000",
+ "value": "IHERED-994"
}
- }
- ],
- "gender" : "${#gender}",
- "birthDate" : "${#birthDate}",
- "managingOrganization" : {
- "reference" : "#org1"
+ },
+ "type": "replaced-by"
+ }
+ ]
}
-
-```
-
-
-These parameters are mandatory in CREATE method
-* name.given
-* name.family
-* birthdate
-* gender
+```
+#### Delete one or more patient(s)
-### DELETE METHOD
-______________________________________________________________________
-#### Patient Resource :
+Link: <https://profiles.ihe.net/ITI/PIXm/ITI-104.html#2310443-remove-patient>
-Send the following REST Request
+The delete operation allows suppression of the patient with its identifier thanks to a conditional deletion.
+This application allows multiple deletion if the identifier returned more than one Patient.
- Delete : {serverAdress}/ch_fhir/Patient/{uuid}
+````http
+DELETE http://example.org/fhir/Patient?identifier=urn:oid:1.3.6.1.4.1.21367.13.20.1000|IHERED-994 HTTP/1.1
+Accept: application/fhir+json
+````
-#### Bundle Resource :
+if the delete is successful the application returns a `200 OK` response otherwise it would be a `204 No Content`.
-Send the following REST Request
->DELETE : {serverAdress}/Bundle/{id}
-
-Same body as a create except :
-* request method must be "delete" at the end :
-```json
-
- "request" : {
- "method" : "DELETE",
- "url" : "Patient"
- },
-```
+### Errors returned
+---
-* Mandatory field to fill in case of DELETE method :
- * uuid
+Malformed requests can cause different types of error, for now `422 Unprocessable Entity` is mostly returned.
+Future features will allow a better granularity for code returned.
diff --git a/Proxy/installation.md b/Proxy/installation.md
index 501267a728b7c9992082e8a8ec58379694c0df26..2bc6dc6e05fef988d92756438bee50ea20138044 100755
--- a/Proxy/installation.md
+++ b/Proxy/installation.md
@@ -2,10 +2,10 @@
title: Installation Manual
subtitle: Gazelle Proxy
author: Nicolas BAILLIET
-date: 23/01/2023
-toolversion: 5.0.5
+date: 18/01/2024
+toolversion: 6.0.0
function: Engineer
-version: 2.01
+version: 2.1
status: Approved document
reference: KER1-MAN-IHE-PROXY_INSTALLATION-2_01
customer: IHE-EUROPE
@@ -13,10 +13,63 @@ customer: IHE-EUROPE
# Introduction
-Proxy is the part of the Gazelle testbed which is used to capture the messages exchanged between two systems under test. This tool is also bind to the EVSClient in order to validate the messages stored in the Proxy in a very simple way.
+Proxy is the part of the Gazelle testbed which is used to capture the messages exchanged between two systems under test.
+This tool is also bind to the EVSClient in order to validate the messages stored in the Proxy in a very simple way.
-As for the other tools, the proxy is an open source project and its sources are available at [*https://gitlab.inria.fr/gazelle/applications/test-execution/gazelle-proxy.git*](https://gitlab.inria.fr/gazelle/applications/test-execution/gazelle-proxy.git).
-You can download the latest gazelle-proxy.ear in nexus [*http://gazelle.ihe.net/nexus/index.html#nexus-search;quick~gazelle-proxy.ear*](http://gazelle.ihe.net/nexus/index.html#nexus-search;quick~gazelle-proxy.ear)
+As for the other tools, the proxy is an open source project and its sources are available at
+[*https://gitlab.inria.fr/gazelle/public/core/proxy-v7.git*](https://gitlab.inria.fr/gazelle/public/core/proxy-v7.git).
+You can download the latest gazelle-proxy.ear in nexus
+[*http://gazelle.ihe.net/nexus/index.html#nexus-search;quick~gazelle-proxy.ear*](http://gazelle.ihe.net/nexus/index.html#nexus-search;quick~gazelle-proxy.ear)
+
+# Channel Socket Service (Version 6.0.0 and higher)
+
+## Introduction
+
+The Proxy 6 has externalized the low level operations of the channels in a dedicated service based on Netty 4.
+This service is called the Channel Socket Service.
+
+This service needs to be installed on the same machine as the Proxy and must be started before the Proxy.
+
+Channel Socket Service is withing the Proxy V17 projects.
+
+## Installation
+
+### Prerequisites
+
+1. Java 17
+2. Maven 3.8.x
+3. Docker
+4. Optional: Mandrel 17 (for native compilation)
+
+### Build
+
+1. Clone the project:
+ ```shell
+ git clone [PROXY_V17_URL]
+ ```
+2. Build the project:
+ ```shell
+ mvn clean install -DskipTests
+ ```
+### Run
+
+We can run the Channel Socket Service using the following command:
+```shell
+java -jar proxy-quarkus/target/quarkus-app/quarkus-run.jar
+```
+
+### Configuration
+
+The Channel Socket Service is configured using JVM properties. The following table describes the properties that can be used to configure the Channel Socket Service.
+
+| **Variable name** | **Description** | **Example of value** |
+|------------------------|-------------------------------------------------|----------------------------------------|
+| **record.service.url** | The URL used to communicate with record service | http://localhost:8380/proxy/rest/items |
+| **quarkus.http.port** | The port of the service | 8081 |
+| **quarkus.log.level** | The log leve | INFO |
+
+For more details about the configuration of the Channel Socket Service, please refer to the
+project [README.md](#).
# Compilation and installation
@@ -30,56 +83,98 @@ You will get an EAR in the gazelle-proxy-ear/target folder.
Then, follow the instructions below:
-1. In your database (postgresql 9.1 or higher) create a database named "gazelle-proxy", using UTF-8 encoding and owned by the user gazelle
+## 1. Create database
+
+In your database (postgresql 9.1 or higher) create a database named "gazelle-proxy", using UTF-8 encoding and owned by the user gazelle
```bash
createdb -U gazelle -E UTF8 gazelle-proxy
```
-2. On your file system, create a directory /opt/proxy/DICOM
+## 2. File system
+
+### 2.1 Version 6.0.0 and higher
+For persistent channels, create a file `/opt/proxy/proxyPersistentChannels.json` and make sure that the user running the application has the right to write in it.
+On your file system, create a directory `/opt/proxy/DICOM`.
+```bash
+sudo mkdir -p /opt/proxy/DICOM
+sudo touch /opt/proxy/proxyPersistentChannels.json
+sudo chown -R jboss:jboss-admin /opt/proxy
+sudo chmod -R 775 /opt/proxy
+```
+
+
+### 2.2 Version 5.0.0 and lower
+For persistent channels, create a file `/opt/proxy/proxyPersistentChannels.csv` and make sure that the user running the application has the right to write in it.
+On your file system, create a directory `/opt/proxy/DICOM`.
+
```bash
-sudo mkdir /opt/proxy/DICOM
+sudo mkdir -p /opt/proxy/DICOM
+sudo touch /opt/proxy/proxyPersistentChannels.csv
sudo chown -R jboss:jboss-admin /opt/proxy
sudo chmod -R 775 /opt/proxy
```
-3. Put the ear in the deploy folder of your Jboss AS
+## 3. Put the ear in the deployment folder of your Jboss AS
+
```bash
cp gazelle-proxy-ear/target/gazelle-proxy.ear /usr/local/jboss7/standalone/deployments/gazelle-proxy.ear
```
-4. **WARNING** : From version 4.7.0, datasources have been extracted from the **ear**. The template file can be found in /src/main/application/datasource in the source or in the file gazelle-proxy-X.X.X-datasource.zip from the nexus.
-For more informations about how to manage that externalization, please refer to [general considerations for JBoss7](https://gazelle.ihe.net/gazelle-documentation/General/jboss7.html).
+## 4. Manage datasource
+[WARNING] : From version 4.7.0, datasources have been extracted from the **ear**. The template file can be found in
+/src/main/application/datasource in the source or in the file gazelle-proxy-X.X.X-datasource.zip from the nexus.
+For more information about how to manage that externalization, please refer to
+[general considerations for JBoss7](https://gazelle.ihe.net/gazelle-documentation/General/jboss7.html).
* Datasource name : gazelle-proxyDS
* Database name : gazelle-proxy
-5. Start Jboss AS 7
+## 5. Configure SSO registration
+
+Since version **5.1.0**, Proxy can register itself as a client of a SSO server. This is done by giving some environment variables to the application.
+
+| **Variable name** | **Description** | **Example of value** |
+|-------------------|------------------------------------------------------------------|--------------------------------|
+| GZL_PROXY_K8S_ID | Describes the instance ID and the replica ID of the application. | gazelle-proxy-6dfeeb5595-tl29k |
+
+[WARNING] There are additional required variables for registration of the proxy to the SSO server. Please refer to the
+[README.md in sso-client-v7](https://gitlab.inria.fr/gazelle/public/framework/sso-client-v7#client-registration).
+
+## 6. Start Jboss AS 7
+
```bash
sudo /etc/init.d/jboss7 start
```
-6. Execute the sql script available in your workspace at gazelle-proxy-ear/src/main/sql/schema-5.0.0.sql
+## 7. Execute the sql script available in your workspace at gazelle-proxy-ear/src/main/sql/schema-X.X.X.sql
+
```bash
-psql -U gazelle gazelle-proxy < schema-5.0.0.sql
+psql -U gazelle gazelle-proxy < schema-X.X.X.sql
```
-7. Execute the sql script available in your workspace at gazelle-proxy-ear/src/main/sql/init-5.0.0.sql
+
+## 8. Execute the sql script available in your workspace at gazelle-proxy-ear/src/main/sql/init-5.0.0.sql
+
```bash
-psql -U gazelle gazelle-proxy < init-5.0.0.sql
+psql -U gazelle gazelle-proxy < init-X.X.X.sql
```
-8. Open your favorite browser (we recommand Chrome or Firefox) and go to [*http://yourServer:8080/proxy*](http://yourServer:8080/proxy)
+## 9. Browse the application
-9. The proxy is now up and running, see the next section for information on the configuration.
+Open a browser and go to [*http://yourServer:8080/proxy*](http://yourServer:8080/proxy)
+
+## 10. The proxy is now up and running, see the next section for information on the configuration.
This new instance of the proxy is running without the CAS feature, that means that anyone accessing the tool has the administrator privileges.
-If you rather want to use a single-sign one authentication, configure the application in this way. Edit the preference **application\_works\_without\_cas** to set it to **false.**
+If you rather want to use a single-sign one authentication, configure the application in this way. Edit the preference
+**cas\_enabled** to set it to **false.**
## Called tools
Check that **dcmtk** is installed on the machine. Actually, the proxy uses dcmdump to render the dicom files.
+
```bash
sudo apt get install dcmtk
```
@@ -88,24 +183,33 @@ sudo apt get install dcmtk
There is a set of properties that you can configure on the Configuration page, the table below describes the various properties defined and their default values.
-| **Property name** | **Description** | **Default value** |
-|-------------------------------------------|-----------------------------------------|--------------------|
-| **application\_documentation** | The link to the user manual. Link to this page |
-| **application\_issue\_tracker** | The link to the section of the issue tracker where to report issues about the Gazelle Proxy tool | [https://gazelle.ihe.net/jra/browse/PROXY](https://gazelle.ihe.net/jra/browse/PROXY) |
-| **application\_release\_notes** | The link to the application release notes of the tool | [https://gazelle.ihe.net/jira](https://gazelle.ihe.net/jira) |
-| **application\_works\_without\_cas** | Specifies if the CAS should be used or not, if no CAS is used, property shall be set to true otherwise, it's set to false | true |
-| **application\_url** | The URL used by any user to access the tool. The application needs it to build permanent links inside the tool | [http://yourASURL/proxy](http://yourASURL/proxy) |
-| **cas\_enable** | If you intent to use a CAS, set it tu true here | true |
-| **dcmdump_path** | Path to dcmdump | /usr/bin/dcmdump |
-| **evs\_client\_url** | The URL of the EVSClient application. This is required to validate the messages captured by the proxy. If you install your own instance of the proxy, you also need your own instance of the EVSClient tool. (Do not forget the tailing slash) | [https://gazelle.ihe.net/EVSClient/](https://gazelle.ihe.net/EVSClient/) |
-| **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 | false |
-| **ip\_login\_admin** | regex to be matched by IP address of the users granted as admin | .\* |
-| **jms_communication_is_enabled** | Enable jms communication | false |
-| **max\_proxy\_port** | Specifies the high limit for the opened ports | 11000 |
-| **min\_proxy\_port** | Specifies the low limit for the opened ports | 10000 |
-| **NUMBER_OF_ITEMS_PER_PAGE** | Number of items to diplay in datatable | 20 |
-| **proxy\_ip\_addresses** | This property is used to inform the users of the IP address(es) to use to contact the proxy | 131.254.209.16 (kujira.irisa.fr), 131.254.209.17 (kujira1.irisa.fr), 131.254.209.18 (kujira2.irisa.fr), 131.254.209.19 (kujira3.irisa.fr) |
-| **proxy\_oid** | For each tool, we need an OID which uniquely identify the instance of the tool and the URL used to send back results. | 1.1.1.1.1 |
-| **storage\_dicom** | Absolute path to the system folder used to store the DICOM datasets | /opt/proxy/DICOM |
-| **time\_zone** | The time zone used to display the timestamps | Europe/Paris |
-| **admin_only_mode** | This preference is used to enable/disable the Admin Only mode. This mode restricts the access to messages list and messages details to admin only. Connection can however be shared by an administrator to allow users knowing the connection privacy key to see messages from the connection. | false
+| **Property name** | **Description** | **Default value** |
+|-----------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------|
+| **application\_documentation** | The link to the user manual. Link to this page | |
+| **application\_issue\_tracker** | The link to the section of the issue tracker where to report issues about the Gazelle Proxy tool | [https://gazelle.ihe.net/jra/browse/PROXY](https://gazelle.ihe.net/jra/browse/PROXY) |
+| **application\_release\_notes** | The link to the application release notes of the tool | [https://gazelle.ihe.net/jira](https://gazelle.ihe.net/jira) |
+| **application\_url** | The URL used by any user to access the tool. The application needs it to build permanent links inside the tool | [http://yourASURL/proxy](http://yourASURL/proxy) |
+| **dcmdump_path** | Path to dcmdump | /usr/bin/dcmdump |
+| **evs\_client\_url** | The URL of the EVSClient application. This is required to validate the messages captured by the proxy. If you install your own instance of the proxy, you also need your own instance of the EVSClient tool. (Do not forget the tailing slash) | [https://gazelle.ihe.net/EVSClient/](https://gazelle.ihe.net/EVSClient/) |
+| **jms_communication_is_enabled** | Enable jms communication | false |
+| **max\_proxy\_port** | Specifies the high limit for the opened ports | 11000 |
+| **min\_proxy\_port** | Specifies the low limit for the opened ports | 10000 |
+| **NUMBER_OF_ITEMS_PER_PAGE** | Number of items to display in datatable | 20 |
+| **proxy\_ip\_addresses** | This property is used to inform the users of the IP address(es) to use to contact the proxy | 131.254.209.16 (kujira.irisa.fr), 131.254.209.17 (kujira1.irisa.fr), 131.254.209.18 (kujira2.irisa.fr), 131.254.209.19 (kujira3.irisa.fr) |
+| **proxy\_oid** | For each tool, we need an OID which uniquely identify the instance of the tool and the URL used to send back results. | 1.1.1.1.1 |
+| **storage\_dicom** | Absolute path to the system folder used to store the DICOM datasets | /opt/proxy/DICOM |
+| **time\_zone** | The time zone used to display the timestamps | Europe/Paris |
+| **admin_only_mode** | This preference is used to enable/disable the Admin Only mode. This mode restricts the access to messages list and messages details to admin only. Connection can however be shared by an administrator to allow users knowing the connection privacy key to see messages from the connection. | false |
+| **proxy_persistent_channels_file_path** | This file path where persistent channels are written. The file must be created by server admin | /opt/proxy/proxyPersistentChannels.csv |
+
+# SSO Configuration
+
+There are additional preferences to configure the SSO authentication.
+
+| Preference name | Description | Example of value |
+| ---------------- | ---------------------------------------------------------------------- | ---------------- |
+| **cas_enabled** | Enable or disable the CAS authentication. | true |
+| **ip_login** | Enable authentication by IP address matching `ip_login_admin` regex. | false |
+| **ip_login_admin** | Regex to authorize ip authentication if CAS authentication is disabled. | .* |
+
+For more documentation about SSO configurations, follow the link [here](https://gitlab.inria.fr/gazelle/public/framework/sso-client-v7/-/blob/master/cas-client-v7/README.md).
\ No newline at end of file
diff --git a/Proxy/media/channel_list_page.png b/Proxy/media/channel_list_page.png
old mode 100755
new mode 100644
index 3b089412627925ef37f01fcbb7d76e49a8c31707..c1cf4dcae5ab562191f85441f56c94865a673f96
Binary files a/Proxy/media/channel_list_page.png and b/Proxy/media/channel_list_page.png differ
diff --git a/Proxy/media/channel_list_page_with_channel.png b/Proxy/media/channel_list_page_with_channel.png
old mode 100755
new mode 100644
index 9b01efdde3da82c4d2819a9ba58246fc55238f01..08ea68131e9210325fd68b55a260bcdfd579d273
Binary files a/Proxy/media/channel_list_page_with_channel.png and b/Proxy/media/channel_list_page_with_channel.png differ
diff --git a/Proxy/media/hl7_message.png b/Proxy/media/hl7_message.png
old mode 100755
new mode 100644
index 33ef7e4a693821e8ce433649f3778c400353549a..c7ae5a2e58f2f3c824b37cca83e881d05babe0d5
Binary files a/Proxy/media/hl7_message.png and b/Proxy/media/hl7_message.png differ
diff --git a/Proxy/media/open_new_channel.png b/Proxy/media/open_new_channel.png
old mode 100755
new mode 100644
index 50f3f1ae5ebc14c94005c692d73ed4e45ee41734..4bb3b5c9ad322c1d4d1f504c22a6e6a09b09a874
Binary files a/Proxy/media/open_new_channel.png and b/Proxy/media/open_new_channel.png differ
diff --git a/Proxy/media/persist_channel_in_list.png b/Proxy/media/persist_channel_in_list.png
new file mode 100644
index 0000000000000000000000000000000000000000..82827cdf95381ae41a016350ccf9137604c7d430
Binary files /dev/null and b/Proxy/media/persist_channel_in_list.png differ
diff --git a/Proxy/media/persist_new_channel.png b/Proxy/media/persist_new_channel.png
new file mode 100644
index 0000000000000000000000000000000000000000..7c73272d4414ada4d0a5c019de7453499a47fc0e
Binary files /dev/null and b/Proxy/media/persist_new_channel.png differ
diff --git a/Proxy/media/synchronize_with_channel_socket_service.png b/Proxy/media/synchronize_with_channel_socket_service.png
new file mode 100644
index 0000000000000000000000000000000000000000..2af211b4d23339bc835dc73b17979e3203034e0b
Binary files /dev/null and b/Proxy/media/synchronize_with_channel_socket_service.png differ
diff --git a/Proxy/release-note.md b/Proxy/release-note.md
index 45895712db725d9f765d93403d99bf9f86324e6f..2a70f29718a13221e5edf30084089e6631b31eee 100755
--- a/Proxy/release-note.md
+++ b/Proxy/release-note.md
@@ -1,20 +1,115 @@
---
title: Release note
-subtitle: Proxy - 5.0.6
-toolversion: 5.0.6
-releasedate: 2023-02-02 00:00:00.0
+subtitle: Proxy
+toolversion: 6.1.0
+releasedate: 2024-02-06
author: Anne-Gaëlle BERGE
function: Software Engineer
customer: IHE Europe
reference: KER1-RNO-IHE-Proxy
---
+# 6.1.0
+_Release date: 2024-02-06_
+
+Context : Gazelle User Management Renovation step 2
+
+__Task__
+* \[[PROXY-308](https://gazelle.ihe.net/jira/browse/PROXY-308)\] Integrate new sso-client-v7
+
+# 6.0.0
+_Release date: 2024-01-18
+
+Step 1 of Proxy renovation.
+
+__Story__
+
+* \[[PROXY-274](https://gazelle.ihe.net/jira/browse/PROXY-274)\] Create and start channels from TM
+* \[[PROXY-275](https://gazelle.ihe.net/jira/browse/PROXY-275)\] Create/start one TCP channel from Proxy UI.
+* \[[PROXY-276](https://gazelle.ihe.net/jira/browse/PROXY-276)\] Create start of several channels from an uploaded CSV in proxy UI.
+* \[[PROXY-277](https://gazelle.ihe.net/jira/browse/PROXY-277)\] Support DICOM Channel
+* \[[PROXY-278](https://gazelle.ihe.net/jira/browse/PROXY-278)\] Support HL7v2 Channel
+* \[[PROXY-279](https://gazelle.ihe.net/jira/browse/PROXY-279)\] Support TCP SYSLOG Channel
+* \[[PROXY-281](https://gazelle.ihe.net/jira/browse/PROXY-281)\] Support HTTP Channel
+* \[[PROXY-286](https://gazelle.ihe.net/jira/browse/PROXY-286)\] Support secured channels
+* \[[PROXY-287](https://gazelle.ihe.net/jira/browse/PROXY-287)\] Support TLS 1.3 for secured channels
+* \[[PROXY-288](https://gazelle.ihe.net/jira/browse/PROXY-288)\] HTTP Rewrite
+* \[[PROXY-289](https://gazelle.ihe.net/jira/browse/PROXY-289)\] Support SNI for secured channels
+* \[[PROXY-291](https://gazelle.ihe.net/jira/browse/PROXY-291)\] Stop channel individually from UI
+* \[[PROXY-292](https://gazelle.ihe.net/jira/browse/PROXY-292)\] Stop All channel from UI
+* \[[PROXY-293](https://gazelle.ihe.net/jira/browse/PROXY-293)\] Record messages grouped in connections
+* \[[PROXY-294](https://gazelle.ihe.net/jira/browse/PROXY-294)\] Record TLS handshake information
+* \[[PROXY-307](https://gazelle.ihe.net/jira/browse/PROXY-307)\] Improve channels save/upload format to JSON
+
+__Bug__
+
+* \[[PROXY-312](https://gazelle.ihe.net/jira/browse/PROXY-312)\] Wrong Responder IP
+* \[[PROXY-313](https://gazelle.ihe.net/jira/browse/PROXY-313)\] Bad DICOM dump
+* \[[PROXY-314](https://gazelle.ihe.net/jira/browse/PROXY-314)\] HL7v2 unclear decoding error message
+* \[[PROXY-315](https://gazelle.ihe.net/jira/browse/PROXY-315)\] Incoherent Cipher-Suites list in proxy-v7
+* \[[PROXY-316](https://gazelle.ihe.net/jira/browse/PROXY-316)\] HTTP Wrong decoding error message
+* \[[PROXY-317](https://gazelle.ihe.net/jira/browse/PROXY-317)\] Channels filters not working
+* \[[PROXY-318](https://gazelle.ihe.net/jira/browse/PROXY-318)\] Empty IP is allowed in channels upload
+* \[[PROXY-319](https://gazelle.ihe.net/jira/browse/PROXY-319)\] Unclear message when saving secured config
+* \[[PROXY-320](https://gazelle.ihe.net/jira/browse/PROXY-320)\] Unclear TLS error message
+* \[[PROXY-321](https://gazelle.ihe.net/jira/browse/PROXY-321)\] Raw message display text not working
+* \[[PROXY-322](https://gazelle.ihe.net/jira/browse/PROXY-322)\] Remove All not working in secured channels
+* \[[PROXY-324](https://gazelle.ihe.net/jira/browse/PROXY-324)\] Go to the last page not working
+* \[[PROXY-325](https://gazelle.ihe.net/jira/browse/PROXY-325)\] Share message icon not working
+* \[[PROXY-326](https://gazelle.ihe.net/jira/browse/PROXY-326)\] Copy button not working
+* \[[PROXY-327](https://gazelle.ihe.net/jira/browse/PROXY-327)\] Proxy opens too many SQL Connections
+
+
+__Task__
+* \[[PROXY-280](https://gazelle.ihe.net/jira/browse/PROXY-280)\] Support TCP Raw Channel
+* \[[PROXY-284](https://gazelle.ihe.net/jira/browse/PROXY-284)\] Native image
+* \[[PROXY-285](https://gazelle.ihe.net/jira/browse/PROXY-285)\] Proxy Channel Performence Testing
+* \[[PROXY-295](https://gazelle.ihe.net/jira/browse/PROXY-295)\] Pipeline handlers extension
+* \[[PROXY-296](https://gazelle.ihe.net/jira/browse/PROXY-296)\] Proxy J7 adaptation implementation
+* \[[PROXY-297](https://gazelle.ihe.net/jira/browse/PROXY-297)\] proxy service sync with channel socket service
+* \[[PROXY-298](https://gazelle.ihe.net/jira/browse/PROXY-298)\] Custom pipeline fork
+* \[[PROXY-311](https://gazelle.ihe.net/jira/browse/PROXY-311)\] System Tests Proxy V17
+
+# 5.1.1
+_Release date: 2023-12-13_
+
+__Bug__
+* \[[PROXY-302](https://gazelle.ihe.net/jira/browse/PROXY-302)\] Cannot log with ipLogin
+
+__Story__
+* \[[PROXY-303](https://gazelle.ihe.net/jira/browse/PROXY-303)\] Dump Dicom to xml in WADO-RS response
+
+# 5.1.0
+_Release date: 2023-07-11_
+
+Step 1 of Gazelle User Management renovation.
+
+__Task__
+* \[[PROXY-268](https://gazelle.ihe.net/jira/browse/PROXY-268)\] [GUM] Cas-client-v7 update integration
+
+# 5.0.8
+_Release date: 2023-06-09_
+
+__Bug__
+* \[[PROXY-270](https://gazelle.ihe.net/jira/browse/PROXY-270)\] Missing some French translation in Gazelle Proxy
+
+__Improvement__
+* \[[PROXY-263](https://gazelle.ihe.net/jira/browse/PROXY-263)\] The proxy must be able to include the HTTP Header when sending the message to EVSClient for validation
+* \[[PROXY-264](https://gazelle.ihe.net/jira/browse/PROXY-264)\] The proxy must be able to persit some channel
+
+# 5.0.7
+_Release date: 2023-04-17_
+
+__Bug__
+* \[[PROXY-262](https://gazelle.ihe.net/jira/browse/PROXY-262)\] Fix TOS popup
# 5.0.6
+_Release date: 2023-02-02_
+
__Bug__
-* \[[PROXY-262](https://gazelle.ihe.net/jira/browse/PROXY-262)\] Texte pour les cookies
+* \[[PROXY-262](https://gazelle.ihe.net/jira/browse/PROXY-262)\] Fix TOS popup
# 5.0.5
-_Release date: 2023-01-23_
+_Release date: 2023-01-24_
__Bug__
* \[[PROXY-261](https://gazelle.ihe.net/jira/browse/PROXY-261)\] NPE occurs when sending messages without mutual authentication
diff --git a/Proxy/user.md b/Proxy/user.md
index 76a8b9930f156cf5d0e01f1497a1e23150c0e6b3..0e997dc595276c4c797dd46b8e649737219cef49 100755
--- a/Proxy/user.md
+++ b/Proxy/user.md
@@ -2,8 +2,8 @@
title: User Manual
subtitle: Gazelle Proxy
author: Nicolas BAILLIET
-date: 23/01/2023
-toolversion: 5.0.5
+date: 13/12/2023
+toolversion: 5.1.1
function: Engineer
version: 2.01
status: Approved document
@@ -13,22 +13,27 @@ customer: IHE-EUROPE
# Project Overview
-The proxy is used to capture TCP/IP packets exchanged by test participants using secured or not secured channel. The packed flow is analyzed and stored in a database for further analysis by protocol specific analysers.
+The proxy is used to capture TCP/IP packets exchanged by test participants using secured or not secured channel.
+The packed flow is analyzed and stored in a database for further analysis by protocol specific analysers.
The packet analysers available are :
+
* HTTP
* DICOM
* HL7V2
* Syslog
* Raw
-Each message is saved with the network details, including an id of the socket (named channel id) used for that message as a socket can transport many messages (HTTP, DICOM).Â
+Each message is saved with the network details, including an id of the socket (named channel id) used for that message
+as a socket can transport many messages (HTTP, DICOM).
-**The proxy is set up on ovh1.ihe-europe.net, and accessed with [*the web interface*](https://gazelle.ihe.net/proxy). ovh1.ihe-europe.net has a limited range of port numbers available from the Internet. Ports from 10200 to 11000 must be used for channel creation.**Â
+**The proxy is set up on ovh1.ihe-europe.net, and accessed with [*the web interface*](https://gazelle.ihe.net/proxy).
+ovh1.ihe-europe.net has a limited range of port numbers available from the Internet. Ports from 10200 to 11000 must be used for channel creation.**
## Usage
-The web interface allows to create channels. A channel opens a port on the server hosting the proxy and redirecting all traffic to a configured server on a specific port.
+The web interface allows to create channels. A channel opens a port on the server hosting the proxy and redirecting all
+traffic to a configured server on a specific port.
Data stream is not modified, but analyzed using the chosen packet analyser.
@@ -52,17 +57,22 @@ For HTTP(S) messages, matching request/response is displayed in parenthesis.
The proxy is integrated with Gazelle using web standards.
-It publishes a web service allowing Gazelle to send test instance steps and configurations. Also, when a step is done, Gazelle calls the web service.
+It publishes a web service allowing Gazelle to send test instance steps and configurations. Also, when a step is done,
+Gazelle calls the web service.
-The proxy then opens the needed channels and listen on specified ports (provided in the system configurations). It also records the test instance chronology for further searches.
+The proxy then opens the needed channels and listen on specified ports (provided in the system configurations). It also
+records the test instance chronology for further searches.
-In Gazelle, if the test instance has proxy enabled, a link is available on each step. This link opens the proxy with the Gazelle step technical id as a parameter. The proxy then builds a filter to get messages matching the step and displays the matching messages.
+In Gazelle, if the test instance has proxy enabled, a link is available on each step. This link opens the proxy with the
+Gazelle step technical id as a parameter. The proxy then builds a filter to get messages matching the step and displays the matching messages.
## Introduction
-Gazelle TestManagement tools can be used in conjunction with a proxy for the capture of the messages exchanged between a test participants.
+Gazelle TestManagement tools can be used in conjunction with a proxy for the capture of the messages exchanged between a
+test participants.
The proxy is able to capture :
+
* HL7v2 messages
* Dicom Transactions
* Webservices messages
@@ -70,27 +80,28 @@ The proxy is able to capture :
The advantages of using the proxy when running a test are the followings :
-the Proxy is a neutral way to capture the exchanged messages.
-
-the Proxy displays the captured messages in a unified way for all the tests performed, simplifying the work of the monitors when examining the logs
+* the Proxy is a neutral way to capture the exchanged messages.
+* the Proxy displays the captured messages in a unified way for all the tests performed, simplifying the work of the
+monitors when examining the logs
+* the Proxy provides permanent link to the captured messages that can be linked to test instance steps and avoid the cut
+and paste of logs in the chat window of the test instance. It then helps linking the logs to the test and enables all the participants to the test to see the entire set of messages exchanges between the test participants.
+* the Proxy helps to verify the captured messages through a direct link to the EVS Client GUI.
-the Proxy provides permanent link to the captured messages that can be linked to test instance steps and avoid the cut and paste of logs in the chat window of the test instance. It then helps linking the logs to the test and enables all the participants to the test to see the entire set of messages exchanges between the test participants.
-
-the Proxy helps verifying the captured messages through a direct link to the EVS Client GUI.
-
-
+
## Limitations
-Proxy acts as a network relay between two SUTs. As a result, system configuration has to be modified. The TCP connection must be established on the proxy on the system configuration's proxy port instead of opening a connection to the responder SUT directly.
+Proxy acts as a network relay between two SUTs. As a result, system configuration has to be modified. The TCP connection
+must be established on the proxy on the system configuration's proxy port instead of opening a connection to the responder SUT directly.
## How does it work ?
-For each system in Gazelle TestManagement tool there is a set of configuration parameters. For each port that an SUT needs to open, there is a mirror port number on the proxy.Â
+For each system in Gazelle TestManagement tool there is a set of configuration parameters. For each port that an SUT needs
+to open, there is a mirror port number on the proxy.
All proxy ports must be opened by a Gazelle admin, each system configuration being mapped to a proxy port.
-The proxy GUI can be access at the following URL :Â [*https://gazelle.ihe.net/proxy*](https://gazelle.ihe.net/proxy)
+The proxy GUI can be access at the following URL : [*https://gazelle.ihe.net/proxy*](https://gazelle.ihe.net/proxy)
## Start a new channel
@@ -98,7 +109,8 @@ To start a new channel, you have to be connected as an administrator.
-The form displayed should be completed with message type, proxy's port, responder's IP or hostname and responder's port. The channel can be secure or not secure by activating the lock icon.
+The form displayed should be completed with message type, proxy's port, responder's IP or hostname and responder's port.
+The channel can be secure or not secure by activating the lock icon.
@@ -106,12 +118,21 @@ Then, one the channel is started, it can be visible in the channel list page
-For secured configuration details, you can go to Administration/Secured Channel Configuration (admin only) or click on the lock icon to be redirected in read only mode (any user)
+For secured configuration details, you can go to Administration/Secured Channel Configuration (admin only) or click on
+the lock icon to be redirected in read only mode (any user)
NB : Update the configuration induce a restart of all previously opened channels.
+## Synchronize with Channel Socket Service (Version >= 6.0.0)
+
+As the low level socket management is now delegated to a dedicated service, the proxy needs to be synchronized with this
+service to be able to open new channels. This synchronization is done automatically every 5 minutes, but can be done manually
+by clicking on the "Synchronize with Channel Socket Service" button in the Channels List page.
+
+
+
## Automated filtering
@@ -119,41 +140,93 @@ Proxy and Gazelle know each other, and each test step in Gazelle has a proxy lin
-This link displays the list of the messages matching the test step configuration. It also filters the messages by time, showing only messages sent after the last test step marked as verified (or test instance started) and this test step marked as to be verified.
+This link displays the list of the messages matching the test step configuration. It also filters the messages by time,
+showing only messages sent after the last test step marked as verified (or test instance started) and this test step marked as to be verified.
## Finding captured messages manually
-By accessing proxy directly using [*https://gazelle.ihe.net/proxy*](https://gazelle.ihe.net/proxy), messages can be filtered on different criterias. By clicking a value in the table, it either opens the message details for id column, or set the filter for other columns.
+By accessing proxy directly using [*https://gazelle.ihe.net/proxy*](https://gazelle.ihe.net/proxy), messages can be
+filtered on different criterias. By clicking a value in the table, it either opens the message details for id column,
+or set the filter for other columns.
The messages list displays only one type of message, if HTTP is selected, HL7v2 messages are not shown.
-Each captured message has a permanent link that can be used in Gazelle. The best way to use it is to add this link to a test step instance. The monitor will be then able to validate the message using EVSClient.
+Each captured message has a permanent link that can be used in Gazelle. The best way to use it is to add this link to a
+test step instance. The monitor will be then able to validate the message using EVSClient.
+## Persist a channel
+
+**For Version >6.0.0**, gazelle-proxy migrate the persistent channels to a JSON format. The file is located in
+`/opt/proxy/proxyPersistentChannels.json` and is accessible by jboss user.
+
+**For version >5.0.8**, gazelle-proxy can now have a persist feature that allowed user to persist created channel into csv
+file present in server.
+To perform this feature it needs 2 steps :
+
+1. create a file named `proxyPersistentChannels.csv` into `/opt/proxy/proxyPersistentChannels.csv` and make it accessible by jboss user
+
+ ```bash
+ cd /opt/proxy/
+ sudo touch proxyPersistentChannels.csv
+ sudo chmod -R 755 . && sudo chown -R jboss:jboss-admin .
+ ```
+
+2. Add property into Administration > Configuration
+
+ | Preference name | Value |
+ |:-----------------------------------:|:--------------------------------------:|
+ | proxy_persistent_channels_file_path | /opt/proxy/proxyPersistentChannels.csv |
+
+Once done you can know persist your channel during creation of new channel by ticking the case `Make the channel persistent?`
+
+
+
+The channel is now created with an `Unpersit` button.
+
+
+
+The chanel is written in `/opt/proxy/proxyPersistentChannels.csv` (or `/opt/proxy/proxyPersistentChannels.json`) in this format :
+
+```csv
+"HTTP","true","10000","example.com","443","true"
+```
+
+The fields are in this strict order:
+
+```csv
+"Type of Message","is Secured?","Proxy port","Responder Host","Responder port","is Persistent ?"
+```
+
+
# WebService API
-* *startAllChannels* : It takes "List<Configuration> configurations" in argument. It start a new channel in proxy for each configuration set.
+* *startAllChannels* : It takes "List<Configuration> configurations" in argument. It starts a new channel in proxy for each configuration set.
-* *startTestInstance* : It takes "TestInstance testInstance" in argument. It start a new channel in proxy for a test instance.
+* *startTestInstance* : It takes "TestInstance testInstance" in argument. It starts a new channel in proxy for a test instance.
-* *markTestStep* : It takes "int testStepId" in argument. It set the date of a test step with the current.
+* *markTestStep* : It takes "int testStepId" in argument. It set the date of a test step with the current.
-* *getMinProxyPort* :Â It return the min\_proxy\_port define in proxy configuration.
+* *getMinProxyPort* : It returns the min\_proxy\_port define in proxy configuration.
-* *getMaxProxyPort* :Â It return the max\_proxy\_port define in proxy configuration.
+* *getMaxProxyPort* : It returns the max\_proxy\_port define in proxy configuration.
# Admin Only Mode
The proxy can be configured to use the "Admin only" mode. This mode restrict the access to the message list and details to administrators only.
-Not logged in users or logged in users without admin rights will not be able to see any message if this mode is activated. Any captured message will have a private access in this mode by default. Id the message is captured wiht this mode disabled, when switching the mode on, the message will still be private by default.
-An admin user can however Share connection. This basically means that a privacy key is associated to the connection and that any user with any rights knowing this privacy key will be able to access messages from this connection.
+Not logged in users or logged in users without admin rights will not be able to see any message if this mode is activated.
+Any captured message will have a private access in this mode by default. Id the message is captured with this mode disabled,
+when switching the mode on, the message will still be private by default.
+An admin user can however Share connection. This basically means that a privacy key is associated to the connection and
+that any user with any rights knowing this privacy key will be able to access messages from this connection.
When this mode is enabled, the Message List is not accessible in the menu for not admin users :
-When an Admin user access the message list with this mode enabled, he can see which message is shared and which message is private. He can also filter messages based on this criterion.
+When an Admin user access the message list with this mode enabled, he can see which message is shared and which message
+is private. He can also filter messages based on this criterion.
@@ -162,8 +235,11 @@ Finally when on a message detail page, the admin user can shared the associated
-The current privacy state of the connection can be found as an icon on the top right corner of the Message details panel. For instance, the connection associated to the message in the following picture is private.
+The current privacy state of the connection can be found as an icon on the top right corner of the Message details panel.
+For instance, the connection associated to the message in the following picture is private.
-At any moment this mode can be enabled or disabled. Between two activations, connection will keep the same privacy status (shared or private). When the mode is diasbled, all connection and all messages can be accessed by all users again. The fact that they are private in Admin only mode has no impact when the mode is disabled.
+At any moment this mode can be enabled or disabled. Between two activations, connection will keep the same privacy status
+(shared or private). When the mode is disabled, all connection and all messages can be accessed by all users again.
+The fact that they are private in Admin only mode has no impact when the mode is disabled.
diff --git a/README.md b/README.md
index 3d7469895d39783bfb29d3d592d26bc54c2fdbd1..c502fce8de2c3cc0a6120617b295a366518b4836 100755
--- a/README.md
+++ b/README.md
@@ -1,16 +1,16 @@
-# Generate beautiful word from markdown
+# Gazelle User Documentation
Generate gazelle framework documentation from markdown files.
-This project generates pdf, pdf with revision marks and a static website (using jekyll).
+This project generates static website (using jekyll) and PDF documents (oudated).
## Build and preview website with Docker
It requires Docker and docker-compose installed.
-No local Ruby, Pandoc, tex, ... are required.
+No more local Ruby, Pandoc, tex, ... are required.
-To update website and serve it :
+To update website and serve it (ONLY FOR DEV):
```bash
docker-compose up --build
@@ -18,55 +18,41 @@ docker-compose up --build
Document is then available at <http://localhost:1080/gazelle-documentation/>
-## Requirements
+## Build without Docker
- sudo apt-get install make git git-svn texlive-xetex pandoc ruby-dev
+### setup
-Clone using git
-
- mkdir gazelle-user-documentation
- cd gazelle-user-documentation
- git clone git@gitlab.inria.fr:gazelle/documentation/gazelle-user-documentation.git
-
-You shall have previously defined your GitLab user: git config --global user.email "email@example.com"
-
-### Usage of git
-
-To update your local copy
-
- git rebase .
-
-Once your work is ready, you can commit locally
-
- git add filenames
- git commit -m "blah blah" filenames
-
-And then push all the local commits on Git Lab
-
- git push
-
-## Generate documentation
+```bash
+sudo apt-get install make git git-svn texlive-xetex pandoc ruby-dev build-essential dh-autoreconf
+```
-install required software
+Then, from `gazelle-dev-documentation` folder run to install some more libs and required gems
-from `gazelle-dev-documentation` folder run:
+```bash
+make setup
+```
- $ make setup
- # will install requirement on the computer
+### Generate the documents and the website
+```bash
+make
+```
- $ make
- # will generate all the documents and the website
- $ make view
- # will generate all the documents and start jekyll
+### Add a gem in the bundle
+```bash
+cd target/jekyll-gazelle-documentation
+sudo bundle add webrick
+sudo bundle install
-from a project folder run:
- $ make release-notes
- # will generate the PDF version of the release notes
+```
-Check target folder for results
+### Generate all the documents and start Jekyll (do not use in production)
+```bash
+sudo bundle exec jekyll serve
+```
+Once it is done you server must have been started on localhost:4000/gazelle-documentation/
## Folder structure
gazelle-documentation
@@ -76,7 +62,7 @@ Check target folder for results
| |--Makefile
| |--media/
| |--user.md
- Â | |--release-notes/
+ | |--release-notes/
| | |--1_0_0.md (one file per release, named with version identifier)
| |--target/ (Created at compile time)
|
@@ -85,7 +71,7 @@ Check target folder for results
| |--Makefile
| |--media/
| |--user.md
- Â | |--release-notes/
+ | |--release-notes/
| | |--1_0_0.md (one file per release, named with version identifier)
| |--target/ (Created at compile time)
|
@@ -107,11 +93,32 @@ The YAML header is used by Jekyll and pandoc to generate menus and front pages,
The YAML header is used by Jekyll and pandoc to generate menus and front pages, make sure all the metadata are present and up-to-date. The *.md files must start with the YAML header.
+## Conversion Markdown to Pdf files
+
+To generate pdf files use the command (might take some times)
+
+```bash
+sudo make -i pdf-gen
+```
+
+you can use
+```bash
+sudo make clean
+```
+to remove all generated files
+
+!!WARNING!!
+Be careful with table in markdown they may break your pdf if table are too big.
+
+In any case if your pdf is break you might want to use the extension markdown pdf with visual studio code.
+
+With this extension you can generate pdf one by one with command available in the extension.
+
+Table with this extension are correct
-# Links
+## Links
http://pandoc.org/
[Pandoc installation package](https://github.com/jgm/pandoc/releases/tag/1.17.2)
-http://blog.cigrainger.com/2014/07/pandoc-markdown.html
diff --git a/SVS-Simulator/installation.md b/SVS-Simulator/installation.md
index 72b19cf3c661aa5ce4ff5ced4bd3c723fccd1842..dfd5eb24e02c6c45bb68f96953d6a121e2c34611 100755
--- a/SVS-Simulator/installation.md
+++ b/SVS-Simulator/installation.md
@@ -2,7 +2,7 @@
title: Installation Manual
subtitle: SVS Simulator
author: Anne-Gaëlle Bergé
-date: 19/01/2022
+date: 13/04/2023
toolversion: 2.3.x
function: Quality Engineer
version: 2.02
@@ -26,9 +26,9 @@ If you rather want to build the project by yourself, you must checkout the lates
1- Checkout the latest tag available on Inria’s forge:
```bash
-git clone https://gitlab.inria.fr/gazelle/applications/test-execution/simulator/svs-simulator.git
+git clone https://gitlab.inria.fr/gazelle/public/core/svs-simulator.git
cd svs-simulator
-git checkout tag/SVSSimulator-<version>
+git checkout <version>
```
2- \[Optional\] Edit the pom.xml file and create a new profile
@@ -72,7 +72,7 @@ You first need to initialize the database with some data available in a SQL scri
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).
+Before executing the script, open the file and checked the various preferences to be inserted in the app\_configuration table, especially the application\_url and other preferences relative to the user authentication (see Application configuration section).
Finally, execute the script to initialize the database:Â
@@ -100,13 +100,9 @@ In the Administration menu, you will find a sub-menu entitled "Application Confi
|----------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------|
| application\_issue\_tracker\_url | The URL of the bug tracking system where to post issues | https://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) or false (uses a CAS service to authenticate users) |
| documentation\_url | Where to find the user manual | https://gazelle.ihe.net/content/svs-simulator |
| esvs\_xsd\_location | URL of XSD schema ESVS-20100726.xsd | https://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) or 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) | https://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= |
@@ -114,6 +110,18 @@ In the Administration menu, you will find a sub-menu entitled "Application Confi
| svs\_repository\_url | URL of the Sharing Value Set Repository actor of the SVSSimulator | https://gazelle.ihe.net |
| svs\_xsd\_location | URL of XSD schema SVS.xsd | Â https://gazelle.ihe.net/xsd/svs/SVS.xsd |
+# SSO Configuration
+
+There are additional preferences to configure the SSO authentication.
+
+| Preference name | Description | Example of value |
+| ---------------- | ---------------------------------------------------------------------- | ---------------- |
+| **cas_enabled** | Enable or disable the CAS authentication. | true |
+| **ip_login** | Enable authentication by IP address matching `ip_login_admin` regex. | false |
+| **ip_login_admin** | Regex to authorize ip authentication if CAS authentication is disabled. | .* |
+
+For more documentation about SSO configurations, follow the link [here](https://gitlab.inria.fr/gazelle/public/framework/sso-client-v7/-/blob/master/cas-client-v7/README.md).
+
# 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.
diff --git a/SVS-Simulator/release-note.md b/SVS-Simulator/release-note.md
index 0caa5bb5df2d63315c553cbb1a849f96fda9a528..793a5a78423e1b44fab53260d1dea9c6b70a8cc7 100755
--- a/SVS-Simulator/release-note.md
+++ b/SVS-Simulator/release-note.md
@@ -1,17 +1,39 @@
---
title: Release note
subtitle: SVSSimulator
-toolversion: 2.3.2
-releasedate: 2023-02-02 00:00:00.0
+toolversion: 3.0.0
+releasedate: 2024-02-06
author: Nicolas BAILLIET
function: Software Engineer
customer: IHE Europe
reference: KER1-RNO-IHE-SVSSIMULATOR
---
+# 3.0.0
+_Release date: 2024-02-06_
+
+Context : Gazelle User Management Renovation step 2
+
+__Task__
+* \[[SVS-248](https://gazelle.ihe.net/jira/browse/SVS-248)\] Integrate new sso-client-v7
+* \[[SVS-249](https://gazelle.ihe.net/jira/browse/SVS-249)\] Remove username display in GUI
+
+# 2.3.4
+_Release date: 2023-04-13_
+
+__Bug__
+* \[[SVS-246](https://gazelle.ihe.net/jira/browse/SVS-246)\] Fix TOS popup
+
+# 2.3.3
+_Release date: 2023-02-01_
+
+__Bug__
+* \[[SVS-247](https://gazelle.ihe.net/jira/browse/SVS-247)\] Fix CGU 1st wave
+
# 2.3.2
-#releasedate: 2023-02-02 00:00:00.0
+_Release date: 2023-02-01_
+
__Bug__
-* \[[SVS-246](https://gazelle.ihe.net/jira/browse/SVS-246)\] Texte pour les cookies
+* \[[SVS-246](https://gazelle.ihe.net/jira/browse/SVS-246)\] Fix TOS popup
# 2.3.1
_Release date: 2022-01-19_
diff --git a/SVS-Simulator/user.md b/SVS-Simulator/user.md
index 04808808d4466acb7106b5c2d25cd95a7823aadd..50526bf7161344b4465fbd3fc16dc4206deef70f 100755
--- a/SVS-Simulator/user.md
+++ b/SVS-Simulator/user.md
@@ -2,7 +2,7 @@
title: User Manual
subtitle: SVS Simulator
author: Nicolas Bailliet
-date: 19/01/2022
+date: 13/04/2023
toolversion: 2.3.x
function: Software Engineer
version: 1.04
diff --git a/Schematron-Validator/installation.md b/Schematron-Validator/installation.md
index ae834a6c0e25822e63d8f2f5c4f73772fa2d9e1e..4a906f27e724852e0262f71d70d5f77ffbcbb976 100755
--- a/Schematron-Validator/installation.md
+++ b/Schematron-Validator/installation.md
@@ -2,7 +2,7 @@
title: Installation Manual
subtitle: Schematron Validator
author: Hilary RAMANANTSALAMA
-date: 2019-03-19
+date: 2023-04-04
toolversion: 2.5.x
function: Engineer
version: 2.01
@@ -14,12 +14,12 @@ customer: IHE-EUROPE
Schematron-based Validator is a maven project. Sources are available on the INRIA Source Forge at the following URL:
-[*https://gitlab.inria.fr/gazelle/applications/test-execution/validator/SchematronValidator.git*](https://gitlab.inria.fr/gazelle/applications/test-execution/validator/SchematronValidator.git)
+[*https://gitlab.inria.fr/gazelle/public/validation/schematron-validator.git*](https://gitlab.inria.fr/gazelle/public/validation/schematron-validator.git)
If you'd like to checkout the sources on your system you might want to use the following git command, provided subversion is installed on your system.
```bash
-git clone https://gitlab.inria.fr/gazelle/applications/test-execution/validator/SchematronValidator.git
+git clone https://gitlab.inria.fr/gazelle/public/validation/schematron-validator.git
```
Note that the latest executable can be extracted from our nexus repository as well at
@@ -112,21 +112,29 @@ sudo chown -R jboss:jboss-admin /opt/SchematronValidator_prod
|application_release_notes_url | |https://gazelle.ihe.net/jira/projects/SCHVAL?selectedItem=com.atlassian.jira.jira-projects-plugin:release-page&status=released |
|application_url | The public URL of the tool |[http://yourDomain/SchematronValidator](http://yourDomain/SchematronValidator) |
|application_url_basename | | SchematronValidator |
-|application_works_without_cas | If true, any user might be granted with admin role. If false, the tool is bound to a CAS service for user authentication | false |
|application_zone | | EUROPE |
|bin_path | Relative path to the folder in which are stored the schematrons | bin |
-|cas_enabled | If true, the CAS service for user authentication is used |true |
-|cas_url | URL of the central authentication service |[http://yourDomain/cas](http://yourDomain/cas) |
|cda_xsd_path | absolute path to the XSD file used for validating CDA | /opt/SchematronValidator_prod/xsd/cda/CDA.xsd |
|data_path | | data |
|documentation_url | Link to the user guide | https://gazelle.ihe.net/gazelle-documentation/Schematron-Validator/user.html |
|epsos_cda_xsd_path | absolute path to the XSD file used for validating epSOS CDA | |
|gazelle_home_path | absolute path to the directory in which are stored the files used by the tool | /opt/SchematronValidator |
-|ip_login | If application_works_without_cas = true, authentication is based on user's IP | false |
-|ip_login_admin | Regex to be matched by the IP addresses of the users who can be granted as admin |.\* |
|mif_root_directory | Relative path to the folder where are stored the MIF files | /mif |
|monitor_email | The email of the second person who will receive failure notification from the tool | - |
|reports_path | | reports |
|time_zone | Time zone | UTC+01 |
|gazelle_transformation_url | | http://localhost:8580/transformation-ejb/GazelleTransformationService/Transformation?wsdl |
|xsd_1_1_validator_path | |/opt/SchematronValidator_prod/bin/XSDValidator-1.0-jar-with-dependencies.jar|
+
+
+# SSO Configuration
+
+There are additional preferences to configure the SSO authentication.
+
+| Preference name | Description | Example of value |
+| ---------------- | ---------------------------------------------------------------------- | ---------------- |
+| **cas_enabled** | Enable or disable the CAS authentication. | true |
+| **ip_login** | Enable authentication by IP address matching `ip_login_admin` regex. | false |
+| **ip_login_admin** | Regex to authorize ip authentication if CAS authentication is disabled. | .* |
+
+For more documentation about SSO configurations, follow the link [here](https://gitlab.inria.fr/gazelle/public/framework/sso-client-v7/-/blob/master/cas-client-v7/README.md).
\ No newline at end of file
diff --git a/Schematron-Validator/release-note.md b/Schematron-Validator/release-note.md
index ba91a60241c392519ffdbddc89dc664c31380b76..9f07ebf54d4f2b62dfc27a1bf8c4723ec5f19731 100755
--- a/Schematron-Validator/release-note.md
+++ b/Schematron-Validator/release-note.md
@@ -1,13 +1,35 @@
---
title: Release note
subtitle: Schematron Validator
-toolversion: 2.5.0
-releasedate: 2019-03-18
+toolversion: 2.6.0
+releasedate: 2024-02-06
author: Anne-Gaëlle BERGE
function: Software Engineer
customer: IHE Europe
reference: KER1-RNO-IHE-SCHEMATRON_VALIDATOR
---
+
+# 2.6.0
+
+_Release date: 2024-02-06
+
+Context : Gazelle User Management Renovation step 2
+
+__Task__
+* \[[SCHVAL-192](https://gazelle.ihe.net/jira/browse/SCHVAL-192)\] Integrate new sso-client-v7
+
+# 2.5.2
+_Release date: 2023-04-04_
+
+__Bug__
+* \[[SCHVAL-186](https://gazelle.ihe.net/jira/browse/SCHVAL-186)\] ANS CR-Bio validation
+
+# 2.5.1
+_Release date: 2021-12-21_
+
+__Improvement__
+* \[[SCHVAL-181](https://gazelle.ihe.net/jira/browse/SCHVAL-181)\] Externalize the configuration of the mail server
+
# 2.5.0
_Release date: 2019-03-18_
diff --git a/Schematron-Validator/user.md b/Schematron-Validator/user.md
index 16ef810cb05edfe4ed5aeb6496c610eb16927f19..ef35021cc7ed490b5d7c0692e049d064403c7110 100755
--- a/Schematron-Validator/user.md
+++ b/Schematron-Validator/user.md
@@ -2,8 +2,8 @@
title: User Manual
subtitle: Schematron Validator
author: Anne-Gaëlle BERGE
-date: 21/01/2019
-toolversion: 2.4.x
+date: 04/04/2023
+toolversion: 2.5.x
function: Software Engineer
version: 1.04
status: Approved document
diff --git a/Test-Management/admin.md b/Test-Management/admin.md
index 927b4236970cf2ca370e00fc4819924091b1a635..d9188abbf1f25fe4caa44c945ffa7125184f5cd9 100755
--- a/Test-Management/admin.md
+++ b/Test-Management/admin.md
@@ -2,9 +2,9 @@
title: Administration guide
subtitle: Gazelle Test Management
author: Nicolas BAILLIET
-function: Software ngineer
-releasedate: 23/12/2022
-toolversion: 6.10.X
+function: Software Engineer
+releasedate: 06/11/2023
+toolversion: 7.X.X
version: 1.02
status: Approved document
reference: KER1-MAN-IHE-TEST_MANAGEMENT_ADMIN-1_02
@@ -654,10 +654,8 @@ From this page, you can see what are the active testing sessions, active/inactiv
From the Administration of testing sessions page, click on "Add an event"; a new form will be displayed. The following information are requested
-- Year : when the testing event takes place
-- Zone : where the testing event takes place
-- Type : what type of event are you registering
-- Description : will be used as title of the testing session
+- Name : will be used as title of the testing session, it's unique and mandatory
+- Description : optionally describe the testing session
- Start date : beginning of the testing event itself
- End date : end of the testing event
- Registration deadline : after this date, users will not be able to alter their system (addition/removal of actor/profile)
diff --git a/Test-Management/conformance_tool.md b/Test-Management/conformance_tool.md
index c55a574122d3fac798809b1235cf62aa6a7f4df0..a9302760a36a424c36e01027202121714dad8041 100755
--- a/Test-Management/conformance_tool.md
+++ b/Test-Management/conformance_tool.md
@@ -3,7 +3,7 @@ title: Launching Conformance Tool of XDS Tools from Gazelle Test Management
subtitle: Gazelle Test Management
author: Malo TOUDIC
function: Developer
-date: 13/06/2018
+date: 06/11/2023
version: 0.01
status: Draft
reference: KER1-MAN-IHE-TEST_MANAGEMENT_GWT_XDSTOOLS-0_01
diff --git a/Test-Management/installation.md b/Test-Management/installation.md
index dc274a8a754896a80d7d6d8633756f037b1df8d4..441d2129c4c03f9c2c161844c6adb4375ae3e08e 100755
--- a/Test-Management/installation.md
+++ b/Test-Management/installation.md
@@ -2,9 +2,9 @@
title: Installation manual
subtitle: Gazelle Test Management
author: Nicolas BAILLIET
-function: Engineer
-releasedate: 23/12/2022
-toolversion: 6.10.X
+function: Software Engineer
+releasedate: 06/11/2023
+toolversion: 7.X.X
version: 1.02
status: Approved document
reference: KER1-MAN-IHE-TEST_MANAGEMENT_INSTALLATION-1_02
@@ -15,25 +15,41 @@ customer: IHE-EUROPE
# Purpose
-Thanks for having chosen Gazelle !
+Thanks for having chosen Gazelle ! Test Management is an open-source project under Apache2 licence.
Here is a guide to help you with installing Test Management.
# Pre-requisites
-Gazelle Test Management runs under Jboss AS 7.2.0 with a postgresql PostGresql 9.1 or higher database. For general considerations regarding the installation of the
+Gazelle Test Management runs under Jboss AS 7.2.0 with a PostgreSQL 9.6 or higher database. For general considerations regarding the installation of the
application server, read [Jboss7 installation guide](../General/jboss7.html).
-# Sources
+# Binary
+
+You can either fetch the public EAR (released version) in our [Nexus repository](https://gazelle.ihe.net/nexus/index.html#nexus-search;gav~~gazelle-tm-ear*~~~) or compile the tool by your own.
+
+## Build from sources
-Test Management is an open source project under Apache2 licence. The sources are available on the INRIA's Gitlab:
+The sources are available on the INRIA's Gitlab:
```bash
-git clone https://gitlab.inria.fr/gazelle/applications/mixed/gazelle-tm.git
+git clone https://gitlab.inria.fr/gazelle/public/core/test-management.git
```
-# Database creation and initialization
+It requires jdk8 and maven to build, but jdk7 to run.
+
+```bash
+cd test-management
+mvn clean install
+```
+
+The archive (EAR) and the distribution file are created and placed into gazelle-tm/gazelle-tm-ear/target directory.
+
+# Database setup
+
+## Database creation
+
+You can choose whatever database name you want, you will need to report it in the datasource section of the Jboss configuration.
-You can choose whatever database name you want. You will need to report it in the datasource section of the Jboss configuration.
```bash
su postgresql
psql
@@ -44,11 +60,18 @@ postgres=# \q
exit
```
+## Database initialization for TM version 7.0.0 and newer
+
+Database initialization is automatically handled by the EAR itself.
+
+## Database initialization for TM version prior to 7.0.0
+
Download the files containing all the data required by the application to properly work (schema-X.X.X.sql and init-X.X.X.sql, X.X.X being the latest version available) on Nexus in the sql.zip file : [Nexus repository](https://gazelle.ihe.net/nexus/index.html#nexus-search;gav~~gazelle-tm-ear*~~~) and import it into the newly created database as shown below.
```bash
psql -U gazelle your_database < schema-X.X.X.sql
psql -U gazelle your_database < init-X.X.X.sql
+psql -U gazelle your_database < create_functions.sql
```
# Graphviz
@@ -58,23 +81,41 @@ Gazelle Test Management need the package graphviz to display graph (Display rela
sudo apt install graphviz
```
+# Single Sign On
-# Binary
+With the release 5.15.0, Gazelle Test Management needs a file to interact with the SSO application.
+This application read the configuration of the SSO in a file located in `/opt/gazelle/cas`. You need
+to create this folder and the configuration file `gazelle-tm.properties`.
-You can either fetch the public EAR (released version) in our [Nexus repository](https://gazelle.ihe.net/nexus/index.html#nexus-search;gav~~gazelle-tm-ear*~~~) or compile the tool by your own.
+```
+ mkdir /opt/gazelle/cas
+ touch /opt/gazelle/cas/gazelle-tm.properties
+ chown -R jboss:jboss-admin /opt/gazelle/cas
+ chmod -R g+w /opt/gazelle/cas
+```
+The file **gazelle-tm.properties** shall be created and save in **/opt/gazelle/cas**.
-Before compiling, go to the directory gazelle-tm and edit the file pom.xml. Open this file and adapt the properties of profile prod to your case:
+### SSO properties with gazelle-user-management and Keycloak SSO (Test-Management version 7.0.0 and newer)
-* basename : root of application. Ex : gazelle → http://server/gazelle
-* jdbc.connection.url : replace the last segment with your database name
-* jdbc.connection.user /Â jdbc.connection.password : credentials for database access
-* Then, create the EAR archive with the command line:
+Integrated with Keycloak's Gazelle, the file `gazelle-tm.properties` must contain:
-```bash
-cd gazelle-tm; mvn clean package -Pprod,distribution
+```properties
+casServerUrlPrefix=https://yourUrl.com/auth/realms/gazelle/protocol/cas
+casServerLoginUrl=https://yourUrl.com/auth/realms/gazelle/protocol/cas/login
+casLogoutUrl=https://yourUrl.com/auth/realms/gazelle/protocol/cas/logout
+service = https://yourUrl.com/gazelle
```
-The archive (EAR) and the distribution file are created and placed into gazelle-tm/gazelle-tm-ear/target directory.
+### SSO properties with Apereo CAS (Test-Management version prior to 7.0.0)
+
+Integrated with Apereo-CAS' Gazelle, the file `gazelle-tm.properties` must contain:
+
+```properties
+casServerUrlPrefix = https://yourUrl.com/sso
+casServerLoginUrl = https://yourUrl.com/sso/login
+casLogoutUrl = https://yourUrl.com/sso/logout
+service = https://yourUrl.com/gazelle
+```
# Deployment
@@ -102,35 +143,18 @@ Once you have copied the content of this file in your Jboss configuration:
You can retrieve those values in [gazelle-tm's pom.xml file](https://gazelle.ihe.net/jenkins/view/Test%20Management/job/gazelle-tm-public/ws/pom.xml) for each profile.
-
Since version 5.11.0, you need to configure the mail session that is needed by the tool in the jboss configuration file `standalone.xml`. Read details in the "Externalize mail server configuration" section of [JBoss 7 installation page](../General/jboss7.html) for further information.
+Copy the gazelle-tm.ear into the " standalone/deployments" directory of your JBoss 7 server. Finally, start your server. When the application is deployed, open a browser and go to **http://yourserver/gazelle**. If the deployment and the database initialization are successful you should see the home page.
-Copy the gazelle-tm.ear into the " standalone\\deployments" directory of your JBoss 7 server. Finally, start your server. When the application is deployed, open a browser and go to **http://yourserver/gazelle**. If the deployment and the database initialization are successful you should see the home page.
-
-# Configuration
-
-## SSO
-
-With the release 5.15.0, Gazelle Test Management needs a file to interact with the SSO application.
-This application read the configuration of the SSO in a file located in `/opt/gazelle/cas`. We need to create this folder and the configuration file `gazelle-tm.properties`.
-
-```
- mkdir /opt/gazelle/cas
- touch /opt/gazelle/cas/gazelle-tm.properties
- chown -R jboss:jboss-admin /opt/gazelle/cas
- chmod -R g+w /opt/gazelle/cas
-```
-The file **gazelle-tm.properties** has shall be created and save in **/opt/gazelle/cas**.
-
-The file shall contain the following statements :
-- casServerUrlPrefix = https://yourUrl.com/sso
-- casServerLoginUrl = https://yourUrl.com/sso/login
-- casLogoutUrl = https://yourUrl.com/sso/logout
-- service = https://yourUrl.com/gazelle
-
+# First start
-This instance of Test Management you have just deployed is free of organization, user and testing session. Consequently, the next step will be to create your organization, your account (as an administrator of the application) and the testing session. A testing session is used to hold one event, for example a Connectathon, a showcase or whatever requiring the use of Test Management. If the first part of the installation is successful, you should see the Gazelle home page (see file entitled Home page before installation).
+This instance of Test Management you have just deployed is free of organization, user and testing
+session. Consequently, the next step will be to create your organization, your account (as an
+administrator of the application) and the testing session. A testing session is used to hold one
+event, for example a Connectathon, a showcase or whatever requiring the use of Test Management. If
+the first part of the installation is successful, you should see the Gazelle home page (see file
+entitled Home page before installation).
@@ -156,30 +180,39 @@ You will be redirect to the Home page, if everythink worked fine during the conf
-# Customize the New Home page UI
+# Customize the Home page UI
+
+## Version 6.3.0 and newer
### General
-The new home page support multiple sections, each section contains HTML content, and pre-defined css classes.
+The home page support multiple sections, each section contains HTML content, and pre-defined css classes.
-For the current version **(6.3.0)**, the application doesn't provide a graphical interface to manage these sections,
+For the current version, since **(6.3.0)**, the application doesn't provide a graphical interface to manage these sections,
therefore, an administrator should insert manually his HTML content in the table "tm_sections".
### Default behavior
-The update script **update-6.3.0.sql** (**init-6-3-X.sql** as wel) contains a default HTML content that match predefined styles for the **IHE Connectathon 2022**.
-An administrator could change the column **content** in the tm_section database with his custom HTML.
-
By default, two sections (Documentation and Announcement) are displayed only in the home page, the other two sections
(Tool index and Credits) are visible through all the application pages.
-### Update section
+### Update section priors to 7.0.1
`update tm_section update content='<YOUR_HTML_CONTENT>' where id=<SECTION_ID>`
+
-# Customize the Home page (old version < 6.3.0)
+### Update section since version 7.0.1
+
+The administrator of the current session have access to the Home Page Manager via Administration menu.
+By default, the announcement section is selected. It can be changed via the drop-down menu.
+The selected section can be edited via this page. The `Save and Continue` button will update the section.
+Restore button restore the previous version of the selected section.
+
+
+
+## Version priors to 6.3.0
The home page is built of two blocks the administrators can customize when they are logged in.
diff --git a/Test-Management/media/home_page_manager.png b/Test-Management/media/home_page_manager.png
new file mode 100644
index 0000000000000000000000000000000000000000..c53ecd657624091d86dda2efb2d36b0225f1db5c
Binary files /dev/null and b/Test-Management/media/home_page_manager.png differ
diff --git a/Test-Management/release-note.md b/Test-Management/release-note.md
index db36b7e732a0e1b5ca99a7471a2cbed41e3732a5..ef0bc3dc6bd01d0399753c16ebc39580b0de78c2 100755
--- a/Test-Management/release-note.md
+++ b/Test-Management/release-note.md
@@ -1,13 +1,182 @@
---
title: Release note
subtitle: Test Management
-toolversion: 6.10.0
-releasedate: 2022-12-23
+toolversion: 8.0.0
+releasedate: 2024-02-06
author: Anne-Gaëlle BERGE
function: Software Engineer
customer: IHE Europe
reference: KER1-RNO-IHE-TEST_MANAGEMENT
---
+
+# 8.0.0
+_Release date: 2024-02-06_
+
+Context : Gazelle User Management Renovation step 2
+
+__Story__
+* \[[GZL-5206](https://gazelle.ihe.net/jira/browse/GZL-5206)\] [GUM] Remove account creation in TM
+* \[[GZL-5207](https://gazelle.ihe.net/jira/browse/GZL-5207)\] [GUM] Remove username display
+* \[[GZL-5261](https://gazelle.ihe.net/jira/browse/GZL-5261)\] [GUM] Use new user client in TM to perform actions on users
+
+__Task__
+* \[[GZL-5205](https://gazelle.ihe.net/jira/browse/GZL-5205)\] [GUM] Create webservice to manage organizations
+* \[[GZL-5270](https://gazelle.ihe.net/jira/browse/GZL-5270)\] [GUM] Setup cache for user lookups
+
+# 7.1.6
+_Release date: 2024-01-04_
+
+__Bug__
+* \[[GZL-5306](https://gazelle.ihe.net/jira/browse/GZL-5306)] Display test menu entry as not logged in" is not functionnal
+* \[[GZL-5307](https://gazelle.ihe.net/jira/browse/GZL-5307)] Anonymous users can download the IHE mode
+
+# 7.1.5
+_Release date: 2023-11-06_
+
+__Remarks__
+
+Update gazelle-model, release 5.0.2
+
+Update gazelle-tm-tools, release 4.1.7
+
+__Tâche__
+
+* \[[GZL-5247](https://gazelle.ihe.net/jira/browse/GZL-5247)\] Make testing session uniquely identified
+
+__Bug__
+* \[[GZL-5271](https://gazelle.ihe.net/jira/browse/GZL-5271)\] Impossible to create a new testing session in TM.
+* \[[GZL-5273](https://gazelle.ihe.net/jira/browse/GZL-5273)\] Some unit tests don't pass anymore
+* \[[GZL-5273](https://gazelle.ihe.net/jira/browse/GZL-5277)\] A modification of a testing session name is not well reported
+
+# 7.1.4
+_Release date: 2023-10-13_
+
+__Bug__
+* \[[GZL-5265](https://gazelle.ihe.net/jira/browse/GZL-5265)\] Test run are no more accessible if EVS link is wrong.
+
+# 7.1.3
+_Release date: 2023-10-09_
+
+__Tâche__
+* \[[GZL-5268](https://gazelle.ihe.net/jira/browse/GZL-5268)\] Invalid Dashboard value in Evaluation for capabilities
+* \[[GZL-5269](https://gazelle.ihe.net/jira/browse/GZL-5269)\] TM-Remove report button for vendors
+
+# 7.1.2
+_Release date: 2023-09-20_
+
+__Bug__
+* \[[GZL-5252](https://gazelle.ihe.net/jira/browse/GZL-5252)\] Metatests not properly displayed on Test Execution page
+
+# 7.1.1
+_Release date: 2023-09-14_
+
+__Bug__
+* \[[GZL-5260](https://gazelle.ihe.net/jira/browse/GZL-5260)\] Admin cannot access the list of registered SUT and manage them
+
+# 7.1.0
+_Release date: 2023-09-11_
+
+__Bug__
+* \[[GZL-5164](https://gazelle.ihe.net/jira/browse/GZL-5164)\] Test session creation - setting dates for time-boxed test sessions
+* \[[GZL-5220](https://gazelle.ihe.net/jira/browse/GZL-5220)\] Fix GMM and PR home page
+* \[[GZL-5251](https://gazelle.ihe.net/jira/browse/GZL-5251)\] In GMM, test editors and administrators shall have access to objects/listObjectType.seam
+* \[[GZL-5252](https://gazelle.ihe.net/jira/browse/GZL-5252)\] Metatests not properly displayed on Test Execution page
+* \[[GZL-5258](https://gazelle.ihe.net/jira/browse/GZL-5258)\] Wrong validation permanent links from EVS v6 when providing evidence
+
+__Improvement__
+* \[[GZL-5213](https://gazelle.ihe.net/jira/browse/GZL-5213)\] Allow the adminstrator of the tool to edit the sections of the home page
+* \[[GZL-5214](https://gazelle.ihe.net/jira/browse/GZL-5214)\] Inform the users about the testability status of the profiles they have signed up for
+* \[[GZL-5215](https://gazelle.ihe.net/jira/browse/GZL-5215)\] Allow the testing session manager to automatically update the evaluation for entries related to non-testable profiles
+
+# 6.3.2-SEGUR (SUPPORT)
+_Release date: 2023-09-11_
+
+__Bug__
+* \[[GZL-5258](https://gazelle.ihe.net/jira/browse/GZL-5258)\] Wrong validation permanent links from EVS v6 when providing evidence
+
+Remarks: This version is a SUPPORT release to correct a blocking bug in 6.3.1-SEGUR version.
+
+# 6.10.5 (SUPPORT)
+_Release date: 2023-09-11_
+
+__Bug__
+* \[[GZL-5258](https://gazelle.ihe.net/jira/browse/GZL-5258)\] Wrong validation permanent links from EVS v6 when providing evidence
+
+Remarks: This version is a SUPPORT release to correct a blocking bug in 6.10.4 version.
+
+# 7.0.1
+_Release date: 2023-09-06_
+
+__Bug__
+* \[[GZL-5257](https://gazelle.ihe.net/jira/browse/GZL-5257)\] Missing gazelle_home_path preference for migrations
+
+# 7.0.0
+
+_Release date: 2023-07-12_
+
+Step 1 of Gazelle User Management renovation.
+
+__Bug__
+* \[[GZL-5210](https://gazelle.ihe.net/jira/browse/GZL-5210)\] [GUM] Problem of httpclient dependency versions
+* \[[GZL-5221](https://gazelle.ihe.net/jira/browse/GZL-5221)\] Activation email to vendor-admin has out-dated instructions.
+* \[[GZL-5224](https://gazelle.ihe.net/jira/browse/GZL-5224)\] "Delete user" button should be "Deactivate user"
+* \[[GZL-5228](https://gazelle.ihe.net/jira/browse/GZL-5228)\] Email client application may activate user without admin consent.
+* \[[GZL-5230](https://gazelle.ihe.net/jira/browse/GZL-5230)\] Proxy message link is not displayed in test instance
+* \[[GZL-5231](https://gazelle.ihe.net/jira/browse/GZL-5231)\] Monitor cannot access notes of a system
+* \[[GZL-5244](https://gazelle.ihe.net/jira/browse/GZL-5244)\] Home page show error when there is no preparatory tests during preparation phase
+
+__Task__
+* \[[GZL-5190](https://gazelle.ihe.net/jira/browse/GZL-5190)\] [GUM] Setup Flyway for TM DB
+* \[[GZL-5191](https://gazelle.ihe.net/jira/browse/GZL-5191)\] [GUM] Remove native authentication
+* \[[GZL-5199](https://gazelle.ihe.net/jira/browse/GZL-5199)\] [GUM] Remove reset password from TM
+* \[[GZL-5200](https://gazelle.ihe.net/jira/browse/GZL-5200)\] [GUM] Only uses Identity to access user attributes
+* \[[GZL-5201](https://gazelle.ihe.net/jira/browse/GZL-5201)\] [GUM] Remove block account possibility in TM
+* \[[GZL-5209](https://gazelle.ihe.net/jira/browse/GZL-5209)\] [GUM] Remove log as feature from TM
+
+See also [GUM release note](https://doc-ihe.kereval.cloud/gazelle-applications/v/gazelle-user-management/release-note).
+
+# 6.10.4
+_Release date: 2023-06-23_
+__Bug__
+* \[[GZL-5212](https://gazelle.ihe.net/jira/browse/GZL-5212)\] Inconsistant Prepatory Test Status from the View of Admin
+* \[[GZL-5217](https://gazelle.ihe.net/jira/browse/GZL-5217)\] DIGIT_Unable to edit Monitor test assignment
+
+# 6.10.3
+
+_Release date: 2023-06-01_
+
+__Sub-task__
+* \[[GZL-5126](https://gazelle.ihe.net/jira/browse/GZL-5126)\] Show statistics about SUT network interfaces for testing session managers and administrators
+
+__Bug__
+* \[[GZL-5186](https://gazelle.ihe.net/jira/browse/GZL-5186)\] TM: Conditions for the user to generate his contract have to been revised
+* \[[GZL-5203](https://gazelle.ihe.net/jira/browse/GZL-5203)\] Test Cases are listed not in the expected order
+* \[[GZL-5211](https://gazelle.ihe.net/jira/browse/GZL-5211)\] monitor worklist unexpected error
+
+# 6.10.2
+_Release date: 2023-04-18_
+
+__Bug__
+* \[[GZL-5111](https://gazelle.ihe.net/jira/browse/GZL-5111)\] Allow vendors to use "complete with error" and "verified by vendor" for preparatory test cases
+* \[[GZL-5198](https://gazelle.ihe.net/jira/browse/GZL-5198)\] Allow anonymous vendors to access the testing session scope
+
+# 6.3.1-SEGUR
+_Release date: 2023-04-18_
+
+__Bug__
+* \[[GZL-5208](https://gazelle.ihe.net/jira/browse/GZL-5208)\] Fix TOS popup SEGUR
+
+# 6.10.1
+_Release date: 2023-04-18_
+
+__Bug__
+* \[[GZL-5183](https://gazelle.ihe.net/jira/browse/GZL-5183)\] Cannot generate XSL file from the "List of invoices" page
+* \[[GZL-5187](https://gazelle.ihe.net/jira/browse/GZL-5187)\] Fix TOS popup
+
+__Story__
+* \[[GZL-5072](https://gazelle.ihe.net/jira/browse/GZL-5072)\] Export of financial reports fail
+* \[[GZL-5153](https://gazelle.ihe.net/jira/browse/GZL-5153)\] Review the layout and content of the all test runs page
+
# 6.10.0
_Release date: 2022-12-23_
diff --git a/Test-Management/user.md b/Test-Management/user.md
index ebf7131ebea6c017e299f2b1554a4a3c0a24cc68..a2378725ee18a87e6896823006e7a7d8e86de9e8 100755
--- a/Test-Management/user.md
+++ b/Test-Management/user.md
@@ -3,8 +3,8 @@ title: User manual
subtitle: Gazelle Test Management
author: Anne-Gaëlle Bergé
function: Engineer
-releasedate: 23/12/2022
-toolversion: 6.10.X
+releasedate: 06/11/2023
+toolversion: 7.X.X
version: 2.01
status: Validated
reference: KER1-MAN-IHE-TEST_MANAGEMENT_USER-2_01
diff --git a/Wado-Errors-Manager/Makefile b/Wado-Errors-Manager/Makefile
new file mode 100755
index 0000000000000000000000000000000000000000..cbbc56c706e2a9d7c1b43999f7199c4c956757ea
--- /dev/null
+++ b/Wado-Errors-Manager/Makefile
@@ -0,0 +1,3 @@
+SHELL := /bin/bash
+
+include ../Makefile.generic
diff --git a/Wado-Errors-Manager/installation.md b/Wado-Errors-Manager/installation.md
new file mode 100755
index 0000000000000000000000000000000000000000..8ac616be0050b3de50b3a570700f99a8c998d297
--- /dev/null
+++ b/Wado-Errors-Manager/installation.md
@@ -0,0 +1,34 @@
+---
+subtitle: Wado Errors Manager
+title: Installation Manual
+author: Romuald DUBOURG
+date: 08/09/2023
+toolversion: 1.0.0
+function: Software Developer
+version: 0.01
+status: Draft
+reference:
+customer: IHE-EUROPE
+---
+
+## Requirements
+* Java virtual machine : JDK 17
+
+
+## Installation
+First you should pull the project from:
+https://gitlab.inria.fr/gazelle/private/industrialization/docker/wado-errors-manager.git
+then you can use quarkus with :
+``
+mvn clean package
+cd wado-errors-manager-service
+mvn docker:start
+``
+Or
+you can use the application with :
+``
+mvn clean install
+``
+
+
+
diff --git a/Wado-Errors-Manager/media/example_request.png b/Wado-Errors-Manager/media/example_request.png
new file mode 100644
index 0000000000000000000000000000000000000000..2a8bca8b1f45fa2b8890e34c2443749012dd452a
Binary files /dev/null and b/Wado-Errors-Manager/media/example_request.png differ
diff --git a/Wado-Errors-Manager/user.md b/Wado-Errors-Manager/user.md
new file mode 100755
index 0000000000000000000000000000000000000000..2908a5b3730fd67eec8e5e97e42b6bf907749ec4
--- /dev/null
+++ b/Wado-Errors-Manager/user.md
@@ -0,0 +1,44 @@
+---
+subtitle: Wado Errors Manager
+title: User Manual
+author: Romuald DUBOURG
+date: 08/09/2023
+toolversion: 1.0.0
+function: Software Developer
+version: 0.01
+status: Draft
+reference:
+customer: IHE-EUROPE
+---
+
+# Introduction
+This simulator has no database and no ui. There is only an endpoint that return an error matching with the request sent.
+This endpoint will only return endpoint don't expect any successful response. The goal here is to respond different kind of error to see if they are rightfully handle.
+
+## Usage
+There is an imported file wado-errors-manager/wado-errors-manager-service/src/main/docker/imports/Mapping_OID-HTTP_Error.csv who define for a request which kind of error return.
+There are 5 kind of error who can be return :
+HTTP 403 Forbidden
+HTTP 404 Not Found
+HTTP 410 Gone
+HTTP 502 Bad Gateway
+HTTP 504 Gateway Timeout
+
+The endpoint on which you should send you Get request is define as : HOST/dcm4chee-arc/aets/DCM4CHEE/rs/studies/{studies}/series/{series}/instance/{instances}
+where studies and series can be anything because only instance is important.
+
+The file Mapping_OID-HTTP_Error.csv will link an instance to an error, here is an example with Mapping_OID-HTTP_Error.csv as :
+
+OID (SeriesInstanceUID),Code d'erreur
+1.2.3.4.5.6.7.8.9.1,HTTP 403 Forbidden
+
+
+If I host my application on my computer I can send a get request with postman to http://localhost:8646/rest/wado/dcm4chee-arc/aets/DCM4CHEE/rs/studies/1.3.6.1.4.1.5962.99.1.3711725607.829148806.1687338938407.3.0/series/1.3.6.1.4.1.5962.99.1.3711725607.829148806.1687338938407.6.0/instance/1.2.3.4.5.6.7.8.9.1
+
+The last part of the url( the instance) match with a line of the imported file ,so it will reply the matching error, here it's a 403 Forbidden error.
+
+
+
+In case of incorrect or non-matching instance the error reply is a bad request error.
+
+
diff --git a/XDStar-Client/admin.md b/XDStar-Client/admin.md
index 475739806ab30c7f18ecfc127e9118ee29dc9cf3..a2bc4c1fe256233a177ed490365bb57a06b59205 100755
--- a/XDStar-Client/admin.md
+++ b/XDStar-Client/admin.md
@@ -1,8 +1,8 @@
---
title: Administration Guide
subtitle: XD* Client
-author: Hilary RAMANANTSALAMA
-date: 14/10/2019
+author: Nicolas BAILLIET
+date: 26/06/2023
toolversion: 2.5.x
function: Engineer
version: 1.02
diff --git a/XDStar-Client/installation.md b/XDStar-Client/installation.md
index 7e2b709f61304d3f291d59cf8d9cb64328e5db27..0527556524a645ff09f13c5190cff61b30af0594 100755
--- a/XDStar-Client/installation.md
+++ b/XDStar-Client/installation.md
@@ -1,8 +1,8 @@
---
title: Installation Manual
subtitle: XD* Client
-author: Cédric EOCHE-DUVAL
-date: 14/10/2019
+author: Nicolas BAILLIET
+date: 26/06/2023
toolversion: 2.5.x
function: Engineer
version: 2.02
@@ -50,11 +50,11 @@ All these steps are done by the script. The next paragraph are only details of h
# Compile Sources
-XDStarClient is an open source project under Apache2 licence. The sources are available on the IHE's subversion server:
+XDStarClient is an open source project under Apache2 licence. The sources are available on the IHE's gitlab server:
```bash
-svn checkout https://svn.ihe-europe.net/gazelle/Maven/simulators/XDStar-modules/trunk XDStar-modules
-svn checkout https://svn.ihe-europe.net/gazelle/Maven/simulators/XDStarClient/trunk XDStarClient
+git clone https://gitlab.inria.fr/gazelle/public/simulation/xdstar-modules
+git clone https://gitlab.inria.fr/gazelle/public/simulation/xdstar-client
```
Before compiling, go to the directory XDStarClient and edit the file pom.xml. Open this file and adapt the properties of profile prod to your case :
@@ -177,12 +177,12 @@ INSERT INTO app_configuration VALUES (nextval('app_configuration_id_seq'), 'http
INSERT INTO app_configuration VALUES (nextval('app_configuration_id_seq'), 'https://gazelle.ihe.net/xdstools2/', 'ksa_xdstools_url');
INSERT INTO app_configuration VALUES (nextval('app_configuration_id_seq'), 'false', 'display_IHE_RAD_menu');
INSERT INTO app_configuration VALUES (nextval('app_configuration_id_seq'), 'false', 'display_IHE_ITI_menu');
-INSERT INTO app_configuration VALUES (nextval('app_configuration_id_seq'), 'true', 'ip_login');
+INSERT INTO app_configuration VALUES (nextval('app_configuration_id_seq'), 'false', 'ip_login');
+INSERT INTO app_configuration VALUES (nextval('app_configuration_id_seq'), 'true', 'cas_enabled');
INSERT INTO app_configuration VALUES (nextval('app_configuration_id_seq'), '.*', 'ip_login_admin');
INSERT INTO app_configuration VALUES (nextval('app_configuration_id_seq'), '20', 'NUMBER_OF_ITEMS_PER_PAGE');
INSERT INTO app_configuration VALUES (nextval('app_configuration_id_seq'), '/opt/gazelle/cert/keystore.jks', 'keystore_path');
INSERT INTO app_configuration VALUES (nextval('app_configuration_id_seq'), 'https://gazelle.ihe.net/gazelle-documentation/XDStar-Client/user.html', 'documentation_url');
-INSERT INTO app_configuration VALUES (nextval('app_configuration_id_seq'), 'true', 'application_works_without_cas');
```
@@ -201,13 +201,11 @@ If the deployment and the database initialization are successful you should see
| **application\_release\_notes\_url** | release notes' url | https://gazelle.ihe.net/jira/browse/XDSTAR\#selectedTab=com.atlassian.jira.plugin.system.project%3Achangelog-panel |
| **application\_time\_zone** | time zone | UTC+01 |
| **application\_url** | the url of XDStarClient (too important as it is used by permanent links) | https://gazelle.ihe.net/XDStarClient/ |
-| **application_works_without_cas** | if the application needs the cas or not | true |
| **assertion\_manager\_url** | URL to the assertion manager used | https://gazelle.ihe.net/AssertionManagerGui |
| **attachement\_files\_directory** | file directory on the server, where documnent uploaded and downloaded will be saved | /opt/XDStarClient/attachments/ |
| **avoid\_nist\_validation\_ihe** | set to false when validation using the nist validator is performed | true |
| **birthdate** | used for initialization for XCPD request | 19501201 |
| **Cache-Control** | security parameter | private, no-cache, no-store, must-revalidate, max-age=0 |
-| **cas\_url** | link to the SSO cas | https://gazelle.ihe.net/cas |
| **cda\_mbv\_wsdl** | link to the CDA MBV tool ws | https://gazelle.ihe.net/CDAGenerator-CDAGenerator-ejb/CDAValidatorWS?wsdl |
| **cda\_mbv\_xslt** | link to the stylesheet to render the result of validation of a CDA document | https://gazelle.ihe.net/xsl/mbcdaDetailedResult.xsl |
| **cda\_xsl\_path** | link to the stylesheet to render a cda document | cda.xsl |
@@ -236,8 +234,6 @@ If the deployment and the database initialization are successful you should see
| **homeCommunityID** | used by the XSD.b requests | 1.3.6.1.4.1.12559.11.13.2.3 |
| **home\_root\_oid** | used by the XSD.b requests | 1.3.6.1.4.1.12559.11.13.2.4 |
| **ihe\_source\_root\_oid** | used by the XSD.b requests | 1.3.6.1.4.1.12559.11.13.2.5 |
-| **ip\_login** | used to confirm if the connexion is done using a cas or an ip authentification | true |
-| **ip\_login\_admin** | list of accepted ip address | .\* |
| **key\_alias** | the alias of the keystore used for ssh connexion with responders | tomcat |
| **key\_pass** | password of the key | password |
| **keystore\_pass** | password of the keystore | password |
@@ -270,3 +266,15 @@ If the deployment and the database initialization are successful you should see
| **X-Frame-Options** | security parameter | SAMEORIGIN |
| **X-WebKit-CSP** | security parameter | Use X-Content-Security-Policy values |
| **X-WebKit-CSP-Report-Only** | security parameter | Use X-Content-Security-Policy-Report-Only values |
+
+## SSO Configuration
+
+There are additional preferences to configure the SSO authentication.
+
+| Preference name | Description | Example of value |
+| ---------------- | ---------------------------------------------------------------------- | ---------------- |
+| **cas_enabled** | Enable or disable the CAS authentication. | true |
+| **ip_login** | Enable authentication by IP address matching `ip_login_admin` regex. | false |
+| **ip_login_admin** | Regex to authorize ip authentication if CAS authentication is disabled. | .* |
+
+For more documentation about SSO configurations, follow the link [here](https://gitlab.inria.fr/gazelle/public/framework/sso-client-v7/-/blob/master/cas-client-v7/README.md).
\ No newline at end of file
diff --git a/XDStar-Client/release-note.md b/XDStar-Client/release-note.md
index 3d56169a92dfb5c93a294fa4f9c7b01be567941b..318d7798b3971a9fb714b4d6704b2d80bb4c92f9 100755
--- a/XDStar-Client/release-note.md
+++ b/XDStar-Client/release-note.md
@@ -1,13 +1,40 @@
---
title: Release note
subtitle: XDStarClient
-toolversion: 2.5.11
-releasedate: 2022-11-23
+toolversion: 3.0.0
+releasedate: 2024-02-06
author: Anne-Gaëlle BERGE
function: Software Engineer
customer: IHE Europe
reference: KER1-RNO-IHE-XDSTARCLIENT
---
+# 3.0.0
+_Release date: 2024-02-06_
+
+Context : Gazelle User Management Renovation step 2
+
+__Task__
+* \[[XDSTAR-770](https://gazelle.ihe.net/jira/browse/XDSTAR-770)\] Integrate new sso-client-v7
+* \[[XDSTAR-772](https://gazelle.ihe.net/jira/browse/XDSTAR-772)\] Remove username display in GUI
+
+# 2.5.14
+_Release date: 2023-07-04_
+
+__Bug__
+* \[[XDSTAR-769](https://gazelle.ihe.net/jira/browse/XDSTAR-769)\] Delete empty transactions
+
+# 2.5.13
+_Release date: 2023-06-27_
+
+__Task__
+* \[[XDSTAR-768](https://gazelle.ihe.net/jira/browse/XDSTAR-768)\] Implement new CH Ordinance 15042023 for XDS.b and XDS.I.b
+
+# 2.5.12
+_Release date: 2023-05-25_
+
+__Improvement__
+* \[[XDSTAR-767](https://gazelle.ihe.net/jira/browse/XDSTAR-767)\] Add Xehealth constraints
+
# 2.5.11
_Release date: 2022-11-23_
@@ -34,6 +61,10 @@ __Story__
# 2.5.8
_Release date: 2021-09-19_
+__Bug__
+* \[[XDSTAR-775](https://gazelle.ihe.net/jira/browse/XDSTAR-775)\] [eHS][XDS.b] ITI-18 validator - $MetadataLevel shall equal to 1
+* \[[XDSTAR-776](https://gazelle.ihe.net/jira/browse/XDSTAR-776)\] [eHS][XDS.b] ITI-41 validator - DocumentEntry.Title should be mandatory
+
__Story__
* \[[XDSTAR-763](https://gazelle.ihe.net/jira/browse/XDSTAR-763 )\] Swiss adaptations 3.1
diff --git a/XDStar-Client/user.md b/XDStar-Client/user.md
index 86364135622ec6751674ea2cc9d5b529c5b5d1bb..62a9c362f345f2967ebc0b24dba5b44da3bd4909 100755
--- a/XDStar-Client/user.md
+++ b/XDStar-Client/user.md
@@ -1,8 +1,8 @@
---
title: User Manual
subtitle: XD* Client
-author: Hilary RAMANANTSALAMA
-date: 14/10/2019
+author: Nicolas BAILLIET
+date: 28/06/2023
toolversion: 2.5.x
function: Engineer
version: 1.03
@@ -13,7 +13,7 @@ customer: IHE-EUROPE
# Introduction
-XDStarClient is a tool developped by IHE-Europe / Gazelle team to simulate initiators of the XD\* profiles.
+XDStarClient is a tool developed by IHE-Europe / Gazelle team to simulate initiators of the XD\* profiles.
Below are listed the transactions supported by the tool, as initiator :
diff --git a/XDW-Simulator/installation.md b/XDW-Simulator/installation.md
index 9f2f71015e0ea0beea9215cfa6988326d31558e4..bd5e78d04d489c00f9b156a1e170c6d06a2ac13f 100755
--- a/XDW-Simulator/installation.md
+++ b/XDW-Simulator/installation.md
@@ -21,10 +21,10 @@ To get the artifact on Nexus browse: [*https://gazelle.ihe.net/nexus/index.html#
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 Maven profile to customize your build.
-Checkout the latest tag available on Inria’s forge:
+Checkout the latest tag available on Inria’s gitlab:
```bash
-svn co svn checkout https://svn.ihe-europe.net/gazelle/Maven/simulators/XDWSimulator/tags/XDWSimulator-versionName
+git clone https://gitlab.inria.fr/gazelle/public/simulation/xdw-simulator
```
1. \[Optional\] Edit the pom.xml file and create a new profile
@@ -184,7 +184,6 @@ Use the Administration menu, you will find a sub-menu entitied "Configure applic
| application\_issue\_tracker\_url | URL of the helpdesk or project for XDW Simulator in your bug tracker tool | [*Link to JIRA*](https://gazelle.ihe.net/jira/browse/XDW)|
| application\_release\_note\_url | URL to the release note in JIRA (or elsewhere) | [*Link to JIRA*](https://gazelle.ihe.net/jira/browse/XDW)|
| application\_url | The URL used by any user to access the tool. The application needs it to build permanent links inside the tool| https://publicUrlOfJboss/XDWSimulator |
-| application\_works\_without\_cas | Tells the application how users are authenticated | True: all users are granted as admin<br>False: uses a CAS service to authenticate users|
| contact\_email | The email address of the person to be contacted by the user in case help is needed | - |
| contact\_name | The name of the person to be contacted by the user in case help is needed | - |
| contact\_title | The title of the person to be contacted by the user in case help is needed | - |
@@ -194,6 +193,18 @@ Use the Administration menu, you will find a sub-menu entitied "Configure applic
| evs_url | URL to EVS Client | [*EVSClient URL*](https://gazelle.ihe.net/EVSClient)|
| xdw_xslt_viewer | Location of the XSL file used to display the XDW files | [*XSL URL*] https://gazelle.ihe.net/xsl/XDW.xsl |
+### SSO Configuration
+
+There are additional preferences to configure the SSO authentication.
+
+| Preference name | Description | Example of value |
+| ---------------- | ---------------------------------------------------------------------- | ---------------- |
+| **cas_enabled** | Enable or disable the CAS authentication. | true |
+| **ip_login** | Enable authentication by IP address matching `ip_login_admin` regex. | false |
+| **ip_login_admin** | Regex to authorize ip authentication if CAS authentication is disabled. | .* |
+
+For more documentation about SSO configurations, follow the link [here](https://gitlab.inria.fr/gazelle/public/framework/sso-client-v7/-/blob/master/cas-client-v7/README.md).
+
### 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.
diff --git a/XDW-Simulator/release-note.md b/XDW-Simulator/release-note.md
index 4621e0babb40781e68766938c2bb8b8f03bf220b..0027f449ba53c78f1262f886f5abf0528e06dd29 100755
--- a/XDW-Simulator/release-note.md
+++ b/XDW-Simulator/release-note.md
@@ -1,13 +1,23 @@
---
title: Release note
subtitle: XDW Simulator
-toolversion: 2.1.0
-releasedate: 2019-03-15
+toolversion: 3.0.0
+releasedate: 2024-02-06
author: Anne-Gaëlle BERGE
function: Software Engineer
customer: IHE Europe
reference: KER1-RNO-IHE-XDWSimulator
---
+
+# 3.0.0
+_Release date: 2024-02-06_
+
+Context : Gazelle User Management Renovation step 2
+
+__Improvement__
+* \[[XDW-129](https://gazelle.ihe.net/jira/browse/XDW-129)\] Integrate new sso-client-v7
+* \[[XDW-130](https://gazelle.ihe.net/jira/browse/XDW-130)\] Remove username display in GUI
+
# 2.1.0
_Release date: 2019-03-15_
diff --git a/_templates/jekyll-gazelle-documentation/.gitignore b/_templates/jekyll-gazelle-documentation/.gitignore
index 45c150536e5f3888554c294f27539c5d41072467..8092feb253d2084e86f539d7a50f04d4b720c91d 100755
--- a/_templates/jekyll-gazelle-documentation/.gitignore
+++ b/_templates/jekyll-gazelle-documentation/.gitignore
@@ -1,3 +1,5 @@
_site
.sass-cache
+.jekyll-cache
.jekyll-metadata
+vendor/
diff --git a/_templates/jekyll-gazelle-documentation/Gemfile b/_templates/jekyll-gazelle-documentation/Gemfile
index 109959e849cd71c587dd24b399af5710fe07e812..0b018b53b203824efb8e43be8f57a949bb2fcf7c 100755
--- a/_templates/jekyll-gazelle-documentation/Gemfile
+++ b/_templates/jekyll-gazelle-documentation/Gemfile
@@ -9,16 +9,28 @@ ruby RUBY_VERSION
#
# This will help ensure the proper Jekyll version is running.
# Happy Jekylling!
-gem "jekyll", "3.2.1"
-
+gem "jekyll", "~> 4.2.2"
# This is the default theme for new Jekyll sites. You may change this to anything you like.
-gem "minima"
-
+# gem "minima", "~> 2.5"
# If you want to use GitHub Pages, remove the "gem "jekyll"" above and
# uncomment the line below. To upgrade, run `bundle update github-pages`.
# gem "github-pages", group: :jekyll_plugins
# If you have any plugins, put them here!
-# group :jekyll_plugins do
-# gem "jekyll-github-metadata", "~> 1.0"
-# end
+group :jekyll_plugins do
+ gem "jekyll-feed", "~> 0.12"
+end
+
+# Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem
+# and associated library.
+platforms :mingw, :x64_mingw, :mswin, :jruby do
+ gem "tzinfo", "~> 1.2"
+ gem "tzinfo-data"
+end
+
+# Performance-booster for watching directories on Windows
+gem "wdm", "~> 0.1.1", :platforms => [:mingw, :x64_mingw, :mswin]
+
+# Lock `http_parser.rb` gem to `v0.6.x` on JRuby builds since newer versions of the gem
+# do not have a Java counterpart.
+gem "http_parser.rb", "~> 0.6.0", :platforms => [:jruby]
diff --git a/_templates/jekyll-gazelle-documentation/Gemfile.lock b/_templates/jekyll-gazelle-documentation/Gemfile.lock
old mode 100755
new mode 100644
index 0e0bfcb43c8da37eb5a129ae174e25d2713e8d47..c6aa30893062c870039f4f3c78d6491268186691
--- a/_templates/jekyll-gazelle-documentation/Gemfile.lock
+++ b/_templates/jekyll-gazelle-documentation/Gemfile.lock
@@ -1,48 +1,77 @@
GEM
remote: https://rubygems.org/
specs:
+ addressable (2.8.4)
+ public_suffix (>= 2.0.2, < 6.0)
colorator (1.1.0)
- ffi (1.9.14)
+ concurrent-ruby (1.2.2)
+ em-websocket (0.5.3)
+ eventmachine (>= 0.12.9)
+ http_parser.rb (~> 0)
+ eventmachine (1.2.7)
+ ffi (1.15.5)
forwardable-extended (2.6.0)
- jekyll (3.2.1)
+ http_parser.rb (0.8.0)
+ i18n (1.14.1)
+ concurrent-ruby (~> 1.0)
+ jekyll (4.2.2)
+ addressable (~> 2.4)
colorator (~> 1.0)
- jekyll-sass-converter (~> 1.0)
- jekyll-watch (~> 1.1)
- kramdown (~> 1.3)
- liquid (~> 3.0)
- mercenary (~> 0.3.3)
+ em-websocket (~> 0.5)
+ i18n (~> 1.0)
+ jekyll-sass-converter (~> 2.0)
+ jekyll-watch (~> 2.0)
+ kramdown (~> 2.3)
+ kramdown-parser-gfm (~> 1.0)
+ liquid (~> 4.0)
+ mercenary (~> 0.4.0)
pathutil (~> 0.9)
- rouge (~> 1.7)
+ rouge (~> 3.0)
safe_yaml (~> 1.0)
- jekyll-sass-converter (1.4.0)
- sass (~> 3.4)
- jekyll-watch (1.5.0)
- listen (~> 3.0, < 3.1)
- kramdown (1.12.0)
- liquid (3.0.6)
- listen (3.0.8)
- rb-fsevent (~> 0.9, >= 0.9.4)
- rb-inotify (~> 0.9, >= 0.9.7)
- mercenary (0.3.6)
- minima (1.2.0)
- pathutil (0.14.0)
+ terminal-table (~> 2.0)
+ jekyll-feed (0.17.0)
+ jekyll (>= 3.7, < 5.0)
+ jekyll-sass-converter (2.2.0)
+ sassc (> 2.0.1, < 3.0)
+ jekyll-watch (2.2.1)
+ listen (~> 3.0)
+ kramdown (2.4.0)
+ rexml
+ kramdown-parser-gfm (1.1.0)
+ kramdown (~> 2.0)
+ liquid (4.0.4)
+ listen (3.8.0)
+ rb-fsevent (~> 0.10, >= 0.10.3)
+ rb-inotify (~> 0.9, >= 0.9.10)
+ mercenary (0.4.0)
+ pathutil (0.16.2)
forwardable-extended (~> 2.6)
- rb-fsevent (0.9.7)
- rb-inotify (0.9.7)
- ffi (>= 0.5.0)
- rouge (1.11.1)
- safe_yaml (1.0.4)
- sass (3.4.22)
+ public_suffix (5.0.3)
+ rb-fsevent (0.11.2)
+ rb-inotify (0.10.1)
+ ffi (~> 1.0)
+ rexml (3.2.5)
+ rouge (3.30.0)
+ safe_yaml (1.0.5)
+ sassc (2.4.0)
+ ffi (~> 1.9)
+ terminal-table (2.0.0)
+ unicode-display_width (~> 1.1, >= 1.1.1)
+ unicode-display_width (1.8.0)
PLATFORMS
- ruby
+ x86_64-linux
DEPENDENCIES
- jekyll (= 3.2.1)
- minima
+ http_parser.rb (~> 0.6.0)
+ jekyll (~> 4.2.2)
+ jekyll-feed (~> 0.12)
+ tzinfo (~> 1.2)
+ tzinfo-data
+ wdm (~> 0.1.1)
RUBY VERSION
- ruby 2.2.2p95
+ ruby 2.7.0p0
BUNDLED WITH
- 1.17.3
+ 2.4.16
diff --git a/_templates/jekyll-gazelle-documentation/_config.yml b/_templates/jekyll-gazelle-documentation/_config.yml
index b387ecad3520bcd0d754e24913f7c68b4603d90f..47abb63ce6eef0c8637a53141c16046ea0ce5b11 100755
--- a/_templates/jekyll-gazelle-documentation/_config.yml
+++ b/_templates/jekyll-gazelle-documentation/_config.yml
@@ -6,23 +6,27 @@
# feature for the data you need to update frequently.
#
# For technical reasons, this file is *NOT* reloaded automatically when you use
-# 'jekyll serve'. If you change this file, please restart the server process.
-
+# 'bundle exec jekyll serve'. If you change this file, please restart the server process.
+#
+# If you need help with YAML syntax, here are some quick references for you:
+# https://learn-the-web.algonquindesign.ca/topics/markdown-yaml-cheat-sheet/#yaml
+# https://learnxinyminutes.com/docs/yaml/
+#
# Site settings
# These are used to personalize your new site. If you look in the HTML files,
# you will see them accessed via {{ site.title }}, {{ site.email }}, and so on.
# You can create any custom variable you would like, and they will be accessible
# in the templates via {{ site.myvariable }}.
+
title: Gazelle documentation
email: contact@gazelle.ihe.net
description: >
- This site contains gazelle platform tools documentation
+ Documentation of Gazelle platform and tools.
baseurl: "/gazelle-documentation" # the subpath of your site, e.g. /blog
url: "" # the base hostname & protocol for your site
# Build settings
markdown: kramdown
-theme: minima
defaults:
-
diff --git a/_templates/jekyll-gazelle-documentation/_includes/warning.html b/_templates/jekyll-gazelle-documentation/_includes/warning.html
new file mode 100644
index 0000000000000000000000000000000000000000..ed1e9508a5b9d32eb29b4761d4691c5d69bb3d2d
--- /dev/null
+++ b/_templates/jekyll-gazelle-documentation/_includes/warning.html
@@ -0,0 +1,3 @@
+<div class="alert alert-warning" role="alert">
+ <i class="fa fa-warning"></i>{{ include.content }}
+</div>
diff --git a/_templates/jekyll-gazelle-documentation/static/fonts/fontawesome-webfont.ttf b/_templates/jekyll-gazelle-documentation/static/fonts/fontawesome-webfont.ttf
new file mode 100644
index 0000000000000000000000000000000000000000..d7994e13086b1ac1a216bd754c93e1bccd65f237
Binary files /dev/null and b/_templates/jekyll-gazelle-documentation/static/fonts/fontawesome-webfont.ttf differ
diff --git a/_templates/jekyll-gazelle-documentation/static/fonts/fontawesome-webfont.woff b/_templates/jekyll-gazelle-documentation/static/fonts/fontawesome-webfont.woff
new file mode 100644
index 0000000000000000000000000000000000000000..6fd4ede0f30f170eecb4156beb7235bf01fff00b
Binary files /dev/null and b/_templates/jekyll-gazelle-documentation/static/fonts/fontawesome-webfont.woff differ
diff --git a/_templates/jekyll-gazelle-documentation/static/fonts/fontawesome-webfont.woff2 b/_templates/jekyll-gazelle-documentation/static/fonts/fontawesome-webfont.woff2
new file mode 100644
index 0000000000000000000000000000000000000000..5560193ccc5d768df40766ba54491f1822ed683c
Binary files /dev/null and b/_templates/jekyll-gazelle-documentation/static/fonts/fontawesome-webfont.woff2 differ