Skip to main content


class EnsLib.EDI.ASTM.Adapter.TCPAdapter extends EnsLib.TCP.InboundAdapter

As specialized ASTM 2-way Adapter based on TCPInboundAdapter

Property Inventory

Method Inventory


parameter SETTINGS = ResponseTimeout,OutSeparators,GetReply;
Inherited description: List of properties can be set as settings in the configuration file format is a comma separated list of property names


property %InSeparators as %String (MAXLEN = 4, MINLEN = 4);
Remember separators from last input document
Property methods: %InSeparatorsDisplayToLogical(), %InSeparatorsGet(), %InSeparatorsIsValid(), %InSeparatorsLogicalToDisplay(), %InSeparatorsLogicalToOdbc(), %InSeparatorsNormalize(), %InSeparatorsSet()
property GetReply as %Boolean [ InitialExpression = 1 ];
The default is to get a reply but if the external system does not provide a reply turn this flag off.
Property methods: GetReplyDisplayToLogical(), GetReplyGet(), GetReplyIsValid(), GetReplyLogicalToDisplay(), GetReplyNormalize(), GetReplySet()
property OutQueueName as %String [ ReadOnly ];
Property methods: OutQueueNameDisplayToLogical(), OutQueueNameGet(), OutQueueNameIsValid(), OutQueueNameLogicalToDisplay(), OutQueueNameLogicalToOdbc(), OutQueueNameNormalize()
property OutSeparators as %String (MAXLEN = 4, MINLEN = 4) [ InitialExpression = "Flex" ];
Separator characters to use when sending outbound ASTM documents.

'Flex' means copy the separators from inbound messages, or use the native separators of the outbound message if outbound goes first.

Property methods: OutSeparatorsDisplayToLogical(), OutSeparatorsGet(), OutSeparatorsIsValid(), OutSeparatorsLogicalToDisplay(), OutSeparatorsLogicalToOdbc(), OutSeparatorsNormalize(), OutSeparatorsSet()
property Port as Ens.DataType.TCPAgentPort [ InitialExpression = 10001 , Required ];
TCP Port to connect to. To listen instead of intiating a connection, configure AllowedIPAddresses=!IPaddr.
Property methods: PortDisplayToLogical(), PortGet(), PortIsValid(), PortLogicalToDisplay(), PortLogicalToOdbc(), PortNormalize(), PortSet()
property ResponseTimeout as %Numeric (MINVAL = -1) [ InitialExpression = 15 ];
Number of seconds to wait for a response to begin arriving back from the remote system after sending a request. Setting the timeout to -1 means wait forever.
Property methods: ResponseTimeoutDisplayToLogical(), ResponseTimeoutGet(), ResponseTimeoutIsValid(), ResponseTimeoutLogicalToDisplay(), ResponseTimeoutNormalize(), ResponseTimeoutSet()
property Terminators as %String [ InitialExpression = $C(10) ];
Inherited description: Read-terminator character or characters, if any, for subclasses that do terminated reads.
Property methods: TerminatorsDisplayToLogical(), TerminatorsGet(), TerminatorsIsValid(), TerminatorsLogicalToDisplay(), TerminatorsLogicalToOdbc(), TerminatorsNormalize(), TerminatorsSet()


method Disconnect()
method OnConnected() as %Status
method OnInit() as %Status
Inherited description: This user callback method is called just after %OnNew()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab