Description
DICOM Storage SCP. Provides a DICOM storage service to receive DICOM objects from remote DICOM applications. Typically these objects are images received from modalities. You can also configure what DICOM SOP classes are accepted by the StoreScp service using the #AcceptedImageSOPClasses and #AcceptedOtherSOPClasses attributes.
Attributes
CalledAETitles
List of accepted called AE titles, separated by (backslash). For example, DCM4CHEE\DCM4CHEE2.
CallingAETitles
List of accepted calling AE titles, separated by (backslash). ANY = accept any.
WarnForCoercedAETitles
List of the AE titles for the Storage SCUs for which a warning status, B000, is returned if data elements were coerced. Separate multiple values by (backslash). NONE = no calling AE titles.
AcceptMissingPatientID
Accept storage of objects/images without patient ID
AcceptMissingPatientName
Accept storage of objects/images without patient name
AcceptPatientID
Regular Expression for valid Patient IDs. Patient IDs which does not match the specified pattern are ignored and replaced by a Patient ID generated according attribute "GeneratePatientID".
IgnorePatientID
Regular Expression for invalid Patient IDs. Patient IDs which match the specified pattern are ignored and replaced by a Patient ID generated according attribute #GeneratePatientID.
IgnorePatientIDAETitles
List of the AE titles for the Storage SCUs for which the Patient ID in received objects is ignored. Usually used together with attribute #GeneratePatientID to generate a new Patient ID for such objects. Separate multiple values by (backslash). NONE = no calling AE titles.
GeneratePatientID
Generate a patient ID from a hash of the patient name and birth date and/or study instance uid, if
- the received object has no patient ID or
- the patient ID does not match the pattern defined in "AcceptPatientID" or
- it match the pattern defined in "IgnorePatientID" or
- the object is received from an AE listed in "IgnorePatientIDAETitles".
Use ### and/or $$$ as a placeholder for the decimal hash value of patient name and/or study instance uid.
For example, PACS-##########.
NONE = do not generate patient IDs. But, this means media creation will fail.
IssuerOfPatientIDRules
List of rules used to add the Issuer Of PatientID value if not contained in the received object, if the Patient ID matches the specified regular expression. Multiple rules are separated by new lines.
Format: regExpression:issuer
Example: ^PACS-\d*:DCM4CHEE
If no regular expression is specified, the issuer is added for all patient IDs.
StudyDateInFilePath
Use Study Date in received objects to structure directories of the storage file system. Otherwise - or if the received object does not contain a Study Date - the current date, when receiving the object, is used. (s.a. attributes #YearInFilePath, #MonthInFilePath, #DayInFilePath, #HourInFilePath)
YearInFilePath
Use the year of Study or receiving Date to structure directories of the storage file system.(s.a. attributes #StudyDateInFilePath, #MonthInFilePath, #DayInFilePath, #HourInFilePath)
MonthInFilePath
Use the year of Study or receiving Date to structure directories of the storage file system. (s.a. attributes #StudyDateInFilePath, #YearInFilePath, #DayInFilePath, #HourInFilePath)
DayInFilePath
Use the year of Study or receiving Date to structure directories of the storage file system. (s.a. attributes #StudyDateInFilePath, #YearInFilePath, #MonthInFilePath, #HourInFilePath)
HourInFilePath
Use the year of Study or receiving Date to structure directories of the storage file system. (s.a. attributes #StudyDateInFilePath, #YearInFilePath, #MonthInFilePath, #DayInFilePath)
Md5sum
Generates MD5 file check sum during storage and keep it in DB record
StoreDuplicatesIfDifferentMD5
Store a duplicate object if the MD5 sum of the new object differs from the MD5 sum of the existing file. If the MD5 sum does not match, the files may be corrupted.
StoreDuplicatesIfDifferentHost
Store duplicate objects if the existing files are NOT located on this host.
CompressionRules
List of image compression rules. First matching rule for a received object defines its compression.
Syntax:
<compression rules> := (<compression rule> <EOL>)+
<compression rule> := [<conditions>] <compression>
<conditions> := '[' <condition> { ',' <condition> } ']'
<condition> := <attribute> ['!']'=' <value> {'|' <value> }
<attribute> := 'calling' | 'called' | 'pmi' | 'cuid' | 'imgtype'
<compression> := 'NONE' | 'JPLL' | 'JLSL' | 'J2KR'
Supported compression modes:
NONE
- do not apply compression.JPLL
- JPEG LosslessJLSL
- JPEG-LS LosslessJ2KR
- JPEG 2000 Lossless
Attributes usable to for compression conditions:
calling
- called AE title. Apply the rule to the called AE titles listed as values.called
- called AE title. Apply the rule to the calling AE titles listed as values.pmi
- photometric interpretation.cuid
- SOP Class UID. Apply the rule for the SOP Class UIDs listed as values.imgtype
- type of image. Apply the rule to the image types listed as values, such as RGB.
The value of the attribute Compression Service#MaxConcurrentCodec also effects the on-the-fly compression and decompression during the store of images by the StoreSCP service.
CheckPendingSeriesStoredInterval
Interval in days (#d), hours (#h) or minutes (#m) of check for pending Series Stored Notifications, which were not emitted caused by a crash of the Storage Service during an open association.
NEVER = disable check.
PendingSeriesStoredTimeout
Timeout in hours (#h) or minutes (#m) for emission of Series Stored Notifications after an object of this Series, before the emission of the Notification is triggered by the check for pending Series Stored Notifications.
SerializeDBUpdate
Serialize updates of DB records for received
objects in one association. May decreases Storage Performance!
UpdateDatabaseMaximumRetries
Maximum number of retries to update the database records for new received objects, before a processing failure is returned to the Storage SCU.
UpdateDatabasePerformedRetries
Maximum number of retries actually performed to update the database records for new received objects.
UpdateDatabaseRetryInterval
Delay in milliseconds between retries to update the database records for new received objects.
AcceptedImageSOPClasses
List of image SOP Classes that the Store SCP service accepts. Use either the SOP Class UID value, or the name specified in DICOM Part 6, Annex A Registry of DICOM unique identifiers, concatenating individual words without spaces.
AcceptedTransferSyntaxForImageSOPClasses
List of Transfer Syntaxes for Image SOP Classes that Store SCP service accepts. Order defines selection preference. Use either the Transfer Syntaxes UID value or following defined symbolic names:
- ImplicitVRLittleEndian,
- ExplicitVRLittleEndian,
- DeflatedExplicitVRLittleEndian,
- ExplicitVRBigEndian,
- JPEGBaseline,
- JPEGExtended,
- JPEGLossless (=Process 14 [Selection Value 1]),
- JPEGLossless14,
- JPEGLSLossless,
- JPEGLSLossy,
- JPEG2000Lossless,
- JPEG2000Lossy,
- RLELossless
AcceptedVideoSOPClasses
List of Video SOP Classes that the Store SCP service accepts. Use either the SOP Class UID value, or the name specified in DICOM Part 6, Annex A Registry of DICOM unique identifiers, concatenating individual words without spaces.
AcceptedTransferSyntaxForVideoSOPClasses
List of Transfer Syntaxes for Video SOP Classes that Store SCP service accepts. Order defines selection preference. Use either the Transfer Syntaxes UID value or following defined symbolic names:
- MPEG2
AcceptedWaveformSOPClasses
List of Waveform SOP Classes that the Store SCP service accepts. Use either the SOP Class UID value, or the name specified in DICOM Part 6, Annex A Registry of DICOM unique identifiers, concatenating individual words without spaces.
AcceptedTransferSyntaxForWaveformSOPClasses
List of Transfer Syntaxes for Waveform SOP Classes that Store SCP service accepts. Order defines selection preference. Use either the Transfer Syntaxes UID value or following defined symbolic names:
- ImplicitVRLittleEndian,
- ExplicitVRLittleEndian,
- DeflatedExplicitVRLittleEndian,
- ExplicitVRBigEndian
AcceptedSRSOPClasses
List of Structured Report Document SOP Classes that the Store SCP service accepts.
Use either the SOP Class UID value, or the name specified in DICOM Part 6, Annex A Registry of DICOM unique identifiers, concatenating individual words without spaces.
AcceptedTransferSyntaxForSRSOPClasses
List of Transfer Syntaxes for Structured Report Document SOP Classes that Store SCP service accepts. Order defines selection preference. Use either the Transfer Syntaxes UID value or following defined symbolic names:
- ImplicitVRLittleEndian,
- ExplicitVRLittleEndian,
- DeflatedExplicitVRLittleEndian,
- ExplicitVRBigEndian
AcceptedOtherSOPClasses
List of other (than Image, Video, Waveform, Structured Report) SOP Classes that the Store SCP service accepts.Use either the SOP Class UID value, or the name specified in DICOM Part 6, Annex A Registry of DICOM unique identifiers, concatenating individual words without spaces.
AcceptedTransferSyntaxForOtherSOPClasses
List of Transfer Syntaxes for other (than Image, Video, Waveform, Structured Report) SOP Classes that Store SCP service accepts. Order defines selection preference. Use either the Transfer Syntaxes UID value or following defined symbolic names:
- ImplicitVRLittleEndian,
- ExplicitVRLittleEndian,
- DeflatedExplicitVRLittleEndian,
- ExplicitVRBigEndian
CheckIncorrectWorklistEntry
Check if a received instance should be ignored due to 'Incorrect Worklist Entry Selected'.
MaximumPDULength
Maximum protocol data unit (PDU) package length for receiving PDUs.
This property should be set to equal values for all DICOM SCP services with same called AE Title(s). Otherwise it is non-deterministic, which configured value is effective.
MaximumOperationsInvoked
The maximum number of outstanding operations and/or sub-operations it allows the Association-requester to invoke asynchronously. A value of zero indicates an unlimited number of outstanding operations.
This property should be set to equal values for all DICOM SCP services with same called AE Title(s). Otherwise it is non-deterministic, which configured value is effective.
MaximumOperationsPerformed
The maximum number of outstanding operations and/or sub-operations it allows the Association-requester to perform asynchronously. A value of zero indicates an unlimited number of outstanding operations.
This property should be set to equal values for all DICOM SCP services with same called AE Title(s). Otherwise it is non-deterministic, which configured value is effective.
BufferSize
Size of byte buffer used for copying data from TCP channel to file.
LogAETitles
List of the AE titles for the Storage SCUs for which XMLized object attributes are logged into files <AET>/<timestamp>-cstorerq.xml in the log directory. Useful for creation of XSL stylesheets for attribute coercion. Separate multiple values by \ (backslash). NONE = no calling AE titles.
CoerceConfigDirectory
Directory where configuration files for attribute coercion are located: if XSL stylesheet "cstorerq.xsl" exists in this directory or in a sub-directory equal to the AE Title of a Storage SCU, attributes from this SCU will be coerced according these tylesheets. A relative path name is resolved relative to dcm4chee_home/server/default/.
EJBProviderURL
Identifies JNDI (e.g: jnp://hostname:1099) with EJBs.Use LOCAL if EJBs are deployed in same JBoss instance.
SchedulerServiceName
Used internally. Do NOT modify.
FileSystemMgtName
Used internally. Do NOT modify.
MwlScuServiceName
Used internally. Do NOT modify.
DcmServerName
Used internally. Do NOT modify.
AuditLoggerName
Used internally. Do NOT modify.
Name
The class name of the MBean
State
The status of the MBean
StateString
The status of the MBean in text form
Operations
create
Standard MBean lifecycle method
start
The start lifecycle operation
stop
The stop lifecycle operation
destroy
The destroy lifecycle operation
jbossInternalLifecycle
The detyped lifecycle operation (for internal use only)
resetMaxCountUpdateDatabaseRetries
Reset Update Database - Performed Retries to 0.
reloadStylesheets
Reload Stylesheets
importFile
Import a DICOM file (internal use only)
Notifications
org.dcm4chex.archive.common.SeriesStored
The notification sent whenever a Series of DICOM composite object was received. It is triggered by the receive of an object belonging to a different Series than the objects received before and at the latests when the association is released.