Member Junction
    Preparing search index...

    Inputs for createScheduledModelScoring. The required trio — modelId, targetEntityName, and exactly one scope selector — is the minimum to bind a model to a recurring scoring run; everything else has a sensible default (monthly cadence, ID primary key, numeric score, UTC, generated name).

    Two output modes, driven by whether outputField is supplied:

    • Write-back (outputField present): each run writes the prediction into that target column AND a MJ: ML Model Scoring Bindings lineage row is created.
    • Generic (outputField omitted): each run records its predictions in the process run history (MJ: Process Run Details) only — no write-back column and no scoring binding.
    interface ScheduleModelScoringOptions {
        cadence?: ScoringCadence;
        contextUser?: UserInfo;
        modelId: string;
        name?: string;
        outputField?: string;
        primaryKeyField?: string;
        provider?: IMetadataProvider;
        scope: ScoringScope;
        targetEntityName: string;
        timezone?: string;
        valueKind?: ScoringValueKind;
    }
    Index

    Properties

    cadence?: ScoringCadence

    Recurrence; defaults to 'Monthly' (the 1st of every month at 00:00).

    contextUser?: UserInfo

    Server-side context user (required for data isolation + audit on the saved row).

    modelId: string

    The MJ: ML Models id to score with.

    name?: string

    Optional Record Process name; a descriptive default is generated when omitted.

    outputField?: string

    Optional. The target-entity column to write the prediction into (e.g. 'RenewalScore'). Omit for generic output — each run's predictions are recorded in the process run history (MJ: Process Run Details) only; no write-back column and no scoring binding are created.

    primaryKeyField?: string

    Primary-key field on the target entity (defaults to 'ID').

    Metadata provider to create the entity object against (defaults to the global).

    scope: ScoringScope

    The records each run scores. Populate EXACTLY ONE of: filter, viewId, listId, all.

    targetEntityName: string

    The entity whose rows are scored (e.g. 'Memberships').

    timezone?: string

    Timezone the cron is evaluated in (defaults to 'UTC').

    valueKind?: ScoringValueKind

    Which prediction value to write — numeric 'score' (default) or 'class' label.