Member Junction
    Preparing search index...

    Interface RunRecordProcessOptions

    Options for executing a Record Process.

    interface RunRecordProcessOptions {
        contextUser: UserInfo;
        dryRun?: boolean;
        onProgress?: (progress: ProgressInfo) => void;
        provider?: IMetadataProvider;
        scheduledJobRunID?: string;
        scope?: RecordProcessScopeOverride;
        singleRecordID?: string;
        triggeredBy?: TriggeredByValue;
    }
    Index

    Properties

    contextUser dryRun? onProgress? provider? scheduledJobRunID? scope? singleRecordID? triggeredBy?

    Properties

    contextUser: UserInfo

    The acting user.

    dryRun?: boolean

    Compute-only: for work types that support it (currently FieldRules), produce the per-record diff WITHOUT writing. Powers the preview step of the bulk-update UX.

    onProgress?: (progress: ProgressInfo) => void

    Progress callback.

    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.

    triggeredBy?: TriggeredByValue

    What triggered the run (default OnDemand).

    Settings

    Member Visibility

    On This Page

    Properties