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

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


Parameters Properties Methods Queries Indices ForeignKeys Triggers
4 1 4


This is a Business Service class.

The associated Adapter class is EnsLib.File.InboundAdapter.

%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 ReplyTargetConfigNames
SearchTableClass TargetConfigNames ThrottleDelay
TolerateNewlines Validation

%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


• parameter ADAPTER = "EnsLib.File.InboundAdapter";
The type of adapter used to communicate with external systems
• parameter OpenTimeout = 5;
• parameter ReadTimeout = 1;
• parameter SETTINGS = "ReplyTargetConfigNames:Acknowledgement:selector?multiSelect=1&context={Ens.ContextSearch/ProductionItems?targets=1&productionName=@productionId}";
List of properties can be set as settings in the configuration file format is a comma separated list of property names


• property ReplyTargetConfigNames as %String;
ConfigName(s) of the operations or processes to which reply (i.e. TA1 & 997) messages should be forwarded.


• 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
This user callback method is called via initConfig() from %OnNew() or in the case of SOAP Services from OnPreSOAP()
• method OnProcessInput(pFileStream As %CharacterStream, Output pOutput As %RegisteredObject) 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.