persistent class EnsLib.EDI.EDIFACT.Document
extends %Persistent, EnsLib.EDI.BatchDocument, EnsLib.EDI.Segmented, EnsLib.EDI.EDIFACT.MsgBodyMethods
Represents an Interchange or a TransactionSet. FunctionalGroups are represented as Segments within an Interchange.
• parameter DEFSEARCHCLASS = "EnsLib.EDI.EDIFACT.SearchTable";
Name of the default SearchTable indexing class used in UI choices and MessageBank submissions
• parameter DOCCLASSFULLNAME = "UN EDIFACT EDI Document";
Full descriptive name for this subclass of document
• parameter DOCCLASSNAME = "EDIFACT Document";
Compact descriptive name for this subclass of document
• parameter DOCSHORTNAME = "EDIFACT";
• parameter DOMAIN = "Ensemble";
Use our own domain for localization
• parameter EXTENTSIZE = 2000000;
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.SEF.Schema:DS:EDIFACT";
Name of the associated schema class and after a colon the schema element code that represents a DocType
• 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 Attachments
as array of Ens.StreamContainer;
Attachment streams associated with this document
• property ChildCount
as %Integer [ Calculated,Transient,ReadOnly ];
Number of Children
• property ComponentSeparator
as %String [ Calculated,Transient ];
Sub-element component separator character
• property DocTypeCategory
as %String [ Transient,ReadOnly ];
the category portion of the DocType
• property DocTypeName
as %String [ Transient,ReadOnly ];
Stored raw document type name ; the secondary type name portion of the DocType
• property ElementSeparator
as %String [ Calculated,Transient ];
Data-element separator character
• property EscapeSeparator
as %String [ Calculated,Transient ];
Release / Escape character
• property ExpRepeat
as %Boolean [ InitialExpression = 0 ];
Boolean telling whether explicit indication of repetition is used in this document
• property FullSize
as %Integer [ Calculated,Transient,ReadOnly ];
Size in bytes of the message content.
The calculation assumes 1-byte segment terminators and includes any segments that use more than one storage node.
• property Identifier
as %String [ Calculated,Transient,ReadOnly ];
Unique document identification string found in document content
• property Name
as %String [ Calculated,Transient,ReadOnly ];
Raw type name of document
• property ParentGroupEndSeg
as EnsLib.EDI.EDIFACT.Segment [ Calculated,Transient,ReadOnly ];
• property ParentGroupEndSegId
as %Integer [ Calculated,Transient,ReadOnly ];
Id of the group end segment of the FunctionalGroup in the Interchange within which this TransactionSet arrived
• property ParentGroupSeg
as EnsLib.EDI.EDIFACT.Segment [ Calculated,Transient,ReadOnly ];
• property ParentGroupSegId
as %Integer [ Calculated,Transient,ReadOnly ];
Id of the group start segment of the FunctionalGroup in the Interchange within which this TransactionSet arrived
• property ParentHeaderSeg
as EnsLib.EDI.EDIFACT.Segment [ Calculated,Transient,ReadOnly ];
• property ParentHeaderSegId
as %Integer [ Calculated,Transient,ReadOnly ];
Id of the header segment of the Interchange within which this TransactionSet arrived
• 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 ParentInterchange
as EnsLib.EDI.EDIFACT.Document [ Calculated,Transient,ReadOnly ];
• property ParentTrailerSeg
as EnsLib.EDI.EDIFACT.Segment [ Calculated,Transient,ReadOnly ];
• property ParentTrailerSegId
as %Integer [ Calculated,Transient,ReadOnly ];
Id of the end segment of the Interchange within which this TransactionSet arrived
• 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 RepetitionSeparator
as %String [ Calculated,Transient ];
Repetition separator character
• property SegCount
as %Integer [ Calculated,Transient,ReadOnly ];
Count of segments composing this document
• property SegmentTerminator
as %String [ Calculated,Transient ];
Segment Terminator character(s)
• property Separators
as %String(MAXLEN=7,MINLEN=4) [ Transient ];
All 4 Separators as a String, plus optionally SegmentTerminator: COMSEP_ELESEP_ESCSEP_REPSEP
Additional characters will be output as the Segment Terminator; may be up to 3 chars for output with newlines
• property TypeVersion
as %String [ Calculated,Transient,ReadOnly ];
Raw type version name of message found at MSH:12 in message content
• method %ConstructClone(deep As %Integer = 0, ByRef cloned As %String, location As %String)
as %RegisteredObject
Clone the current document object to a new object and return the new cloned object.
By default references to parent documents are not preserved and child documents are not copied.
If deep is 1 then this does a deep copy which will also construct clones of any child documents.
• method AddAttachment(pStream As %Stream.Object)
as %Status
• method AddEndSegment()
as %Status
• method AddFunctionalGroup(pGS As EnsLib.EDI.EDIFACT.Segment, Output pGroupSegIndex As %Integer = "")
as %Status
• method AddTransactionSet(pTxnSet As EnsLib.EDI.EDIFACT.Document, pGroupSegIndex As %Integer, pAttachment As %Stream.Object = $$$NULLOREF)
as %Status
Add a TransactionSet to the Interchange. Add it to a group given the segment index of the placeholder segment between GS and GE segments.
• method BuildMap(pKeepParsingAfterError As %Boolean = 1, pCreateExplicitRep As %Boolean = 0)
as %Status
pKeepParsingAfterError means keep trying to parse after errors are encountered; returned Status will contain all errors encountered
• method Clear()
as %Status
Delete All Content and reset all properties
• method ComponentSeparatorGet()
as %String
This is a Get accessor method for the ComponentSeparator property.
• method ConstructExplicitClone(ByRef pStatus As %Status)
as EnsLib.EDI.EDIFACT.Document
• method ConstructImplicitClone(ByRef pStatus As %Status)
as EnsLib.EDI.EDIFACT.Document
• method CopyValues(pSource As EnsLib.EDI.EDIFACT.Document, pSourcePath As %String, pTargetPath As %String, pAction As %String, pKey As %String, pEmptyFieldAsNull As %Boolean = 0, pIgnoreMissingSource As %Boolean = 0)
as %Status
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.
• method DocTypeSet(pDocType As %String, pBuildMap As %Boolean = 1)
as %Status
This is a Set accessor method for the DocType property.
• method DumpMaps()
as %Status
• method ElementSeparatorGet()
as %String
This is a Get accessor method for the ElementSeparator property.
• classmethod EnumerateDocTypesClose(ByRef qHandle As %Binary)
as %Status
• classmethod EnumerateDocTypesExecute(ByRef qHandle As %Binary, Category As %String, IncludeBase As %Boolean)
as %Status
• classmethod EnumerateDocTypesFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer)
as %Status
• classmethod EnumerateSegTypesClose(ByRef qHandle As %Binary)
as %Status
• classmethod EnumerateSegTypesExecute(ByRef qHandle As %Binary, Category As %String = "", Level As %String, IncludeBase As %Boolean)
as %Status
• classmethod EnumerateSegTypesFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer)
as %Status
• classmethod EnumerateTypeCategoriesClose(ByRef qHandle As %Binary)
as %Status
• classmethod EnumerateTypeCategoriesExecute(ByRef qHandle As %Binary, Standard As %String = "")
as %Status
• classmethod EnumerateTypeCategoriesFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer)
as %Status
• method EscapeSeparatorGet()
as %String
This is a Get accessor method for the EscapeSeparator property.
• method FindSegment(pSegName As %String, ByRef pIndex As %String = "", Output pStatus As %Status)
as EnsLib.EDI.EDIFACT.Segment
Gets the next segment after index pIndex with name pSegName.
Supports pSegName = '*' to match any segment.
• method FullSizeGet()
as %Integer
This is a Get accessor method for the FullSize property.
• classmethod GetAlias(pContentArrayName As %String, pArrayPos As %String)
as %String
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
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
• classmethod GetManagerLinks(Output pColumns)
as %Boolean
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
Gets the next path in a group
• method GetNextIndex(pPath As %String, pIndex As %String, ByRef pStatus As %Status = $$$OK)
as %String
Gets the next index in an array
• method GetSegmentIndex(pPath As %String, Output pStatus As %Status)
as %Integer
Given a segment path, find the corresponding segment index
• method GetSegmentPath(pIndex As %Integer, Output pStatus As %Status)
as %String
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
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
This is a Get accessor method for the Identifier property.
• classmethod ImportFromDevice(Output pStatus As %Status, ByRef pConfigItem As %String, pIOFormatClassname As %String)
as EnsLib.EDI.EDIFACT.Document
• classmethod ImportFromFile(pFilename As %String, pDocNum As %Integer = 1, Output pStatus As %Status, ByRef pConfigItem As %String, pIOFormatClassname As %String)
as EnsLib.EDI.EDIFACT.Document
• classmethod ImportFromIOStream(pIOStream As %IO.I.CharacterStream, Output pStatus As %Status = $$$OK, ByRef pConfigItem As %String = "", pIOFormatClassname As %String = "")
as EnsLib.EDI.EDIFACT.Document
• classmethod ImportFromLibraryStream(pLibStream As %Stream.Object, Output pStatus As %Status, ByRef pConfigItem As %String, pIOFormatClassname As %String)
as EnsLib.EDI.EDIFACT.Document
• classmethod ImportFromString(pString As %String, Output pStatus As %Status, ByRef pConfigItem As %String, pIOFormatClassname As %String)
as EnsLib.EDI.EDIFACT.Document
• classmethod KillGlobals(Output pDeletedCount, pKeepExtentCount=0, pDisplayLog=1)
• method NameGet()
as %String
This is a Get accessor method for the Name property.
• classmethod NewControlID(pInbound As %Boolean = 0, pReceiverID As %String, pSenderID As %String, pType As %String = "H")
as %Integer
Get an new unique control number. Control numbers are classified into interchange control numbers "I" and
group control numbers "G".
• method NewReplyDocument(pDocType As %String = "", pLocalApplicationID As %String, Output pSC As %Status)
as EnsLib.EDI.EDIFACT.Document
• classmethod NewReplyGroupSeg(pOriginalGS As EnsLib.EDI.EDIFACT.Segment, Output pSC As %Status)
as EnsLib.EDI.EDIFACT.Segment
Create a new group segment as a reply corresponding to an original GS segment
• classmethod NewReplyHeaderSeg(pOriginalHeaderSeg As EnsLib.EDI.EDIFACT.Segment, pLocalApplicationID As %String = "", Output pSC)
as EnsLib.EDI.EDIFACT.Segment
• method OutputHTML()
as %Status
Display Segments as HTML, using DocType info if available
• method OutputHTMLZen()
as %Status
Display Segments as HTML, using DocType info if available
• method OutputToDevice(pSeparators As %String, pIOFormatClassname As %String)
as %Status
• method OutputToFile(pFilename As %String, pOverwrite As %Boolean, pSeparators As %String, pIOFormatClassname As %String)
as %Status
• method OutputToIOStream(pIOStream As %IO.I.CharacterStream, pSeparators As %String, pFlush As %Boolean = 1, pIOFormatClassname As %String = "")
as %Status
• method OutputToLibraryStream(pLibStream As %Stream.Object, pSeparators As %String, pIOFormatClassname As %String)
as %Status
• method OutputToString(pSeparators As %String, Output pStatus As %Status, pIOFormatClassname As %String)
as %String
• method ParentGroupEndSegGet()
as EnsLib.EDI.EDIFACT.Segment
This is a Get accessor method for the ParentGroupEndSeg property.
• method ParentGroupEndSegIdGet()
as %String
This is a Get accessor method for the ParentGroupEndSegId property.
• method ParentGroupSegGet()
as EnsLib.EDI.EDIFACT.Segment
This is a Get accessor method for the ParentGroupSeg property.
• method ParentGroupSegIdGet()
as %String
This is a Get accessor method for the ParentGroupSegId property.
• method ParentHeaderSegGet()
as EnsLib.EDI.EDIFACT.Segment
This is a Get accessor method for the ParentHeaderSeg property.
• method ParentHeaderSegIdGet()
as %String
This is a Get accessor method for the ParentHeaderSegId property.
• method ParentInterchangeGet()
as EnsLib.EDI.EDIFACT.Document
This is a Get accessor method for the ParentInterchange property.
• method ParentInterchangeGetObjectId(force As %Integer)
as %String
Required for AutoForm
• method ParentTrailerSegGet()
as EnsLib.EDI.EDIFACT.Segment
This is a Get accessor method for the ParentTrailerSeg property.
• method ParentTrailerSegIdGet()
as %String
This is a Get accessor method for the ParentTrailerSegId property.
• method PokeDocType(pDocType As %String)
as %Status
• classmethod Purge(Output pDeletedCount As %Integer, pDaysToKeep As %Integer = 7, pDummy As %Boolean = 0)
as %Status
• method RawContentGet()
as %String
This is a Get accessor method for the RawContent property.
• method RepetitionSeparatorGet()
as %String
This is a Get accessor method for the RepetitionSeparator property.
• method SegCountGet()
as %Integer
This is a Get accessor method for the SegCount property.
• method SegmentTerminatorGet()
as %String
This is a Get accessor method for the SegmentTerminator property.
• method SeparatorsSet(newvalue As %String)
as %Status
This is a Set accessor method for the Separators property.
• method SetValueAt(pValue As %String, pSegmentPropertyPath As %String, pAction As %String = "set", pKey As %String = "")
as %Status
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.
• classmethod TotalCount()
as %Integer
• method TypeVersionGet()
as %String
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, pLoopNames As %String, pSC As %Status, pKeepParsingAfterError As %Boolean, pFirstRep As %Boolean = 0, pCreateExplicitRep As %Boolean = 0)
as %Status
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
• method commitCollectionOpenSegments(pCollectionPath As %String)
as %Status
collapse segment objects within the collectionPath into just Id; Save if necessary
• method commitSegmentByIndex(pIndex As %Integer)
as %Status
collapse segment object into just ID; Save if necessary
• method commitSegmentByPath(pPath As %String)
as %Status
collapse segment object into just Id; Save if necessary
• method convertRuntimePathToSchemaPath(pPath As %String)
as %String
• classmethod getGroupEndSegId(pId As %RawString)
as %String
• classmethod getGroupSegId(pId As %RawString)
as %String
• classmethod getHeaderSegId(pParentId As %RawString)
as %String
• method getId()
as %String
The same as %Id(), but allocates the Id even if the object hasn't been saved already
• classmethod getIdentifier(pId As %RawString)
as %String
• classmethod getName(pId As %RawString)
as %String
• method getSegmentIdByIndex(pIndex As %Integer, Output pStatus As %Status)
as %String
• method getSegmentIdByPath(pPath As %String, Output pStatus As %Status)
as %String
• classmethod getSegsAsString(pId As %String, pMaxLen As %Integer = 10000, pStartOffset As %Integer = 1)
as %String
This method is for use from the RawContent property's SQL Compute invocation
• classmethod getTrailerSegId(pParentId As %RawString)
as %String
• classmethod getTypeVersion(pId As %RawString, pParentId As %String)
as %String
• query EnumerateDocTypes(Category As %String = "", IncludeBase As %Boolean = 0)
Selects
Type As %String
Returns a list of available DocTypes for this document class.
The DocType is returned as the first column in the result set.
The Category parameter can be used to restrict the list.
If Category is:
0 - return only DocTypes in standard categories
+ - return only DocTypes in user-defined categories
empty - return DocTypes from all categories
a category name - return only DocTypes in the named category
a partial name suffixed with '%' - return only DocTypes in categories matching the partial category name
other - return nothing
If IncludeBase is:
0 - return only DocTypes defined in the current schema category itself
1 - return all DocTypes in the current schema category's base category in addition to those defined in the current category itself
• query EnumerateSegTypes(Category As %String = "", Level As %String = "", IncludeBase As %Boolean = 0)
Selects
SegType As %String, Field As %String, Description As %String, IsStandard As %Boolean
Returns a list of schema categories and segment types and segment fields for this document class.
The Category and Level parameters can be used to restrict the list.
If Category is:
0 - return only standard categories
+ - return only user-defined categories
empty - return all categories
a category name - return only SegTypes in the named category
a category name:segment type name - return only information about the named SegType
a partial name suffixed with '%' - return only SegTypes in categories matching the partial category name
other - return nothing
If Level is:
0 - return all segment names
n - return the given number of levels of nested field names within each segment
empty - return all levels of nested field names within each segment
If IncludeBase is:
0 - return only segment names defined in the current schema category itself
1 - return all segment names in the current schema category's base category in addition to those defined in the current category itself
• query EnumerateTypeCategories(Standard As %String = "")
Selects
Category As %String, Description As %String, IsStandard As %Boolean, Base As %String
Returns a list of document type schema categories for the document class.
The Standard parameter can be used to restrict the list.
If Standard is:
0 - return only standard categories
+ - return only user-defined categories
empty - return all categories
a partial category name - return only categories starting with the given category name part
other - return nothing
•index (Extent on ) [Extent,Type = bitmap];
•index (OriginalDocId on OriginalDocId);
•index (ParentId on ParentId);
•trigger OnDelete
(BEFORE event DELETE)
