Embedding in dcm4chee (deprecated)

This page describes how installing Weasis to be the default web viewer of dcm4chee web interface.

Weasis is launched from the dcm4chee administrative web interface with Java Webstart, as shown in the pictures below. It may also be copied to a CD (or other removable devices) with images.

Use the weasis protocol instead of Java Web Start because it has been removed from Java 11 release and because the end of public Oracle Java 8 updates from April 2019.
Prefer this page instead.

 

For dcm4chee-arc-light

  1. Install dcm4chee, if not already done.
  2. Go here and download these Weasis files.

    Download issue: Some browsers (Internet Explorer) may rename war files to zip. If so, use the Save As option when downloading and change the name back to war.

    • From the folder with the latest version number:
      • weasis.war
      • weasis-i18n.war (Optional for internationalization)
    • From weasis-pacs-connector folder:
      • the latest version of weasis-pacs-connector.war
  3. Open the wildfly management console (at http://<your-host>:9990).

    • Select the “Deployments” tab
    • Add the .war files using the “Add” button (Choose Upload a new deployment or select Replace when the file already exists)
  4. Configure weasis-pacs-connector 6.x and superior. The default configuration is stored in two files inside weasis-pacs-connector.war . To override the default configuration:

    • Download the current weasis-pacs-connector.properties and dicom-dcm4chee-arc.properties (configuration of the dcm4chee archive)
    • 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).
    • Copy weasis-pacs-connector.properties and dicom-dcm4chee-arc.properties into wildfly/standalone/configuration. With the docker installation use the docker copy command: docker cp …

      Instead of copying the files into wildfly/standalone/configuration, JBoss Command Line Interface Console can be used to override files in the war. Add the two configuration files with the deployment-overlay command:

      deployment-overlay add --name=dcm4chee-arc --deployments=weasis-pacs-connector.war --content=WEB-INF/classes/weasis-pacs-connector.properties=/tmp/weasis-pacs-connector.properties,WEB-INF/classes/dicom-dcm4chee-arc.properties=/tmp/dicom-dcm4chee-arc.properties --redeploy-affected
    • For applying the new configuration, from the management console “Disable” weasis-pacs-connector.war and then “Enable”

    • Optional: add new properties or arguments in the JNLP file, see the configuration of weasis-pacs-connector

  5. To activate Weasis in dcm4chee-arc-light user interface (required 5.10.2 or superior), you need need to changes two attributes in the configuration

    • Add the following properties 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): 

    • IID_PATIENT_URL=../../weasis-pacs-connector/viewer?&patientID={}&target=_self&access_token={}

    • IID_STUDY_URL=../../weasis-pacs-connector/viewer?&studyUID={}&target=_self&access_token={}

      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>:8080/weasis-pacs-connector/...

      The new way of launching Java Westart file (jnlp) will also require an absolute URL as the scheme of the URL is different:
      jnlp://<your-host>:8080/weasis-pacs-connector/...
      jnlps://<your-host>:8443/weasis-pacs-connector/... (TLS connection)
      Replace “<your-host>” with your server hostname

    • Refresh the web page and the view button should appear as in the screenshot above

    • An alternative way to configure the activation is with an LDAP manager (like Apache Directory Studio)

      1. Connect to LDAP, see dcm4chee configuration
      2. Import weasis.ldif

