Class Reference
IRIS for UNIX 2024.1.2
InterSystems: The power behind what matters   
Documentation  Search
  [USER] >  [%iKnow] >  [Model] >  [dictionaryExternal]
Private  Storage   

deprecatedclass %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.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 6 1


Summary

Properties
columns delimiter file headerRows matching
sql

Methods
%AddToSaveSet %BindExport %ClassIsLatestVersion %ClassName
%ConstructClone %DispatchClassMethod %DispatchGetModified %DispatchGetProperty
%DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty
%Extends %GetParameter %IsA %IsModified
%New %NormalizeObject %ObjectModified %OriginalNamespace
%PackageName %QuoteList %QuoteValue %QuoteValueL10N
%RemoveFromSaveSet %SerializeObject %SetModified %Validate
%ValidateObject XMLDTD XMLExport XMLExportToStream
XMLExportToString XMLNew XMLSchema XMLSchemaNamespace
XMLSchemaType


Parameters

• parameter XMLNAME = "external";
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.

Properties

• relationship columns as %iKnow.Model.dictionaryExternalColumn(XMLELEMENTREF=1,XMLPROJECTION="ELEMENT",XMLTYPECONSTRAINT="CHOICE") [ Inverse = external,Cardinality = many ];
• 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 file as %String(MAXLEN=2000,XMLPROJECTION="ATTRIBUTE");
The file containing the dictionary content
• 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
• relationship matching as %iKnow.Model.matching(XMLPROJECTION="none") [ Inverse = external,Cardinality = one ];
Link to the <matching> element this dictionary belongs to.
• property sql as %String(MAXLEN=2000,XMLPROJECTION="ATTRIBUTE");
The query to source the dictionary content from

Methods

• method %Validate(pDomainId As %Integer, pDomainDefinition As %iKnow.Model.domain) as %Status


Copyright (c) 2025 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.