Skip to main content


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

SQL Table Name: %iKnow_Objects.EntityInSourceDetails

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 Unique Entities, occurring in a specific source. This class groups the aggregated frequency and dominance information of a particular entity in a particular source.

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.Queries.EntityAPI, %iKnow.Semantics.DominanceAPI 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 DomainId as %Integer [ Required ];
Property methods: DomainIdDisplayToLogical(), DomainIdGet(), DomainIdIsValid(), DomainIdLogicalToDisplay(), DomainIdNormalize(), DomainIdSet()
property DominanceAsConcept as %Numeric [ Calculated ];
Property methods: DominanceAsConceptCompute(), DominanceAsConceptDisplayToLogical(), DominanceAsConceptGet(), DominanceAsConceptIsValid(), DominanceAsConceptLogicalToDisplay(), DominanceAsConceptNormalize(), DominanceAsConceptSQLCompute()
property DominanceAsRelation as %Numeric [ Calculated ];
Property methods: DominanceAsRelationCompute(), DominanceAsRelationDisplayToLogical(), DominanceAsRelationGet(), DominanceAsRelationIsValid(), DominanceAsRelationLogicalToDisplay(), DominanceAsRelationNormalize(), DominanceAsRelationSQLCompute()
property EntUniId as %Integer [ Required ];
Property methods: EntUniIdDisplayToLogical(), EntUniIdGet(), EntUniIdIsValid(), EntUniIdLogicalToDisplay(), EntUniIdNormalize(), EntUniIdSet()
property Entity as %iKnow.Objects.EntityUnique [ Calculated ];
Property methods: EntityCompute(), EntityGet(), EntityGetObject(), EntityGetObjectId(), EntitySQLCompute()
property FrequencyAsConcept as %Integer;
Property methods: FrequencyAsConceptDisplayToLogical(), FrequencyAsConceptGet(), FrequencyAsConceptIsValid(), FrequencyAsConceptLogicalToDisplay(), FrequencyAsConceptNormalize(), FrequencyAsConceptSet()
property FrequencyAsRelation as %Integer;
Property methods: FrequencyAsRelationDisplayToLogical(), FrequencyAsRelationGet(), FrequencyAsRelationIsValid(), FrequencyAsRelationLogicalToDisplay(), FrequencyAsRelationNormalize(), FrequencyAsRelationSet()
property Source as %iKnow.Objects.Source [ Calculated ];
Property methods: SourceCompute(), SourceGet(), SourceGetObject(), SourceGetObjectId(), SourceSQLCompute()
property SourceId as %Integer [ Required ];
Property methods: SourceIdDisplayToLogical(), SourceIdGet(), SourceIdIsValid(), SourceIdLogicalToDisplay(), SourceIdNormalize(), SourceIdSet()


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

Inherited Members

Inherited Methods


Storage Model: SQLStorage

Maps: 1

  • Map number 1 is named MainMap

    thismap.Global: ^IRIS.IK.EntSrcDetails

  • ^IRIS.IK.EntSrcDetails({DomainId},{SourceId},{EntUniId})
    Node Delimiter Piece Name
    1 FrequencyAsConcept
    2 FrequencyAsRelation
FeedbackOpens in a new tab