Member Junction
    Preparing search index...

    Class ExecuteScheduledJobNowAction

    Execute Scheduled Job Now action.

    Runs a scheduled job immediately, bypassing its cron schedule, through the same engine path the poller uses — lock acquisition, plugin execution, the run record, statistics, and notifications.

    This used to write a Status='Running' run row and return. Nothing consumed those rows: there is no queue reader for ad-hoc runs, only the cron poller, which selects jobs by their schedule and never looks at pending run records. So "Execute Now" reported success, left a row that said Running forever, and never ran anything. Delegating to SchedulingEngine.ExecuteScheduledJob is what makes the name true.

    await RunAction({
      ActionName: 'Execute Scheduled Job Now',
      Params: [
        { Name: 'JobID', Value: 'F3C4A5B6-...' }
      ]
    });

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    AuthorizesCaller

    Accessors

    SupportsAudience

    Methods

    addOutputParam buildJobFilter getBooleanParam getDateParam getNumericParam getParamValue InternalRunAction isValidStatus loadJob Run validateCronExpression

    Constructors

    Properties

    AuthorizesCaller: boolean

    True when the action authorizes its caller itself, so a public entry point such as the RunAction mutation may run it for an authenticated user without an MJ: Action Authorizations link. Set it only on an action that either checks an authorization the caller must hold, or reads and writes only with the caller's own permissions. Leave it false for an action that acts with more authority than its caller, or that reaches data or sends messages the caller chooses but could not otherwise reach.

    The engine reads the marker only from the class that runs, never from its parent classes. A subclass that overrides a marked action must declare the marker again.

    Accessors

    • get SupportsAudience(): boolean

      Whether this action can bound what it returns to an audience (RunActionParams.Audience): everyone besides the caller who will see its output, such as the other participants of a shared conversation.

      false by default, and the engine enforces it: when a run's audience adds a reader beyond the caller, ActionEngineServer.RunAction refuses the action with result code AUDIENCE_UNSUPPORTED, without running it. Override to return true only when the action honours the audience in full — every record, snippet and count it returns is something every reader may see (pass the audience to the search engine, check each reader's entitlement to anything it scopes by, and leave out aggregates computed before that filtering).

      Returns boolean

    Methods

    • Build filter expression for job queries

      Parameters

      • filters: {
            createdAfter?: Date;
            createdBefore?: Date;
            isActive?: boolean;
            jobTypeId?: string;
            status?: string;
        }

        Object containing optional filter criteria

      Returns string

      SQL WHERE clause string

    • Runs a scheduled job immediately.

      Parameters

      • params: RunActionParams

        The action parameters containing:

        • JobID (required): ID of the job to execute
        • Wait (optional, default true): await the job and report its real outcome. Set false to start it and return as soon as it is under way — useful for a long job behind an interactive button, at the cost of the result only saying it started.

      Returns Promise<ActionResultSimple>

      ActionResultSimple with:

      • Success: whether the job itself succeeded (or, with Wait=false, whether it started)
      • ResultCode: SUCCESS, VALIDATION_ERROR, NOT_FOUND, LOCKED, JOB_FAILED, STARTED, or FAILED
      • Params: output parameters 'RunID' and 'RunStatus'

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods