Class Reference
IRIS for UNIX 2019.2
InterSystems: The power behind what matters   
Documentation  Search
  [ENSLIB] >  [EnsLib] >  [EDI] >  [X12] >  [Service] >  [TCPService]
Private  Storage   

class EnsLib.EDI.X12.Service.TCPService extends EnsLib.EDI.X12.Service.Standard

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 1 3


Summary

This is a Business Service class.

The associated Adapter class is EnsLib.EDI.X12.Adapter.TCPInboundAdapter.

Properties
%AlertStartTime %ConfigName %ConfigQueueName
%LastActionTime %LastHandledTime %LastReportedError
%OutsideCreated %PreserveSession %ProcessInputCalled
%QuitTask %RequestHeader %SessionId
%SuperSession %SuperSessionCreatedBeforeSession %WaitForNextCallInterval
%WarnedLatest %isShadow %outFraming
Adapter AddNackErrText AlertGracePeriod
AlertGroups AlertOnError ArchiveIO
BatchErrorAction BatchHandling BatchReplyType
BusinessPartner CommitAckType DefCharEncoding
DocSchemaCategory Framing GenerateSuperSessionID
IOLogEntry IgnoreInboundAck InactivityTimeout
LocalApplicationID ReplyMode SearchTableClass
TargetConfigNames ThrottleDelay TolerateNewlines
Validation

Methods
%AddToSaveSet %ClassIsLatestVersion %ClassName %ConstructClone
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %Extends
%GetParameter %IsA %IsModified %New
%NormalizeObject %ObjectModified %OnClose %OnNew
%OriginalNamespace %PackageName %RemoveFromSaveSet %SerializeObject
%SetModified %SuperSessionSet %ValidateObject AdapterName
AssignOneSetting CloseIOLogEntry EnumerateSettingsClose EnumerateSettingsExecute
EnumerateSettingsFetch ForceSessionId GenerateSuperSession GetDeferredResponseToken
GetProductionSettingValue GetProductionSettings GetPropertyConnections GetRequestClassList
GetResponseClassList GetSegmentTerminator GetSettings GetShadowInstance
IOLogDiscard NewIOLogEntry OnConstructReply OnDocumentEnd
OnDocumentStart OnError OnGenerateSuperSession OnGetConnections
OnInboundAck OnInit OnKeepalive OnMonitor
OnPostDocument OnPreDocument OnProcessInput OnProductionStart
OnProductionStop OnResolveDocType OnTearDown OnValidate
OutputFramedToDevice OutputFramedToIOStream PopulateSuperSession QueueName
SaveIOLogEntry SendAlert SendDeferredResponse SendReply
SendRequestAsync SendRequestSync SetOutFraming constructBatchReply
constructReply getReplyChildDocCode getReplyCode reportReply
resolveAndIndex resolveDocType standardOnProcessInput


Parameters

• parameter ADAPTER = "EnsLib.EDI.X12.Adapter.TCPInboundAdapter";
The type of adapter used to communicate with external systems

Properties

• property BatchHandling as %String(DISPLAYLIST=",Whole Batch,Single-Session Batch,Multi-Session Batch,Individual,",VALUELIST=",Whole,1Session,Batch,Indiv") [ InitialExpression = "Whole",Required ];
How to treat received Message batches: - Whole Batch = don't process child Message documents individually; accumulate and send the whole batch as one composite document - Single-Session Batch = forward each message in the batch as part of a single session, followed objects representing the batch headers / trailers - Multi-Session Batch = forward each message in the batch in its own session, including objects representing the batch headers / trailers - Individual = forward each child message in the batch in its own session; do not forward objects representing the batch headers / trailers

Methods

• 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(pLine As Ens.StringContainer, Output pLineLeftOver As Ens.StringContainer) as %Status
Note: pDocIn is not declared as EnsLib.EDI.X12.Document so that subclasses can handle other types and transform them before calling ##super().
• method SendReply(pReplyDocument As EnsLib.EDI.Document, pOriginalDoc As EnsLib.EDI.Document = $$$NULLOREF) as %Status


Copyright (c) 2019 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.