Skip to main content


class EnsLib.EDI.XML.Service.TCPFramed extends EnsLib.EDI.XML.Service.Standard, EnsLib.TCP.Framed.PassthroughService

Property Inventory

Method Inventory


parameter ADAPTER = EnsLib.TCP.FramedInboundAdapter;
Inherited description: The type of adapter used to communicate with external systems
parameter SETTINGS = SearchTableClass::selector?context={Ens.ContextSearch/SearchTableClasses?host=EnsLib.EDI.XML.Service.Standard},ReplyMode,DocSchemaCategory:Basic:selector?context={Ens.ContextSearch/SchemaCategories?host=EnsLib.EDI.XML.Service.Standard},Validation,-SendAcknowledgement,-SyncCall,-SyncCallTimeout;
Inherited description: List of properties can be set as settings in the configuration file format is a comma separated list of property names


property %VDocFormat as %String;
Format options to apply if we need to output an XML VDoc object as a Stream
Property methods: %VDocFormatDisplayToLogical(), %VDocFormatGet(), %VDocFormatIsValid(), %VDocFormatLogicalToDisplay(), %VDocFormatLogicalToOdbc(), %VDocFormatNormalize(), %VDocFormatSet()
property ReplyMode as %String (DISPLAYLIST = ",Never,Immediate,Application", VALUELIST = ",Never,Immed,App") [ InitialExpression = "Immed" ];
Control of Reply handling; options:
- Never : Do not send back any ACK
- Immediate : Send back AckOK or AckNotOK characters reply message immediately upon receipt of the inbound message
- Application : If message passes validation, wait for reply from target config item and forward it back when it arrives
Property methods: ReplyModeDisplayToLogical(), ReplyModeGet(), ReplyModeIsValid(), ReplyModeLogicalToDisplay(), ReplyModeLogicalToOdbc(), ReplyModeNormalize(), ReplyModeSet()


classmethod OnGetConnections(Output pArray As %String, pItem As Ens.Config.Item)
Inherited description: Return an array of connections for drawing lines on the config diagram
method OnInit() as %Status
This user callback method is called via initConfig() from %OnNew() or in the case of SOAP Services from OnPreSOAP()
method OnProcessInput(pInput As %Stream.Object, pOutput As %Library.RegisteredObject, ByRef pHint As %Library.String) as %Status
Inherited description: Wrap the input stream object in a StreamContainer message object and send it. If the SyncCall setting is true, send synchronously; otherwise send async to ensure that we don't return to the Adapter and let it delete the stream before the target Config Item is finished processing it.
method reportReply(pOriginalDoc As EnsLib.EDI.Document, pReplyCode As %String = "", ByRef pSC As %Status) as EnsLib.EDI.Document

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab