Mercurial > hg > orthanc-book

comparison Sphinx/source/plugins/orthanc-explorer-2.rst @ 845:bf3946cb3ca0

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Orthanc Explorer 2
author Alain Mazy <am@osimis.io>
date Fri, 13 May 2022 12:24:14 +0200
parents
children f58e423adc12
comparison
equal deleted inserted replaced
844:41bae819d80b 845:bf3946cb3ca0
1 .. _orthanc-explorer-2:
2
3
4 Orthanc Explorer 2 plugin
5 =========================
6
7 .. contents::
8
9
10 Introduction
11 ------------
12
13 This plugin provides a new User Interface (UI) to Orthanc. It aims at being
14 more user-friendly, more configurable and more evolutive than the default
15 Orthanc UI which was developed mainly for testing/administrative purpose.
16
17 .. image:: ../images/OE2-screenshot-study-list.png
18 :align: center
19 :width: 1000px
20
21 |
22
23 Note that a major difference between the legacy UI and Orthanc Explorer 2 (OE2)
24 is that OE2 works only at the study level, not the patient level. The main page is
25 the study list in which, of course, you can apply a filter to display only the studies of a single patient.
26
27
28 How to get it ?
29 ---------------
30
31 The source code is available on `GitHub <https://github.com/orthanc-server/orthanc-explorer-2>`__.
32
33 Binaries are included in:
34
35 - The `osimis/orthanc Docker image <https://hub.docker.com/r/osimis/orthanc>`__
36 - The `Windows Installer <https://orthanc.osimis.io/win-installer/OrthancInstaller-Win64-latest.exe>`__ (only for 64bits platform)
37 - The `MacOS packages <https://orthanc.osimis.io/osx/stable/orthancAndPluginsOSX.stable.zip>`__
38
39 Release notes are available `here <https://github.com/orthanc-server/orthanc-explorer-2/blob/master/release-notes.md>`__.
40
41 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/>`__.
42 In any case, the new and old UI can coexist:
43
44 - Orthanc Explorer 2 is available at `http://localhost:8042/ui/app/ <http://localhost:8042/ui/app/>`__
45 - Legacy UI remains available at `http://localhost:8042/app/explorer.html <http://localhost:8042/app/explorer.html>`__
46
47
48 Configuration
49 -------------
50
51 .. highlight:: json
52
53 The plugin must be configured through a configuration file. The minimal configuration to include in your orthanc configuration file is::
54
55 "OrthancExplorer2" : {
56 "Enable": true,
57 "IsDefaultOrthancUI": true
58 }
59
60 There are many more options that are documented in the
61 `default configuration file <https://github.com/orthanc-server/orthanc-explorer-2/blob/master/Plugin/DefaultConfiguration.json>`__.
62
63 Main features you can configure:
64
65 - Root URL
66 - Whether OE2 becomes the default Orhtanc UI
67 - Configure the side menu
68 - Configure the actions available on the resources
69 - Configure the columns of the main study list
70
71
72 Advanced features
73 -----------------
74
75 You may open the OE2 interface directly on a specific study or patient by specifying DICOM Tags directly in the URL.
76 e.g::
77
78 http://localhost:8042/ui/app/#/filtered-studies?PatientID=00000169
79 http://localhost:8042/ui/app/#/filtered-studies?StudyDate=20220512-20220513&ModalitiesInStudy=CR\DX
80 http://localhost:8042/ui/app/#/filtered-studies?StudyInstanceUID=1.2.826.0.1.3680043.8.498.12876244982176669645076277115728403867
81
82
83
84 Roadmap
85 -------
86
87 Main elements of the roadmap are listed hereunder (not in the order of implementation):
88
89 - Multiple language support
90 - Mobile friendly
91 - Allow edition of DICOM Tags
92 - Query-retrieve interface for dicom-web servers & remote DICOM servers
93 - Open other viewers from UI (Radiant, Osirix, MedDream, OHIF, ...)
94
95 A full list of `ideas` is stored directly in the repository's `TODO <https://github.com/orthanc-server/orthanc-explorer-2/blob/master/TODO>`__
96
97
98 Bug reports & support
99 ---------------------
100
101 As usual, you can get support and report issues from the `Orthanc Users group <https://groups.google.com/g/orthanc-users>`__.
102
103 You may also directly introduce bugs or feature requests in `GitHub <https://github.com/orthanc-server/orthanc-explorer-2/issues>`__.
104
105 The plugin is currently maintained by Alain Mazy from `Orthanc.team <https://orthanc.team/>`__ who, like many of you, enjoys
106 receiving a salary for his work. Feel free to hire him if you need a specific feature or bug fixed.
107
108 Donations to `Open Collective <https://opencollective.com/orthanc>`__ may also be used to maintain/develop this plugin.