You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/basics/customize/integration.en.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -156,11 +156,11 @@ Configuration notes:
156
156
- From 5.24.0 {{qidoBaseURL}} must be replaced by your base URL (e.g. https://pacs2.test.com:8443)
157
157
- The character '&' must be escaped in the Docker environment variables.
158
158
- The Authorization header is not required for unsecure service.
159
-
- URL with HTTPS requires a real valid certificate; otherwise, the certificate must be imported into the Weasis Java keystore. For testing purposes in secure mode, you can use the HTTP URL if it is mapped in the OIDC client of keycloack (--url "http://<your-host>:8080/dcm4chee-arc/aets/DCM4CHEE/rs").
159
+
- URL with HTTPS requires a real valid certificate; otherwise, the certificate must be imported into the Weasis Java keystore or must be installed at [system level](https://github.com/nroduit/Weasis/issues/679) (from Weasis 4.6.1).
160
160
{{% /notice %}}
161
161
162
162
{{% notice note %}}
163
-
Known issue: Weasis cannot open the images because of the token length which is cut by IE and Chrome only under Windows. It is working with Firefox on Windows.
163
+
**Known issue on Windows**: Weasis cannot open the images because of the token length which is cut by the browser. It is only working with Firefox on Windows. It is recommended to use [weasis-pacs-connector](#use-weasis-pacs-connector) or [ViewerHub](../../../viewer-hub) to solve this issue.
This page describes how installing Weasis to be the default web viewer of dcm4chee-arc-light web interface. See [How to launch Weasis from any environments](../../basics/customize/integration) to integrate Weasis into your own user interface.
8
+
This page explains how to integrate Weasis with dcm4chee-arc-light using weasis-pacs-connector. To launch Weasis without the connector, follow the alternative [instructions](../../basics/customize/integration/#download-directly-with-dicomweb-restful-services).
9
9
10
-
Weasis is launched from the dcm4chee administrative web interface with the [weasis protocol](../weasis-protocol), as shown in the pictures below.
For a simpler and faster installation without server components, please follow these [instructions](../../basics/customize/integration/#download-directly-with-dicomweb-restful-services); no need to consider the following points on this page. Otherwise, if you need more advanced configurations, then follow these steps:
13
+
Follow these steps for the integration with `weasis-pacs-connector`:
14
+
15
15
16
16
1.[Install dcm4chee](https://github.com/dcm4che/dcm4chee-arc-light/wiki), if not already done (Installation with Docker is straightforward).
17
17
18
-
2. Go [here](https://sourceforge.net/projects/dcm4che/files/Weasis/) and download these following files:
19
-
{{% notice warning %}}
20
-
**Download issue**: Some browsers (like Internet Explorer) may rename war files to zip. If so, use the Save As option when downloading and change the name back to war.
21
-
{{% /notice %}}
22
-
- From weasis-pacs-connector folder:
23
-
- [weasis-pacs-connector.war] Requires at least the version 7.1.2
24
-
- From the folder with the latest version number (Optional if you want to run only the [native version](../) installed on the client system):
25
-
- [weasis.war] requires at least Weasis 3.5.3
26
-
- {{% badge style="info" %}}Optional{{% /badge %}} [weasis-i18n.war] for [internationalization](../translating)
3. Open the <atarget="_blank"href="http://localhost:9990/">wildfly management console</a> (at `http://<your-host>:9990`).
18
+
2. Go [here](https://sourceforge.net/projects/dcm4che/files/Weasis/) and download `weasis-pacs-connector.war` — See [Configuration Matrix](#configuration-matrix) below for the recommended version according to your dcm4chee-arc-light version.
19
+
20
+
3. Open the <atarget="_blank"href="http://localhost:9990/">WildFly management console</a> (at `http://<your-host>:9990`). Note: with some Keycloak versions, the [management console may not be accessible](https://groups.google.com/g/dcm4che/c/UeNKzgijfqo).
31
21
- Select the “Deployments” tab
32
-
- Add the .war files using the “Add” button (Choose Upload a new deployment or select Replace when the file already exists)
22
+
- Add `weasis-pacs-connector.war` using the “Add” button (Choose Upload a new deployment or select Replace when the file already exists)
33
23
{{% notice note %}}
34
-
Alternatively one may deploy .war files using JBoss Command Line Interface Console.
24
+
Alternatively one may deploy the `.war` using JBoss Command Line Interface Console.
35
25
{{% /notice %}}
36
26
37
-
4. Configure weasis-pacs-connector (This step is optional if you just want to keep the default configuration).<br>
27
+
4. Configure weasis-pacs-connector (optional if default settings are sufficient).<br>
38
28
The default configuration is stored in two files inside weasis-pacs-connector.war. To override the default configuration:
39
29
- Download the current [download>weasis-pacs-connector.properties](https://raw.githubusercontent.com/nroduit/weasis-pacs-connector/master/src/main/resources/weasis-pacs-connector.properties) and [download>dicom-dcm4chee-arc.properties](https://raw.githubusercontent.com/nroduit/weasis-pacs-connector/master/src/main/resources/dicom-dcm4chee-arc.properties) (configuration of the dcm4chee archive)
40
30
- Edit the configuration as needed. For example, dcm4chee may be running on a different computer than Weasis, or the AE Title of dcm4chee may have been changed. If so, edit `weasis-pacs-connector.properties` or `dicom-dcm4chee-arc.properties` (Change pacs.host, pacs.port, and pacs.aet).
@@ -46,45 +36,127 @@ Instead of copying the files into $WILDFLY_HOME/standalone/configuration, JBoss
- For applying the new configuration, from the management console "Disable" weasis-pacs-connector.war and then "Enable"
50
-
51
-
5. To activate Weasis in the dcm4chee-arc-light user interface (see the matrix of the required versions in the table below):
52
-
you need to add attributes by either editing docker-compose.env (from 5.22.0) or from the left menu Configuration > Devices > dcm4chee-arc > Extensions > Edit extension > Child Objects > Web Applications > DCM4CHEE (add `&cdb` to the URL if weasis.war has not been deployed on the server-side):
53
-
- Configure the URL for having a view button for the patient or study level.
54
-
- From dcm4chee-arc-light 5.10.2 to 5.19.0, the left menu Configuration > Devices > dcm4chee-arc > Extensions > Archive Device
55
-
- From dcm4chee-arc-light 5.19.1 the left menu Configuration > Devices > dcm4chee-arc > Extensions > Edit extension > Child Objects > Web Applications > DCM4CHEE
56
-
- From dcm4chee-arc-light 5.22.0 by editing docker-compose.env (It allows you to directly apply the properties when deploying, then they can be edited in the web portal). Note: the character ‘&’ must be escaped (e.g., IID_STUDY_URL=../../weasis-pacs-connector/weasis?studyUID={{studyUID}}\\&access_token={{access_token}})
39
+
- To apply the new configuration, from the management console "Disable" `weasis-pacs-connector.war` then "Enable"
40
+
41
+
5. To activate Weasis in the dcm4chee-arc-light user interface (See also [Invoke Image Display in dcm4chee](https://github.com/dcm4che/dcm4chee-arc-light/wiki/Invoke-Image-Display)):
42
+
you need to add attributes by either editing `docker-compose.env` (from 5.22.0) or from the left menu Configuration > Devices > dcm4chee-arc > Extensions > Edit extension > Child Objects > Web Applications > DCM4CHEE:
43
+
- Configure the URL for a view button at patient or study level and then copy the properties from [Configuration Matrix](#configuration-matrix).
44
+
- From dcm4chee-arc-light 5.10.2 to 5.19.0, the left menu: Configuration > Devices > dcm4chee-arc > Extensions > Archive Device
45
+
- From dcm4chee-arc-light 5.19.1 the left menu: Configuration > Devices > dcm4chee-arc > Extensions > Edit extension > Child Objects > Web Applications > DCM4CHEE
46
+
- From dcm4chee-arc-light 5.22.0 by editing `docker-compose.env` (allows applying properties at deploy time). Note: the character `&` must be escaped (e.g., `IID_STUDY_URL=../../weasis-pacs-connector/weasis?studyUID={{studyUID}}\\&access_token={{access_token}}`)
57
47
{{% notice note %}}
58
48
**URL parameters**
59
49
60
50
-`access_token` is necessary in secure mode (secured RESTful services) from dcm4chee-arc-light 5.15.1
61
-
-`_self` avoids to open a new empty window in the web browser<br>
62
-
-`cdb`[cdb parameter](https://nroduit.github.io/en/getting-started/weasis-protocol/#modify-the-launch-parameters) to override the URL of the Weasis web context to null (when you want only the native local version or when weasis.war has not be deployed with weasis-pacs-connector)<br>
63
-
- See also <atarget="_blank"href="https://github.com/dcm4che/dcm4chee-arc-light/wiki/Invoke-Image-Display">Invoke Image Display in dcm4chee</a>
64
-
{{% /notice %}}
65
-
{{% notice tip %}}
66
-
**Absolute path**: The values above starting by "../" are the default relative path when weasis-pacs-connector is installed in the same JBoss as dcm4chee. Otherwise replace the relative URL by an absolute value, ex: `http://<your-host>:<port>/weasis-pacs-connector/...`
51
+
-`_self` avoids opening a new empty window in the browser<br>
67
52
{{% /notice %}}
68
53
- {{% badge style="info" %}}Optional{{% /badge %}} Add <atarget="_blank"href="https://github.com/nroduit/weasis-pacs-connector#launch-weasis-with-other-parameters">other properties</a> in the URL.
69
54
- Refresh the web page and the view button should appear as in the screenshot above
70
55
- To launch the viewer from the web portal, the client computer must have installed the [Weasis package](../).
71
56
72
-
<fontsize="-1">
57
+
## Configuration Matrix
58
+
59
+
{{% notice note %}}
60
+
The list below maps dcm4chee-arc-light versions to the recommended `weasis-pacs-connector`, and gives the properties to add in dcm4chee-arc-light configuration to enable Weasis launching.
61
+
62
+
Older versions pass _self via query parameter (target=_self); newer versions (5.22.2+) use the dedicated property IID_URL_TARGET=_self.
| Unsecured | from 5.10.2 to 5.19.0 | ../../weasis-pacs-connector/weasis?&patientID={}&target=_self<br>../../weasis-pacs-connector/weasis?&studyUID={}&target=_self |
77
-
| Unsecured*| from 5.10.2 to 5.19.0 | ../../weasis-pacs-connector/weasis?&patientID={}&cdb&target=_self<br>../../weasis-pacs-connector/weasis?&studyUID={}&cdb&target=_self |
78
-
| Secured | from 5.15.1 to 5.19.0 | ../../weasis-pacs-connector/weasis?&patientID={}&target=_self&access_token={}<br>../../weasis-pacs-connector/weasis?&studyUID={}&target=_self&access_token={} |
79
-
| Secured*| from 5.15.1 to 5.19.0 | ../../weasis-pacs-connector/weasis?&patientID={}&cdb&target=_self&access_token={}<br>../../weasis-pacs-connector/weasis?&studyUID={}&cdb&target=_self&access_token={} |
80
-
| Unsecured | from 5.19.1 to 5.22.1 | IID_PATIENT_URL=../../weasis-pacs-connector/weasis?&patientID={}&target=_self<br>IID_STUDY_URL=../../weasis-pacs-connector/weasis?&studyUID={}&target=_self |
81
-
| Unsecured*| from 5.19.1 to 5.22.1 | IID_PATIENT_URL=../../weasis-pacs-connector/weasis?&patientID={}&cdb&target=_self<br>IID_STUDY_URL=../../weasis-pacs-connector/weasis?&studyUID={}&cdb&target=_self |
82
-
| Secured | from 5.19.1 to 5.22.1 | IID_PATIENT_URL=../../weasis-pacs-connector/weasis?&patientID={}&target=_self&access_token={}<br>IID_STUDY_URL=../../weasis-pacs-connector/weasis?&studyUID={}&target=_self&access_token={} |
83
-
| Secured*| from 5.19.1 to 5.22.1 | IID_PATIENT_URL=../../weasis-pacs-connector/weasis?&patientID={}&cdb&target=_self&access_token={}<br>IID_STUDY_URL=../../weasis-pacs-connector/weasis?&studyUID={}&cdb&target=_self&access_token={} |
84
-
| Secured | from 5.22.2 | IID_PATIENT_URL=../../weasis-pacs-connector/weasis?patientID={{patientID}}&access_token={{access_token}}<br>IID_STUDY_URL=../../weasis-pacs-connector/weasis?studyUID={{studyUID}}&access_token={{access_token}} <br>IID_URL_TARGET=_self |
85
-
| Secured*| from 5.22.2 | IID_PATIENT_URL=../../weasis-pacs-connector/weasis?patientID={{patientID}}&cdb&access_token={{access_token}}<br>IID_STUDY_URL=../../weasis-pacs-connector/weasis?studyUID={{studyUID}}&cdb&access_token={{access_token}} <br>IID_URL_TARGET=_self |
Copy file name to clipboardExpand all lines: content/getting-started/weasis-protocol.en.md
+3-4Lines changed: 3 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -61,7 +61,7 @@ For loading multiple images, it's recommended to use a manifest file that refere
61
61
62
62
### Examples to Load Images
63
63
64
-
If you use weasis-pacs-connector, please refer to <atarget="_blank"href="https://github.com/nroduit/weasis-pacs-connector#launch-weasis">Launch Weasis</a>.
64
+
If you use weasis-pacs-connector, please refer to [Launch Weasis](https://github.com/nroduit/weasis-pacs-connector#launch-weasis).
65
65
66
66
* Use [$dicom:get](../../basics/commands/#dicomget) to load a static XML manifest containing direct links (without WADO server) {{< launch >}}$dicom:get -w "https://nroduit.github.io/demo-archive/Lumbar/mf.xml"{{< /launch >}}
The command for modifying the configuration at launch is `$weasis:config` which can have different arguments:
90
90
91
-
***cdb** is the Weasis web context (The URL of weasis.war). If the value is null, the weasis version installed from the [native installer](../) is used. In the weasis-pacs-connector <atarget="_blank"href="https://github.com/nroduit/weasis-pacs-connector/blob/master/src/main/resources/weasis-pacs-connector.properties">configuration</a>, the default value is defined by `weasis.base.url`.
92
-
***cdb-ext** is the extension web context of Weasis (The URL of weasis-ext.war containing additional plugins). In the weasis-pacs-connector <atarget="_blank"href="https://github.com/nroduit/weasis-pacs-connector/blob/master/src/main/resources/weasis-pacs-connector.properties">configuration</a>, the default value is defined by `weasis.ext.url`.
91
+
***cdb** is the Weasis web context (The URL of weasis-native.zip package in [ViewerHub](../../viewer-hub)). If the value is null, the weasis version installed from the [native installer](../) is used. In the weasis-pacs-connector [configuration](https://github.com/nroduit/weasis-pacs-connector/blob/master/src/main/resources/weasis-pacs-connector.properties), the default value is defined by `weasis.base.url`.
93
92
***arg** is an argument for the launcher. The value must start by $, like arg="$dicom:close --all" (Note: the value can also be directly in the base URI, outside $weasis:config). Single-valued argument but can be specified multiple times.
94
93
***pro** is a property for the launcher containing a key and a value separate by a space. Single-valued property but can be specified multiple times.
95
94
***auth** is the web authorization parameter
96
95
***wcfg** is the URL the remote Weasis configuration service.
97
96
98
-
Here are some examples that modify the launcher properties without using <atarget="_blank"href="https://github.com/nroduit/weasis-pacs-connector#launch-weasis">weasis-pacs-connector</a>:
97
+
Here are some examples that modify the launcher properties without using [weasis-pacs-connector](https://github.com/nroduit/weasis-pacs-connector#launch-weasis):
0 commit comments