DocsNodesStarts the workflowClient online / offline

Client online / offline

Starts a run when a client goes offline or comes back, and stays that way for a while. The wait keeps a board that reboots or roams between access points from paging you.

Kindtrigger:clientPresence
GroupStarts the workflow
CreditsFree
Ports out1

How it looks

Settings

SettingRequiredWhat it does
This clientclientRefYesThe client to watch.
GoesstateNoOffline (the default) or Online.
For at leastforSecondsNoHow long it must stay that way before a run starts. 1 minute by default, at most 24 hours.
If it fires while a run is still goingconcurrencyPolicyNoQueue by default. See Runs that overlap below.
Correlation keycorrelationKeyNoWhich runs count as the same for the setting above. Left empty, the client and state. Set it to share one line with another trigger.

Ports

PortThe run leaves by it when
defaultThe client has stayed in that state for the time you set.

What it adds to the run

Later nodes can read these, in a condition or as {{name}} in a text field.

ValueHolds
triggerWhich client changed, and to what.
triggeredAtWhen the trigger fired.

Example

Tell me when the pump controller drops off

  1. This client pump-01, goes Offline, for at least 5 minutes.
  2. Connect an Email node: "pump-01 has been offline for 5 minutes".
  3. Add a second workflow with Goes Online to hear when it's back.
Firmware updatesA board that closes its connection to install firmware shows as updating, not offline, for 5 minutes, so an update doesn't start an offline run.

Runs that overlap

What happens when the trigger fires again while a run with the same correlation key is still going.

SettingWhat happens
QueuedefaultThe new event waits. When the run finishes, the oldest waiting event starts the next one. Events wait up to 24 hours.
Allow parallelAnother run starts alongside.
Drop if runningThe new event is dropped.
Cancel existingThe running one is cancelled and a new one starts.

Problems you might see

CodeMeans
INVALID_CLIENT_REFThe client isn't one in this workspace.
INVALID_PRESENCE_DURATIONFor at least is negative or over 24 hours.

Problems found when you publish stop the publish and point at the node. Problems while a run is going fail the node, and its On failure setting decides what happens next. See the error codes for the API's own.