Mercurial > hg > orthanc-book
changeset 845:bf3946cb3ca0
Orthanc Explorer 2
author | Alain Mazy <am@osimis.io> |
---|---|
date | Fri, 13 May 2022 12:24:14 +0200 |
parents | 41bae819d80b |
children | 2f8ee0aef0a6 |
files | Sphinx/source/contributing.rst Sphinx/source/faq/improving-interface.rst Sphinx/source/images/OE2-screenshot-study-list.png Sphinx/source/plugins.rst Sphinx/source/plugins/orthanc-explorer-2.rst |
diffstat | 5 files changed, 122 insertions(+), 24 deletions(-) [+] |
line wrap: on
line diff
--- a/Sphinx/source/contributing.rst Thu May 12 09:39:48 2022 +0200 +++ b/Sphinx/source/contributing.rst Fri May 13 12:24:14 2022 +0200 @@ -17,7 +17,7 @@ * **Orthanc Core**: - - :ref:`Improved Web user interface <improving-interface>` + - Continue improving the :ref:`Orthanc Explorer 2 <orthanc-explorer-2>` User Interface - Support of DICOM C-GET SCU * **Stone Web viewer**: @@ -32,7 +32,7 @@ - :ref:`Worklist plugin <worklist>` to interface with REST API, HL7 or Mirth - Please `get in touch with Osimis <info@osimis.io>`__ if you + Please `get in touch with the Orthanc Team <info@orthanc.team>`__ if you want to sponsor these developments. If you find Orthanc useful and wish to contribute to its development, @@ -159,13 +159,13 @@ <https://groups.google.com/forum/#!forum/orthanc-users>`_. -* **Financial support**: Buying professional services is the best way - to make the Orthanc project sustainable in the long term. +* **Financial support**: - - Osimis provides `support packs and professional development - services <https://osimis.io/en/orthanc-support-contract>`__ around the - Orthanc ecosystem and, more generally, around medical - imaging. + - Since February 2022, you are invited to fund the Orthanc project + through its `Open Collective <https://opencollective.com/orthanc>`__ + page. The funds collected there will help us maintain Orthanc, + release new features and answer questions on the Orthanc Users Group. - - Check out the :ref:`professional services provided by our + - Buying professional services is also a good way to make the Orthanc project + sustainable in the long term. Check out the :ref:`professional services provided by our community <support-freelancers>`.
--- a/Sphinx/source/faq/improving-interface.rst Thu May 12 09:39:48 2022 +0200 +++ b/Sphinx/source/faq/improving-interface.rst Fri May 13 12:24:14 2022 +0200 @@ -40,14 +40,11 @@ front-end Web developer could take care of this task using well-known JavaScript frameworks (such as Angular, Vue.js...). -It is possible that an official plugin that provides a more advanced -user interface will be developed in the future (provided we find -funding for this development). In the meantime, you can also contact -**Osimis**, the commercial partner of the Orthanc project, by using -the `contact form <https://www.orthanc-server.com/orthanc-pro.php>`_ -that is available on the official Web page of Orthanc. +.. note:: Since May 2022, a new :ref:`Orthanc Explorer 2 <orthanc-explorer-2>` + plugin is available to provide a more user-friendly, + more configurable and evolutive UI for Orthanc. -Finally, have a look to the following **related projects**: +Finally, you may also have a look to the following **related projects**: * In 2017-2018, a team of Master students from `ULiège <https://www.uliege.be/>`__ has done some work about creating a @@ -88,11 +85,3 @@ and `AMQP <https://en.wikipedia.org/wiki/Advanced_Message_Queuing_Protocol>`__ to handle the asynchronous tasks. - -* Last but not least, as written above, please consider buying the - `professional development services by Osimis - <https://osimis.io/en/orthanc-support-contract>`__. Osimis can help medical - and hospital audience with the deployment of a **certified, - integrated clinical environment** around Orthanc. In turn, the money - you pay will contribute to make the Orthanc project sustainable in - the long term.
--- a/Sphinx/source/plugins.rst Thu May 12 09:39:48 2022 +0200 +++ b/Sphinx/source/plugins.rst Fri May 13 12:24:14 2022 +0200 @@ -70,6 +70,7 @@ plugins/osimis-webviewer.rst plugins/authorization.rst plugins/housekeeper.rst + plugins/orthanc-explorer-2.rst .. _plugins-uclouvain:
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Sphinx/source/plugins/orthanc-explorer-2.rst Fri May 13 12:24:14 2022 +0200 @@ -0,0 +1,108 @@ +.. _orthanc-explorer-2: + + +Orthanc Explorer 2 plugin +========================= + +.. contents:: + + +Introduction +------------ + +This plugin provides a new User Interface (UI) to Orthanc. It aims at being +more user-friendly, more configurable and more evolutive than the default +Orthanc UI which was developed mainly for testing/administrative purpose. + +.. image:: ../images/OE2-screenshot-study-list.png + :align: center + :width: 1000px + +| + +Note that a major difference between the legacy UI and Orthanc Explorer 2 (OE2) +is that OE2 works only at the study level, not the patient level. The main page is +the study list in which, of course, you can apply a filter to display only the studies of a single patient. + + +How to get it ? +--------------- + +The source code is available on `GitHub <https://github.com/orthanc-server/orthanc-explorer-2>`__. + +Binaries are included in: + +- The `osimis/orthanc Docker image <https://hub.docker.com/r/osimis/orthanc>`__ +- The `Windows Installer <https://orthanc.osimis.io/win-installer/OrthancInstaller-Win64-latest.exe>`__ (only for 64bits platform) +- The `MacOS packages <https://orthanc.osimis.io/osx/stable/orthancAndPluginsOSX.stable.zip>`__ + +Release notes are available `here <https://github.com/orthanc-server/orthanc-explorer-2/blob/master/release-notes.md>`__. + +Depending on the configuration, the plugin can replace the default Orthanc UI you are redirected to when accessing orthanc at `http://localhost:8042/ <http://localhost:8042/>`__. +In any case, the new and old UI can coexist: + +- Orthanc Explorer 2 is available at `http://localhost:8042/ui/app/ <http://localhost:8042/ui/app/>`__ +- Legacy UI remains available at `http://localhost:8042/app/explorer.html <http://localhost:8042/app/explorer.html>`__ + + +Configuration +------------- + +.. highlight:: json + +The plugin must be configured through a configuration file. The minimal configuration to include in your orthanc configuration file is:: + + "OrthancExplorer2" : { + "Enable": true, + "IsDefaultOrthancUI": true + } + +There are many more options that are documented in the +`default configuration file <https://github.com/orthanc-server/orthanc-explorer-2/blob/master/Plugin/DefaultConfiguration.json>`__. + +Main features you can configure: + +- Root URL +- Whether OE2 becomes the default Orhtanc UI +- Configure the side menu +- Configure the actions available on the resources +- Configure the columns of the main study list + + +Advanced features +----------------- + +You may open the OE2 interface directly on a specific study or patient by specifying DICOM Tags directly in the URL. +e.g:: + + http://localhost:8042/ui/app/#/filtered-studies?PatientID=00000169 + http://localhost:8042/ui/app/#/filtered-studies?StudyDate=20220512-20220513&ModalitiesInStudy=CR\DX + http://localhost:8042/ui/app/#/filtered-studies?StudyInstanceUID=1.2.826.0.1.3680043.8.498.12876244982176669645076277115728403867 + + + +Roadmap +------- + +Main elements of the roadmap are listed hereunder (not in the order of implementation): + +- Multiple language support +- Mobile friendly +- Allow edition of DICOM Tags +- Query-retrieve interface for dicom-web servers & remote DICOM servers +- Open other viewers from UI (Radiant, Osirix, MedDream, OHIF, ...) + +A full list of `ideas` is stored directly in the repository's `TODO <https://github.com/orthanc-server/orthanc-explorer-2/blob/master/TODO>`__ + + +Bug reports & support +--------------------- + +As usual, you can get support and report issues from the `Orthanc Users group <https://groups.google.com/g/orthanc-users>`__. + +You may also directly introduce bugs or feature requests in `GitHub <https://github.com/orthanc-server/orthanc-explorer-2/issues>`__. + +The plugin is currently maintained by Alain Mazy from `Orthanc.team <https://orthanc.team/>`__ who, like many of you, enjoys +receiving a salary for his work. Feel free to hire him if you need a specific feature or bug fixed. + +Donations to `Open Collective <https://opencollective.com/orthanc>`__ may also be used to maintain/develop this plugin.