Skip to main content

This documentation is for an older version of this product. See the latest version of this content.Opens in a new tab

Ens.X12.FunctionSet

class Ens.X12.FunctionSet extends Ens.Rule.FunctionSet

Utility functions for creating X12 Documents

Method Inventory

Methods

classmethod X12CompleteTrailerAndReturnClear(X12Document As EnsLib.EDI.X12.Document, Save As %Boolean = 0) as %String
For the X12Document the appropriate Trailer segment will be created if it does not exist and the count and control fields assigned based on the contents of the X12Document.
If the optional Save is true (the default is false) then the X12Document will be saved.
The method returns the empty string allowing the unloading of an object via assignment.
If an Error is encountered it will be thrown.
final classmethod X12NewFunctionalGroup(InterchangeParent As EnsLib.EDI.X12.Document, DocType As %String = "", ForceNewPlaceHolderInParent As %Boolean = 0) as EnsLib.EDI.X12.Document
Make and return an X12 FuntionalGroup Document without GE segment
The separators will be taken from the InterchangeParent.
The Document Category will be taken from InterchangeParent unless specified in optional Doctype
The Document Name will be taken from Doctype if given otherwise it will be FunctionalGroup
The optional Doctype may specify just a document name and does not need to include the Document category as that can be taken from the InterchangeParent.
The new document will be set as a batch child of InterchangeParent
The document will have a TransactionSet place holder segment.
If ForceNewPlaceHolderInParent is true (the default is false) then a new GroupDocsRef place holder segment will be made in the InterchangeParent
If an Error is encountered it will be thrown.
final classmethod X12NewTransactionSet(GroupParent As EnsLib.EDI.X12.Document, DocType As %String = "", ForceNewPlaceHolderInParent As %Boolean = 0) as EnsLib.EDI.X12.Document
Make and return an X12 Transaction Set Document without SE segment
The separators will be taken from the GroupParent.
The Document Category will be taken from GroupParent unless specified in Doctype
The Document Name will be taken from Doctype
The Doctype may specify just a document name and does not need to include the Document category as that can be taken from the GroupParent.
The new document will be set as a batch child of GroupParent
If ForceNewPlaceHolderInParent is true (the default is false) then a new TransactionSetDocsRef place holder segment will be made in the GroupParent
If an Error is encountered it will be thrown.
classmethod X12SaveDocumentAndReturnClear(X12Document As EnsLib.EDI.X12.Document) as %String
The X12Document will be saved
The method returns the empty string allowing the unloading of an object via assignment.
If an Error is encountered it will be thrown.

Inherited Members

Inherited Methods

FeedbackOpens in a new tab