Skip to main content
Version: 1.9.0

Simulator

Simulate a connection to an external service, useful during development when the real service is un-available etc. It can also be used to automatically replay a fixed set of simulated values over a repeating 24h period, or configured with a custom schedule.

Agent configuration

There is no configuration required on the agent for this protocol.

For attributes linked to this agent, the following describes the supported agent link fields which are in addition to the standard Agent Link fields:

FieldDescriptionValue typeRequired
typeAgent typeText (Must be SimulatorAgentLink)Y
replayDataA dataset of values that should be replayed (i.e. written to the linked attribute) in a continuous loopSimulatorReplayDatapoint[]N
scheduleWhen defined overwrites the default 24h dataset length and how it is replayed.SimulatorProtocol.ScheduleN

Additional info

Attributes linked to this agent that are written to will follow a route through the system as if it came from a remote service.

The has predicted data points configuration item will cause the dataset of the current and next occurrence to be inserted as predicted data points alongside the normally scheduled data points.

If the replayData contains data points scheduled after the default 24 hours or the recurrence rule, the data points will be ignored.

Simulator Replay Datapoints

Attributes linked to this agent that have a replayData field in their Agent Link will cause the values within to be replayed over a 24h period in a continuous loop, unless a schedule is configured. Each SimulatorReplayDatapoint value must have a timestamp (seconds offset from midnight 00:00 in the system time of the machine that hosts the manager) and a value, this value will then be written to the attribute at the specified seconds offset from midnight each day.

Schedule

The schedule can be set to occur only once when only a start- (and end) date are defined, or as a recurring event following the RFC 5545 RRULE format. If not provided defaults to every 24 hours.