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

abstract class EnsLib.EDI.X12.Operation.Standard extends Ens.BusinessOperation, EnsLib.EDI.X12.Util.IOFraming

This is an abstract superclass for X12 Operations that send an X12 message

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 4 3


Summary

This is a Business Operation class.

Properties
%AlertStartTime %ConfigName %ConfigQueueName %LastActionTime
%LastHandledTime %LastReportedError %QuitTask %RequestHeader
%SessionId %SuperSession %WarnedLatest %isShadow
%outFraming Adapter AlertGroups AlertOnError
AlertRetryGracePeriod ArchiveIO BusinessPartner DefCharEncoding
DeferResponse FailureTimeout Framing IOLogEntry
InactivityTimeout NoFailWhileDisconnected QueueCountAlert QueueWaitAlert
ReplyCodeActions Retry RetryCount RetryInterval
SearchTableClass SendSuperSession Separators SuspendMessage
ThrottleDelay 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 DeferResponse EnumerateSettingsClose
EnumerateSettingsExecute EnumerateSettingsFetch GenerateSuperSession GetDeferredResponseToken
GetMessageList GetProductionSettingValue GetProductionSettings GetPropertyConnections
GetSettings GetShadowInstance IncludeSuperSession NewIOLogEntry
OnError OnFailureTimeout OnGenerateSuperSession OnGetConnections
OnGetReplyAction OnInit OnKeepalive OnMessage
OnMonitor OnProductionStart OnProductionStop OnTearDown
OnValidate OutputFramedToDevice OutputFramedToIOStream QueueName
SaveIOLogEntry SendAlert SendDeferredResponse SendRequestAsync
SendRequestSync SetOutFraming validateAndIndex

Subclasses
EnsLib.EDI.X12.Operation.BatchStandard EnsLib.EDI.X12.Operation.ReplyStandard

Parameters

• parameter SETTINGS = "Separators,SearchTableClass::selector?context={Ens.ContextSearch/SearchTableClasses?host=EnsLib.EDI.X12.Operation.Standard},DefCharEncoding::selector?context={Ens.ContextSearch/CharacterSets},Validation";
List of properties can be set as settings in the configuration file format is a comma separated list of property names

Properties

• property FailureTimeout as %Numeric(MINVAL=-1) [ InitialExpression = -1 ];
How long to keep retrying before giving up and returning an error code
• property SearchTableClass as %String(MAXLEN=100);
Store a set of searchable properties in SearchTable records associated with each document processed.

These records will be of the named SearchTable class, if any.

• property Separators as %String(MAXLEN=10) [ InitialExpression = $$$X12DefSeparatorsEsc_$$$X12DefSegTerminator_"\r\n" ];
String of separator characters to use in encoding outbound documents. Order is DataElementSeparator, ComponentSeparator, RepetitionSeparator.

Empty string means use the default values of the outbound document.

Additional characters will be used to override the Segment Terminator; may be up to 3 chars for output with newlines.

After position 3, '\r' means Ascii 13 (Carriage Return), '\n' means Ascii 10 (Linefeed / Newline), and '\a' means Ascii 30 (Record Separator).

You can also pad the separators up to position 3 with \x if you need to specify a line terminator but want your output messages to show less than 3 separators. The separators designated by \x will not be written out.

• property Validation as %String;
Comma-separated string specifying types of Validation to perform; see the class EnsLib.EDI.X12.Validator for details.

Any non-zero string will invoke basic validation.


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 OnValidate(pDoc As EnsLib.EDI.Document, pValSpec As %String, Output pStatus As %Status) as %Boolean
Override this method to implement your own custom method for validating of an incoming Document
• method validateAndIndex(pDoc As EnsLib.EDI.Document) as %Status


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