Member Junction
    Preparing search index...

    Interface OrganicKeyConfig

    Configuration for an organic key on an entity in the additionalSchemaInfo config file. Organic keys enable cross-entity relationships based on shared business data (email, phone, domain, etc.) rather than foreign key constraints.

    interface OrganicKeyConfig {
        CustomNormalizationExpression?: string;
        Description?: string;
        MatchFieldNames: string[];
        Name: string;
        NormalizationStrategy?: "LowerCaseTrim" | "Trim" | "ExactMatch" | "Custom";
        RelatedEntities: OrganicKeyRelatedEntityConfig[];
        Sequence?: number;
    }
    Index

    Properties

    CustomNormalizationExpression? Description? MatchFieldNames Name NormalizationStrategy? RelatedEntities Sequence?

    Properties

    CustomNormalizationExpression?: string

    SQL expression template when NormalizationStrategy is 'Custom'. Uses {{FieldName}} placeholder.

    Description?: string

    Optional description of the key's purpose

    MatchFieldNames: string[]

    Field names on the owning entity that constitute the key

    Name: string

    Human-readable name for this key (e.g., "Email Match", "Domain Match")

    NormalizationStrategy?: "LowerCaseTrim" | "Trim" | "ExactMatch" | "Custom"

    Normalization strategy for comparison. Default: 'LowerCaseTrim'

    RelatedEntities: OrganicKeyRelatedEntityConfig[]

    Related entities to show on the form when viewing a record matched by this key

    Sequence?: number

    Ordering when an entity has multiple organic keys (auto-assigned from array index if omitted)

    Settings

    Member Visibility

    On This Page

    Properties