View source for Configuring the CTPClient Application for Clinical Trials

The CTPClient application is a program for anonymizing images and transmitting them from image acquisition sites to principal investigator sites in clinical trials. This article describes how to configure, distribute, and run the program. The intended audience for this article is clinical trial administrators and their software minions.

==Running CTPClient==
CTPClient can be launched via the Java webstart mechanism, thus removing the necessity for installing CTP applications at the image acquisition sites. When run via webstart, the user accesses a URL on the principal investigator's CTP site, and the browser downloads CTPClient and starts it. The recommended method for launching CTPClient via webstart is to use the CTP Application Server on the CTP site. For general information on the Application Server, see [[Using the CTP Application Server]].

CTPClient can also be launched as a stand-alone application installed on the client computer. When run stand-alone, the program is started by double-clicking the program's icon or by launching a command window and entering the command:

:<b><tt>java -jar CTPClient.jar [options]</tt></b>

where [options] is a series of quoted parameters, each in the form:

:<b><tt>"param=value"</tt></b>

==The Processing Pipeline==
CTPClient has a fixed processing pipeline consisting of these stages, in this order:
* DicomFilter
* DicomDecompressor
* DicomPixelAnonymizer
* DicomAnonymizer
* HttpExportService
* DirectoryStorageService

The DicomFilter and DicomPixelAnonymizer stages must be explicitly enabled using the parameters described in the next section. The DicomDecompressor stage is run <u>only if</u> the object being processed matches a signature of the DicomPixelAnonymizer; otherwise, the object is not decompressed. See [[The CTP DICOM Pixel Anonymizer]] for more information.

The DicomAnonymizer is always enabled.

No default script is provided for the DicomFilter.

Default scripts are provided for the DicomPixelAnonymizer and the DicomAnonymizer. 

No default lookup table is provided for the DicomAnonymizer.

