JBoss

JMX MBean View

Back to Agent View Refresh MBean View

MBean description:

DICOM Unified Worklist and Procedure Step related Service Class Providers

List of MBean attributes:

Name Type Access Value Description
Name java.lang.String R UPSScpService 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
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.
WorklistLabel java.lang.String RW Default value for Worklist Label (0074,1202), used if no value is provided in the N-CREATE RQ by the UPS Push SCU.
SupplementIssuerOfPatientID boolean RW True False Supplement received UPS 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 UPS SCU AE by its AE Configuration entry.
SupplementByHostName boolean RW True False If there is no Issuer of Patient ID associated to the UPS 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 UPS SCU AE will be considered to determine the associated Issuer of Patient ID. If there are several AE configuration entries with matching host name with different non-zero values for Issuer of Patient ID, no Issuer of Patient ID will be supplemented.
SupplementByHostAddress boolean RW True False If there is no Issuer of Patient ID associated to the UPS 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 UPS SCU AE will be considered to determine the associated Issuer of Patient ID. If there are several AE configuration entries with matching host name with different non-zero values for Issuer of Patient ID, no Issuer of Patient ID will be supplemented.
PatientMatching java.lang.String RW Defines which Patient Attributes in received UPS 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 UPS N-CREATE request. Attribute names without question marks specifies, that DICOM UPS 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 UPS 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 UPS N-CREATE request *and* in the matching Patient Record.

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

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

NoMatchForNoValue boolean RW True False Do not match entities with zero-length value for specified matching keys (= non DICOM conform matching behavior).
AcceptedSOPClasses java.lang.String RW List of accepted UPS related SOP Classes. Use either the SOP Class UID value, or following defined symbolic names: UnifiedProcedureStepPushSOPClass, UnifiedProcedureStepWatchSOPClass, UnifiedProcedureStepPullSOPClass, UnifiedProcedureStepEventSOPClass
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
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!
AcceptTimeout int RW A-Associate accept timeout in milliseconds. 0 = no timeout.
DIMSETimeout int RW DIMSE message timeout in milliseconds. 0 = no timeout.
SocketCloseDelay int RW Socket close delay in milliseconds after an A-Release response.
TcpNoDelay boolean RW True False Send packets as quickly as possible (Disable Nagle's algorithmn).
SendBufferSize int RW Buffer size used for socket output. 0 = use platform default.
ReceiveBufferSize int RW Buffer size used for socket input. 0 = use platform default.
AccessBlobAsLongVarBinary boolean RW True False Change JDBC binding for Oracle BLOB's to LONGVARBINARY for accessing attributes stored in BLOB columns of DB records.
TransactionIsolationLevel java.lang.String RW Transaction isolation level for queries. Values can be one of: DEFAULT|READ_UNCOMMITTED|READ_COMMITTED|REPEATABLE_READ|SERIALIZABLE.
RetryIntervals java.lang.String RW Number and interval of retries made to notify a SCU of a change in state of a UPS instance.

Format:
Comma separated list of numberxinterval pairs or NEVER.
The interval can be specified in seconds (##s), minutes (##m), hours (##h) or days (##d).
Individual settings for specific Destination AETs can be specified by prefix [AET], separating several AET setting by new line. An entry without [AET] prefix will be treated as default.

Example: 5x1m,10x10m
=> retry a total of 5 times, one minute apart for each retry; then retry a total of 10 times, 10 minutes apart for each retry.

Example:
[AET1]2x1m,3x10m
[AET2]NEVER
5x1m,10x10m
=> for destination AET1 retry a total of 2 times, one minute apart for each retry; then retry a total of 3 times, 10 minutes apart for each retry. Retries are disabled for destination AET2. For all other destinations retry a total of 5 times, one minute apart for each retry; then retry a total of 10 times, 10 minutes apart for each retry.

Concurrency int RW Maximum number of concurrent notifications.
FetchSize int RW JDBC Fetch size.
QueueName java.lang.String RW Used internally. Do NOT modify.
JMSServiceName javax.management.ObjectName RW View MBean Used internally. Do NOT modify.
DcmServerName javax.management.ObjectName RW View MBean Used internally. Do NOT modify.
AEServiceName javax.management.ObjectName RW View MBean Used internally. Do NOT modify.
TLSConfigName javax.management.ObjectName RW View MBean Used internally. Do NOT modify.

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

void createUPS()

Create UPS.

Param ParamType ParamValue ParamDescription
scpaet java.lang.String Calling AE Title used by UPS SCP in Association RQ for notification of globally subscribed Receiving AEs.
dataset org.dcm4che.data.Dataset Attribute List

void updateOrCreateUPS()

Update UPS with matching Work Item Code and Requested Procedure ID or create new UPS.

Param ParamType ParamValue ParamDescription
dataset org.dcm4che.data.Dataset Attribute List

void updateUPS()

Update specified UPS.

Param ParamType ParamValue ParamDescription
scpaet java.lang.String Calling AE Title used by UPS SCP in Association RQ for notification of subscribed Receiving AEs.
iuid java.lang.String UPS SOP Instance UID
dataset org.dcm4che.data.Dataset Modification List

java.lang.String startUPS()

Change State of specified UPS to IN PROGRESS. Returns Transaction UID.

Param ParamType ParamValue ParamDescription
scpaet java.lang.String Calling AE Title used by UPS SCP in Association RQ for notification of subscribed Receiving AEs.
iuid java.lang.String UPS SOP Instance UID

void completeUPS()

Change State of specified UPS to COMPLETED.

Param ParamType ParamValue ParamDescription
scpaet java.lang.String Calling AE Title used by UPS SCP in Association RQ for notification of subscribed Receiving AEs.
iuid java.lang.String UPS SOP Instance UID
tuid java.lang.String Transaction UID

void cancelUPS()

Change State of specified UPS to CANCELED.

Param ParamType ParamValue ParamDescription
scpaet java.lang.String Calling AE Title used by UPS SCP in Association RQ for notification of subscribed Receiving AEs.
iuid java.lang.String UPS SOP Instance UID
tuid java.lang.String Transaction UID

void subscribeReceiveUPSEventReports()

Subscribe to receive UPS Event Reports for specified UPS.

Param ParamType ParamValue ParamDescription
scpaet java.lang.String Calling AE Title used by UPS SCP in Association RQ for initial notification of subscribing Receiving AE.
uid java.lang.String UPS SOP Instance UID
aet java.lang.String Receiving AE
dellock boolean True False Deletion Lock

void subscribeGlobally()

Subscribe to receive UPS Event Reports globally.

Param ParamType ParamValue ParamDescription
scpaet java.lang.String Calling AE Title used by UPS SCP in Association RQ for initial notification of subscribing Receiving AE.
aet java.lang.String Receiving AE
dellock boolean True False Deletion Lock

void unsubscribeReceiveUPSEventReports()

Unsubscribe from receiving UPS Event Reports for specified UPS.

Param ParamType ParamValue ParamDescription
uid java.lang.String UPS SOP Instance UID
aet java.lang.String Receiving AE

void unsubscribeGlobally()

Unsubscribe from Receiving UPS Event Reports globally.

Param ParamType ParamValue ParamDescription
aet java.lang.String Receiving AE

void suspendGlobalSubscription()

Suspend Global Subscription.

Param ParamType ParamValue ParamDescription
aet java.lang.String Receiving AE