Home > Class Reference > ENSLIB namespace > EnsLib.EDI.X12.Document

EnsLib.EDI.X12.Document

persistent class EnsLib.EDI.X12.Document extends %Library.Persistent, EnsLib.EDI.BatchDocument, EnsLib.EDI.Segmented, EnsLib.EDI.X12.MsgBodyMethods

SQL Table Name: EnsLib_EDI_X12.Document

Represents an Interchange or a TransactionSet. FunctionalGroups are represented as Segments within an Interchange.

Property Inventory

Method Inventory

Parameters

parameter DEFSEARCHCLASS = EnsLib.EDI.X12.SearchTable;
Name of the default SearchTable indexing class used in UI choices and MessageBank submissions
parameter DOCCLASSFULLNAME = ASC X12 EDI Document;
Inherited description: Full descriptive name for this subclass of document
parameter DOCCLASSNAME = X12 Document;
Inherited description: Compact descriptive name for this subclass of document
parameter DOCSHORTNAME = X12;
parameter DOMAIN = Ensemble;
Use our own domain for localization
parameter EXTENTSIZE = 2000000;
Inherited description: The EXTENTSIZE parameter is used to inform the SQL Query Optimizer of the approximate number of instances in the extent containing instances of this class.

For example, a class that expects to have about 1,000,000 instances should define:

parameter EXTENTSIZE = 1000000;
parameter SCHEMACLASS = EnsLib.EDI.X12.Schema:DS;
Name of the associated schema class and after a colon the schema element code that represents a DocType

Properties

