Member Junction
    Preparing search index...

    Interface RunRecordProcessOptions

    Options for executing a Record Process.

    interface RunRecordProcessOptions {
        ContextUser: UserInfo;
        DryRun?: boolean;
        DryRunSampleSize?: number;
        LastRunAt?: Date;
        OnProgress?: (progress: ProgressInfo) => void;
        OverwriteHumanValues?: boolean;
        Provider?: IMetadataProvider;
        ScheduledJobRunID?: string;
        Scope?: RecordProcessScopeOverride;
        SingleRecordID?: string;
        SkipUnchanged?: boolean;
        TriggeredBy?: TriggeredByValue;
    }
    Index

    Properties

    ContextUser DryRun? DryRunSampleSize? LastRunAt? OnProgress? OverwriteHumanValues? Provider? ScheduledJobRunID? Scope? SingleRecordID? SkipUnchanged? TriggeredBy?

    Properties

    ContextUser: UserInfo

    The acting user.

    DryRun?: boolean

    Compute-only: produce each record's result and the write-back preview WITHOUT writing (see RecordProcessExecutor.BuildProcessor for what each work type does). Powers the preview step of the bulk-update UX.

    DryRunSampleSize?: number

    Dry runs preview at most this many records when no scope or single record is given and the processor declares a default sample size.

    LastRunAt?: Date

    Optional timestamp of the previous run, used for 'UpdatedAt' watermark strategy.

    OnProgress?: (progress: ProgressInfo) => void

    Progress callback.

    OverwriteHumanValues?: boolean

    Overwrite values a person entered, and retire their Human values (default false).

    Provider?: IMetadataProvider

    The owning provider (defaults to the active provider).

    ScheduledJobRunID?: string

    FK to the owning ScheduledJobRun when launched by the scheduler (links the Process Run back).

    Scope?: RecordProcessScopeOverride

    Runtime scope override (selected rows / a view / a list / a filter), used instead of the stored Scope. This is how a grid/list UI runs a process against exactly what the user is looking at.

    SingleRecordID?: string

    Process a single record (the on-change / on-demand single-record case) instead of the scope.

    SkipUnchanged?: boolean

    Whether the run skips records its watermark says are unchanged (default: the Record Process's SkipUnchanged). A version backfill passes false; it still refreshes the watermarks of the records it processes.

    TriggeredBy?: TriggeredByValue

    What triggered the run (default OnDemand).

    Settings

    Member Visibility

    On This Page

    Properties