diff --git a/Assertion-Manager/installation.md b/Assertion-Manager/installation.md index 4cd4e94453ac59686c25a044762a68b94353ed94..5b80a7117d0aeffa07fc7a50d13f73bf799799a2 100755 --- a/Assertion-Manager/installation.md +++ b/Assertion-Manager/installation.md @@ -40,6 +40,18 @@ It will: * Get the latest released version of Assertion Manager and deploy it in your JBoss server. * Create the database if it doesn't exist. +## Deployment +To deploy Assertion Manager: +1. Paste the archive **AssertionManagerGui.ear** in the JBoss deployment directory `${JBOSS7\_HOME}/standalone/deployments/` +2. Display JBoss server logs, start JBoss and wait for **ear** deployment. +3. The application can be browsed at http://localhost:8080/AssertionManagerGui. *Port could also be different whether you have modified the JBoss configuration*. +4. **WARNING** : From version 4.2.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 AssertionManager-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). + +Datasource name : AssertionManagerBaseDS + +Database name : assertion-manager + ## Insert configuration values Configuration can be done through the Administration interface or with an sql script. diff --git a/Assertion-Manager/release-note.md b/Assertion-Manager/release-note.md index 8d3123db7a5d19c635ca4037685a9cbee7a42211..c2d8f06f9f6669183d86c48b5e23f0154674bae2 100644 --- a/Assertion-Manager/release-note.md +++ b/Assertion-Manager/release-note.md @@ -1,13 +1,27 @@ --- title: Release note subtitle: Assertion Manager -toolversion: 4.1.0 -releasedate: 2018-06-06 +toolversion: 4.2.0 +releasedate: 2020-10-29 author: Anne-Gaëlle BERGE function: Software Engineer customer: IHE Europe -reference: KER1-RNO-IHE-ORDER_MANAGER +reference: KER1-RNO-IHE-ASSERTION_MANAGER --- +# 4.2.0 +_Release date: 2020-10-29_ + +__Bug__ +* \[[AM-257](https://gazelle.ihe.net/jira/browse/AM-257)\] NPE while trying to save an assertion in review mode +* \[[AM-272](https://gazelle.ihe.net/jira/browse/AM-272)\] Applies to entities not updated in assertions table when removing links +* \[[AM-273](https://gazelle.ihe.net/jira/browse/AM-273)\] Navigating between pages in both Assertions Menu and review mode doesn't work + +__Improvement__ +* \[[AM-258](https://gazelle.ihe.net/jira/browse/AM-258)\] Extract datasource configuration +* \[[AM-259](https://gazelle.ihe.net/jira/browse/AM-259)\] Update SQL scripts archive + + + # 4.1.0 _Release date: 2018-06-06_ diff --git a/EPR-ATC-Simulator/release-note.md b/EPR-ATC-Simulator/release-note.md index 30281720db01e1a8d668c8b93f894628b88b9e2f..81b1eeb425c099eedde4100d396f06dc34a509fd 100644 --- a/EPR-ATC-Simulator/release-note.md +++ b/EPR-ATC-Simulator/release-note.md @@ -1,13 +1,21 @@ --- title: Release note subtitle: ATC Simulator -toolversion: 1.3.3 -releasedate: 2020-03-18 +toolversion: 1.3.4 +releasedate: 2020-10-18 author: Youn Cadoret function: Software Engineer customer: IHE Europe reference: KER1-RNO-IHE-ATC_SIMULATOR --- + +# 1.3.4 +_Release date: 2020-10-08_ + +__Bug__ +* \[[ATCREPO-21](https://gazelle.ihe.net/jira/browse/ATCREPO-21)\] CH:ATC Simulator - Invalid EprDocumentTypeCode in Response + + # 1.3.3 _Release date: 2020-03-18_ diff --git a/EPR-Access-Token-Provider/installation.md b/EPR-Access-Token-Provider/installation.md new file mode 100644 index 0000000000000000000000000000000000000000..409f119c35834790a07315f5654525acc4691a8f --- /dev/null +++ b/EPR-Access-Token-Provider/installation.md @@ -0,0 +1,75 @@ +--- +title: Installation Manual +subtitle: EPR Access Token Provider +author: Wylem Bars +releasedate: 2020-09-21 +toolversion: 1.0.3 +function: Engineer +version: 1.01 +status: Approved document +reference: KER1-MAN-IHE-EPR_ACCESS_TOKEN_PROVIDER_INSTALL +customer: IHE-EUROPE +--- + +# Introduction + +EPR Access Token Provider a Dummy rest service providing Token for IUA transactions used in EPR context. +This tool is used to generate an IUA token in order to perform FHIR based tests between participants. + +# Sources and binaries + +* Sources are available on Inria's GitLab: [https://gitlab.inria.fr/gazelle/applications/test-execution/simulator/access-token-provider](https://gitlab.inria.fr/gazelle/applications/test-execution/simulator/access-token-provider) +* A compiled version is available in the Gazelle Nexus repository, download the [WAR of the latest version](https://gazelle.ihe.net/nexus/#nexus-search;quick~dummy-authorization-server-service). + +# Installation + +## Database + +No database is needed for this tool. + +## Wildfly 18.0.0 + +EPR Access Token Provider runs on a Wildfly 18 server. + +If your do not have yet a Wildfly 18 server, you can install one using the [instructions to install Wildfly 18](../General/wildfly18.html) page. + +## Deployment + +You are now ready to deploy the tool and to start the Jboss server: + +1. Copy the app.dummy-authorization-server-service-1.0.2.war file in the standalone/deployments folder of this new wildfly server. +2. Start Wildfly server (sudo service wildfly-{name} start) + +# Configuration + +## Audience + +Audience used by the tool are configured in a __.properties__ file. It needs to be configured in the Wildfly server under JNDI name +__java:/app/gazelle/audience-retriever/operational-preferences__. The file content shall resemble something like : + +``` +audience1=secret1 +audience2=secret2 +``` + +To be able to access the file from the application you need to : + +1. Install the __factories__ module available [here](https://gazelle.ihe.net/wildfly18/factories.jar) in your Wildfly. See +[Install or update PostgreSQL JDBC driver](../General/wildfly18.html#install-or-update-postgresql-jdbc-driver) section from the Wildfly18 +Gazelle documentation for more information on how to install the module. +2. Add this configuration to your standalone.xml in the __urn:jboss:domain:naming:2.0__ subsystem : + +```xml +<subsystem xmlns="urn:jboss:domain:naming:2.0"> + <bindings> + <object-factory name="java:/app/gazelle/audience-retriever/operational-preferences" module="net.ihe.gazelle.factories" class="net.ihe.gazelle.factories.PropertiesFactory"> + <environment> + <property name="path" value="{path}/audience.properties"/> + </environment> + </object-factory> + </bindings> + <remote-naming/> +</subsystem> +``` + +{path} can be any path you want on your file system. \ No newline at end of file diff --git a/EPR-Access-Token-Provider/release-note.md b/EPR-Access-Token-Provider/release-note.md index 874f3820830c4d4a0664c02d6b6cbd87ff6fa502..6088516eeb7e27c9e241b4faa4ad92f82913400d 100644 --- a/EPR-Access-Token-Provider/release-note.md +++ b/EPR-Access-Token-Provider/release-note.md @@ -1,13 +1,20 @@ --- title: Release note subtitle: EPR Access Token Provider -toolversion: 1.0.2 -releasedate: 2020-09-15 +toolversion: 1.0.3 +releasedate: 2020-09-21 author: Wylem BARS function: Software Engineer customer: IHE Europe reference: KER1-RNO-IHE-EPR_ACCESS_TOKEN_PROVIDER --- + +# CH:IUA Access Token Provider 1.0.3 +_Release date: 2020-09-21_ + +__Improvement__ +* \[[IUAINFRA-65](https://gazelle.ihe.net/jira/browse/IUAINFRA-65)\] Add new users to ATP + # CH:IUA Access Token Provider 1.0.2 _Release date: 2020-09-15_ diff --git a/EPR-Access-Token-Provider/user.md b/EPR-Access-Token-Provider/user.md index f6b4ccefab9b963579c0ab8324bacaaaa07e1f70..ae4456f0113e91284879f0929d7e913cdc78e36c 100755 --- a/EPR-Access-Token-Provider/user.md +++ b/EPR-Access-Token-Provider/user.md @@ -3,8 +3,8 @@ title: User Manual subtitle: Access Token Provider author: Wylem BARS function: Developer -releasedate: 02/09/2020 -toolversion: 1.0.1 +releasedate: 2020-09-21 +toolversion: 1.0.3 version: 0.01 status: DRAFT reference: KER1-MAN-IHE-ACCESS_TOKEN_PROVIDER @@ -16,29 +16,52 @@ eHealthSuisse Access Token Provider ----------------------------------------- ehealthSuisse Access Token Provider is a Dummy rest service providing Token for IUA transactions used in EPR context. +This tool is used to generate an IUA token in order to perform FHIR based tests between participants. ### Data Set -#### Available user ID +#### Available user IDs -| User ID | -|----------| -| aamrein | -| aerne | +| User ID | User Role | +|----------|-----------| +| aamrein | PAT | +| aerne | PAT | +| aerne2 | PAT | +| bovie | PAT | +| lavdic | PAT | +| magpar | HCP | +| rspieler | HCP | +| aandrews | HCP | +| ltieche | ASS | -Those are the users for whom token can be generated. +Those are the available users for whom token can be generated. + +#### Audience + +Those are configured in the tool configuration files. Each Audience is represented with an audienceId and a secret value that is used by the tool +to sign issued tokens. ### EndPoint -* [Access Token Provider : https://ehealthsuisse.ihe-europe.net/authorization-server/mock-token](https://ehealthsuisse.ihe-europe.net/authorization-server/mock-token) +* Access Token Provider : [https://ehealthsuisse.ihe-europe.net/authorization-server/mock-token](https://ehealthsuisse.ihe-europe.net/authorization-server/mock-token) + +### Request examples + +Example 1 : using user magpar (role : HCP) + +```https://ehealthsuisse.ihe-europe.net/authorization-server/mock-token?userId=magpar&audienceId=audience``` + +Example 2 : using user aerne (role : patient) + +```https://ehealthsuisse.ihe-europe.net/authorization-server/mock-token?userId=aerne&audienceId=audience``` -### Request example +Example 3 : using user ltieche (role : ASS) -```https://ehealthsuisse.ihe-europe.net/authorization-server/mock-token?userId=aamrein&audienceId=audience``` +```https://ehealthsuisse.ihe-europe.net/authorization-server/mock-token?userId=ltieche&audienceId=audience``` | Parameter Name | Usage | |-------------|-----------------------------------------------------------------------| | userId | User for whom the token is generated | | audienceId | ID of the audience used to retrieve secret in Gazelle configurations. | -The response body to this request will be the content of the generated token. +The response body to this request will be the content of the generated token. \ No newline at end of file diff --git a/EPR-Assertion-Provider-Simulator/release-note.md b/EPR-Assertion-Provider-Simulator/release-note.md index 85e321e18a31555a4f26df50487bd2af613ff77c..392cf1c4f6dcb82cec8c55574f01e4f4600a72d7 100644 --- a/EPR-Assertion-Provider-Simulator/release-note.md +++ b/EPR-Assertion-Provider-Simulator/release-note.md @@ -1,13 +1,30 @@ --- title: Release note subtitle: Assertion Provider Simulator -toolversion: 1.1.7 -releasedate: 2020-03-05 +toolversion: 1.1.9 +releasedate: 2020-10-08 author: Malo TOUDIC function: Software developer customer: IHE-Europe reference: KER1-RNO-IHE-ASSERTION_PROVIDER_SIMULATOR --- + +# 1.1.9 +_Release date: 2020-10-08_ + +__Bug__ +* \[[APS-15](https://gazelle.ihe.net/jira/browse/APS-15)\] Update the location of the faultcode in the XUA mockup + + + +# 1.1.8 +_Release date: 2020-09-24_ + +__Bug__ +* \[[APS-14](https://gazelle.ihe.net/jira/browse/APS-14)\] AppliesTo is not a mandatory element in the SAML assertion + + + # 1.1.7 _Release date: 2020-03-05_ diff --git a/EVS-Client/release-note.md b/EVS-Client/release-note.md index 460db301e80d338ad1770d14a24167dfef536226..497198ed8e28baeb84963744778c42f989273602 100644 --- a/EVS-Client/release-note.md +++ b/EVS-Client/release-note.md @@ -1,13 +1,21 @@ --- title: Release note subtitle: EVS Client -toolversion: 5.12.2 -date: 2020-02-14 +toolversion: 5.12.3 +date: 2020-10-16 author: Anne-Gaëlle BERGE function: Software Engineer customer: IHE Europe reference: KER1-RNO-IHE-EVS_CLIENT --- +# 5.12.3 +_Release date: 2020-10-16_ + +## Gazelle X Validation 1.4.3 + +__Bug__ + +* \[[XVAL-168](https://gazelle.ihe.net/jira/browse/XVAL-168)\] Unit test file uploading is not working in partitioned environment # 5.12.2 _Release date: 2020-02-14_ diff --git a/Gazelle-FHIR-Validator/installation.md b/Gazelle-FHIR-Validator/installation.md index fd89f672a5a70bb643b7bd7629846b117c60020f..7772e46649291816a37ac50a259694b04b651f92 100644 --- a/Gazelle-FHIR-Validator/installation.md +++ b/Gazelle-FHIR-Validator/installation.md @@ -2,8 +2,8 @@ title: Installation Manual subtitle: Gazelle FHIR Validator author: Wylem Bars -date: 10/09/2020 -toolversion: 4.1.0 +releasedate: 2020-09-23 +toolversion: 4.1.2 function: Engineer version: 2.01 status: Approved document diff --git a/Gazelle-FHIR-Validator/release-note.md b/Gazelle-FHIR-Validator/release-note.md index 5f5502509c018f3610c462aff13937db1b17568d..97c46afdc52cc16dd8de3c9a93273a24608cf6e0 100644 --- a/Gazelle-FHIR-Validator/release-note.md +++ b/Gazelle-FHIR-Validator/release-note.md @@ -1,13 +1,27 @@ --- title: Release note subtitle: Gazelle FHIR Validator -toolversion: 4.1.0 -releasedate: 2020-09-11 +toolversion: 4.1.2 +releasedate: 2020-09-23 author: Anne-Gaëlle BERGE function: Software Engineer customer: IHE Europe reference: KER1-RNO-IHE-GAZELLE_FHIR_VALIDATOR --- + +# 4.1.2 +_Release date: 2020-09-23_ + +__Bug__ +* \[[FHIRVAL-125](https://gazelle.ihe.net/jira/browse/FHIRVAL-125)\] Validation report not returned when error is raised by IG Server + +# 4.1.1 +_Release date: 2020-09-15_ + +__Bug__ +* \[[FHIRVAL-122](https://gazelle.ihe.net/jira/browse/FHIRVAL-122)\] POST does not contain Content-Type header when calling IG Server + + # 4.1.0 _Release date: 2020-09-11_ diff --git a/Gazelle-FHIR-Validator/user.md b/Gazelle-FHIR-Validator/user.md index 3a7432ab66cd760781ab2a08b729c5b287ad2cf7..c99031bd5de4d2d6b59aea8825c4460fb6e8ba59 100755 --- a/Gazelle-FHIR-Validator/user.md +++ b/Gazelle-FHIR-Validator/user.md @@ -2,8 +2,8 @@ title: User Manual subtitle: Gazelle FHIR Validator author: Wylem Bars -date: 02/09/2019 -toolversion: 3.x.x +releasedate: 2020-09-23 +toolversion: 4.1.2 function: Engineer version: 1.03 status: Approved document @@ -15,7 +15,7 @@ customer: IHE-EUROPE This tool owns the validator for the messages defined in the IHE profiles based on FHIR. Two types of messages are validated: * The requests (URLs) are parsed and validating using an in-house algorithm, based on a template defined by the test designer from the user interface. -* The FHIR resrouces are validated in three steps: +* The FHIR resources are validated in three steps: * Is the message a valid XML or JSON document * Does the message complies with the FHIR requirements * Does the message complies with IHE requirements (uses the structure definitions published by IHE or other domains) diff --git a/Gazelle-HL7-Validator/user.md b/Gazelle-HL7-Validator/user.md index d23e74a61bd64a4050bb6491c86fda635bb48804..ee85526f4913e206419ae965157b65c4ef39e74b 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: 13/05/2019 -toolversion: 3.5.x +date: 16/09/2020 +toolversion: 3.6.x version: 1.04 status: Approved document reference: KER1-MAN-IHE-GAZELLE_HL7_VALIDATOR_USER-1_04 diff --git a/Gazelle-Webservice-Tester/installation.md b/Gazelle-Webservice-Tester/installation.md index ed6b99d9ce4bcdb4bf8bfefd6058b85c404ec6f4..09d1c054b7950aa7ef1a0182a59d9f9879d5b2df 100644 --- a/Gazelle-Webservice-Tester/installation.md +++ b/Gazelle-Webservice-Tester/installation.md @@ -4,7 +4,7 @@ subtitle: Gazelle Webservice Tester author: Malo TOUDIC function: Software developer date: 05/03/2019 -toolversion: 1.6.x +toolversion: 1.7.x version: 1.02 status: Approved document reference: KER1-MAN-IHE-GAZELLE_WEBSERVICE_TESTER_USER diff --git a/Gazelle-Webservice-Tester/release-note.md b/Gazelle-Webservice-Tester/release-note.md index 577aae5c31c4e3d6e426bf97f8bac02aa96e68d7..b999c557d8fcac7703b66e628692bb9cf5346315 100644 --- a/Gazelle-Webservice-Tester/release-note.md +++ b/Gazelle-Webservice-Tester/release-note.md @@ -1,15 +1,22 @@ --- title: Release note subtitle: Gazelle Webservice Tester -toolversion: 1.7.2 -releasedate: 2020-09-15 +toolversion: 1.7.3 +releasedate: 2020-09-17 author: Malo TOUDIC function: Software developer customer: IHE-Europe reference: KER1-RNO-IHE-GAZELLE_WEBSERVICE_TESTER --- +# 1.7.3 +_Release date: 2020-09-17_ + +__Improvement__ +* \[[GWT-143](https://gazelle.ihe.net/jira/browse/GWT-143)\] Improve performance on Execution Result Display + + # 1.7.2 -__Release date: 2020-09-15_ +_Release date: 2020-09-15_ __Improvement__ * \[[GWT-137](https://gazelle.ihe.net/jira/browse/GWT-137)\]GWT doesn't display the POST element for REST requests diff --git a/HPD-Simulator/installation.md b/HPD-Simulator/installation.md index 129c8232c19b2c7612787ab2dc39cbb7151f640d..21a059fa85bca804862f06a95eb815f3e5760bd2 100755 --- a/HPD-Simulator/installation.md +++ b/HPD-Simulator/installation.md @@ -1,9 +1,9 @@ --- title: Installation manual -subtitle: HPD Simulatorœ +subtitle: HPD Simulator author: Anne-Gaëlle BERGE function: Engineer -date: 02/09/2016 +date: 16/09/2020 toolversion: 2.2.x version: 1.02 status: Approved document diff --git a/HPD-Simulator/user.md b/HPD-Simulator/user.md index 6ca57eaa5738adbd68f65ab0a27a7938e929208d..55f1ddca1ab6f0425f182e272449e5be89573e8b 100644 --- a/HPD-Simulator/user.md +++ b/HPD-Simulator/user.md @@ -3,8 +3,8 @@ title: User manual subtitle: HPD Simulator author: Anne-Gaëlle BERGE function: Engineer -date: 02/09/2016 -toolversion: 2.1.2 +date: 16/09/2020 +toolversion: 2.2.2 version: 1.02 status: Approved document reference: KER1-MAN-IHE-HPD_SIMULATOR_USER-1_02 diff --git a/Patient-Manager/installation.md b/Patient-Manager/installation.md index 0ac6989e720e048fdcc761279ce188dbe9ddbdc8..464f0f347ae242b2dbf27a0b9d4605c4ac611f67 100755 --- a/Patient-Manager/installation.md +++ b/Patient-Manager/installation.md @@ -2,8 +2,8 @@ title: Installation Manual subtitle: Patient Manager author: Anne-Gaëlle BERGE -date: 15/05/2019 -toolversion: 9.11.X +releasedate: 2020-09-22 +toolversion: 9.12.X function: Engineer version: 1.07 status: Approved document diff --git a/Patient-Manager/release-note.md b/Patient-Manager/release-note.md index acac6b0687350bbac3431d048f7b6717a7223e3a..78edc27bd929fa9e1f7e0b526ab86d480ee9b0db 100644 --- a/Patient-Manager/release-note.md +++ b/Patient-Manager/release-note.md @@ -1,14 +1,21 @@ --- title: Release note subtitle: PatientManager -toolversion: 9.12.0 -releasedate: 2020-07-27 +toolversion: 9.12.1 +releasedate: 2020-09-22 author: Anne-Gaëlle BERGE function: Software Engineer customer: IHE Europe reference: KER1-RNO-IHE-PATIENT_MANAGER --- +# 9.12.1 +_Release date: 2020-09-22_ + +__Bug__ +* \[[PAM-719](https://gazelle.ihe.net/jira/browse/PAM-719)\] PAMSimulator does not handle incomming ITI-44 when patient.id is duplicated +* \[[PAM-721](https://gazelle.ihe.net/jira/browse/PAM-721)\] STUDY-PatientManager as Responding Gateway returns more patients than requested + # 9.12.0 _Release date: 2020-07-27_ diff --git a/Patient-Manager/user.md b/Patient-Manager/user.md index 72c2c01714eb675f1beb34d085dc87c31404b82c..18a79ebd556c3f84db8b5e418262e847b2f53cc0 100644 --- a/Patient-Manager/user.md +++ b/Patient-Manager/user.md @@ -2,8 +2,8 @@ title: User Manual subtitle: Patient Manager author: Anne-Gaëlle BERGE -date: 25/01/2018 -toolversion: 9.11.x +releasedate: 2020-09-22 +toolversion: 9.12.x function: Engineer version: 2.05 status: Approved document diff --git a/Patient-Registry/installation.md b/Patient-Registry/installation.md index 4f18d47cfd20b0a636951a0b488899d4f62da89d..856d61c67f2adf7fbea4c8c649433cf80bd63b72 100755 --- a/Patient-Registry/installation.md +++ b/Patient-Registry/installation.md @@ -179,5 +179,5 @@ cp pdqm-connector-X.X.X.war /usr/local/wildfly18/standalone/deployments/pdqm-con ``` Start wildfly. The API can be accessed at (depending on your configured host and port) - * Retrieve : [GET http://localhost:8480/pdqm-simulator/Patient/{id}](http://localhost:8480/pdqm-simulator/Patient/{id}) - * Search : [POST http://localhost:8480/pdqm-simulator/Patient](http://localhost:8480/pdqm-simulator/Patient) \ No newline at end of file + * 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) \ No newline at end of file diff --git a/Test-Management/admin.md b/Test-Management/admin.md index 5f478922a477d47e6e8e81d8fa519cb284e692cd..fb1544d43d65fbc1b0cd2cb8794d7c6911d29a52 100644 --- a/Test-Management/admin.md +++ b/Test-Management/admin.md @@ -3,8 +3,8 @@ title: Administration guide subtitle: Gazelle Test Management author: Guillaume THOMAZON function: Engineer -date: 18/10/2016 -toolversion: 5.12.x +releasedate: 19/10/2020 +toolversion: 5.13.x version: 1.02 status: Approved document reference: KER1-MAN-IHE-TEST_MANAGEMENT_ADMIN-1_02 diff --git a/Test-Management/installation.md b/Test-Management/installation.md index c568962373fa62abcb13a326f0cc15fb79c999c1..5477c5a51e6215e58c054aadc1fbb2b192851831 100755 --- a/Test-Management/installation.md +++ b/Test-Management/installation.md @@ -3,8 +3,8 @@ title: Installation manual subtitle: Gazelle Test Management author: Guillaume THOMAZON function: Engineer -date: 25/03/2019 -toolversion: 5.12.x +releasedate: 19/10/2019 +toolversion: 5.13.x version: 1.02 status: Approved document reference: KER1-MAN-IHE-TEST_MANAGEMENT_INSTALLATION-1_02 @@ -21,7 +21,7 @@ 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 PostGresql 9.1 or higher database. For general considerations regarding the installation of the application server, read [Jboss7 installation guide](../General/jboss7.html). # Sources @@ -49,6 +49,14 @@ Download the file containing all the data required by the application to properl pg_restore -U gazelle -h 127.0.0.1 -d your_database tm-first-import.data ``` +# Graphviz + +Gazelle Test Management need the package graphviz to display graph (Display relations between actors and transactions for a given integration profile) +```bash +sudo apt install graphviz +``` + + # 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. @@ -70,7 +78,7 @@ The archive (EAR) and the distribution file are created and placed into gazelle- Test Management requires JBoss 7.2.0 to have some additional libraries (see pre-requisites section). -Since version 5.10.0, Before you start your Jboss server, you shall configure the datasource at `[YOUR_JBOSS_INSTALL]/standalone/configuration/standalone.xml`. +Since version 5.10.0, Before you start your Jboss server, you shall configure the datasource at `[YOUR_JBOSS_INSTALL]/standalone/configuration/standalone.xml`. Read details in the "Externalize datasources from tool projects" section of [JBoss 7 installation page](../General/jboss7.html). The datasource element to import in the standalone.xml file is available in the [project](https://gazelle.ihe.net/jenkins/view/Test%20Management/job/gazelle-tm-public/ws/gazelle-tm-ear/src/main/datasource/TestManagement-ds.xml). @@ -89,11 +97,11 @@ Once you have copied the content of this file in your Jboss configuration: * min.pool.size = 1 and max.pool.size = 70 for the instance running at EU-CAT outside of connectathon periods and for intances using the __public__ profile * min.pool.size = 1 and max.pool.size = 30 for the Gazelle Master Model * min.pool.size = 1 and max.pool.size = 10 for the Product Registry and other instances - + 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. + +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. diff --git a/Test-Management/media/oid_export_button.png b/Test-Management/media/oid_export_button.png new file mode 100644 index 0000000000000000000000000000000000000000..ea15024947cc98b72523030577557f7b023c5bab Binary files /dev/null and b/Test-Management/media/oid_export_button.png differ diff --git a/Test-Management/media/oid_import_panel.png b/Test-Management/media/oid_import_panel.png new file mode 100644 index 0000000000000000000000000000000000000000..1fa9362ad08c06aade76082e0c0c408682124545 Binary files /dev/null and b/Test-Management/media/oid_import_panel.png differ diff --git a/Test-Management/media/oid_import_report.png b/Test-Management/media/oid_import_report.png new file mode 100644 index 0000000000000000000000000000000000000000..e1f2e9e2f5a68f0b253c551349645ff42cec0748 Binary files /dev/null and b/Test-Management/media/oid_import_report.png differ diff --git a/Test-Management/media/oid_menu.png b/Test-Management/media/oid_menu.png new file mode 100644 index 0000000000000000000000000000000000000000..a2a81ecf452a1b0bb5c6e5b03e98988347b5e116 Binary files /dev/null and b/Test-Management/media/oid_menu.png differ diff --git a/Test-Management/media/samples_export_button.png b/Test-Management/media/samples_export_button.png new file mode 100644 index 0000000000000000000000000000000000000000..8362d522f07903fa28d93d519429699224e5422a Binary files /dev/null and b/Test-Management/media/samples_export_button.png differ diff --git a/Test-Management/media/samples_import_panel.png b/Test-Management/media/samples_import_panel.png new file mode 100644 index 0000000000000000000000000000000000000000..e2a92fe4854a5f1485efbb56bceb1824dd60d424 Binary files /dev/null and b/Test-Management/media/samples_import_panel.png differ diff --git a/Test-Management/media/samples_import_report.png b/Test-Management/media/samples_import_report.png new file mode 100644 index 0000000000000000000000000000000000000000..e8be2e21f5ec4c627c9dfca5f23e121fe9e50f83 Binary files /dev/null and b/Test-Management/media/samples_import_report.png differ diff --git a/Test-Management/media/samples_menu.png b/Test-Management/media/samples_menu.png new file mode 100644 index 0000000000000000000000000000000000000000..fc54ca099aa50462f3ff3f9899b1ae39b6a2f79c Binary files /dev/null and b/Test-Management/media/samples_menu.png differ diff --git a/Test-Management/release-note.md b/Test-Management/release-note.md index 23d5b0fa2a33ba889d6a1a0d2a8cd8ca56fbcece..7405a7b980d5875ad0318c9e57c34529b79ccacb 100644 --- a/Test-Management/release-note.md +++ b/Test-Management/release-note.md @@ -17,6 +17,16 @@ __Remarks__ __Improvement__ * \[[GZL-4947](https://gazelle.ihe.net/jira/browse/GZL-4947)\] CTT Integration +# 5.13.0 +_Release date: 2020-10-19_ + +__Bug__ +* \[[GZL-4909](https://gazelle.ihe.net/jira/browse/GZL-4909)\] Unexpected error on re-login + +__Improvement__ +* \[[GZL-4851](https://gazelle.ihe.net/jira/browse/GZL-4851)\] Import/Export Samples definitions +* \[[GZL-4852](https://gazelle.ihe.net/jira/browse/GZL-4852)\] Import/export OID root definitions + # 5.12.1 _Release date: 2019-09-26_ diff --git a/Test-Management/user.md b/Test-Management/user.md index 8d78c176abcfb136a17c7b032ddaf397f95cddf3..bb8e85ab8d3b060ff6bc35f276291d722e4e66da 100644 --- a/Test-Management/user.md +++ b/Test-Management/user.md @@ -3,8 +3,8 @@ title: User manual subtitle: Gazelle Test Management author: Guillaume THOMAZON function: Engineer -date: 20/05/2019 -toolversion: 5.12.x +releasedate: 19/10/2019 +toolversion: 5.13.x version: 2.01 status: To be verified reference: KER1-MAN-IHE-TEST_MANAGEMENT_USER-2_01 @@ -1604,6 +1604,417 @@ If the __Review Changes before saving__ option is activated, simply click the __ the changes and import them into the Gazelle Test Management instance. If something is not ok with the document, click the __Reset__ button. Changes will not be made on the tools data and you will be able to upload another document. +#### Import/Export of OID Root Definition + +##### Import + +OID Root Definition can be extracted from the Gazelle Test Management instance into an XML file. This file can be later on used to import those OID Root +Definitions in any other instance of the tool. +To do so go to the Administration/Manage/Configurations/OIDs Management menu : + + + +Once you accessed the OID Management page, when accessing the OID Roots tab, you will have the list of all OID Roots for your instance displayed. +To export them simply click the __Export OID Roots__ button. This will create the XML file corresponding to the OID Roots and +automatically downloads it. + + + +Here is an example of what kind of XML file will be generated : + +``` +<?xml version="1.0" encoding="UTF-8" standalone="yes"?> +<oidRootDefinitions> + <oidRootDefinition> + <rootOID>1.3.6.1.4.1.21367.2017.2.3</rootOID> + <lastValue>29</lastValue> + <label> + <label>repositoryUniqueID OID</label> + </label> + <oidRequirements> + <label>repositoryUniqueID OID</label> + <actorIntegrationProfileOptionList> + <actorIntegrationProfile> + <actor> + <keyword>IMG_DOC_SOURCE</keyword> + <name>Imaging Document Source</name> + <description>Publishes imaging data and makes it available for retrieval.</description> + <id>62</id> + </actor> + <integrationProfile> + <keyword>XCA-I</keyword> + <name>Cross-Community Access for Imaging</name> + <description>The Cross-Community Access for Imaging (XCA-I) Integration Profile specifies actors and transactions to query and retrieve patient-relevant medical imaging data being held by other communities. </description> + <id>253</id> + <integrationProfileStatusType> + <keyword>FT</keyword> + <name>Final Text</name> + <description></description> + </integrationProfileStatusType> + <domainsForDP> + <keyword>RAD</keyword> + <name>Radiology</name> + <description>IHE Radiology addresses information sharing, workflow and patient care in radiology, including mammography and nuclear medicine.</description> + <id>1</id> + </domainsForDP> + </integrationProfile> + <profileLinks> + <transaction> + <keyword>RAD-69</keyword> + <name>Retrieve Imaging Doc Set</name> + <description>Retrieve Imaging Doc Set</description> + <id>179</id> + <transactionStatusType> + <keyword>FT</keyword> + <name>Final Text</name> + <description></description> + </transactionStatusType> + <transactionLinks> + <fromActor> + <keyword>RESP_IMG_GATEWAY</keyword> + <name>Responding Imaging Gateway</name> + <description>The responding Imaging Gateway proxies Cross Gateway Retrieve Imaging Document Set requests from an Initiating Imaging Gateway to an Imaging Document Source with an Image Document Set Retrieve request.</description> + <id>1192</id> + </fromActor> + <toActor> + <keyword>IMG_DOC_SOURCE</keyword> + <name>Imaging Document Source</name> + <description>Publishes imaging data and makes it available for retrieval.</description> + <id>62</id> + </toActor> + </transactionLinks> + </transaction> + <transactionOptionType> + <keyword>R</keyword> + <name>Required</name> + <description></description> + </transactionOptionType> + </profileLinks> + </actorIntegrationProfile> + <integrationProfileOption> + <keyword>NONE</keyword> + <name>None</name> + <description>None</description> + <reference></reference> + <toDisplay>true</toDisplay> + </integrationProfileOption> + <maybeSupportive>true</maybeSupportive> + </actorIntegrationProfileOptionList> + <prefix></prefix> + </oidRequirements> + </oidRootDefinition> +</oidRootDefinitions> +``` + +Now with this file, you can import OID Roots into any instance of the tool. + +##### Export + +On the same page, at the bottom you will find a panel titled __Import OID Roots__. + + + +This panel explains the basic rules that are used for OID Roots import : + +* Actor/Integration Profile/Option detection is based on keywords. If one does not appear in the database but is referenced by a requirement, the requirement will be ignored. +* If an OID Root references an unknown label (or no label) it will be ignored +* If an OID Root is already defined for a label, it will not be imported. Additional requirements from the imported file will be added to the already existing requirements. + +You can also see a checkbox for __Review Changes before saving__. This option is activated by default. When activated, a report about the files content +will be displayed as information to the user. The user will then be able to accept the changes and import the OID Roots or cancel the action. If the option +is not activated, the changes will be imported directly in the base. The report will still be displayed but changes have already been made in the database. +The reports sums up what elements were found missing, what Root have been ignored, what Root will be imported and what Root have been found duplicated +and won't be imported. + + + +If the __Review Changes before saving__ option is activated, simply click the __Import OID Roots__ button on the bottom of the report to validate the changes +and import them into the Gazelle Test Management instance. If something is not ok with the uploaded document, just click the __Reset__ button. +Changes will not be made on the tools data and you will be able to upload another document. + + +#### Import/Export of Samples Type + +##### Import + +Samples Type can also be extracted into an XML file. The principle is very similar to what is done with other model elements. +To export Samples Type, go to the Administration > Manage > Samples > Manage Samples menu : + + + +Once you accessed the Samples Administration page, you will have the list of all Samples Type for your instance displayed. Those Samples Type can be +filtered base on their status. To export them simply click the __Export Filtered Samples' Type__ +button. This will create the XML file corresponding to the filtered Samples' Type and automatically downloads it. + + + +Here is an example of what kind of XML file will be generated : + +``` +<?xml version="1.0" encoding="UTF-8" standalone="yes"?> +<objectTypes> + <objectType> + <keyword>GSPS</keyword> + <description>Grey Scale Presentation State</description> + <default_desc><p>Patient ID:</p> +<p>Patient Name:</p> +<p>Your table:</p> +<p>Your name:</p></default_desc> + <instructions><p><span style="border-collapse: collapse; line-height: 12px;">Upload your sample GSPS objects and associated images. See add'l instructions in ...</span></p> +<p><span style="border-collapse: collapse; line-height: 12px;"><strong>Pre-Connectathon test:</strong> MESA test 282 </span></p> +<p><span style="border-collapse: collapse; line-height: 12px;"><strong>Connectathon test</strong> CPI_Store Sample.</span></p> +<p><span style="border-collapse: collapse; line-height: 12px;"><br /></span></p></instructions> + <objectTypeStatus> + <description>The object type can be used</description> + <keyword>ready</keyword> + <labelToDisplay>ready</labelToDisplay> + </objectTypeStatus> + <objectAttributes> + <keyword>Bitmap Display Shutter</keyword> + <description>Dicom Part 3 C7.6.15</description> + </objectAttributes> + <objectCreators> + <description></description> + <AIPO> + <actorIntegrationProfile> + <actor> + <keyword>EC</keyword> + <name>Evidence Creator</name> + <description>A system that creates additional evidence objects such as images, presentation states, Key Image Notes, and/or Evidence Documents and transmits them to an Image Archive. It also makes requests for storage commitment to the Image Manager for the data previously transmitted. It may also retrieve worklist entries for post-processing steps from the Post-Processing Manager and provide notification of completion of the step, allowing the enterprise to track the status of post-processing work.</description> + <id>18</id> + </actor> + <integrationProfile> + <keyword>CPI</keyword> + <name>Consistent Presentation of Images</name> + <description>The Consistent Presentation of Images Integration Profile specifies a number of transactions that maintain the consistency of presentation for grayscale images and their presentation state information (including user annotations, shutters, flip/rotate, display area, and zoom). It also defines a standard contrast curve, the Grayscale Standard Display Function, against which different types of display and hardcopy output devices can be calibrated. It thus supports hardcopy, softcopy and mixed environments.</description> + <id>17</id> + <integrationProfileTypes> + <keyword>EHR_ACCESS</keyword> + <name>EHR Access</name> + <description></description> + </integrationProfileTypes> + <integrationProfileStatusType> + <keyword>FT</keyword> + <name>Final Text</name> + <description></description> + </integrationProfileStatusType> + <domainsForDP> + <keyword>RAD</keyword> + <name>Radiology</name> + <description>IHE Radiology addresses information sharing, workflow and patient care in radiology, including mammography and nuclear medicine.</description> + <id>1</id> + </domainsForDP> + <documentSection> + <section>5_Consistent_Presentation_of_Im</section> + <document> + <name>IHE_RAD_TF_Vol1</name> + <title>IHE Radiology Technical Framework Volume 1</title> + <revision>13.0</revision> + <type>TECHNICAL_FRAMEWORK</type> + <url>http://ihe.net/uploadedFiles/Documents/Radiology/IHE_RAD_TF_Vol1.pdf</url> + <volume>1</volume> + <domain> + <keyword>RAD</keyword> + <name>Radiology</name> + <description>IHE Radiology addresses information sharing, workflow and patient care in radiology, including mammography and nuclear medicine.</description> + <id>1</id> + </domain> + <linkStatus>0</linkStatus> + <linkStatusDescription>This url is pointing to a PDF</linkStatusDescription> + <lifecyclestatus>FINAL_TEXT</lifecyclestatus> + <document_md5_hash_code>f7f2125b95d3562447399300aa5aa4a1</document_md5_hash_code> + <dateOfpublication>2014-07-30T00:00:00+02:00</dateOfpublication> + </document> + <type>TITLE</type> + </documentSection> + </integrationProfile> + <profileLinks> + <transaction> + <keyword>RAD-14</keyword> + <name>Query Images</name> + <description>An Image Display queries the Image Archive for a list of entries representing images by patient, study, series, or instance.</description> + <id>15</id> + <transactionStatusType> + <keyword>FT</keyword> + <name>Final Text</name> + <description></description> + </transactionStatusType> + <transactionLinks> + <fromActor> + <keyword>ID</keyword> + <name>Image Display</name> + <description>A part of a system that can access imaging evidence objects (images, Presentation States, Key Image Notes, Evidence Documents) through network query/retrieve or reading interchange media and allow the user to view these objects.</description> + <id>32</id> + </fromActor> + <toActor> + <keyword>IM</keyword> + <name>Image Manager/Archive</name> + <description>A system that provides functions related to safe data storage and image data handling. It supplies image availability information to the Department System Scheduler. It is always grouped with an Image Archive to provide long term storage of images, presentation states, Key Image Notes, and Evidence Documents.</description> + <id>17</id> + </toActor> + </transactionLinks> + </transaction> + <transactionOptionType> + <keyword>O</keyword> + <name>Optional</name> + <description></description> + </transactionOptionType> + </profileLinks> + </actorIntegrationProfile> + <integrationProfileOption> + <keyword>NONE</keyword> + <name>None</name> + <description>None</description> + <reference></reference> + <toDisplay>true</toDisplay> + </integrationProfileOption> + <maybeSupportive>true</maybeSupportive> + </AIPO> + </objectCreators> + <objectFiles> + <description>Upload a screen capture of the document of your peer as rendered by your system. Note that depending on the options supported by your system, the screen capture may also include a capture of the screen showing imported data in your system +</description> + <min>1</min> + <max>1</max> + <type> + <keyword>SNAPSHOT</keyword> + <description>Snapshot of object</description> + <extensions>jpg,png,gif,jpeg</extensions> + <writable>false</writable> + <validate>false</validate> + </type> + <uploader>reader</uploader> + </objectFiles> + <objectReaders> + <description></description> + <AIPO> + <actorIntegrationProfile> + <actor> + <keyword>ID</keyword> + <name>Image Display</name> + <description>A part of a system that can access imaging evidence objects (images, Presentation States, Key Image Notes, Evidence Documents) through network query/retrieve or reading interchange media and allow the user to view these objects.</description> + <id>32</id> + </actor> + <integrationProfile> + <keyword>CPI</keyword> + <name>Consistent Presentation of Images</name> + <description>The Consistent Presentation of Images Integration Profile specifies a number of transactions that maintain the consistency of presentation for grayscale images and their presentation state information (including user annotations, shutters, flip/rotate, display area, and zoom). It also defines a standard contrast curve, the Grayscale Standard Display Function, against which different types of display and hardcopy output devices can be calibrated. It thus supports hardcopy, softcopy and mixed environments.</description> + <id>17</id> + <integrationProfileTypes> + <keyword>EHR_ACCESS</keyword> + <name>EHR Access</name> + <description></description> + </integrationProfileTypes> + <integrationProfileStatusType> + <keyword>FT</keyword> + <name>Final Text</name> + <description></description> + </integrationProfileStatusType> + <domainsForDP> + <keyword>RAD</keyword> + <name>Radiology</name> + <description>IHE Radiology addresses information sharing, workflow and patient care in radiology, including mammography and nuclear medicine.</description> + <id>1</id> + </domainsForDP> + <documentSection> + <section>5_Consistent_Presentation_of_Im</section> + <document> + <name>IHE_RAD_TF_Vol1</name> + <title>IHE Radiology Technical Framework Volume 1</title> + <revision>13.0</revision> + <type>TECHNICAL_FRAMEWORK</type> + <url>http://ihe.net/uploadedFiles/Documents/Radiology/IHE_RAD_TF_Vol1.pdf</url> + <volume>1</volume> + <domain> + <keyword>RAD</keyword> + <name>Radiology</name> + <description>IHE Radiology addresses information sharing, workflow and patient care in radiology, including mammography and nuclear medicine.</description> + <id>1</id> + </domain> + <linkStatus>0</linkStatus> + <linkStatusDescription>This url is pointing to a PDF</linkStatusDescription> + <lifecyclestatus>FINAL_TEXT</lifecyclestatus> + <document_md5_hash_code>f7f2125b95d3562447399300aa5aa4a1</document_md5_hash_code> + <dateOfpublication>2014-07-30T00:00:00+02:00</dateOfpublication> + </document> + <type>TITLE</type> + </documentSection> + </integrationProfile> + <profileLinks> + <transaction> + <keyword>RAD-14</keyword> + <name>Query Images</name> + <description>An Image Display queries the Image Archive for a list of entries representing images by patient, study, series, or instance.</description> + <id>15</id> + <transactionStatusType> + <keyword>FT</keyword> + <name>Final Text</name> + <description></description> + </transactionStatusType> + <transactionLinks> + <fromActor> + <keyword>ID</keyword> + <name>Image Display</name> + <description>A part of a system that can access imaging evidence objects (images, Presentation States, Key Image Notes, Evidence Documents) through network query/retrieve or reading interchange media and allow the user to view these objects.</description> + <id>32</id> + </fromActor> + <toActor> + <keyword>IM</keyword> + <name>Image Manager/Archive</name> + <description>A system that provides functions related to safe data storage and image data handling. It supplies image availability information to the Department System Scheduler. It is always grouped with an Image Archive to provide long term storage of images, presentation states, Key Image Notes, and Evidence Documents.</description> + <id>17</id> + </toActor> + </transactionLinks> + </transaction> + <transactionOptionType> + <keyword>R</keyword> + <name>Required</name> + <description></description> + </transactionOptionType> + </profileLinks> + </actorIntegrationProfile> + <integrationProfileOption> + <keyword>NONE</keyword> + <name>None</name> + <description>None</description> + <reference></reference> + <toDisplay>true</toDisplay> + </integrationProfileOption> + <maybeSupportive>true</maybeSupportive> + </AIPO> + </objectReaders> + </objectType> +</objectTypes> +``` + +Now with this file, you can import those Samples' Type into any instance of the tool. + +##### Export + +On the same page, at the bottom you will find a panel titled __Import Samples' Type__. + + + +This panel explains the basic rules that are used for Samples' Type import : + +* Actor/Integration Profile/Option detection is based on keywords. If one does not appear in the database the Samples' Type will be ignored +* If a Samples' Type references an unknown status (based on keyword) it will be ignored +* If a Samples' Type references a file with unknown typ, the Samples' Type will be ignored + + +You can also see a checkbox for __Review Changes before saving__. This option is activated by default. When activated, a report about the files content +will be displayed as information to the user. The user will then be able to accept the changes and import the Samples' Type or cancel the action. If +the option is not activated, the changes will be imported directly in the base. The report will still be displayed but changes have already been made +in the database. +The reports sums up what TF Model elements were found missing, what Samples' Type will be ignored, what Samples' Type will be imported and which one have +been found duplicated and won't be imported. + + + +If the __Review Changes before saving__ option is activated, simply click the __Import Samples' Type__ button on the bottom of the report to validate +the changes and import them into the Gazelle Test Management instance. If something is not ok with the document, click the __Reset__ button. +Changes will not be made on the tools data and you will be able to upload another document. + ## Systems Management