JBoss

JMX MBean View

Back to Agent View Refresh MBean View

MBean description:

DICOM Modality Performed Procedure Step SCP. Used to the calling and called AE titles for receiving MPPS messages.

List of MBean attributes:

Name Type Access Value Description
CalledAETitles java.lang.String RW List of accepted called AE titles, separated by \(backslash). For example, DCM4CHEE\DCM4CHEE2.
CallingAETitles java.lang.String RW List of accepted calling AE titles, separated by \(backslash).
ANY = accept any.
CONFIGURED_AETS = accept any configured AE Title.
GeneratePatientID java.lang.String RW Generate a patient ID from a hash of the patient name and birth date and/or study instance uid, if the received MPPS N-CREATE message contains no patient ID.
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.
Issuer of Patient ID for generated Patient IDs will be set to the Issuer of Patient ID associated to the MPPS SCP (=Called) AE by its AE configuration entry. If no Issuer of Patient ID is configured for the MPPS SCP, Issuer of Patient ID is set to the value configured by attribute IssuerOfPatientIDGeneratedPatientID.
IssuerOfPatientIDGeneratedPatientID java.lang.String RW Issuer of Patient ID for generated Patient ID's, if no Issuer of Patient ID is associated with the MPPS SCP (=Called) AE by its AE Configuration entry.
SupplementIssuerOfPatientID boolean RW True False Supplement received MPPS N-CREATE message containing a Patient ID, but no Issuer of Patient ID, with a value for Issuer of Patient ID, if such is associated with the MPPS SCU AE by its AE Configuration entry.
SupplementIssuerOfAccessionNumber boolean RW True False Supplement received MPPS N-CREATE message containing Scheduled Step Attributes Sequence items with a non-empty Accession Number, but no Issuer of Accession Number Sequence, with such Sequence containing one item with Local Namespace Enitity ID, Universial Enitity ID and Universial Enitity ID Type, if such is associated with the MPPS SCU AE by its AE Configuration entry.
SupplementByHostName boolean RW True False If there is no Issuer of Patient ID or Issuer of Accession Number associated to the MPPS SCU AE by an AE configuration entry with matching AE Title, AE configuration entries which host name is equals to the host name of the MPPS SCU AE will be considered to determine the associated Issuer of Patient ID or Issuer of Accession Number. If there are several AE configuration entries with matching host name with different non-zero values for Issuer of Patient ID or Issuer of Accession Number, no Issuer of Patient ID or Issuer of Accession Number will be supplemented.
SupplementByHostAddress boolean RW True False If there is no Issuer of Patient ID or Issuer of Accession Number associated to the MPPS SCU AE by an AE configuration entry with matching AE Title, AE configuration entries which host name is equals to the IP address of the MPPS SCU AE will be considered to determine the associated Issuer of Patient ID or Issuer of Accession Number. If there are several AE configuration entries with matching host name with different non-zero values for Issuer of Patient ID or Issuer of Accession Number, no Issuer of Patient ID or Issuer of Accession Number will be supplemented.
GeneratePatientIDForUnscheduledFromAETitles java.lang.String RW List of AE titles of MPPS SCUs for which the Patient ID in received MPPS N-CREATE request without Scheduled Procedure Step reference shall be replaced by a new generated Patient ID. Separate multiple values by "\"(backslash).
If the list is prefixed by "!\", the Patient ID in MPPS N-CREATE requests without Scheduled Procedure Step reference received from any MPPS SCUs, except which AE title is specified in the list, will be replaced by a new generated Patient ID.
"NONE" = do not replace Patient IDs in MPPS N-CREATE request from any MPPS SCU.
PatientMatching java.lang.String RW Defines which Patient Attributes in received MPPS N-CREATE requests shall be considered for the selection of an existing Patient record in the archive.

Format: 'pid'['?']',issuer'['?'][',' ['['] demograhic-matches [']'] ]
demograhic-matches ::= demograhic-match['|' ...]
demograhic-match ::= [ignore',']demograhic-fields
ignore ::= 'ignore("' regular-expression '")'
demograhic-fields ::= demograhic-field['?'][',' ...]
demograhic-field ::= 'familyname'['(1)'] | 'givenname'['(1)'] | 'middlename'['(1)'] | 'nameprefix'['(1)'] | 'namesuffix'['(1)'] | birthdate | sex

Multiple alternative demograhic-matches can be specified using '|' as delimiter.

Substrings specified by 'ignore("' regular-expression '")' will be ignored for matching patient name components.

A '(1)' suffix of the attribute name specifies that only the first character need to match.

