Skip to main content


class HS.IHE.ATNA.SecureApplication.TCP.Operations extends Ens.BusinessOperation, HS.IHE.ATNA.SecureApplication.Syslog.Common, HS.IHE.Common.Actor.Base, HS.HC.Util.Trace.Helper

Property Inventory

Method Inventory


parameter ADAPTER = HS.IHE.ATNA.SecureApplication.TCP.TextLineOutboundAdapter;
Inherited description: The type of adapter used to communicate with external systems
parameter INVOCATION = Queue;
Inherited description: 2 modes: Queue, InProc
parameter LOGCONNECTIONS = 0;
parameter SETTINGS = ServiceName:Basic:selector?Select=1&context={HS.Util.ContextSearch/ServiceNameItemsByParam?Type=TCP},TCPDebugOutputFile,AuditMessageType,CustomAuditMessageClass;
Inherited description: List of properties can be set as settings in the configuration file format is a comma separated list of property names


property AuditMessageType as %String (VALUELIST = ",DICOM,RFC3881,CUSTOM") [ InitialExpression = "DICOM" ];
Property methods: AuditMessageTypeDisplayToLogical(), AuditMessageTypeGet(), AuditMessageTypeIsValid(), AuditMessageTypeLogicalToDisplay(), AuditMessageTypeLogicalToOdbc(), AuditMessageTypeNormalize(), AuditMessageTypeSet()
property CustomAuditMessageClass as %String);
When AuditMessageType is set to CUSTOM the class which will generate the ATNA message (likely an extension of HS.IHE.ATNA.Repository.AggregationToDICOMAuditMessage)
Property methods: CustomAuditMessageClassDisplayToLogical(), CustomAuditMessageClassGet(), CustomAuditMessageClassIsValid(), CustomAuditMessageClassLogicalToDisplay(), CustomAuditMessageClassLogicalToOdbc(), CustomAuditMessageClassNormalize(), CustomAuditMessageClassSet()
property RegistryService as %String;
Caches Service Registry information for the currently selected service. Format is: $lb(Service Name, Service %Id, Device OID, Assigning Authority, Receiving Application, Receiving Facility, Host, Port, StayConnected, SSLConfig)
Property methods: RegistryServiceDisplayToLogical(), RegistryServiceGet(), RegistryServiceIsValid(), RegistryServiceLogicalToDisplay(), RegistryServiceLogicalToOdbc(), RegistryServiceNormalize(), RegistryServiceSet()
property ServiceName as %String (MAXLEN = 512);
The service name found in HS.Registry.Service.*
Property methods: ServiceNameDisplayToLogical(), ServiceNameGet(), ServiceNameIsValid(), ServiceNameLogicalToDisplay(), ServiceNameLogicalToOdbc(), ServiceNameNormalize(), ServiceNameSet()
property TCPDebugOutputFile as %String;
Property methods: TCPDebugOutputFileDisplayToLogical(), TCPDebugOutputFileGet(), TCPDebugOutputFileIsValid(), TCPDebugOutputFileLogicalToDisplay(), TCPDebugOutputFileLogicalToOdbc(), TCPDebugOutputFileNormalize(), TCPDebugOutputFileSet()


method OnInit() as %Status
Inherited description: This user callback method is called via initConfig() from %OnNew() or in the case of SOAP Services from OnPreSOAP()
method OnMessage(pRequest As %Persistent, Output pResponse As %Persistent = $$$NULLOREF) as %Status
Inherited description: This is the default message handler. All request types not declared in the message map are delivered here
method OutputToDebugFile(pAuditMessage As %String = "") as %Status
method UpdateRegistryService(pService)
UpdateRegistryService updates - if needed - the info in the RegistryService property. Update is based on pService, the ServiceName setting, and the info currently in RegistryService. The ServiceName setting is the default service name to use, and may be overridden by pRequest.AdditionalInfo.GetAt("ServiceName"). If RegistryService is updated, then the properties on this BO's TCP adapter are also updated. If Service Registry settings on a TCP service are changed, then this BO should be restarted to guarantee that the changes are effective at run time.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab