This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRIS, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions page (login required).

Home > Class Reference > ENSLIB namespace > EnsLib.EDI.SEF.Schema

EnsLib.EDI.SEF.Schema

abstract class EnsLib.EDI.SEF.Schema

VDoc Schema classmethods and queries

Method Inventory

Methods

classmethod BuildCategoryMaps(pCategory As %String)
classmethod DocStructuresClose(ByRef qHandle As %Binary) as %Status
classmethod DocStructuresExecute(ByRef qHandle As %Binary, Category As %String = "", IncludeBase As %Boolean = 0, SchemaFamily As %String = "") as %Status
classmethod DocStructuresFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) as %Status
classmethod ElementExists(pElementSpec As %String = "") as %Boolean
classmethod GetAlias(pArrayName 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, pType As %String = "", pLevel As %Integer, pIncludeBase As %Boolean = 0) as %Status
Get all properties for a given document structure
classmethod GetDescription(pElementSpec As %String, pItem As %Integer = "") as %String
Get the description of an item or an indexed piece of an item
classmethod MergeToX12(pCatList As %String = "", pUseOld As %Boolean = 0) as %Status
classmethod ResolveSchemaTypeToDocType(pSchemaCategory As %String, pTypeName As %String, Output pStatus As %Status) as %String
Given a Schema category and a Message TypeName string, return the corresponding DocType (document structure)
classmethod SegTypesClose(ByRef qHandle As %Binary) as %Status
classmethod SegTypesExecute(ByRef qHandle As %Binary, Category As %String = "", Level As %String = "", IncludeBase As %Boolean = 0, SchemaFamily As %String = "", ExpandedDocType As %Boolean = 0) as %Status
classmethod SegTypesFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) as %Status
classmethod TypeCategoriesClose(ByRef qHandle As %Binary) as %Status
classmethod TypeCategoriesExecute(ByRef qHandle As %Binary, Standard As %String = "", SchemaFamily As %String = "") as %Status
classmethod TypeCategoriesFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) as %Status
classmethod buildContentArray(Output pContents, pMode As %String = "source", pType As %String, pLevel As %Integer = 0) as %Status
Get all properties for a given document structure
classmethod buildDocStructureMap(pCategory As %String, pDocStructName As %String)
classmethod buildDocStructureMapLoop(pArrayName As %String, pSchemaPathMap As %String, pNamePrefix As %String, pValuePrefix As %String, pCategory As %String, pTransactionSet As %String) as %Status
classmethod buildSegmentStructureMap(pCategory As %String, pTransactionSet As %String, pSegment As %String) as %Status
classmethod getFieldsContentArray(Output pContents, pMode As %String, pCategory As %String, pTransName As %String, pSegType As %String, pLevel As %Integer) as %Status
Given a segment type, extract the content array for the fields (items)
classmethod getSegsContentArray(Output pContents, pMode As %String, pCategory As %String, pTransName As %String, pStructItem As %String, pLoopName As %String, pLevel As %Integer, Output pSC As %Status = $$$OK) as %Integer
classmethod mergeStructureToX12(pCat As %String, pDocStruct As %String, pSegItem As %Integer, pParentKeySegs As %String, pParentReps As %String, Output pTriggerKeyPos As %Integer, Output pTriggerKey As %String, Output pStatus As %Status) as %String
classmethod storeCompositeToX12(pCat As %String, pDocStruct As %String, pCompositeName As %String, pSegOrdinal, pSegElem) as %Status
classmethod storeSegToX12(pCat As %String, pDocStruct As %String, pSegItem As %String, ByRef pTriggerKey As %String) as %Status
Given a segment type, extract the content array for the fields (items)

Queries

query DocStructures(Category As %String = "", IncludeBase As %Boolean = 0, SchemaFamily As %String = "")
Selects DocStructure As %String, Description As %String, IsStandard As %Boolean
Returns a list of available DocTypes for the corresponding 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 SegTypes(Category As %String = "", Level As %String = "", IncludeBase As %Boolean = 0, SchemaFamily As %String = "", ExpandedDocType 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 the corresponding 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
If ExpandedDocType is:
0 - return SegTypes as Category:SegName
1 - return SegTypes as Category:DocStruct:Segment-Ordinal
query TypeCategories(Standard As %String = "", SchemaFamily As %String = "")
Selects Category As %String, Description As %String, IsStandard As %Boolean, Base As %String
FeedbackOpens in a new window