Release gazelle Test Management 5.16.0 (External tool development)

Patient-Registry/installation.md

@@ -14,14 +14,14 @@ customer: IHE-EUROPE
 # Patient Registry 
 
 The Patient Registry project is dedicated to the management of patient demographics and identifiers test data. 
-It will embed connectors such as FHIR PDQm, PIX or PAM.
+It will embed connectors such as FHIR PDQm, PIXm or PAM.
 
 ## 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 obtain in the "Releases" section.
+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.
@@ -43,7 +43,7 @@ applications : [general considerations for WildFly 18](/gazelle-documentation/Ge
 
 ### Database
 
-Patient regsistry is using Patient Manager's database. It only needs a datasource connection declared in wildfly 18. 
+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)
 
 **Datasource name** : `patientRegistryDS`
@@ -73,11 +73,14 @@ The sources are accessible here: [https://gitlab.inria.fr/gazelle/applications/t
 
 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). 
-The name of the latest release, can be obtain in the "Releases" section.
+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.
 
+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~pdqm-connector-service)
+and select the **pixm-connector.war** artifact for download.
+
 ## Installation
 
 ### Patient Manager dependency
@@ -98,10 +101,11 @@ To know how to do that, see [General considerations for WildFly 18](/gazelle-doc
 
 Define a resource in your server with name *java:/app/gazelle/pdqm-connector/operational-preferences*.
 
-This resource should refer to a .properties file. This file shall contain the following properties :
+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 search patients.   | http://localhost:8380/patient-registry/processing-service |
+| 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|
+| xrefpatientregistry.url | URL of the CrossReference Processing Service used to XReference.   | http://localhost:8580/patient-registry/patient-registry/CrossReferenceService/xref-processing-service?wsdl |
 
 ### Application server
 
@@ -180,4 +184,122 @@ 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-connector/Patient/{id}](http://localhost:8480/pdqm-connector/Patient/{id})
- * Search : [POST http://localhost:8480/pdqm-connector/Patient](http://localhost:8480/pdqm-connector/Patient)
+ * Search : [POST http://localhost:8480/pdqm-connector/Patient](http://localhost:8480/pdqm-connector/Patient)
\ No newline at end of file
+
+# 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
+
+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.)
+
+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).
+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)
+and select the **pixm-connector.war** artifact for download.
+
+## Installation
+
+### 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 Connector needs at least Patient Manager version 9.11.6.
+
+PIXm also needs Patient Registry to be installed.
+With connector version 1.0.x, you will need Patient Registry version 2.0.x.
+
+
+### 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)
+
+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>
+<object-factory name="java:/app/gazelle/pixm-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>
+```
+
+Replace this property `${DEPLOYMENT_PROPERTIES}` with your own path to the deployment property file. 
+
+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|
+| xrefpatientregistry.url | URL of the CrossReference Processing Service used to XReference.   | http://localhost:8580/patient-registry/patient-registry/CrossReferenceService/xref-processing-service?wsdl |
+
+### Application server
+
+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)
+
+
+#### Configure WildFly 18 for Pixm Connector
+
+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
+```
+
+2. Download module `factories.jar`
+```bash
+sudo wget https://gazelle.ihe.net/wildfly18/factories.jar
+```
+
+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>
+```
+
+4. Add `jboss:jboss-admin` rights
+```bash
+sudo chown jboss:jboss-admin *
+sudo chmod 775 *
+```
+
+
+### 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
+**pdqm-connector.war**. This is important for the path on which connector's web services will be exposed.
+
+```
+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))

Patient-Registry/release-note.md

 ---
 title: Release note
 subtitle: PatientRegistry
-toolversion: 1.0.0
-releasedate: 2020-04-23
-author: Wylem BARS
+toolversion: 2.0.0
+releasedate: 2021-07-12
+author: Franck Desaize
 function: Software Engineer
 customer: IHE Europe
 reference: KER1-RNO-IHE-PATIENT_MANAGER
 ---
+# PIXm Connector 1.0.0
+_Release date: 2021-07-12_
+
+
+# Patient Registry 2.0.0
+_Release date: 2021-07-12_
+
+
+
 # PDQm Connector 1.0.0
 _Release date: 2020-04-24_