add documentation for proxy 5.0.8

Proxy/user.md

@@ -2,8 +2,8 @@
 title:  User Manual
 subtitle: Gazelle Proxy
 author: Nicolas BAILLIET
-date: 18/04/2023
-toolversion: 5.0.7
+date: 09/06/2023
+toolversion: 5.0.8
 function: Engineer
 version: 2.01
 status: Approved document
@@ -16,6 +16,7 @@ customer: IHE-EUROPE
 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  
@@ -63,6 +64,7 @@ In Gazelle, if the test instance has proxy enabled, a link is available on each
 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
@@ -78,7 +80,7 @@ the Proxy provides permanent link to the captured messages that can be linked to
 
 the Proxy helps verifying the captured messages through a direct link to the EVS Client GUI.
 
-![](./media/hl7_message.png)
+![HL7 Message interface with button to download, see or send to EVS for validation](./media/hl7_message.png)
 
 ## Limitations
 
@@ -132,6 +134,46 @@ The messages list displays only one type of message, if HTTP is selected, HL7v2
 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.
 ![](./media/secured_message_details.png)
 
+## Persist a channel
+
+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?`
+
+![](./media/persist_new_channel.png)
+
+The channel is now created with an `Unpersit` button.
+
+![](./media/persist_channel_in_list.png)
+
+The chanel is written in `/opt/proxy/proxyPersistentChannels.csv` 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.
@@ -147,8 +189,8 @@ Each captured message has a permanent link that can be used in Gazelle. The be
 # 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 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.  
 When this mode is enabled, the Message List is not accessible in the menu for not admin users :
 
 ![](./media/not_logged_in_admin_only.png)