Workflow node reference
Every block the API accepts in a workflow's graph, by kind. A node is {id, kind, ref, params}; rows flow along its wires, and each node reads columns that a node upstream wrote. The graph's JSON shape is in the API reference.
A row is a pass (one antenna's view of one satellite from AOS to LOS), a link (that view over the whole run), or, after sum_by, an antenna, satellite or ground station per day.
Inputs
A graph has exactly one input.
| Name | Reads | Writes | Needs |
|---|---|---|---|
passes | The satellites and antennas in your network config, sampled every step_s over the run's window | One pass row per pass, with max_elevation | step_s. Optional satellite_ids and antenna_ids; leave them out for all. Explore covers at most 2 satellites |
links | The same | One link row per link, over all its passes in the run | The same. Optional window_s, the window a run covers from when it starts; rfi-watch sets an hour at 60 s steps |
Lanes
Each lane writes a column of its own name, with a p10, p50 and p90 at each step. quantile holds one of them at all three, such as p90 for the wet tail of weather.
| Name | Reads | Writes | Needs |
|---|---|---|---|
snr | The link budget from your network config's RF values; on Operator, the Link SNR model where it serves | snr, in dB | Nothing: always runs |
weather | A rain-fade climatology; on Operator, the Weather attenuation model where it serves. A scenario's extra fade adds to it | weather, fade in dB | Nothing: always runs |
demand | The Satellite demand model | demand, the share of the pass the satellite can expect an antenna for | Operator, and a deployment that serves the model |
rfi | The RF interference model | rfi, the dB interference takes off the link | Operator, and a deployment that serves the model |
ssa | The SSA pass forecast model | ssa, the chance the antenna holds the satellite | Operator, and a deployment that serves the model |
demand, rfi and ssa have no physics baseline. Where the model is not served, a run that reads the lane is refused with 422 lanes_not_served; below Operator, with 403 plan_required and feature: learned_corrections. Left out of a graph, each counts as no loss.
Transforms
| Name | Reads | Writes | Needs |
|---|---|---|---|
sinr | snr; weather and rfi when upstream | sinr: SNR less fade and interference, in dB, at each step | weather and rfi before it, or they count as no loss |
capacity | sinr | capacity: the GB the pass carries at its SINR, from the radio's own MODCOD table or DVB-S2's | Pass rows |
success | ssa and demand when upstream | success: the chance the pass happens as planned | ssa and demand before it. Pass rows |
expected_gb | capacity, success | expected_gb: capacity times success | Pass rows |
modcod_schedule | sinr | modcod_changes, and a time-tagged MODCOD series on the item | Pass rows |
lock_loss | sinr, rfi | rfi_db, the worst step; lock_loss_risk, the share of steps where interference alone drops the low case below the lowest MODCOD; and a recommendation to reroute | Pass or link rows |
sum_by | The column you name | One row per antenna, satellite or ground_station (by) per UTC day (per: day): passes, sellable minutes and the summed range | Network: a graph with sum_by is the antenna-capacity template, which saving refuses below Network with 403 plan_required (a trial allows it). Waits for the whole run |
swap | The column you name, usually expected_gb | swap, the GB gained in the low case, and a recommendation to swap to a backup pass with its deadline | at_risk_share (0 to 1): a pass is at risk when the weather lane, at its p50, costs more than this share of its clear-sky GB (rain-fade-swap uses 0.3). backup_within_s, cancel_lead_s. Waits for the whole run |
ledger | The column you name, and the contacts logged in the run's dataset | ledger: GB possible, GB delivered and the outcome per pass; totals per ground station on the run | A run with a past window and a dataset, such as audit. Waits for the whole run |
policy | A recommendation from a step upstream | The recommendation's mode | mode: suggest sends it as advice; approve holds it for a person. See From trial to sending |
Conditions
| Name | Reads | Writes | Needs |
|---|---|---|---|
threshold | column, at quantile for a column with a range | Nothing: matching rows leave by true, the rest by false | op (<, <=, >, >=) and value |
Outputs
Each output turns the rows that reach it into items: columns make each item's value, and sort orders them.
| Name | Reads | Writes | Needs |
|---|---|---|---|
predictions | The rows that reach it | The items GET /predictions returns | Exactly one per graph. Every plan |
feed | The same | The workflow results a connector in your network pulls, for its connection | mapping naming its system: yamcs, lattice, cosmos or custom. Delivers on Operator; Lattice and COSMOS on Enterprise; custom needs a connector you approved |
destination | The same | A push to one of your destinations | destination_id, a destination your account has. Delivers on Operator |
A test run or a scenario run sends nothing from feed and destination outputs. See Results out.
Graph rules
The API refuses a graph that breaks one, naming the node or edge:
- One input, one
predictionsoutput, no cycles, and every node past the input fed. - Only an output takes more than one incoming wire.
- A lane goes before the transform that reads it (
lane_after_reader), and never after a node that waits for the whole run (lane_after_whole_run). - Each node has the columns it reads on every path upstream (
column_missing) and the row type it reads (type_mismatch). - No two mission control outputs name one connection, and no two destination outputs one destination.
- A graph whose deciding step is
lock_loss, as inrfi-watch, has nolatticeorcosmosmission control output: those bridges drop reroutes (reroutes_not_delivered). - Once a graph has a
policyinapprovemode, every path to every output passes through one (output_around_approval), and through one placed after every step that suggests an action (swap,lock_loss) and everypolicyinsuggestmode on that path. A policy before the step that suggests the action holds nothing.
Check a graph without saving it with POST /predictions/workflows/{slug}/validate; the builder does this as you edit.
Next: change a template with these blocks in Recipes.