For dcm4chee-web3

  1. Install dcm4chee, if not already done. For security see also how to limit the server access.

    • dcm4chee-web3 is not compatible with versions of dcm4chee before 2.16.0
    • dcm4chee 2.16.0 to 2.17.0 are compatible with dcm4chee-web3, but the older dcm4chee-web is installed by default.
    • For dcm4chee 2.17.1+, dcm4chee-web3 is already installed. To check if it is the latest version, start dcm4chee-web3 (http://<your-host>:8080/dcm4chee-web3/), log in, and mouse over the dcm4chee.org icon in the upper right corner.
  2. Go here and download these Weasis files.

    Download issue: Some browsers (Internet Explorer) may rename war files to zip. If so, use the Save As option when downloading and change the name back to war.

    • From the folder with the latest version number:
      • weasis.war
      • weasis-i18n.war (Optional for internationalization)
    • From weasis-pacs-connector folder:
      • dcm4chee-web-weasis.jar
      • weasis-pacs-connector.war (requires the version 6.1.x, the version 7.x is not supported)
  3. Place these files in the dcm4chee deploy folder (server/default/deploy/).

  4. To activate Weasis, go to the JMX console (at http://<your-host>:8080/jmx-console)

    • In dcm4chee.web select service=WebConfig and set these two values:

      WebviewerNames = weasis
      WebviewerBaseUrl = NONE
      From weasis-pacs-connector 5.0 WebviewerBaseUrl can have different values:

      • Launch Weasis as an external application (default value when NONE): WebviewerBaseUrl = weasis:/weasis-pacs-connector/viewer
      • Launch Weasis as an Applet in the web browser (not recommended as several browsers block Java plugin) : WebviewerBaseUrl = weasis:/weasis-pacs-connector/viewer-applet

      • Launching Weasis from jnlp protocol. The new way of launching Java Westart file (jnlp) will require an absolute URL:

        • weasis:jnlp://<your-host>:8080/weasis-pacs-connector/viewer
        • weasis:jnlps://<your-host>:8443/weasis-pacs-connector/viewer

          Replace “<your-host>” with your server hostname

        From dcm4chee 2.18.3, it possible to reuse the default host name of dcm4chee:

        • weasis:jnlp://${server.host}:8080/weasis-pacs-connector/viewer
        • weasis:jnlps://${server.host}:8443/weasis-pacs-connector/viewer
    • Click the Apply Changes button

  5. Configure Weasis (This step is optional if you just want to keep the default configuration. It is required when the AETitle DCM4CHEE has been changed) The default configuration is stored in two files inside weasis-pacs-connector.war. To override the default configuration:

    • According to the version of weasis-pacs-connector:

    • Copy the files into a folder in the classpath of the servlet container. In JBoss (inferior to version 7), the best location would typically be server/default/conf.

    • 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.properties for weasis-pacs-connector 6.x. Edit the properties: pacs.host, pacs.port, pacs.aet…

    • Optional: add new properties or arguments in the JNLP file, see configuration of weasis-pacs-connector

  6. That’s all, now restart dcm4chee and launch Weasis from the dcm4chee-web3 portal.


For dcm4chee-web (old web interface - before 2.17.1)

  1. Go here and download:

    • The last Weasis version: weasis.war
    • The Weasis internationalization (translation): weasis-i18n.war (optional)
    • The modified dcm4chee web interface dcm4chee-web/version/dcm4chee-web.war)

      dcm4chee version: dcm4chee-web.war has been built only for some dcm4chee versions. For other versions see rebuild dcm4chee-web from any version.

  2. Place these three files into the deploy folder (server/default/deploy/) of dcm4chee.

  3. Modify the permission in /dcm4jboss-web/src/etc/conf/dcm4chee-web/folder.permissions or in server/default/conf/dcm4chee-web if dcm4chee is already installed:

    folder.*=edit,move,delete,view,*export,edit.newStudyUID,mergepat,study_permission,study_permission.free_role_action,query_has_issuer folder.*export=export_tf,export_xds

    folder=WebUser(send,view);DatacareUser(edit,move,delete,export_xds,view);WebAdmin(*)

  4. That’s all, now restart dcm4chee and launch Weasis from the web portal.


Write weasis-portable to DICOM CDs with dcm4chee-cdw

  1. Install dcm4chee-cdw (see doc/INSTALL.txt in the archive)
  2. Extract weasis-portable.zip into the ../dcm4chee/server/default/data/mergedir directory
  3. Go to the dcm4che jmx console (dcm4chee.cdw):
    • Select the MediaCreationMgtSCP item and set to true the value of DefaultIncludeDisplayApplication
    • Select the MakeIsoImage item and set to 4 the value of isoLevel
  4. Click on the Apply Changes button

    Embedding a Java Runtime for Windows: The executable (viewer-win32.exe) allows to embed a JRE in the relative directory “jre/windows” (e.g. weasis-portable/jre/windows/bin/java.exe). To support 32 and 64-bit architecture, copy 32-bit Java Runtime from its installed directory.

    Note: the embedded Java Runtime is used only when no runtime is available on the system. When Java is run from CD, it could be a little slow.