Class Reference
IRIS for UNIX 2024.1.2
InterSystems: The power behind what matters   
Documentation  Search
  [USER] >  [EnsLib] >  [EDI] >  [X12] >  [Service] >  [SOAPService]
Private  Storage   

class EnsLib.EDI.X12.Service.SOAPService extends EnsLib.SOAP.Service, EnsLib.EDI.X12.Service.Standard

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
4 5 6


Summary

Properties
%AlertStartTime %ConfigName %ConfigQueueName
%LastActionTime %LastHandledTime %LastReportedError
%OutsideCreated %PreserveSession %ProcessInputCalled
%QuitTask %RequestHeader %SessionId
%SuperSession %SuperSessionCreatedBeforeSession %WaitForNextCallInterval
%WarnedLatest %isShadow %outFraming
Adapter AddNackErrText AddressingIn
AddressingOut AlertGracePeriod AlertGroups
AlertOnError ArchiveIO Attachments
BadMessageHandler Base64LineBreaks BatchErrorAction
BatchHandling BatchReplyType BodyId
BodyXmlId BusinessPartner CommitAckType
ContentId ContentLocation DefCharEncoding
DefCompSep DefRepSep DefSegTerm
DocSchemaCategory DummyLibStreamIn FaultAddressing
FaultHeaders Framing GatewayTimeout
GenerateSuperSessionID HeadersIn HeadersOut
IOLogEntry IOStreamIn IOStreamReply
IgnoreInboundAck ImportHandler InactivityTimeout
IsMTOM LibStreamReply LocalApplicationID
Location MTOMRequired MsgClass
OutputTypeAttribute OverrideClientResponseWaitTimeout Password
RMSession ReferencesInline ReplyMode
RequestMessageStart ResponseAttachments ResponseContentId
ResponseContentLocation SAXFlags SNIPLevel
SOAPInvoked SearchTableClass SecurityContextToken
SecurityIn SecurityNamespace SecurityOut
SegTerminator SessionCookie SoapFault
SoapVersion SupportDelayedSyncRequest TargetConfigNames
ThrottleDelay Timeout TolerateNewlines
Transport UseSimulatedSync Username
ValMode Validation WriteSOAPBodyMethod

Methods
%AddEnvelopeNamespace %AddToSaveSet %ClassIsLatestVersion
%ClassName %ConstructClone %DispatchClassMethod
%DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty
%Extends %GetParameter %IsA
%IsModified %New %NormalizeObject
%ObjectModified %OnClose %OnCreateRMSession
%OnNew %OriginalNamespace %PackageName
%RemoveFromSaveSet %SerializeObject %SetModified
%SuperSessionSet %ValidateObject AdapterName
AssignOneSetting CloseIOLogEntry ConvertParameter
Decrypt Encrypt EnumerateSettingsClose
EnumerateSettingsExecute EnumerateSettingsFetch EscapeHTML
EscapeURL FileWSDL ForceSessionId
GatewayTimeout GenerateSuperSession GetBodyId
GetDeferredResponseToken GetMsgHdrRequestKey GetProductionSettingValue
GetProductionSettings GetPropertyConnections GetRequestClassList
GetResponseClassList GetSegmentTerminator GetSettings
GetShadowInstance HyperEventCall HyperEventHead
IOLogDiscard Include Initialize
InsertHiddenField InsertHiddenFields IsPrivate
Link MakeFault MakeFault12
MakeSecurityFault MakeStatusFault NewIOLogEntry
NormalizeName OnAdapterHTTPResponse OnAuthorize
OnCancelSecureConversation OnConstructReply OnDocumentEnd
OnDocumentStart OnError OnGenerateSuperSession
OnGetConnections OnHandleNoResponseYet OnInboundAck
OnInit OnKeepalive OnMonitor
OnPageError OnParsingError OnPopulateSendSyncHandling
OnPostDocument OnPostHTTP OnPostHyperEvent
OnPostWebMethod OnPreDocument OnPreHyperEvent
OnPreWebMethod OnProcessInput OnProductionStart
OnProductionStop OnRequestMessage OnResolveDocType
OnSOAPRequest OnStartSecureConversation OnTearDown
OnValidate OutputFramedToDevice OutputFramedToIOStream
Page PopulateSuperSession Process
ProcessBinary ProcessBody ProcessBodyNode
QueueName QuoteJS Reset
ReturnFault ReturnMethodStatusFault ReturnOneWay
ReturnStatusFault RewriteURL SOAPLogContains
SaveIOLogEntry Send SendAlert
SendDeferredResponse SendReply SendRequestAsync
SendRequestSync SetOutFraming SetReturnStatusCode
ShowError StartTimer StopTimer
ThrowError UnescapeHTML UnescapeURL
VerifySendSyncHandlingInstructions WSAddSignatureConfirmation constructBatchReply
constructReply getReplyChildDocCode getReplyCode
reportReply resolveAndIndex resolveDocType
standardOnProcessInput statusReturn


Parameters

• parameter ADAPTER = "EnsLib.SOAP.InboundAdapter";
The type of adapter used to communicate with external systems
• parameter NAMESPACE = "http://tempuri.org";
SOAP Namespace for the WebService Override this parameter in your subclass with the unique namespace URI of your organization.
• parameter SERVICENAME = "X12Service";
The SOAP name of this service. Override this parameter in the subclass.
• parameter SETTINGS = "-Framing";
List of properties can be set as settings in the configuration file format is a comma separated list of property names

Properties

• property DummyLibStreamIn as %Stream.GlobalCharacter;
• property IOStreamIn as %IO.MetaCharacterStream;
• property IOStreamReply as %IO.MetaCharacterStream;
• property LibStreamReply as %Stream.GlobalCharacter;
• property SegTerminator as %String [ InitialExpression = $C(13,10) ];
End-Segment marker character(s)

Methods

• method %OnNew(pConfigName As %String) as %Status
initialize Business Host object
• method GetSegmentTerminator() as %String
Return the segment terminator string that the Parser and the OutputTo...() methods will use.
• 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(pStreamIn As %CharacterStream, Output pStreamOut As %CharacterStream) 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 Send(Input As %Stream.GlobalCharacter) as %Stream.GlobalCharacter [ WebMethod ]
• method SendReply(pReplyDocument As EnsLib.EDI.Document, pOriginalDoc As EnsLib.EDI.Document = $$$NULLOREF) as %Status


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