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..0183d89ca9878c90b8dba9ac504527a2ad4fbc53 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/user.md b/Proxy/user.md index aef46924ed3ec8e6e92cbf0dcddbae2b887bbaea..77676c63e985b372981123b6fa4d60eda8a562b7 100755 --- a/Proxy/user.md +++ b/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. - + ## 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.  +## 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?` + + + +The channel is now created with an `Unpersit` button. + + + +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 : 