property %maps [ MultiDimensional , Transient ];
A local array of orefs "orefs" - a local map of integer ids to segment objects And either a subscript into ^IRIS.Temp for this object's LVD maps (for notes on LVD implementation see EnsEDI.inc) or local storage for these additional maps: "runtimeIndex" - array for runtime index to segment; will always be defined unless mapRuntimePath is defined "runtimePath" - array for runtime path to segment "bidirectionalLink" - array for runtime path and index linkage
Property methods: %mapsDisplayToLogical(), %mapsGet(), %mapsIsValid(), %mapsLogicalToDisplay(), %mapsLogicalToOdbc(), %mapsNormalize(), %mapsSet()
property Attachments as array of Ens.StreamContainer;
Attachment streams associated with this document
Property methods: AttachmentsBuildValueArray(), AttachmentsCollectionToDisplay(), AttachmentsCollectionToOdbc(), AttachmentsDisplayToCollection(), AttachmentsGet(), AttachmentsGetObject(), AttachmentsGetObjectId(), AttachmentsGetStored(), AttachmentsGetSwizzled(), AttachmentsIsValid(), AttachmentsOdbcToCollection(), AttachmentsSet(), AttachmentsSetObject(), AttachmentsSetObjectId()
property ChildCount as %Integer [ Calculated , Transient , ReadOnly ];
Number of Children
Property methods: ChildCountCompute(), ChildCountDisplayToLogical(), ChildCountGet(), ChildCountIsValid(), ChildCountLogicalToDisplay(), ChildCountNormalize(), ChildCountSQLCompute()
property ComponentSeparator as %String [ Calculated , Transient ];
Sub-element component separator character
Property methods: ComponentSeparatorDisplayToLogical(), ComponentSeparatorGet(), ComponentSeparatorIsValid(), ComponentSeparatorLogicalToDisplay(), ComponentSeparatorLogicalToOdbc(), ComponentSeparatorNormalize()
property DocTypeCategory as %String [ Transient , ReadOnly ];
the category portion of the DocType
Property methods: DocTypeCategoryDisplayToLogical(), DocTypeCategoryGet(), DocTypeCategoryIsValid(), DocTypeCategoryLogicalToDisplay(), DocTypeCategoryLogicalToOdbc(), DocTypeCategoryNormalize(), DocTypeCategorySet()
property DocTypeName as %String [ Transient , ReadOnly ];
Stored raw document type name ; the secondary type name portion of the DocType
Property methods: DocTypeNameDisplayToLogical(), DocTypeNameGet(), DocTypeNameIsValid(), DocTypeNameLogicalToDisplay(), DocTypeNameLogicalToOdbc(), DocTypeNameNormalize()
property ElementSeparator as %String [ Calculated , Transient ];
Data-element separator character
Property methods: ElementSeparatorDisplayToLogical(), ElementSeparatorGet(), ElementSeparatorIsValid(), ElementSeparatorLogicalToDisplay(), ElementSeparatorLogicalToOdbc(), ElementSeparatorNormalize()
property Envelope as %String);
XML or other 'envelope' for the X12 document message. The X12 document will be inserted in place of the "<!--X12DOC-->" string If present, otherwise after the end of the Envelope.
Property methods: EnvelopeDisplayToLogical(), EnvelopeGet(), EnvelopeGetStored(), EnvelopeIsValid(), EnvelopeLogicalToDisplay(), EnvelopeLogicalToOdbc(), EnvelopeNormalize(), EnvelopeSet()
property FullSize as %Integer [ Calculated , Transient , ReadOnly ];
Size in bytes of the message content (assuming 1-byte segment terminators, including segments >32k)
Property methods: FullSizeDisplayToLogical(), FullSizeGet(), FullSizeIsValid(), FullSizeLogicalToDisplay(), FullSizeNormalize()
property FunctionalGroups as EnsLib.EDI.X12.Document [ MultiDimensional , Transient ];
Temporary property used to hold pointers to FunctionalGroup child documents
Used in DTL Editor when using the DocType Batch multiple structure
Only used if Name is Interchange
Setter/Getter methods are overridden
Property methods: FunctionalGroupsGet(), FunctionalGroupsGetObject(), FunctionalGroupsGetObjectId(), FunctionalGroupsGetSwizzled(), FunctionalGroupsIsValid(), FunctionalGroupsNewObject(), FunctionalGroupsSet(), FunctionalGroupsSetObject(), FunctionalGroupsSetObjectId(), FunctionalGroupsUnSwizzle()
property Identifier as %String [ Calculated , Transient , ReadOnly ];
Unique document identification string found in document content
Property methods: IdentifierCompute(), IdentifierDisplayToLogical(), IdentifierGet(), IdentifierIsValid(), IdentifierLogicalToDisplay(), IdentifierLogicalToOdbc(), IdentifierNormalize(), IdentifierSQLCompute()
property Name as %String [ Calculated , Transient , ReadOnly ];
Raw type name of document
Property methods: NameCompute(), NameDisplayToLogical(), NameGet(), NameIsValid(), NameLogicalToDisplay(), NameLogicalToOdbc(), NameNormalize(), NameSQLCompute()
property ParentGE as EnsLib.EDI.X12.Segment [ Calculated , Transient , ReadOnly ];
Property methods: ParentGEGet(), ParentGEIdCompute(), ParentGEIdDisplayToLogical(), ParentGEIdGet(), ParentGEIdIsValid(), ParentGEIdLogicalToDisplay(), ParentGEIdNormalize(), ParentGEIdSQLCompute()
property ParentGEId as %Integer [ Calculated , Transient , ReadOnly ];
Id of the GE segment of the FunctionalGroup in the Interchange within which this TransactionSet arrived or Id of the IEA segment of the Interchange within which this FunctionGroup arrived
Property methods: ParentGEIdCompute(), ParentGEIdDisplayToLogical(), ParentGEIdGet(), ParentGEIdIsValid(), ParentGEIdLogicalToDisplay(), ParentGEIdNormalize(), ParentGEIdSQLCompute()
property ParentGS as EnsLib.EDI.X12.Segment [ Calculated , Transient , ReadOnly ];
Property methods: ParentGSGet(), ParentGSIdCompute(), ParentGSIdDisplayToLogical(), ParentGSIdGet(), ParentGSIdIsValid(), ParentGSIdLogicalToDisplay(), ParentGSIdNormalize(), ParentGSIdSQLCompute()
property ParentGSId as %Integer [ Calculated , Transient , ReadOnly ];
Id of the GS segment of the FunctionalGroup in the Interchange within which this TransactionSet arrived or Id of the ISA segment of the Interchange within which this FunctionGroup arrived
Property methods: ParentGSIdCompute(), ParentGSIdDisplayToLogical(), ParentGSIdGet(), ParentGSIdIsValid(), ParentGSIdLogicalToDisplay(), ParentGSIdNormalize(), ParentGSIdSQLCompute()
property ParentIEA as EnsLib.EDI.X12.Segment [ Calculated , Transient , ReadOnly ];
Property methods: ParentIEAGet(), ParentIEAIdCompute(), ParentIEAIdDisplayToLogical(), ParentIEAIdGet(), ParentIEAIdIsValid(), ParentIEAIdLogicalToDisplay(), ParentIEAIdNormalize(), ParentIEAIdSQLCompute()
property ParentIEAId as %Integer [ Calculated , Transient , ReadOnly ];
Id of the IEA segment of the Interchange within which this TransactionSet arrived
Property methods: ParentIEAIdCompute(), ParentIEAIdDisplayToLogical(), ParentIEAIdGet(), ParentIEAIdIsValid(), ParentIEAIdLogicalToDisplay(), ParentIEAIdNormalize(), ParentIEAIdSQLCompute()
property ParentISA as EnsLib.EDI.X12.Segment [ Calculated , Transient , ReadOnly ];
Property methods: ParentISAGet(), ParentISAIdCompute(), ParentISAIdDisplayToLogical(), ParentISAIdGet(), ParentISAIdIsValid(), ParentISAIdLogicalToDisplay(), ParentISAIdNormalize(), ParentISAIdSQLCompute()
property ParentISAId as %Integer [ Calculated , Transient , ReadOnly ];
Id of the ISA segment of the Interchange within which this TransactionSet arrived
Property methods: ParentISAIdCompute(), ParentISAIdDisplayToLogical(), ParentISAIdGet(), ParentISAIdIsValid(), ParentISAIdLogicalToDisplay(), ParentISAIdNormalize(), ParentISAIdSQLCompute()
property ParentIds as %String [ Calculated , Transient , ReadOnly ];
A $List of the Ids of all the enclosing parent documents of this nested document, if nested, in order from from immediate to outermost E.g. for Id of enclosing EncounterBatch if we are an Encounter
Property methods: ParentIdsCompute(), ParentIdsDisplayToLogical(), ParentIdsGet(), ParentIdsIsValid(), ParentIdsLogicalToDisplay(), ParentIdsLogicalToOdbc(), ParentIdsNormalize(), ParentIdsSQLCompute()
property ParentInterchange as EnsLib.EDI.X12.Document [ Calculated , Transient , ReadOnly ];
Property methods: ParentInterchangeGet(), ParentInterchangeGetObjectId()
property RawContent as %String (MAXLEN = 10000) [ Calculated , Transient , ReadOnly ];
The raw text content of the document. Note that this is a truncated version suitable for use in SQL results and visual inspection, but not a complete or definitive representation of the document.
Property methods: RawContentCompute(), RawContentDisplayToLogical(), RawContentGet(), RawContentIsValid(), RawContentLogicalToDisplay(), RawContentLogicalToOdbc(), RawContentNormalize(), RawContentSQLCompute()
property RepetitionSeparator as %String [ Calculated , Transient ];
Repetition separator character
Property methods: RepetitionSeparatorDisplayToLogical(), RepetitionSeparatorGet(), RepetitionSeparatorIsValid(), RepetitionSeparatorLogicalToDisplay(), RepetitionSeparatorLogicalToOdbc(), RepetitionSeparatorNormalize()
property SegCount as %Integer [ Calculated , Transient , ReadOnly ];
Count of segments composing this document
Property methods: SegCountCompute(), SegCountDisplayToLogical(), SegCountGet(), SegCountIsValid(), SegCountLogicalToDisplay(), SegCountNormalize(), SegCountSQLCompute()
property SegmentTerminator as %String [ Calculated , Transient ];
Segment Terminator character(s)
Property methods: SegmentTerminatorDisplayToLogical(), SegmentTerminatorGet(), SegmentTerminatorIsValid(), SegmentTerminatorLogicalToDisplay(), SegmentTerminatorLogicalToOdbc(), SegmentTerminatorNormalize()
property Separators as %String (MAXLEN = 6, MINLEN = 3) [ Transient ];
All 3 Separators as a String, plus optionally SegmentTerminator: ELESEP_COMSEP_REPSEP Additional characters will be output as the Segment Terminator; may have up to 3 additional chars for output with newlines
Property methods: SeparatorsDisplayToLogical(), SeparatorsGet(), SeparatorsIsValid(), SeparatorsLogicalToDisplay(), SeparatorsLogicalToOdbc(), SeparatorsNormalize(), SeparatorsSet()
property TransactionSets as EnsLib.EDI.X12.Document [ MultiDimensional , Transient ];
Temporary property used to hold pointers to TransactionSet child documents
Used in the DTL Editor when using the DocType Batch multiple structure
Only used if Name is Group
Setter/Getter methods are overridden
Property methods: TransactionSetsGet(), TransactionSetsGetObject(), TransactionSetsGetObjectId(), TransactionSetsGetSwizzled(), TransactionSetsIsValid(), TransactionSetsNewObject(), TransactionSetsSet(), TransactionSetsSetObject(), TransactionSetsSetObjectId(), TransactionSetsUnSwizzle()
property TypeVersion as %String [ Calculated , Transient , ReadOnly ];
Raw type version name of message found at MSH:12 in message content
Property methods: TypeVersionCompute(), TypeVersionDisplayToLogical(), TypeVersionGet(), TypeVersionIsValid(), TypeVersionLogicalToDisplay(), TypeVersionLogicalToOdbc(), TypeVersionNormalize(), TypeVersionSQLCompute()

