Skip to main content
WORKBENCH

DolphinScheduler external schedule

Push a published job as a DolphinScheduler SHELL node. The worker submits with a CLI token.

The workbench can push a published job to Apache DolphinScheduler. A SHELL node appears in the workflow; when it fires, the worker runs stx sync task submit. Push writes that node only. It does not issue or write the worker login token.

Built-in Schedule stays a single-machine lightweight cron. Complex dependencies and unified alerting live in the DolphinScheduler workflow; STX owns the script version and the submit.

Open external schedule​

In the Web UI dock, open Workbench, open the job, then switch the right pane to Schedule:

Cron and schedule preview are at the top; External schedule is below. When unbound, the hint says you can copy the SHELL script to create a node by hand, or push it to DolphinScheduler.

StateUI
UnboundHint: copy the SHELL script to create a node by hand, or push it to DolphinScheduler
BoundShows the workflow / node code and "Published vN · pushed vM"
After bindBuilt-in schedule stays off: "This task is bound to Dolphin, so the built-in schedule stays off"

Both built-in and external schedule run the published version only. Unpublished edits are not scheduled.

Publish first​

If the job is unpublished, the UI says "Publish the task before pushing it to Dolphin". Dry run and Push stay disabled.

Push is allowed after a publish. The same published version cannot be pushed again; the UI says "vN is already pushed. Publish a new version before updating the node".

Copy the script or push​

ButtonWhat it does
Copy node scriptCopies the SHELL body and worker reminder so you can create a node in Dolphin by hand
Push to DolphinOpens the push dialog; STX writes the DolphinScheduler workflow
Update nodeAfter bind, overwrites this SHELL node only and leaves edges unchanged
Open DolphinOpens the Dolphin page when a console URL exists
UnbindRemoves the STX-side binding only. It does not change the DolphinScheduler workflow or revoke login tokens

The copied script submits the current job and keeps Dolphin placeholders, for example:

exec stx sync task submit 12 --wait --confirm \
--external-ref "ds:${system.workflow.instance.id}:${system.task.definition.code}" \
--schedule-time "${system.datetime}"

Streaming jobs use --wait --close-job=false --confirm so the CLI exit does not stop the job. The script does not write --timeout; job duration is owned by the engine terminal state and the Dolphin node timeout. Default worker group is default.

The reminder says the worker environment (default name stx-cli-prod) must bind the STX login token itself; push does not write STX_TOKEN.

Save a scheduler connection​

If there is no connection yet, Push to Dolphin asks for an Open API URL and token before it can list projects.

FieldMeaning
Connection nameA local label, for example dolphin-prod
Open API URLFor example http://10.0.0.30:12345/dolphinscheduler. The Dolphin API host must be reachable from STX; this is not the STX Web UI
Dolphin Open API tokenRequired, sent as the token header. This is not the worker STX_TOKEN
Dolphin versionOptional; empty probes automatically. Only 3.x: 3.0 / 3.1 / 3.2 use process-definition; 3.3+ use workflow-definition

After save, the token is masked as "Open API token saved (masked)". Pick a Scheduler connection and Project, then create or reuse a workflow.

New or reuse a workflow​

ModeWhat it does
New workflowEnter a Workflow name. Optionally Reuse the STX built-in schedule to copy the current cron
Reuse workflowPick a workflow, then Upstream nodes / Downstream nodes

If the selected edges would cycle, the UI says "The selected edges would create a cycle, so push is blocked" and does not write Dolphin.

A later push overwrites this SHELL node only and leaves edges unchanged. The dialog can show Current Dolphin script and Script that will be written.

Use Dry run first ("Dry run passed; Dolphin was not changed"), then Push.

Worker login token​

Push does not bind the login token. The Dolphin worker must reach the STX install host API (default 17800).

The STX client and server share the same binary. Copy it to the worker machine to use CLI features without starting a server there. See Quick deploy → Install STX CLI.

Example: STX on 10.0.0.10, Dolphin worker on 10.0.0.30. Issue the token on 10.0.0.10, then bind it on the worker:

stx login --server http://10.0.0.10:17800 --token stx_...

Or set STX_SERVER and STX_TOKEN on the worker. Issue steps: Token management.

CLI​

# Dry run / push (needs --confirm)
stx sync task dolphin push 12 --dry-run --confirm
stx sync task dolphin push 12 --new-workflow --workflow-name stx-orders --confirm

# Save a Dolphin connection
stx sync scheduler connection create --name dolphin-prod \
--base-url http://10.0.0.30:12345/dolphinscheduler \
--token <dolphin-open-api-token> --confirm

After Dolphin triggers, the job carries a ds: reference. The bottom job list Mode column shows Dolphin schedule, separate from manual runs and built-in cron:

Cancel by reference:

stx sync job cancel-by-ref --external-ref 'ds:123:456' --confirm

Writing, publishing, and built-in schedule: Debug workbench.