|
DCMTK
Version 3.6.9
OFFIS DICOM Toolkit
|
ppsmgr [options] port
The ppsmgr application implements an IHE Performed Procedure Step Manager. The application will listen on a specified TCP/IP port for incoming association requests from an MPPS SCU. In case an association was acknowledged and MPPS information was received, the ppsmgr application will (in the role of an MPPS SCU) forward the received information to other MPPS SCPs which can be configured with the necessary help of a mandatory configuration file. The ppsmgr application also supports the Verification Service Class as an SCP. Furthermore, the ppsmgr application supports the private Shutdown SOP class in DCMTK and can be shut down by having another application (e.g. termscu from dcmnet) negotiate this SOP Class with ppsmgr.
port tcp/ip port number to listen on
-h --help
print this help text and exit
--version
print version information and exit
--arguments
print expanded command line arguments
-q --quiet
quiet mode, print no warnings and errors
-v --verbose
verbose mode, print processing details
-d --debug
debug mode, print debug information
-ll --log-level [l]evel: string constant
(fatal, error, warn, info, debug, trace)
use level l for the logger
-lc --log-config [f]ilename: string
use config file f for the logger
-c --config [f]ilename: string
use specific configuration file
(default: /usr/local/etc/dcmtk/ppsmgr.cfg)
-s --single-process
single process mode
--fork
fork child process for each association (default)
UID generation:
-sn --serial-number [s]erial number: integer (1..9999)
serial number of this installation, will be added
to SOP instance UID (for GO-Kard only)
other processing options:
-nfw --no-forwarding
no forwarding of MPPS messages (receive and store only)
-rt --resend-timeout [t]imeout: integer (1..3600, default: 3600)
resend unsuccessfully transmitted MPPS messages
after t seconds
preferred network transfer syntaxes (receiving):
+x= --prefer-uncompr
prefer explicit VR local byte order (default)
+xe --prefer-little
prefer explicit VR little endian TS
+xb --prefer-big
prefer explicit VR big endian TS
+xi --implicit
accept implicit VR little endian TS only
network host access control (tcp wrapper):
-ac --access-full
accept connections from any host (default)
+ac --access-control
enforce host access control rules
preferred network transfer syntaxes (forwarding):
-x= --propose-uncompr
propose all uncompressed TS, explicit VR with local byte
ordering first (default)
-xe --propose-little
propose all uncompressed TS, explicit VR little endian first
-xb --propose-big
propose all uncompressed TS, explicit VR big endian first
-xi --propose-implicit
propose implicit VR little endian TS only
other network options:
-aet --aetitle [a]etitle: string (default: PPSMGR)
set my calling AE title (forwarding)
--refuse
refuse association
--reject
reject association if no implementation class UID
--max-pdu-rec [n]umber of bytes: integer (4096..131072)
set max receive pdu (receiving) to n bytes (default: 16384)
--max-pdu-fwd [n]umber of bytes: integer (4096..131072)
set max receive pdu (forwarding) to n bytes (default: 16384)
-dhl --disable-host-lookup
disable hostname lookup
general:
-md --message-directory [d]irectory: string (default: ".")
write unsuccessfully transmitted MPPS messages
temporarily to existing directory d
post-1993 value representations:
+u --enable-new-vr
enable support for new VRs (UN/UT) (default)
-u --disable-new-vr
disable support for new VRs, convert to OB
The semantic impacts of the above mentioned options is clear for the majority of options. Some particular options, however, are so specific that they need detailed descriptions which will be given in this passage.
Option –serial-number is intended for situations in which the ppsmgr application has to generate one or more new DICOM UIDs. In such a case, the integer which is passed to the application through this option will be added to the given UID root, so that it is possible to generate unique UIDs.
The ppsmgr application supports the following SOP Classes as an SCP:
VerificationSOPClass 1.2.840.10008.1.1 ModalityPerformedProcedureStep 1.2.840.10008.3.1.2.3.3 PrivateShutdownSOPClass 1.2.276.0.7230010.3.4.1915765545.18030.917282194.0
The ppsmgr application will accept presentation contexts for all of the abovementioned supported SOP Classes using any of the transfer syntaxes:
LittleEndianImplicitTransferSyntax 1.2.840.10008.1.2 LittleEndianExplicitTransferSyntax 1.2.840.10008.1.2.1 BigEndianExplicitTransferSyntax 1.2.840.10008.1.2.2
The default behaviour of the ppsmgr application is to prefer transfer syntaxes having an explicit encoding over the default implicit transfer syntax. If ppsmgr is running on big-endian hardware it will prefer BigEndianExplicit to LittleEndianExplicit transfer syntax (and vice versa). This behaviour can be changed with the –prefer options (see above).
The ppsmgr application does not support extended negotiation.
When compiled on Unix platforms with TCP wrapper support, host-based access control can be enabled with the –access-control command line option. In this case the access control rules defined in the system's host access control tables for ppsmgr are enforced. The default locations of the host access control tables are /etc/hosts.allow and /etc/hosts.deny. Further details are described in hosts_access(5).
The level of logging output of the various command line tools and underlying libraries can be specified by the user. By default, only errors and warnings are written to the standard error stream. Using option –verbose also informational messages like processing details are reported. Option –debug can be used to get more details on the internal activity, e.g. for debugging purposes. Other logging levels can be selected using option –log-level. In –quiet mode only fatal errors are reported. In such very severe error events, the application will usually terminate. For more details on the different logging levels, see documentation of module "oflog".
In case the logging output should be written to file (optionally with logfile rotation), to syslog (Unix) or the event log (Windows) option –log-config can be used. This configuration file also allows for directing only certain messages to a particular output stream and for filtering certain messages based on the module or application where they are generated. An example configuration file is provided in <etcdir>/logger.cfg).
All command line tools use the following notation for parameters: square brackets enclose optional values (0-1), three trailing dots indicate that multiple values are allowed (1-n), a combination of both means 0 to n values.
Command line options are distinguished from parameters by a leading '+' or '-' sign, respectively. Usually, order and position of command line options are arbitrary (i.e. they can appear anywhere). However, if options are mutually exclusive the rightmost appearance is used. This behaviour conforms to the standard evaluation rules of common Unix shells.
In addition, one or more command files can be specified using an '@' sign as a prefix to the filename (e.g. @command.txt). Such a command argument is replaced by the content of the corresponding text file (multiple whitespaces are treated as a single separator unless they appear between two quotation marks) prior to any further evaluation. Please note that a command file cannot contain another command file. This simple but effective approach allows to summarize common combinations of options/parameters and avoids longish and confusing command lines (an example is provided in file <datadir>/dumppat.txt).
The ppsmgr utility will attempt to load DICOM data dictionaries specified in the DCMDICTPATH environment variable. By default, i.e. if the DCMDICTPATH environment variable is not set, the file <datadir>/dicom.dic will be loaded unless the dictionary is built into the application (default for Windows).
The default behaviour should be preferred and the DCMDICTPATH environment variable only used when alternative data dictionaries are required. The DCMDICTPATH environment variable has the same format as the Unix shell PATH variable in that a colon (":") separates entries. On Windows systems, a semicolon (";") is used as a separator. The data dictionary code will attempt to load each file specified in the DCMDICTPATH environment variable. It is an error if no data dictionary can be loaded.
<etcdir>/ppsmgr.cfg - example configuration file
termscu(1)
Copyright (C) 2005-2024 by OFFIS e.V., Escherweg 2, 26121 Oldenburg, Germany.