Skip to main content
Version: 1

Start Scheduling Step Engine

  • Category​

    • Orchestration
    • Scheduling
    • Automation

  • Flow Icon​

Overview​

The Start Scheduling Step Engine component triggers the Step Engine’s scheduler from Flow.
It emits a scheduling request (event-driven) using the parameters you provide, allowing you to start or manage Step Engine jobs without custom Apex in your Flow.

Use this when you need to kick off, re-run, or control Step Engine work as part of a larger automation.

info

Note: This feature is paid for and will require activation, please speak to your Plinqx Account Manager for more information

Inputs​

  1. developerName (Required)
    The Developer Name (identifier) for the Step Engine configuration or process you want to schedule.

  2. scheduleOption (Required)
    The scheduling action/option to apply (e.g., "Start", "Reschedule", "RunNow").

    Use the exact option values expected by your Step Engine configuration.

  3. jobIds (Optional)
    A List of Job Ids to target when your scheduling action pertains to existing jobs (e.g., rescheduling or controlling specific jobs).

  4. abortJobs (Optional, Boolean)
    If true, instructs the scheduler to abort the specified jobs (commonly used together with jobIds).

Output​

  1. outputResult
    A string message describing the result of the scheduling request (success or error details).

Example Scenario – Starting a Daily Step Engine Job​

Scenario Overview:
A Salesforce org uses Plinqx Step Engine to process daily data transformations. Instead of manually starting the job, the business wants a Flow that automatically triggers the Step Engine scheduler at the right point in a larger automation.

Implementation with Start Scheduling Step Engine Component:

Flow Setup for Automation Trigger:

  • Create a Flow that runs at the desired event (e.g., after records are loaded, or at the start of a nightly automation chain).

  • Insert the Start Scheduling Step Engine component to call the Step Engine scheduler.

Configuring Input:

  • developerName is set to Daily_Step_Engine (the configured Step Engine process).

  • scheduleOption is set to Start to launch the schedule.

Sample Input:

developerName: Daily_Step_Engine scheduleOption: Start

Executing Start Scheduling Step Engine:

  • The scheduler queues the job identified by Daily_Step_Engine.

  • The request is event-driven, so Flow doesn’t directly run the job but hands it off to Step Engine’s orchestration layer.

Output:

  • outputResult returns "Schedule queued successfully for Daily_Step_Engine".

  • The Flow can branch on this result string to confirm success or handle errors.

Behavior:

  • The Step Engine job is added to the scheduler’s queue and runs per its configuration.

  • If scheduleOption were instead RunNow, the job would execute immediately rather than wait on the configured schedule.

Utilizing Results:

  • Use outputResult in a Decision element to detect failures (look for "error") or confirm success.

  • Downstream Flow logic can then continue automation, notify admins, or trigger dependent processes.

Example Scenario – Aborting Stuck Step Engine Jobs​

Scenario Overview:
A Salesforce org runs a recurring Step Engine job for data loading. Occasionally, jobs may get stuck or need to be cancelled mid-run. Instead of manually aborting them in the Step Engine UI, admins want a Flow action that can abort specific jobs automatically.

Implementation with Start Scheduling Step Engine Component:

Flow Setup for Admin Control:

  • Build a Flow that can be triggered manually (e.g., by an admin screen flow) or automatically (e.g., when monitoring logic detects long-running jobs).

  • Add the Start Scheduling Step Engine component to issue the abort request.

Configuring Input:

  • developerName is set to DataLoad_Step_Engine (the Step Engine job configuration).

  • scheduleOption is set to Abort.

  • jobIds is populated with the list of Step Engine Job Ids to cancel.

  • abortJobs is set to true to confirm the cancellation.

Sample Input:

developerName: DataLoad_Step_Engine scheduleOption: Abort jobIds: ["707xx00000AAAAB", "707xx00000AAAAC"] abortJobs: true

Executing Start Scheduling Step Engine:

  • The component sends an abort request to the Step Engine scheduler.

  • Only the specified jobs in jobIds are targeted.

Output:

  • outputResult returns "2 job(s) aborted for DataLoad_Step_Engine".

  • Flow can branch on this output to log the abort, notify admins, or retry the process.

Behavior:

  • The scheduler cancels only the specified job instances.

  • If abortJobs is not true, the abort request is ignored.

  • If invalid jobIds are provided, the result string will return error details.

Utilizing Results:

  • Use outputResult in a Decision element to handle outcomes (success, partial failure, or error).

  • Optionally, add logic to retry or escalate if abort fails.

Best Practices​

  • Use exact identifiers: developerName must match your Step Engine’s configured developer name.
  • Validate options: Ensure scheduleOption is one of the options supported by your Step Engine.
  • Guard aborts: Only set abortJobs when you intend to cancel the provided jobIds.
  • Chain decisions: Branch on outputResult (or check for keywords like "success"/"error") to handle downstream steps.

Troubleshooting​

  • No effect / no run → Verify developerName exists and scheduleOption is supported.
  • Abort not working → Ensure abortJobs = true and jobIds contains valid job identifiers.
  • Error string returned → Inspect outputResult for details (e.g., subscription or configuration issues) and adjust inputs accordingly.