Skip to main content


deprecated persistent class %iKnow.Objects.DictionaryItem extends %Library.Persistent

SQL Table Name: %iKnow_Objects.DictionaryItem

Note: the use of this class is no longer recommended for accessing elements of a specific domain. For those scenarios, %iKnow.Tables.Utils offers a more flexible and customizable way of projecting iKnow domain data to SQL

This is a read-only object representation wrapping the internal iKnow data structures for Dictionary Items.

This class can be used from ObjectScript or SQL to access a single or small number of entries, but the storage mappings are not meant to support elaborate or complex queries targeting this SQL table.

Please use the predefined queries in %iKnow.Matching.DictionaryAPI and other query classes to consult Dictionary data as the internal global structures are designed to optimize performance for these queries rather than general-purpose access.

Property Inventory

Method Inventory


parameter READONLY = 1;
Inherited description: READONLY = 1 means that objects can be created, opened but not saved or deleted. Tables are projected to SQL as READONLY.


property DefaultLanguage as %String [ Calculated ];
Property methods: DefaultLanguageCompute(), DefaultLanguageDisplayToLogical(), DefaultLanguageGet(), DefaultLanguageIsValid(), DefaultLanguageLogicalToDisplay(), DefaultLanguageLogicalToOdbc(), DefaultLanguageNormalize(), DefaultLanguageSQLCompute()
property DefaultLanguageId as %Integer;
Property methods: DefaultLanguageIdDisplayToLogical(), DefaultLanguageIdGet(), DefaultLanguageIdIsValid(), DefaultLanguageIdLogicalToDisplay(), DefaultLanguageIdNormalize(), DefaultLanguageIdSet()
property Dictionary as %iKnow.Objects.Dictionary [ Calculated ];
Property methods: DictionaryCompute(), DictionaryGet(), DictionaryGetObject(), DictionaryGetObjectId(), DictionarySQLCompute()
property DictionaryId as %Integer;
Property methods: DictionaryIdDisplayToLogical(), DictionaryIdGet(), DictionaryIdIsValid(), DictionaryIdLogicalToDisplay(), DictionaryIdNormalize(), DictionaryIdSet()
property DictionaryItemId as %Integer [ Required ];
Property methods: DictionaryItemIdDisplayToLogical(), DictionaryItemIdGet(), DictionaryItemIdIsValid(), DictionaryItemIdLogicalToDisplay(), DictionaryItemIdNormalize(), DictionaryItemIdSet()
property DomainId as %Integer [ Required ];
Property methods: DomainIdDisplayToLogical(), DomainIdGet(), DomainIdIsValid(), DomainIdLogicalToDisplay(), DomainIdNormalize(), DomainIdSet()
property Name as %String (MAXLEN = 1000);
Property methods: NameDisplayToLogical(), NameGet(), NameIsValid(), NameLogicalToDisplay(), NameLogicalToOdbc(), NameNormalize(), NameSet()
property URI as %String (MAXLEN = 1000);
Property methods: URIDisplayToLogical(), URIGet(), URIIsValid(), URILogicalToDisplay(), URILogicalToOdbc(), URINormalize(), URISet()


classmethod Open(pDomainId As %Integer, pDictionaryItemId As %Integer) as %iKnow.Objects.DictionaryItem
Returns a %iKnow.Objects.DictionaryItem object using the supplied identifiers, resolving negative dictionary Item IDs to the appropriate coordinates for a cross-domain dictionary entry.


index (DictIdIndex on DomainId,DictionaryId);
Index methods: DictIdIndexExists()
index (DictItemURIIndex on DomainId,URI) [Unique];
Index methods: DictItemURIIndexCheck(), DictItemURIIndexCheckUnique(), DictItemURIIndexDelete(), DictItemURIIndexExists(), DictItemURIIndexOpen(), DictItemURIIndexSQLCheckUnique(), DictItemURIIndexSQLExists(), DictItemURIIndexSQLFindPKeyByConstraint(), DictItemURIIndexSQLFindRowIDByConstraint()
index (PKINDEX on DomainId,DictionaryItemId) [IdKey, PrimaryKey, Type = key, Unique];
Index methods: PKINDEXCheck(), PKINDEXDelete(), PKINDEXExists(), PKINDEXOpen(), PKINDEXSQLCheckUnique(), PKINDEXSQLExists(), PKINDEXSQLFindPKeyByConstraint(), PKINDEXSQLFindRowIDByConstraint()

Inherited Members

Inherited Methods


Storage Model: SQLStorage

Maps: 3

  • Map number 1 is named DictIdIndex

    thismap.Global: ^IRIS.IK.Mat.DictToItem

  • Map number 2 is named DictItemURIIndex

    thismap.Global: ^IRIS.IK.Mat.DictItemURI

  • ^IRIS.IK.Mat.DictToItem({DomainId},{DictionaryId},{DictionaryItemId})
  • Map number 3 is named MainMap

    thismap.Global: ^IRIS.IK.Mat.DictItemId

  • ^IRIS.IK.Mat.DictItemURI({DomainId},{URI})
    Node Delimiter Piece Name
    Node Delimiter Piece Name
    1 DictionaryId
    2 Name
    3 URI
    4 DefaultLanguageId
FeedbackOpens in a new tab