Difference between revisions of "The MIRC Module"

From MircWiki
Jump to: navigation, search
(The MIRC Configuration File)
(The MIRC Configuration File)
Line 120: Line 120:
 
</mirc>
 
</mirc>
 
</pre>
 
</pre>
 +
 +
These are the key attributes of the root element:
 +
 +
* <b><tt>UI</tt></b>: the default UI of the system. Standard values are <b>integrated</b> and <b>classic</b>.
 +
* <b><tt>addresstype</tt></b> ="dynamic"
 +
* <b><tt>date</tt></b> ="2012.12.23 at 09:28:28 CST"
 +
* <b><tt>disclaimerurl</tt></b> =""
 +
* <b><tt>downloadenb</tt></b> ="yes"
 +
* <b><tt>email</tt></b> ="johnperry@dls.net"
 +
* <b><tt>masthead</tt></b> ="ChildrensLogo2.jpg"
 +
* <b><tt>mastheadheight</tt></b> ="109"
 +
* <b><tt>mode</tt></b> ="rad"
 +
* <b><tt>popup</tt></b> ="login"
 +
* <b><tt>roles</tt></b> ="department"
 +
* <b><tt>rsnaVersion</tt></b> ="Z97"
 +
* <b><tt>sharestats</tt></b> ="yes"
 +
* <b><tt>showptids</tt></b> ="yes"
 +
* <b><tt>showsitename</tt></b> ="yes"
 +
* <b><tt>siteid</tt></b>: the unique ID of the site, assigned automatically by the system. Its value is the system time in milliseconds when the system first starts. It is used by the RSNA TFS site to collate activity reports from the various sites in the field.
 +
* <b><tt>sitename</tt></b>: the name displayed on the query page.
 +
* <b><tt>siteurl</tt></b> ="http://192.168.0.4:80"
 +
* <b><tt>timeout</tt></b> ="7"
 +
* <b><tt>version</tt></b> ="Z105"
 +
 +
note the <b><tt>siteid</tt></b> attribute. It is
  
 
==The MIRC Base Servlet==
 
==The MIRC Base Servlet==

Revision as of 17:25, 3 January 2013

UNDER CONSTRUCTION

The MIRC module (MIRC.jar) contains the code of the CTP plugin that implements TFS, the RSNA Teaching File System. This article describes the theory of operation of the packages and files contained in the MIRC module. The intended audience for this article is software engineers extending or maintaining any of that software.

See Setting Up a MIRC Development Environment for information on obtaining and building the MIRC module. It will be helpful to get the source code and build it so you can reference the Javadocs as you go along.

1 Overview

The MIRC module contains many packages. In general, major system functions (as well as some minor ones) are encapsulated in their own packages, but because many functions interact, this principle is not universally maintained. Most system functions have classes and files that are contained in the jar file. Often, the files are XSL programs used for the generation of web pages or Javascript and CSS files referenced by the web pages. These files are served directly from the jar file without having to be installed on the disk. See The Util Module for a description of how the server serves files from the classpath.

2 The TFS-installer

The TFS-installer uses the same installer program as CTP. It includes a full installation of CTP, but it includes a different config.xml file snd additional libraries.

To prevent the loss of site-specific configuration information, the installer does not overwrite the config.xml file during an upgrade installation. The standard TFS config.xml file includes the MIRC plugin and pipelines for the File Service, the DICOM Service, and the TCE Service.

The additional libraries include the Apache XML libraries because the standard Java XML libraries don't support passing DOM objects as parameters to XSL transforms. This capability is used widely in TFS, but not CTP, so they are only included in the TFS installer.

3 The MIRC Plugin

All the code for TFS is included in the MIRC plugin, including all the servlets, the TFS-specific pipeline stages, and many XSL, Javascript, CSS, image, and files. The plugin is loaded when CTP loads the configuration, and it is started after the server is started but before any of the pipelines are started.

The root attribute of the MIRC plugin's configuration file element defines the root directory of all the TFS files. The default location is mircsite under the CTP directory, but it can be changed if it is desired to locate the teaching files on another drive or network system. Because the installer never overwrites any of the teaching file information, in most cases it is safe in the CTP directory tree.

When the plugin is started, it loads the MIRC configuration file. It then loads various databases and adds all the TFS servlets to the server. It also ensures that if the admin user exists, it has the author, publisher, and department roles. Finally, it rebuilds the RadLex index (if necessary), and starts several daemon threads to monitor the status of non-local libraries (LibraryMonitor), draft documents (DraftDocumentMonitor)), and the activity report submission process that sends information on the site to the RSNA (SummarySubmitter).

When CTP shuts down, the MIRC plugin receives a shutdown method call, which triggers the closing of all the databases.

