Files
config-pacs-docker/dcm4chee/default/conf/xmdesc/dcm4chee-ianscu-xmbean.xml
2025-02-26 14:49:25 +07:00

295 lines
12 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mbean PUBLIC "DCMSCU attributes template extends jboss_xmbean_1_1.dtd" "dcm4chee-scu-xmbean.dtd">
<mbean>
<description>IAN/SCN SCU Service. Used to notify DICOM peers about available instances for Instance Available Notifications and Study Content Notifications.</description>
<descriptors>
<persistence persistPolicy="OnUpdate"/>
<persistence-manager value="org.jboss.mx.persistence.DelegatingPersistenceManager"/>
</descriptors>
<class>org.dcm4chex.archive.dcm.ianscu.IANScuService</class>
<constructor>
<description>The default constructor</description>
<name>IanScuService</name>
</constructor>
<!-- Attributes -->
&defaultAttributes;
&defaultSCUAttributes;
<attribute access="read-write" getMethod="getNotifiedAETs" setMethod="setNotifiedAETs">
<description>List of AE titles of notified application entities, separated by \(backslash).
NONE = do not notify any application entity.
</description>
<name>NotifiedAETitles</name>
<type>java.lang.String</type>
<descriptors>
<value value="NONE"/>
</descriptors>
</attribute>
<attribute access="read-only" getMethod="isEnabled" >
<description>IAN Enabled? IAN SCU is enabled if NotifiedAETitles and/or Mpps2IanDestinationStylesheet not NONE</description>
<name>isEnabled</name>
<type>boolean</type>
</attribute>
<attribute access="read-write"
getMethod="isNotifyOtherServices"
setMethod="setNotifyOtherServices">
<description><![CDATA[Enables notification of other services about the
event, that all objects referenced in a MPPS COMPLETE message became
available in the archive. Must be activated, if XDS-I auto-publishing
feature is used.<br />
Standard services which are notified: XDS-I, ExportManager, UPSFeed, GPWLFeed]]>
</description>
<name>NotifyOtherServices</name>
<type>boolean</type>
<descriptors>
<value value="true" />
</descriptors>
</attribute>
<attribute access="read-write"
getMethod="isSendOneIANforEachMPPS"
setMethod="setSendOneIANforEachMPPS">
<description>Send IAN not before having received the last instance of the
instance set referenced in the MPPS. Otherwise send IAN already when
receiving the last instance of a Series or when the association over
which instances were received is closed by the sender.
</description>
<name>SendOneIANforEachMPPS</name>
<type>boolean</type>
<descriptors>
<value value="true" />
</descriptors>
</attribute>
<attribute access="read-write"
getMethod="isOnMppsLinkedEnabled"
setMethod="setOnMppsLinkedEnabled">
<description>Enable sending of IAN when MPPS was linked with MWL.
</description>
<name>OnMppsLinkedEnabled</name>
<type>boolean</type>
<descriptors>
<value value="false" />
</descriptors>
</attribute>
<attribute access="read-write" getMethod="getCallingAET" setMethod="setCallingAET">
<description>Calling AE title used in the Association Request.
</description>
<name>CallingAETitle</name>
<type>java.lang.String</type>
<descriptors>
<value value="ABPACS"/>
</descriptors>
</attribute>
<attribute access="read-write" getMethod="getRetryIntervalls" setMethod="setRetryIntervalls">
<description>Number and intervals of retries for failed
Instance Available or Study Content Notification requests. &lt;br&gt;Format:
&lt;br&gt;Comma separated list of &lt;i&gt;number&lt;/I&gt; x &lt;i&gt;interval&lt;/I&gt; pairs.
&lt;br&gt;The interval can be specified in seconds (##s),
minutes (##m), hours (##h) or days (##d).
&lt;br&gt;Example:
&lt;br&gt;5x1m,10x10m means 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.
</description>
<name>RetryIntervals</name>
<type>java.lang.String</type>
<descriptors>
<value value="5x1m,12x5m,24x1h,7x1d"/>
</descriptors>
</attribute>
<attribute access="read-write" getMethod="isOfferStudyContentNotification" setMethod="setOfferStudyContentNotification">
<description>Offer Basic Study Content Notification Service - additionally
to the Instance Available Notification Service - in the Association Request.
</description>
<name>OfferStudyContentNotification</name>
<type>boolean</type>
<descriptors>
<value value="true"/>
</descriptors>
</attribute>
<attribute access="read-write" getMethod="isPreferInstanceAvailableNotification" setMethod="setPreferInstanceAvailableNotification">
<description>Prefer the use of the Instance Available Notification Service if
the Instance Available Notification and Basic Study Content Notification
Service is supported by the remote application entity.
</description>
<name>PreferInstanceAvailableNotification</name>
<type>boolean</type>
<descriptors>
<value value="true"/>
</descriptors>
</attribute>
<attribute access="read-write" getMethod="getConcurrency" setMethod="setConcurrency">
<description>Maximum number of concurrent sent notifications.
</description>
<name>Concurrency</name>
<type>int</type>
<descriptors>
<value value="1"/>
</descriptors>
</attribute>
<attribute access="read-write"
getMethod="getStylesheet"
setMethod="setStylesheet">
<description><![CDATA[Stylesheet to get (additional) destinations from MPPS informations. <br />
The output must contain a &lt;destination aet="DEST" &gt; element for each destination.
Use NONE to disable this feature.<br />
A relative path name is resolved relative to
<i>archive-install-directory</i>/server/default/.]]>
</description>
<name>Mpps2IanDestinationStylesheet</name>
<type>java.lang.String</type>
<descriptors>
<value value="NONE"/>
</descriptors>
</attribute>
<attribute access="read-write" getMethod="getScnPriority" setMethod="setScnPriority">
<description>Priority used in Basic Study Content Notification Requests.
Enumerated Values: LOW, MEDIUM, HIGH.
</description>
<name>StudyContentNotificationPriority</name>
<type>java.lang.String</type>
<descriptors>
<value value="MEDIUM"/>
</descriptors>
</attribute>
<attribute access="read-write" getMethod="getRetrieveURI" setMethod="setRetrieveURI">
<description>Retrieve URI of this system. This value will be added to IAN dataset in attribute (0040,E010).
NONE = do not add Retrieve URI(0040,E010).
</description>
<name>RetrieveURI</name>
<type>java.lang.String</type>
<descriptors>
<value value="NONE"/>
</descriptors>
</attribute>
<attribute access="read-write" getMethod="getRetrieveLocationUID" setMethod="setRetrieveLocationUID">
<description>Retrieve Location UID of this system. This value will be added to IAN dataset in attribute (0040,E011).
NONE = do not add Retrieve Location UID(0040,E011).
</description>
<name>RetrieveLocationUID</name>
<type>java.lang.String</type>
<descriptors>
<value value="NONE"/>
</descriptors>
</attribute>
<attribute access="read-write"
getMethod="getQueueName"
setMethod="setQueueName">
<description>Used internally. Do not modify.</description>
<name>QueueName</name>
<type>java.lang.String</type>
</attribute>
<attribute access="read-write"
getMethod="getJmsServiceName"
setMethod="setJmsServiceName">
<description>Used internally. Do NOT modify.
</description>
<name>JMSServiceName</name>
<type>javax.management.ObjectName</type>
</attribute>
<attribute access="read-write"
getMethod="getStoreScpServiceName"
setMethod="setStoreScpServiceName">
<description>Used internally. Do not modify.
</description>
<name>StoreScpServiceName</name>
<type>javax.management.ObjectName</type>
</attribute>
<attribute access="read-write"
getMethod="getMppsScpServiceName"
setMethod="setMppsScpServiceName">
<description>Used internally. Do not modify.
</description>
<name>MppsScpServiceName</name>
<type>javax.management.ObjectName</type>
</attribute>
<attribute access="read-write"
getMethod="getDeleteStudyServiceName"
setMethod="setDeleteStudyServiceName">
<description>Used internally. Do not modify.
</description>
<name>DeleteStudyServiceName</name>
<type>javax.management.ObjectName</type>
</attribute>
<attribute access="read-write"
getMethod="getContentEditServiceName"
setMethod="setContentEditServiceName">
<description>Used internally. Do not modify.
</description>
<name>ContentEditServiceName</name>
<type>javax.management.ObjectName</type>
</attribute>
<attribute access="read-write"
getMethod="getTemplatesServiceName"
setMethod="setTemplatesServiceName">
<description>Used internally. Do NOT modify.
</description>
<name>TemplatesServiceName</name>
<type>javax.management.ObjectName</type>
</attribute>
<!-- Operations -->
&defaultOperations;
<operation impact="ACTION">
<description>schedule IAN for instances of specified study</description>
<name>scheduleIANforStudy</name>
<parameter>
<description>Study Instance UID</description>
<name>uid</name>
<type>java.lang.String</type>
</parameter>
<return-type>void</return-type>
</operation>
<operation impact="ACTION">
<description>schedule IAN for instances of specified series</description>
<name>scheduleIANforSeries</name>
<parameter>
<description>Series Instance UID</description>
<name>uid</name>
<type>java.lang.String</type>
</parameter>
<return-type>void</return-type>
</operation>
<operation impact="ACTION">
<description>schedule random IAN for testing</description>
<name>scheduleRandomIAN</name>
<parameter>
<description>Retrieve AE Title of all referenced instances</description>
<name>retrieveAET</name>
<type>java.lang.String</type>
</parameter>
<parameter>
<description>Availability (ONLINE, NEARLINE , OFFLINE or NOT AVAILABLE)
of all referenced instances</description>
<name>availability</name>
<type>java.lang.String</type>
</parameter>
<parameter>
<description>Number of referenced Series</description>
<name>numSeries</name>
<type>int</type>
</parameter>
<parameter>
<description>Number of referenced Instances per referenced Series</description>
<name>numInstancesPerSeries</name>
<type>int</type>
</parameter>
<return-type>void</return-type>
</operation>
<operation impact="ACTION">
<description>Notify other services about IAN. (can be also called from web3 after link/unlink)</description>
<name>notifyOtherServices</name>
<parameter>
<description>MPPS attributes</description>
<name>mpps</name>
<type>org.dcm4che.data.Dataset</type>
</parameter>
<return-type>void</return-type>
</operation>
</mbean>