A question mark('?') after a attribute name specifies that a missing value in received DICOM N-CREATE requests will match with any value for that attribute in existing Patient Records, as Patient Records with missing values for that attribute will match with any value for that attribute in received DICOM MPPS N-CREATE request. Attribute names without question marks specifies, that DICOM MPPS N-CREATE requests without values for such attributes will not match any existing Patient Record, and Patient Records without values for such attributes will not get selected on receive of any DICOM MPPS N-CREATE request.

With 'pid?', you have to configure the Patient's family name complex ('familyname') as additional matching criterium.

Surrounding demograhic-match by brackets('[]') defines, that demographic fields shall *not* be considered for the selection of an existing Patient record, if the Patient ID is qualified by an Issuer/Authority in the received MPPS N-CREATE request *and* in the matching Patient Record.

Warning:Improper configuration may cause MPPS assignments to wrong patient.

Default: pid,issuer?[familyname,givenname,middlename?,birthdate]

AcceptedTransferSyntax java.lang.String RW List of accepted Transfer Syntaxes. Order defines selection preference. Use either the Transfer Syntaxes UID value or following defined symbolic names: ImplicitVRLittleEndian, ExplicitVRLittleEndian, DeflatedExplicitVRLittleEndian, ExplicitVRBigEndian
CoerceConfigDirectory java.lang.String RW Directory where configuration files for attribute coercion are located: if XSL stylesheet "mpps-ncreaterq.xsl" or "mpps-nsetrq.xsl" exists in this directory or in a sub-directory equal to the AE Title of a MPPS SCU, attributes of MPPS N-CREATE or MPPS N-SET requests from this SCU will be coerced according these stylesheets. A relative path name is resolved relative to archive-install-directory/server/default/.
AddMwlAttrsToMppsXsl java.lang.String RW Stylesheet to add MWL Attributes to MPPS Dataset for 'MPPS Linked' notification.
This allow the use of additional MWL attributes to create ORM message in MPPS2ORM service. A relative path name is resolved relative to archive-install-directory/server/default/.
NONE..use MPPS Attributes.
WriteCoercionXmlLog boolean RW True False Enable logging of coercions in separate log files.
FileName: <LOG_DIR>/coercion/<timestamp>.<xsl file>.[in]|[out]
Coercion logs are only written for Calling AETs specified in LogAETitles!
LogAETitles java.lang.String RW List of the AE titles for the MPPS SCUs for which XMLized N-CREATE and N-SET request attributes are logged into files AET/timestamp-mpps-ncreaterq.xml and AET/timestamp-mpps-nsetrq.xml in the log directory. Useful for creation of XSL stylesheets for attribute coercion. Separate multiple values by \ (backslash). NONE = no calling AE titles.
MaximumPDULength int RW Maximum protocol data unit (PDU) package length for receiving PDUs. Attention: 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 int RW 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. Attention: 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 int RW 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. Attention: 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!
DcmServerName javax.management.ObjectName RW View MBean Used internally. Do NOT modify.
TemplatesServiceName javax.management.ObjectName RW View MBean Used internally. Do NOT modify.
AEServiceName javax.management.ObjectName RW View MBean Used internally. Do NOT modify.
Name java.lang.String R MPPSScpService The class name of the MBean
State int R 3 The status of the MBean
StateString java.lang.String R Started The status of the MBean in text form

List of MBean operations:


void create()

Standard MBean lifecycle method


void start()

The start lifecycle operation


void stop()

The stop lifecycle operation


void destroy()

The destroy lifecycle operation


void jbossInternalLifecycle()

The detyped lifecycle operation (for internal use only)

Param ParamType ParamValue ParamDescription
method java.lang.String The lifecycle operation

java.util.Map linkMppsToMwl()

Link MPPS to MWL entries (LOCAL Modality Worklist).

Param ParamType ParamValue ParamDescription
spsIDs [Ljava.lang.String; List of Scheduled Procedure Step IDs
mppsIUIDs [Ljava.lang.String; List of MPPS SOP Instance UIDs

java.util.Map linkMppsToMwl()

Link MPPS to MWL entries of external Modality worklist.

Param ParamType ParamValue ParamDescription
spsAttrs [Lorg.dcm4che.data.Dataset; List of Scheduled Procedure Step Attributes
mppsIUIDs [Ljava.lang.String; List of MPPS SOP Instance UIDs

void unlinkMpps()

Unlink MPPS to MWL entries.

Param ParamType ParamValue ParamDescription
mppsIUID java.lang.String MPPS SOP Instance UID

boolean deleteMPPSEntries()

Deletes a list of MPPS entries.

Param ParamType ParamValue ParamDescription
iuids [Ljava.lang.String; List of MPPS Instance UIDs