Member Junction
    Preparing search index...

    Interface SecondaryDimension

    Definition of a single secondary scope dimension.

    Secondary dimensions allow fine-grained scoping beyond the primary scope level. Each dimension can be configured for validation, inheritance behavior, and defaults.

    2.131.0

    interface SecondaryDimension {
        defaultValue?: string;
        description?: string;
        entityId?: string;
        inheritanceMode?: "cascading" | "strict";
        name: string;
        required?: boolean;
    }
    Index

    Properties

    defaultValue? description? entityId? inheritanceMode? name required?

    Properties

    defaultValue?: string

    Default value if not provided at runtime. Only used when required=false. If the dimension is not in the runtime scope and a defaultValue is set, this value will be used.

    description?: string

    Human-readable description of this dimension for documentation.

    entityId?: string

    Optional MemberJunction Entity ID for validation. When provided, runtime values can be validated as existing records in that entity. When null/omitted, the dimension accepts any string value (useful for non-entity dimensions like "Region", "DealStage", "ProductLine", etc.).

    inheritanceMode?: "cascading" | "strict"

    Inheritance mode for this specific dimension, overrides defaultInheritanceMode.

    • 'cascading': Notes without this dimension match queries with it (broader retrieval). For example, if querying with ContactID=123, notes without any ContactID will match.
    • 'strict': Notes must exactly match the provided dimension value. Notes without the dimension do NOT match queries that include it.
    name: string

    Dimension name/key (e.g., "ContactID", "TeamName", "Region"). This is the key used in ExecuteAgentParams.SecondaryScopes and stored in the SecondaryScopes JSON field on notes/examples/runs.

    required?: boolean

    Whether this dimension is required at runtime. When true, ExecuteAgentParams.SecondaryScopes must include this dimension or have a defaultValue defined.

    false

    Settings

    Member Visibility

    On This Page

    Properties