Skip to main content


persistent class %iKnow.Objects.EntityOccurrence extends %Library.Persistent

SQL Table Name: %iKnow_Objects.EntityOccurrence

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 Entity Occurrences.

This class can be used from Cache 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.Queries.EntityAPI and other query classes to consult entity data as the internal global structures are designed to optimize performance for these queries rather than general-purpose access.

NOTE: This object assumes all underlying data structures are present. Use domain-specific copies of these objects for domains where not all indices are built. See also the GenerateAllObjectsForDomain() method in %iKnow.Objects.Utils.

Property 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 CrcOccurrenceIdM as %Integer;
Property methods: CrcOccurrenceIdMDisplayToLogical(), CrcOccurrenceIdMGet(), CrcOccurrenceIdMIsValid(), CrcOccurrenceIdMLogicalToDisplay(), CrcOccurrenceIdMNormalize(), CrcOccurrenceIdMSet()
property CrcOccurrenceIdR as %Integer;
Property methods: CrcOccurrenceIdRDisplayToLogical(), CrcOccurrenceIdRGet(), CrcOccurrenceIdRIsValid(), CrcOccurrenceIdRLogicalToDisplay(), CrcOccurrenceIdRNormalize(), CrcOccurrenceIdRSet()
property CrcOccurrenceIdS as %Integer;
Property methods: CrcOccurrenceIdSDisplayToLogical(), CrcOccurrenceIdSGet(), CrcOccurrenceIdSIsValid(), CrcOccurrenceIdSLogicalToDisplay(), CrcOccurrenceIdSNormalize(), CrcOccurrenceIdSSet()
property DomainId as %Integer [ Required ];
Property methods: DomainIdDisplayToLogical(), DomainIdGet(), DomainIdIsValid(), DomainIdLogicalToDisplay(), DomainIdNormalize(), DomainIdSet()
property EntOccId as %Integer [ Required ];
Property methods: EntOccIdDisplayToLogical(), EntOccIdGet(), EntOccIdIsValid(), EntOccIdLogicalToDisplay(), EntOccIdNormalize(), EntOccIdSet()
property EntTypeId as %Integer;
Property methods: EntTypeIdDisplayToLogical(), EntTypeIdGet(), EntTypeIdIsValid(), EntTypeIdLogicalToDisplay(), EntTypeIdNormalize(), EntTypeIdSet()
property EntUniId as %Integer;
Property methods: EntUniIdDisplayToLogical(), EntUniIdGet(), EntUniIdIsValid(), EntUniIdLogicalToDisplay(), EntUniIdNormalize(), EntUniIdSet()
property Entity as %iKnow.Objects.EntityUnique [ Calculated ];
Property methods: EntityCompute(), EntityGet(), EntityGetObject(), EntityGetObjectId(), EntitySQLCompute()
property Literal as %String (MAXLEN = 1000) [ Calculated ];
Property methods: LiteralCompute(), LiteralDisplayToLogical(), LiteralGet(), LiteralIsValid(), LiteralLogicalToDisplay(), LiteralLogicalToOdbc(), LiteralNormalize(), LiteralSQLCompute()
property PathId as %Integer;
Property methods: PathIdDisplayToLogical(), PathIdGet(), PathIdIsValid(), PathIdLogicalToDisplay(), PathIdNormalize(), PathIdSet()
property PosInPath as %Integer;
Property methods: PosInPathDisplayToLogical(), PosInPathGet(), PosInPathIsValid(), PosInPathLogicalToDisplay(), PosInPathNormalize(), PosInPathSet()
property PosInSentence as %Integer;
Property methods: PosInSentenceDisplayToLogical(), PosInSentenceGet(), PosInSentenceIsValid(), PosInSentenceLogicalToDisplay(), PosInSentenceNormalize(), PosInSentenceSet()
property Sentence as %iKnow.Objects.Sentence [ Calculated ];
Property methods: SentenceCompute(), SentenceGet(), SentenceGetObject(), SentenceGetObjectId(), SentenceSQLCompute()
property SentenceId as %Integer;
Property methods: SentenceIdDisplayToLogical(), SentenceIdGet(), SentenceIdIsValid(), SentenceIdLogicalToDisplay(), SentenceIdNormalize(), SentenceIdSet()
property SourceId as %Integer [ Calculated ];
Property methods: SourceIdCompute(), SourceIdDisplayToLogical(), SourceIdGet(), SourceIdIsValid(), SourceIdLogicalToDisplay(), SourceIdNormalize(), SourceIdSQLCompute()
property StemmedEntUniId as %Integer [ Calculated ];
If the domain has stemming enabled, this points to the stemmed entity's ID
Property methods: StemmedEntUniIdCompute(), StemmedEntUniIdDisplayToLogical(), StemmedEntUniIdGet(), StemmedEntUniIdIsValid(), StemmedEntUniIdLogicalToDisplay(), StemmedEntUniIdNormalize(), StemmedEntUniIdSQLCompute()
property StemmedEntity as %iKnow.Objects.EntityUnique [ Calculated ];
Property methods: StemmedEntityCompute(), StemmedEntityGet(), StemmedEntityGetObject(), StemmedEntityGetObjectId(), StemmedEntitySQLCompute()


index (PKINDEX on DomainId,EntOccId) [IdKey, PrimaryKey, Type = key, Unique];
Index methods: PKINDEXCheck(), PKINDEXDelete(), PKINDEXExists(), PKINDEXOpen(), PKINDEXSQLCheckUnique(), PKINDEXSQLExists(), PKINDEXSQLFindPKeyByConstraint(), PKINDEXSQLFindRowIDByConstraint()

Inherited Members

Inherited Methods


Storage Model: CacheSQLStorage

Maps: 1

  • Map number 1 is named MainMap

    thismap.Global: ^ISC.IK.EntOccId

  • ^ISC.IK.EntOccId({DomainId},{EntOccId})
    Node Delimiter Piece Name
    1 EntUniId
    2 EntTypeId
    3 SentenceId
    4 PosInSentence
    5 CrcOccurrenceIdM
    6 CrcOccurrenceIdR
    7 CrcOccurrenceIdS
    8 PathId
    9 PosInPath
FeedbackOpens in a new tab