As mentioned in [[#Building CTPClient|Building CTPClient]], below, a special CTPClient build can be created for specific applications, including application-specific files and configuration parameters.

==Run-time Configuration==
CTPClient is designed to be configured by setting the [options] parameters for the transmitting site. When run via webstart, these parameters can be supplied by query parameters in the URL, as in this example:

:<b><tt>http://ctp.university.edu/webstart/CTPClient?param1=value1&param2=value2</tt></b>

Note that when a value includes whitespace or any other characters that are illegal in a URL, the value must be URL-encoded.

The parameters supported by the program are:

*<b><tt><font size=4>windowTitle</font></tt></b>: The text to be shown in the title bar of the CTP Client window. The default is "CTP Client".
*<b><tt><font size=4>panelTitle</font></tt></b>: The text to be shown at the top of the main pane in the CTPClient UI. The default is "CTP Client".
*<b><tt><font size=4>helpURL</font></tt></b>: The URL to be accessed when the user clicks the Help button on the CTPClient UI. If this parameter is missing, the Help button is not displayed.


*<b><tt><font size=4>scpPort</font></tt></b>: The port on which CTPClient is to start a DICOM Storage SCP to receive objects via the DICOM protocol. If set to any integer greater than zero, CTPClient starts the SCP and accepts transfers from DICOM Storage SCUs. If the parameter is not supplied, or if it is blank or a non-integer value, the SCP is disabled. The default configuration does not enable the SCP.


*<b><tt><font size=4>acceptNonImageObjects</font></tt></b>: Specifies whether non-image objects are to be selected for processing. If set to "yes", all objects are accepted. If set to any other value, only images are accepted. The default configuration only accepts image objects.


*<b><tt><font size=4>dialogEnabled</font></tt></b>: Specifies whether to provide a dialog for entry of parameters at runtime. If set to "yes", a dialog is constructed from definitions in an XML file. If set to any other value, no dialog is provided.
*<b><tt><font size=4>dialogName</font></tt></b>: The name of an XML file stored on the CTP server in the same directory as the CTPClient being served by the Application Server. If the file is not found on the server, CTPClient looks for the file in the same directory in which the program is running. If that fails, CTPClient looks for the default dialog file built into the application (<b><tt>DIALOG.xml</tt></b>). If the XML file cannot be found, the dialog is disabled, even if the dialogEnabled parameter is set to "yes". Values provided by the user in the dialog are treated as if they were options included in the start command of the program. {See [[#The Dialog XML Schema|The Dialog XML Schema]] for a description of how to configure the dialog.) 
*<b><tt><font size=4>showDialogButton</font></tt></b>: Specifies whether to display a button allowing the user to display the dialog. If set to "no", a dialog button is not displayed. If set to any other value, the dialog button is displayed.


*<b><tt><font size=4>dfEnabled</font></tt></b>: Specifies whether to use the DicomFilter to select objects for processing. If set to "yes", objects are selected using the DicomFilter script. If set to any other value, no filtering is done.
*<b><tt><font size=4>dfScriptName</font></tt></b>: The name of a DicomFilter script file stored on the CTP server in the same directory as the CTPClient being served by the Application Server. When present, CTPClient downloads the script file from the server. When not present, CTPClient looks for the default script (<b><tt>DF.script</tt></b>) built into the application. If no default script is found, the DicomFilter stage is disabled, even if the dfEnabled parameter is set to "yes".


*<b><tt><font size=4>dpaEnabled</font></tt></b>: Specifies whether the DicomPixelAnonymizer is to be included in the processing of objects. If set to "yes", objects are processed using the DicomPixelAnonymizer script. If set to any other value, no pixel anonymization is done.
*<b><tt><font size=4>dpaScriptName</font></tt></b>: The name of a DicomPixelAnonymizer script file stored on the CTP server in the same directory as the CTPClient being served by the Application Server. When present, CTPClient downloads the script file from the server. When not present, CTPClient looks for the default script (<b><tt>DPA.script</tt></b>) built into the application. If no default script is found, the DicomPixelAnonymizer stage is disabled, even if the dpaEnabled parameter is set to "yes".
*<b><tt><font size=4>setBurnedInAnnotation</font></tt></b>: Specifies whether the BurnedInAnnotation element is to be set to "NO" for DICOM objects that match a DicomPixelAnonymizer signature. If set to "yes", the element value is set, if the parameter is missing or has any other value, the element is not modified. 


*<b><tt><font size=4>daScriptName</font></tt></b>: The name of a DicomAnonymizer script file stored on the CTP server in the same directory as the CTPClient being served by the Application Server. When present, CTPClient downloads the script file from the server. When not present, CTPClient uses the default script (<b><tt>DA.script</tt></b>) built into the application.
*<b><tt><font size=4>daLUTName</font></tt></b>: The name of a DicomAnonymizer lookup table file stored on the CTP server in the same directory as the CTPClient being served by the Application Server. When present, CTPClient downloads the lookup table file from the server. When not present, CTPClient looks for the default lookup table (<b><tt>LUT.properties</tt></b>) built into the application. If no lookup table is available, an empty lookup table is provided.


*<b><tt><font size=4>httpURL</font></tt></b>: The URL of the destination HttpImportService. If this parameter is not supplied, or if it is blank, the HttpExportService is disabled. This parameter must be a complete URL, including the protocol (http://IP:port or https://IP:port).
*<b><tt><font size=4>showURL</font></tt></b>: "yes" to display a UI field for entering the URL of the destination HttpImportService. "no" to suppress the UI field, thus forcing the URL to be the value of the <b><tt>url</tt></b> parameter. The default value is "yes".


*<b><tt><font size=4>dicomURL</font></tt></b>: The URL of the destination DICOM Storage SCP (e.g. PACS or workstation). If this parameter is not supplied, or if it is blank, the DicomExportService is disabled. This parameter must be a complete URL, including the protocol (e.g. dicom://CalledAET:CallingAET@IP:port).


*<b><tt><font size=4>exportDirectory</font></tt></b>: The path to a directory in which processed files are to be stored. Files are stored with names constructed from their SOPInstanceUIDs. If this parameter is not supplied, or if it is blank, the DirectoryStorageService is disabled.


*<b><tt><font size=4>showBrowseButton</font></tt></b>: Specifies whether to display a button allowing the user to browse the local disk for images to display. If an scpPort is defined and the showBrowseButton parameter is set to "no", a browse button is not displayed. If the parameter is set to any other value, the dialog button is displayed, whether an scpPort parameter is supplied or not. 
*<b><tt><font size=4>renameFiles</font></tt></b>: Whether to rename exported files in the form Study_Series_Acquisition_Instance.dcm. If this parameter is not supplied, or if its value is not "yes", files are named by their SOPInstanceUID values..

In addition to the standard parameters above, CTPClient supports special parameters for modifying the DicomAnonymizer script parameters and lookup table entries. 

Any parameter name starting with the at-sign ( '@' ) is treated as an anonymizer script modification. The '@' is removed, and the rest of the parameter name is used as the name of a script PARAM. The parameter value (the text after the '=' character) is used as the value for that PARAM. The intent of this feature is to allow a standard script to be tailored for a specific image acquisition site. Note that this feature does not allow element scripts to be modified; it only allows script PARAM values to be changed.

Any parameter name starting with the dollar-sign ( '$' ) is treated as a lookup table modification. The '$' is removed, and the rest of the parameter name is used as the lookup table key. The parameter value (the text after the '=' character) is used as the value for that key. The intent of this feature is to allow a standard lookup table to be tailored for a specific image acquisition site.

For more information on anonymizer parameters and lookup tables, see [[The CTP DICOM Anonymizer]], [[The CTP DICOM Anonymizer Configurator]], and [[The CTP Lookup Table Editor]].

The Application Server supplies three parameters automatically when starting CTPClient. These are used by CTPClient to contact the server when the <b><tt>dfScriptName</tt></b>, <b><tt>dpaScriptName</tt></b>, <b><tt>daScriptName</tt></b>, or <b><tt>daLUTName</tt></b> parameters are supplied. If CTPClient is not started via webstart and the project requires that files be obtained from a server, the three parameters below must be supplied explicitly.

*<b><tt><font size=4>protocol</font></tt></b>: The protocol to be used for communication with the CTP site's web server.
*<b><tt><font size=4>host</font></tt></b>: The host IP address or domain name (and port) of the CTP site's web server.
*<b><tt><font size=4>application</font></tt></b>: The name of the application ("<b><tt>CTPClient</tt></b>").

==The Dialog XML Schema==
When the <b><tt>dialogEnabled</tt></b> parameter is set to "yes", CTPClient loads an XML file to define the contents of a dialog allowing the user to enter values for parameters. The following is an example XML structure specifying three parameters:

<pre>
<dialog title="New Patient">
    <h>Site Parameters</h>
    <p>
        Enter the ID value for this site.
    </p>
    <param
        name="@SITEID"
        label="Site ID"
        value=""/>
    <h>Patient Parameters</h>
    <p>
        Enter the ID and name values for this patient.
    </p>
    <param
        name="@SUBJECTID"
        label="Subject ID"
        value=""/>
    <param
        name="@SUBJECTNAME"
        label="Subject Name"
        value=""/>
</dialog>
</pre>

The <b><tt>title</tt></b> attribute of the root element specifies the title of the popup. The title is also used as the name of the button in the main CTPClient window for displaying the dialog, so it should be fairly short.

The <b><tt>h</tt></b> element specifies a heading. The element has one optional attribute, <b><tt>align</tt></b>, with allowed values <b><tt>left</tt></b>, <b><tt>center</tt></b>, and <b><tt>right</tt></b>, The default is <b><tt>center</tt></b>.

The <b><tt>p</tt></b> element specifies a paragraph. Word wrapping is not provided; lines are broken at newline characters. The element has one optional attribute, <b><tt>align</tt></b>, with allowed values <b><tt>left</tt></b>, <b><tt>center</tt></b>, and <b><tt>right</tt></b>, The default is <b><tt>left</tt></b>.

The <b><tt>param</tt></b> element specifies a parameter whose value is to be entered into the dialog by the user. 
* The <b><tt>name</tt></b> attribute specifies the name of an option parameter.
* The <b><tt>label</tt></b> attribute specifies the text to be displayed beside the entry field for the parameter.
* The <b><tt>value</tt></b> attribute specifies the initial value provided in the entry field. If a value was provided by an option parameter when CTPClient was started, that value takes precedence over the value of the <b><tt>value</tt></b> attribute.

Parameter names starting with <b><tt>@</tt></b> specify PARAM values in DicomAnonymizer scripts.

Parameter names starting with <b><tt>$</tt></b> specify values in DicomAnonymizer lookup tables.

The <b><tt>param</tt></b> element has an optional <b><tt>readonly</tt></b> attribute. When set to <b><tt>yes</tt></b>, the entry in the table is not editable. 
*If the <b><tt>name</tt></b> attribute is specified and the <b><tt>value</tt></b> attribute is missing or blank, the text displayed is the value of the specified configuration parameter.
*If the <b><tt>value</tt></b> attribute is not blank, it takes precedence over any configuration parameter specified by the <b><tt>name</tt></b> attribute.
*Examples:
<pre>
    <param
        name="@SITEID"
        label="Site ID:"
        readonly="yes"/>
    <param
        label="Note:"
        value="Some readonly text"
        readonly="yes"/>
</pre>

==Building CTPClient==
In some trials, it may be desired to build a special version of CTPClient with pre-configured values in the configuration files.

The source code for CTPClient is on GitHub at https://github.com/johnperry/CTPClient.

The default configuration files are located in the <b><tt>source/files</tt></b> directory:
* <b><tt>config.properties</tt></b>
* <b><tt>DPA.script</tt></b>
* <b><tt>DA.script</tt></b>

In special situations, default files for the dialog, DicomFilter and DicomAnonymizer lookup table can be provided. The following are the names required by the application:

* <b><tt>DIALOG.xml</tt></b>
* <b><tt>DF.script</tt></b>
* <b><tt>LUT.properties</tt></b>

The program is built using <b><tt>ant</tt></b>. After the build is complete, a zip file containing all the files necessary for deployment is located in the <b><tt>products</tt></b> directory.

==Deploying CTPClient on the CTP Application Server==
As described in [[Using the CTP Application Server]], all the files for CTPClient must be placed in the <b><tt>CTP/ROOT/CTPClient</tt></b> directory. The latest version is encapsulated in a zip file on the RSNA MIRC site at http://mirc.rsna.org/download/CTPClient.zip. 

Included in the zip file is the XSL file required by the Application Server for automatic creation of the webstart <b><tt>jnlp</tt></b> file.

To deploy CTPClient, create the CTP/ROOT/CTPClient directory and copy all the files from the zip file into it.