This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRIS, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions page (login required).

Home > Class Reference > ENSLIB namespace > EnsLib.EDI.ASTM.Operation.TCPOperation


class EnsLib.EDI.ASTM.Operation.TCPOperation extends EnsLib.EDI.ASTM.Operation.Standard

Property Inventory

Method Inventory


parameter ADAPTER;
Inherited description: The type of adapter used to communicate with external systems
parameter SETTINGS = PartnerService:Basic:selector?context={Ens.ContextSearch/ProductionItems?services=1&productionName=@productionId};
Inherited description: List of properties can be set as settings in the configuration file format is a comma separated list of property names


property PartnerService as %String (MAXLEN = 128);
The name of an ASTM service to which outbound messages will be forwarded for sending to a remote ASTM device. Additionally the IP address of the remote ASTM device may be appended after a colon if the service allows connections from multiple remote devices. Services with JobPerConnection = true will not receive messages from this operation unless the IP address is appended. Services with JobPerConnection = false will work with just the service name entered here.
Property methods: PartnerServiceDisplayToLogical(), PartnerServiceGet(), PartnerServiceGetReplyDisplayToLogical(), PartnerServiceGetReplyGet(), PartnerServiceGetReplyIsValid(), PartnerServiceGetReplyLogicalToDisplay(), PartnerServiceGetReplyNormalize(), PartnerServiceGetReplySet(), PartnerServiceIsValid(), PartnerServiceLogicalToDisplay(), PartnerServiceLogicalToOdbc(), PartnerServiceNormalize(), PartnerServiceSet()
property PartnerServiceGetReply as %Boolean [ InitialExpression = 1 ];
This is the GetReply setting from the service's adapters GetReply
Property methods: PartnerServiceGetReplyDisplayToLogical(), PartnerServiceGetReplyGet(), PartnerServiceGetReplyIsValid(), PartnerServiceGetReplyLogicalToDisplay(), PartnerServiceGetReplyNormalize(), PartnerServiceGetReplySet()
property ResponseTimeout as %Numeric [ InitialExpression = -1 ];
In the case a synchronous response is called for by the sender, this value governs how long this Operation should wait for a response from the instrument via the PartnerService. A value of -1 means to wait forever and not fail. Note that this may prevent un-forced shutdown of this Operation.
Property methods: ResponseTimeoutDisplayToLogical(), ResponseTimeoutGet(), ResponseTimeoutIsValid(), ResponseTimeoutLogicalToDisplay(), ResponseTimeoutNormalize(), ResponseTimeoutSet()


classmethod OnGetConnections(Output pArray As %String, pItem As Ens.Config.Item)
Return an array of connections for drawing lines on the config diagram
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 EnsLib.EDI.ASTM.Document, Output pResponse As %Persistent) as %Status
Inherited description: This is the default message handler. All request types not declared in the message map are delivered here

Inherited Members

Inherited Properties

Inherited Methods