Skip to main content

This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.Opens in a new tab

For information on migrating to InterSystems IRISOpens in a new tab, see Why Migrate to InterSystems IRIS?

This version of the product is no longer supported, and this documentation is no longer updated regularly. See the latest version of this content.Opens in a new tab

EnsLib.EDI.X12.Operation.Standard

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

Property Inventory

Method Inventory

Parameters

parameter SETTINGS = Separators,SearchTableClass::selector?context={Ens.ContextSearch/SearchTableClasses?host=EnsLib.EDI.X12.Operation.Standard},DefCharEncoding::selector?context={Ens.ContextSearch/CharacterSets},Validation;
Inherited description: 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 methods: FailureTimeoutDisplayToLogical(), FailureTimeoutGet(), FailureTimeoutIsValid(), FailureTimeoutLogicalToDisplay(), FailureTimeoutNormalize(), FailureTimeoutSet()
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 methods: SearchTableClassDisplayToLogical(), SearchTableClassGet(), SearchTableClassIsValid(), SearchTableClassLogicalToDisplay(), SearchTableClassLogicalToOdbc(), SearchTableClassNormalize(), SearchTableClassSet()
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 methods: SeparatorsDisplayToLogical(), SeparatorsGet(), SeparatorsIsValid(), SeparatorsLogicalToDisplay(), SeparatorsLogicalToOdbc(), SeparatorsNormalize(), SeparatorsSet()
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.

Property methods: ValidationDisplayToLogical(), ValidationGet(), ValidationIsValid(), ValidationLogicalToDisplay(), ValidationLogicalToOdbc(), ValidationNormalize(), ValidationSet()

Methods

method OnInit() as %Status
Inherited description: 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

Inherited Members

Inherited Properties

Inherited Methods

Subclasses

FeedbackOpens in a new tab