Methods

method AddAttachment(pStream As %Stream.Object) as %Status [ Language = objectscript ]
method AddEndSegment() as %Status [ Language = objectscript ]
See Ens.X12.FunctionSet for updated helper class methods
method AddFunctionalGroup(pGS As EnsLib.EDI.X12.Segment, Output pGroupSegIndex As %Integer = "") as %Status [ Language = objectscript ]
See Ens.X12.FunctionSet for updated helper class methods
method AddTransactionSet(pTxnSet As EnsLib.EDI.X12.Document, pGroupSegIndex As %Integer, pAttachment As %Stream.Object = $$$NULLOREF) as %Status [ Language = objectscript ]
Add a TransactionSet to the Interchange. Add it to a group given the segment index of the placeholder segment between GS and GE segments. See Ens.X12.FunctionSet for updated helper class methods
method BuildMap(pKeepParsingAfterError As %Boolean = 1, pReportMissingLoopAsFirstSeg As %Boolean = 0) as %Status [ Language = objectscript ]
pKeepParsingAfterError means keep trying to parse after errors are encountered; returned Status will contain all errors encountered pReportMissingLoopAsFirstSeg means to report the first segment from loop as missing instead of naming the loop if the loop is missing
method Clear() as %Status [ Language = objectscript ]
Delete All Content and reset all properties
method ComponentSeparatorGet() as %String [ Language = objectscript ]
method CopyValues(pSource As EnsLib.EDI.X12.Document, pSourcePath As %String, pTargetPath As %String, pAction As %String, pKey As %String, pEmptyFieldAsNull As %Boolean = 0, pIgnoreMissingSource As %Boolean = 0) as %Status [ Language = objectscript ]
Inherited description: Copy a whole set of values from source to target when iteration is implied between 2 VDocs pSourcePath contains the property path to the source set
pTargetPath contains the property path to the target set
pAction contains an action code: "set", etc..
pKey contains an optional key value or a set of comma-separated key values to be used as array indices where empty array index placeholders are present in pPropertyPath.
classmethod DetermineReplyVersion(pIGRef As %String) as %String [ Language = objectscript ]
Determine the reply type to use with the given Implementation Guide reference. We send a 999 response to HIPAA standard transactions with version 5010 or greater. Otherwise we send a 997 response.
method DocTypeSet(pDocType As %String, pBuildMap As %Boolean = 1) as %Status [ Language = objectscript ]
method DumpMaps() as %Status [ Language = objectscript ]
method ElementSeparatorGet() as %String [ Language = objectscript ]
classmethod EnumerateDocTypesClose(ByRef qHandle As %Binary) as %Status [ Language = objectscript ]
classmethod EnumerateDocTypesExecute(ByRef qHandle As %Binary, Category As %String, IncludeBase As %Boolean, IncludeInterchangeTree As %Boolean) as %Status [ Language = objectscript ]
classmethod EnumerateDocTypesFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer) as %Status [ Language = objectscript ]
classmethod EnumerateSegTypesClose(ByRef qHandle As %Binary) as %Status [ Language = objectscript ]
classmethod EnumerateSegTypesExecute(ByRef qHandle As %Binary, Category As %String, Level As %String, IncludeBase As %Boolean) as %Status [ Language = objectscript ]
classmethod EnumerateSegTypesFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer) as %Status [ Language = objectscript ]
classmethod EnumerateTypeCategoriesClose(ByRef qHandle As %Binary) as %Status [ Language = objectscript ]
classmethod EnumerateTypeCategoriesExecute(ByRef qHandle As %Binary, Standard As %String = "") as %Status [ Language = objectscript ]
classmethod EnumerateTypeCategoriesFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer) as %Status [ Language = objectscript ]
method FindSegment(pSegName As %String, ByRef pIndex As %String = "", Output pStatus As %Status) as EnsLib.EDI.X12.Segment [ Language = objectscript ]
Gets the next segment after index pIndex with name pSegName. Supports pSegName = '*' to match any segment.
method FullSizeGet() as %Integer [ Language = objectscript ]
classmethod GetAlias(pContentArrayName As %String, pArrayPos As %String) as %String [ Language = objectscript ]
This method computes the Alias string for a property name, given the property's node in the Content Array.
classmethod GetContentArray(Output pContents, pMode As %String, pDocType As %String, pLevel As %Integer, pIncludeBase As %Boolean) as %Status [ Language = objectscript ]
Inherited description: Returns array of properties that make up the contents of this object.
This method in implemented within the document class.
The content array is in the form:
pContents(n,"type")="%String"
pContents(n,"name")="Field"
pContents(n,"alias")=alias code
If pContents(n) is non-zero then the property is a composite type with
sub-properties. The sub-properties are indexed with a similar structure under
pContents(n,m) where m is the index of the subtype property.
classmethod GetFullSize(pMsgId) as %Integer [ Language = objectscript ]
Returns an array of links to manager pages for this type of VDoc; item 0 is the family description
method GetNextGroupPath(pGroup As %String, pPath As %String, ByRef pStatus As %Status = $$$OK) as %String [ Language = objectscript ]
Gets the next path in a group
method GetNextIndex(pPath As %String, pIndex As %String, ByRef pStatus As %Status = $$$OK) as %String [ Language = objectscript ]
Gets the next index in an array
classmethod GetReplyGroupSegs(pLocalApplicationID As %String = "", pOriginalReceiversCode As %String, pOriginalSendersCode As %String, pVersion As %String, Output pReplyGESeg As EnsLib.EDI.X12.Segment, Output pSC As %Status, pSeparators As %String = $$$X12DefSeparators) as EnsLib.EDI.X12.Segment [ Language = objectscript ]
Create new GS/GE group segments as a reply, having been given relevant values from original ISA or GS
method GetSegmentIndex(pPath As %String, Output pStatus As %Status) as %Integer [ Language = objectscript ]
Given a segment path, find the corresponding segment index
method GetSegmentPath(pIndex As %Integer, Output pStatus As %Status) as %String [ Language = objectscript ]
Given a segment index, find the corresponding segment path
method GetValueAt(pSegmentPropertyPath As %String, pSeparators As %String, Output pStatus As %Status, pTreatEmptyAsNull As %Boolean = 0) as %String [ Language = objectscript ]
Inherited description: Return the value of the designated virtual property.
pPropertyPath contains a text expression representing the address within the document of the value of interest.
pFormat contains additional context that may be used to influence the form of the result value
If no value can be found matching pPropertyPath in the current document an empty string is returned and output argument pStatus returns status information explaining the failure
pTreatEmptyFieldAsNull indicates whether repeating fields which have a separator but are empty should be considered to have a count of 1 (if false) or 0 (if true) This is implemented by the document subclass.
method IdentifierGet() as %String [ Language = objectscript ]
classmethod ImportFromDevice(Output pStatus As %Status, ByRef pConfigItem As %String, pIOFormatClassname As %String, pDefaultRepSep As %String = "", pDefaultCompSep As %String = "", pDefaultSegTerminator As %String = "") as EnsLib.EDI.X12.Document [ Language = objectscript ]
classmethod ImportFromFile(pFilename As %String, pDocNum As %Integer = 1, Output pStatus As %Status, ByRef pConfigItem As %String, pIOFormatClassname As %String, pDefaultRepSep As %String = "", pDefaultCompSep As %String = "", pDefaultSegTerminator As %String = "") as EnsLib.EDI.X12.Document [ Language = objectscript ]
classmethod ImportFromIOStream(pIOStream As %IO.I.CharacterStream, Output pStatus As %Status = $$$OK, ByRef pConfigItem As %String = "", pIOFormatClassname As %String = "", pDefaultRepSep As %String = "", pDefaultCompSep As %String = "", pDefaultSegTerminator As %String = "") as EnsLib.EDI.X12.Document [ Language = objectscript ]
classmethod ImportFromLibraryStream(pLibStream As %Stream.Object, Output pStatus As %Status, ByRef pConfigItem As %String, pIOFormatClassname As %String, pDefaultRepSep As %String = "", pDefaultCompSep As %String = "", pDefaultSegTerminator As %String = "") as EnsLib.EDI.X12.Document [ Language = objectscript ]
classmethod ImportFromString(pString As %String, Output pStatus As %Status, ByRef pConfigItem As %String, pIOFormatClassname As %String, pDefaultRepSep As %String = "", pDefaultCompSep As %String = "", pDefaultSegTerminator As %String = "") as EnsLib.EDI.X12.Document [ Language = objectscript ]
classmethod KillGlobals(Output pDeletedCount, pKeepExtentCount=0, pDisplayLog=1) [ Language = objectscript ]
method NameGet() as %String [ Language = objectscript ]
classmethod New997OuterGroupSegs(pOriginalISASeg As EnsLib.EDI.X12.Segment, pLocalApplicationID As %String = "", pFuncID As %String, pVersion As %String, Output pReplyGESeg As EnsLib.EDI.X12.Segment, Output pSC As %Status) as EnsLib.EDI.X12.Segment [ Language = objectscript ]
Create new 997 GS/GE group segment as a reply corresponding to an original ISA segment
classmethod NewControlID(pType As %String) as %Integer [ Language = objectscript ]
Get a new unique control number. Control number type can be Interchange control numbers "I", group Control numbers "G", TransactionSet control numbers "T".
classmethod NewDocumentReply997Segs(pOriginalSTSeg As EnsLib.EDI.X12.Segment, pCodes As %String = 0, Output pReplyAK5Seg As EnsLib.EDI.X12.Segment, Output pSC As %Status, pGSGreater As %String = "", pRejectErrors As %Boolean = 1) as EnsLib.EDI.X12.Segment [ Language = objectscript ]
Create new AK2/AK5 acknowledgement segments as a reply corresponding to an original ST Transaction Set
classmethod NewGroupReply997Segs(pOriginalGSSeg As EnsLib.EDI.X12.Segment, pOriginalGESeg As EnsLib.EDI.X12.Segment = $$$NULLOREF, pCodes As %String = 0, Output pReplyAK1Seg As EnsLib.EDI.X12.Segment, Output pReplyAK9Seg As EnsLib.EDI.X12.Segment, Output pReplySESeg As EnsLib.EDI.X12.Segment, Output pSC As %Status) as EnsLib.EDI.X12.Segment [ Language = objectscript ]
Create new ST(997)/AK1/AK9/SE group reply segments as a reply corresponding to an original GS segment
method NewReplyDocument(pDocType As %String = "", pLocalApplicationID As %String, Output pSC As %Status) as EnsLib.EDI.X12.Document [ Language = objectscript ]
classmethod NewReplyGroupSegs(pOriginalGSSeg As EnsLib.EDI.X12.Segment, pLocalApplicationID As %String = "", pFuncID As %String, pVersion As %String, Output pReplyGESeg As EnsLib.EDI.X12.Segment, Output pSC As %Status) as EnsLib.EDI.X12.Segment [ Language = objectscript ]
Create new GS/GE group segment as a reply corresponding to an original GS segment
classmethod NewReplyHeaderSegs(pOriginalISASeg As EnsLib.EDI.X12.Segment, pLocalApplicationID As %String = "", Output pReplyIEASeg As EnsLib.EDI.X12.Segment, Output pSC As %Status) as EnsLib.EDI.X12.Segment [ Language = objectscript ]
Create new ISA/IEA interchange segments as a reply corresponding to an original ISA segment
classmethod NewReplyHeaderSegsFromString(pOriginalISAString, pLocalApplicationID As %String = "", Output pReplyIEASeg As EnsLib.EDI.X12.Segment, Output pSC As %Status, pDefaultSeparators As %String = $$$X12DefSeparators, pDocType As %String) as EnsLib.EDI.X12.Segment [ Language = objectscript ]
Create new ISA/IEA interchange segments as a reply corresponding to an original ISA segment, while recognizing that the original segment may be incomplete
classmethod NewReplyTA1Seg(pOriginalISASeg As EnsLib.EDI.X12.Segment, pCode As %String = $$$CodeTA1I18NoError, Output pSC As %Status, pRejectErrors As %Boolean = 1) as EnsLib.EDI.X12.Segment [ Language = objectscript ]
Create a new TA1 acknowledgement segment as a reply corresponding to an original ISA segment
classmethod NewReplyTA1SegFromString(pOriginalISAString As %String, pCode As %String = $$$CodeTA1I18NoError, Output pSC As %Status, pRejectErrors As %Boolean = 1, pDefaultSeps As %String = $$$X12DefSeparators) as EnsLib.EDI.X12.Segment [ Language = objectscript ]
Create a new TA1 acknowledgement segment as a reply corresponding to an original ISA segment
method OutputHTML() as %Status [ Language = objectscript ]
Display Segments as HTML, using DocType info if available
method OutputHTMLZen() as %Status [ Language = objectscript ]
Display Segments as HTML, using DocType info if available
method OutputToDevice(pSeparators As %String, pIOFormatClassname As %String) as %Status [ Language = objectscript ]
method OutputToFile(pFilename As %String, pOverwrite As %Boolean, pSeparators As %String, pIOFormatClassname As %String) as %Status [ Language = objectscript ]
method OutputToIOStream(pIOStream As %IO.I.CharacterStream, pSeparators As %String, pFlush As %Boolean = 1, pIOFormatClassname As %String = "") as %Status [ Language = objectscript ]
method OutputToLibraryStream(pLibStream As %Stream.Object, pSeparators As %String, pIOFormatClassname As %String) as %Status [ Language = objectscript ]
method OutputToString(pSeparators As %String, Output pStatus As %Status, pIOFormatClassname As %String) as %String [ Language = objectscript ]
method ParentGEGet() as EnsLib.EDI.X12.Segment [ Language = objectscript ]
method ParentGEIdGet() as %String [ Language = objectscript ]
method ParentGSGet() as EnsLib.EDI.X12.Segment [ Language = objectscript ]
method ParentGSIdGet() as %String [ Language = objectscript ]
method ParentIEAGet() as EnsLib.EDI.X12.Segment [ Language = objectscript ]
method ParentIEAIdGet() as %String [ Language = objectscript ]
method ParentISAGet() as EnsLib.EDI.X12.Segment [ Language = objectscript ]
method ParentISAIdGet() as %String [ Language = objectscript ]
method ParentInterchangeGet() as EnsLib.EDI.X12.Document [ Language = objectscript ]
method ParentInterchangeGetObjectId(force As %Integer) as %String [ Language = objectscript ]
Required for AutoForm
method PokeDocType(pDocType As %String) as %Status [ Language = objectscript ]
classmethod Purge(Output pDeletedCount As %Integer, pDaysToKeep As %Integer = 7, pDummy As %Boolean = 0) as %Status [ Language = objectscript ]
method RawContentGet() as %String [ Language = objectscript ]
method RepetitionSeparatorGet() as %String [ Language = objectscript ]
method SegCountGet() as %Integer [ Language = objectscript ]
method SegmentTerminatorGet() as %String [ Language = objectscript ]
method SetValueAt(pValue As %String, pSegmentPropertyPath As %String, pAction As %String = "set", pKey As %String = "") as %Status [ Language = objectscript ]
Inherited description: Set the value of the designated virtual property.
pValue contains the value to set.
pPropertyPath contains a text expression representing the address within the document of the value of interest.
pKey contains an optional key value or a set of comma-separated key values to be used as array indices where empty array index placeholders are present in pPropertyPath.
pAction contains an action code: "set", "clear", "append", etc.
method SourceGet() as %String [ Language = objectscript ]
Retrieve Source document name from parent, if available
classmethod TotalCount() as %Integer [ Language = objectscript ]
method TypeVersionGet() as %String [ Language = objectscript ]
Inherited description: Subclasses should override this if the version can be gotten from the document content
method buildRuntimePathFromIndex(pId As %String, pPath As %String, pContentArray As %String, pType As %String, ByRef pCurrSeg As %Integer, pParentGrpOpt As %Boolean, pSC As %Status = $$$OK, pKeepParsingAfterError As %Boolean, pReportMissingLoopAsFirstSeg As %Boolean = 0) as %Status [ Language = objectscript ]
Build a segment map for the current segment index array based on the document schema
If pKeepParsingAfterError is false then stop parsing when first error is encountered
classmethod checkDocType(ByRef pDocType As %String) as %Status [ Language = objectscript ]
method commitCollectionOpenSegments(pCollectionPath As %String) as %Status [ Language = objectscript ]
collapse segment objects within the collectionPath into just Id; Save if necessary
method commitSegmentByIndex(pIndex As %Integer) as %Status [ Language = objectscript ]
collapse segment object into just ID; Save if necessary
method commitSegmentByPath(pPath As %String) as %Status [ Language = objectscript ]
collapse segment object into just Id; Save if necessary
method convertRuntimePathToSchemaPath(pPath As %String) as %String [ Language = objectscript ]
classmethod getGEId(pId As %RawString) as %String [ Language = objectscript ]
classmethod getGSId(pId As %RawString) as %String [ Language = objectscript ]
classmethod getIEAId(pParentId As %RawString) as %String [ Language = objectscript ]
classmethod getISAId(pParentId As %RawString) as %String [ Language = objectscript ] <