Home > Class Reference > ENSLIB namespace > %iKnow.Model.dictionaryExternal


class %iKnow.Model.dictionaryExternal extends %iKnow.Model.node

This element allows loading dictionary content from an external file or from a SQL query, as an alternative to fully listing the dictionary content in <dictionary>, <item> and <term> elements.

Property Inventory

Method Inventory


parameter XMLNAME = external;
Inherited description: This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.


relationship columns as array of %iKnow.Model.dictionaryExternalColumn (XMLELEMENTREF = 1, XMLPROJECTION = "ELEMENT", XMLTYPECONSTRAINT = "CHOICE") [ InitialExpression = $listbuild("%iKnow.Model.dictionaryExternalColumn","external",+$this,"many",0,0) , Transient , Inverse = external , Cardinality = many ];
Property methods: columnsGet(), columnsGetObject(), columnsGetObjectId(), columnsGetSwizzled(), columnsIsEmpty(), columnsIsValid(), columnsNewObject(), columnsRClose(), columnsRExec(), columnsRFetch(), columnsRelate(), columnsSQLCompute(), columnsSet(), columnsUnRelate()
property delimiter as %String (XMLPROJECTION = "ATTRIBUTE") [ InitialExpression = ";" ];
When referring to a file, this property defines the delimiter separating the different columns in the file
Property methods: delimiterDisplayToLogical(), delimiterGet(), delimiterIsValid(), delimiterLogicalToDisplay(), delimiterLogicalToOdbc(), delimiterNormalize(), delimiterSet()
property file as %String (MAXLEN = 2000, XMLPROJECTION = "ATTRIBUTE");
The file containing the dictionary content
Property methods: fileDisplayToLogical(), fileGet(), fileIsValid(), fileLogicalToDisplay(), fileLogicalToOdbc(), fileNormalize(), fileSet()
property headerRows as %Integer (XMLPROJECTION = "ATTRIBUTE");
When referring to a file, this property defines how many header rows to skip at the top of the file
Property methods: headerRowsDisplayToLogical(), headerRowsGet(), headerRowsIsValid(), headerRowsLogicalToDisplay(), headerRowsNormalize(), headerRowsSet(), headerRowsXSDToLogical()
relationship matching as %iKnow.Model.matching (XMLPROJECTION = "none") [ Inverse = external , Cardinality = one ];
Link to the <matching> element this dictionary belongs to.
Property methods: matchingGet(), matchingGetObject(), matchingGetObjectId(), matchingGetSwizzled(), matchingIsValid(), matchingNewObject(), matchingRClose(), matchingRExec(), matchingRFetch(), matchingRelate(), matchingSQLCompute(), matchingSet(), matchingUnRelate()
property sql as %String (MAXLEN = 2000, XMLPROJECTION = "ATTRIBUTE");
The query to source the dictionary content from
Property methods: sqlDisplayToLogical(), sqlGet(), sqlIsValid(), sqlLogicalToDisplay(), sqlLogicalToOdbc(), sqlNormalize(), sqlSet()


method %Validate(pDomainId As %Integer, pDomainDefinition As %iKnow.Model.domain) as %Status [ Language = objectscript ]

Inherited Members

Inherited Methods