4 The MIRC Configuration File

The MIRC plugin and the three TFS pipelines are configured in the config.xml file, but all the other configuration information for a TFS site is contained in the mirc.xml file, located in the root of the plugin (typically CTP/mircsite). The mirc.xml file contains all the configuration information for the site, all the local libraries it contains, all the non-local libraries it can query. the File Service, and the Case of the Day (if any).

This is an abbreviated listing of a mirc.xml file for a test site:

<mirc
    UI="integrated"
    addresstype="dynamic"
    date="2012.12.23 at 09:28:28 CST"
    disclaimerurl=""
    downloadenb="yes"
    email="johnperry@dls.net"
    masthead="ChildrensLogo2.jpg"
    mastheadheight="109"
    mode="rad"
    popup="login"
    roles="department"
    rsnaVersion="Z97"
    sharestats="yes"
    showptids="yes"
    showsitename="yes"
    siteid="1343228846573"
    sitename="JP's Teaching Files"
    siteurl="http://192.168.0.4:80"
    timeout="7"
    version="Z105">
    <Libraries>
        <Library
            address="/storage/ss4"
            authenb="yes"
            autoindex="no"
            dcmenb="yes"
            deflib="no"
            enabled="yes"
            id="ss4"
            jpegquality="-1"
            local="yes"
            maxsize="100"
            subenb="yes"
            tceenb="yes"
            timeout="0"
            zipenb="yes">
            <title>JP's MIRC Storage Service</title>
            <tagline/>
        </Library>
        <Library
            address="/storage/ss1"
            authenb="yes"
            autoindex="no"
            dcmenb="yes"
            deflib="yes"
            enabled="yes"
            id="ss1"
            jpegquality="-1"
            local="yes"
            maxsize="75"
            subenb="yes"
            tceenb="yes"
            timeout="0"
            zipenb="no">
            <title>My MIRC Site</title>
            <tagline/>
        </Library>
        <Library
            address="http://mirc.childrensmemorial.org/storage/ss12"
            deflib="no"
            enabled="yes"
            local="no">
            <title>CMH: Children's Memorial Hospital General Pediatric Cases</title>
        </Library>
        <Library
            address="http://147.140.2.19:8080/storage/ss2"
            deflib="no"
            enabled="yes"
            local="no">
            <title>Thomas Jefferson University Hospital - Neuro</title>
        </Library>
    </Libraries>
    <FileService
        maxsize="75"
        timeout="0"/>
    <news>
        <title>20110902 DX CHEST STUDY</title>
        <image>
            /storage/ss4/docs/20121002065223174/9999.68816769595213868527999756405838373430_base.jpeg
        </image>
        <url>/storage/ss4/docs/20121002065223174/MIRCdocument.xml</url>
    </news>
</mirc>

These are the key attributes of the root element:

  • UI: the default UI of the system. Standard values are integrated and classic.
  • addresstype ="dynamic"
  • date ="2012.12.23 at 09:28:28 CST"
  • disclaimerurl =""
  • downloadenb ="yes"
  • email ="johnperry@dls.net"
  • masthead ="ChildrensLogo2.jpg"
  • mastheadheight ="109"
  • mode ="rad"
  • popup ="login"
  • roles ="department"
  • rsnaVersion ="Z97"
  • sharestats ="yes"
  • showptids ="yes"
  • showsitename ="yes"
  • siteid: the unique ID of the site, assigned automatically by the system. Its value is the system time in milliseconds when the system first starts. It is used by the RSNA TFS site to collate activity reports from the various sites in the field.
  • sitename: the name displayed on the query page.
  • siteurl ="http://192.168.0.4:80"
  • timeout ="7"
  • version ="Z105"
note the siteid attribute. It is

5 The MIRC Base Servlet

6 Users, Roles, and Preferences

6.1 MircUserManagerServlet

6.2 PreferencesServlet

7 QueryService

7.1 QueryServiceAdmin

7.2 CaseNavigatorService

8 StorageService

8.1 StorageServiceAdmin

8.2 Support Services

8.2.1 AddImagesService

8.2.2 SortImagesService

8.2.3 CommentService

8.2.4 RevertService

8.2.5 PublishService

9 Conference Service

10 The Author Services

10.1 The Advanced Author Service

10.2 The Basic Author Service

10.3 The Submit Service

10.4 The Zip Service

10.5 Author Summary

11 The MIRC Pipelines

11.1 The File Service

11.2 The DICOM Service

11.3 The TCE Service

12 ResetSerice

13 DownloadService

14 Activity Report

15 RadLexSuggest

16 Utility Classes

16.1 MircDocument

16.2 RadLexIndex