Consumer Placeholder Token Reference
All 104 payload placeholder tokens across 10 contexts, read from the shared consumer placeholder engine.
The four payload consumers — MQTT, Apache Kafka, Azure Event Hub and AWS Kinesis — now share one placeholder engine, so this is the complete token set for all of them, read from the engine at v7.2.0.
A token resolves only when its context is in scope. Publishing a calendar value puts the measure, time period and measure value contexts in scope; publishing an event-sliced value puts the event period and event scheme contexts in scope instead. A token from a context that is not in scope is left unresolved rather than blanked, which is what makes an unsubstituted [token] in a payload a useful diagnostic — see Consumer Placeholder Reference for how to read one.
Every date token comes in six forms#
A timestamp is registered once and expands to six tokens. Picking the right one is usually the difference between a destination that parses your payload and one that does not:
| Form | Example | Gives |
|---|---|---|
[name] |
[periodstart] |
The instance's local time |
[name]utc |
[periodstartutc] |
UTC |
[name]unix |
[periodstartunix] |
Epoch seconds |
[name]unix_ms |
[periodstartunix_ms] |
Epoch milliseconds |
[name]utcunix |
[periodstartutcunix] |
Epoch seconds |
[name]utcunix_ms |
[periodstartutcunix_ms] |
Epoch milliseconds |
Epoch values are an instant, so the unix and utcunix spellings are the same number — both exist so a payload can read consistently alongside its neighbours.
The bare token is instance-local, not UTC. [periodstart] is rendered in the instance's time zone. A destination that assumes UTC will silently shift every timestamp by your offset, and the data will look plausible. Where the receiving system expects UTC, say so explicitly with [periodstartutc].
Always available#
Resolvable in every payload, with no context required.
| Token | Kind | Notes |
|---|---|---|
[now] |
date | |
[nowutc] |
date |
Measure#
The measure being published — its identity, naming and configuration.
| Token | Kind | Notes |
|---|---|---|
[hierarchicalname] |
text | |
[instancename] |
text | |
[intervaltype] |
alias | alias for [measureintervaltype] |
[measuredescription] |
text | |
[measureformat] |
text | |
[measureid] |
number | |
[measureintervaltype] |
text | |
[measurename] |
text | |
[measureparent] |
text | |
[measureuom] |
text | |
[parent] |
alias | alias for [measureparent] |
[timescheme] |
text |
Time period#
The calendar period a value belongs to.
| Token | Kind | Notes |
|---|---|---|
[periodend] |
date | instance local time |
[periodendunix_ms] |
epoch | milliseconds |
[periodendunix] |
epoch | seconds |
[periodendutc] |
date | UTC |
[periodendutcunix_ms] |
epoch | milliseconds |
[periodendutcunix] |
epoch | seconds |
[periodstart] |
date | instance local time |
[periodstartunix_ms] |
epoch | milliseconds |
[periodstartunix] |
epoch | seconds |
[periodstartutc] |
date | UTC |
[periodstartutcunix_ms] |
epoch | milliseconds |
[periodstartutcunix] |
epoch | seconds |
[timeperiodid] |
number | |
[timeschemeshift] |
text |
Measure value#
The value itself, with its quality, version and provenance.
| Token | Kind | Notes |
|---|---|---|
[attribute] |
text | |
[attributevalue] |
text | |
[duration] |
number | |
[formattedvalue] |
text | |
[measurevalue] |
number | |
[measurevaluedatetime] |
date | instance local time |
[measurevaluedatetimeunix_ms] |
epoch | milliseconds |
[measurevaluedatetimeunix] |
epoch | seconds |
[measurevaluedatetimeutc] |
date | UTC |
[measurevaluedatetimeutcunix_ms] |
epoch | milliseconds |
[measurevaluedatetimeutcunix] |
epoch | seconds |
[measurevalueid] |
number | |
[preferred] |
text | |
[quality] |
number | |
[stringvalue] |
text | |
[usernameid] |
number | |
[version] |
number |
Event period#
The event instance, when publishing event-sliced data.
| Token | Kind | Notes |
|---|---|---|
[duration] |
number | |
[eventperiodid] |
number | |
[periodend] |
date | instance local time |
[periodendquality] |
number | |
[periodendunix_ms] |
epoch | milliseconds |
[periodendunix] |
epoch | seconds |
[periodendutc] |
date | UTC |
[periodendutcunix_ms] |
epoch | milliseconds |
[periodendutcunix] |
epoch | seconds |
[periodstart] |
date | instance local time |
[periodstartquality] |
number | |
[periodstartunix_ms] |
epoch | milliseconds |
[periodstartunix] |
epoch | seconds |
[periodstartutc] |
date | UTC |
[periodstartutcunix_ms] |
epoch | milliseconds |
[periodstartutcunix] |
epoch | seconds |
[preferredevent] |
text |
Event scheme#
The event scheme the period belongs to.
| Token | Kind | Notes |
|---|---|---|
[eventscheme] |
alias | alias for [eventschemename] |
[eventschemedescription] |
text | |
[eventschemeid] |
number | |
[eventschemename] |
text |
Measure event period value#
A measure value sliced by an event period.
| Token | Kind | Notes |
|---|---|---|
[attribute] |
text | |
[attributevalue] |
text | |
[eventschemesetname] |
text | |
[formattedvalue] |
text | |
[measureeventperiodvalue] |
number | |
[measureeventperiodvaluedatetime] |
date | instance local time |
[measureeventperiodvaluedatetimeunix_ms] |
epoch | milliseconds |
[measureeventperiodvaluedatetimeunix] |
epoch | seconds |
[measureeventperiodvaluedatetimeutc] |
date | UTC |
[measureeventperiodvaluedatetimeutcunix_ms] |
epoch | milliseconds |
[measureeventperiodvaluedatetimeutcunix] |
epoch | seconds |
[measureeventperiodvalueid] |
number | |
[name] |
text | |
[preferred] |
text | |
[quality] |
number | |
[stringvalue] |
text | |
[usernameid] |
number | |
[value] |
alias | alias for [measureeventperiodvalue] |
[version] |
number |
Event attribute values#
Attribute values on the event; searched across several periods in order.
| Token | Kind | Notes |
|---|---|---|
[preferred] |
text |
Backfill#
Whether this payload is a backfill rather than a live publish.
| Token | Kind | Notes |
|---|---|---|
[backfill] |
text |
Raw value#
A raw timestamped reading — the context used when publishing a tag.
| Token | Kind | Notes |
|---|---|---|
[measureintervaltype] |
text | |
[measurevalue] |
number | |
[periodstart] |
date | instance local time |
[periodstartunix_ms] |
epoch | milliseconds |
[periodstartunix] |
epoch | seconds |
[periodstartutc] |
date | UTC |
[periodstartutcunix_ms] |
epoch | milliseconds |
[periodstartutcunix] |
epoch | seconds |
[quality] |
number | |
[stringvalue] |
text | |
[timestamp] |
date | instance local time |
[timestampunix_ms] |
epoch | milliseconds |
[timestampunix] |
epoch | seconds |
[timestamputc] |
date | UTC |
[timestamputcunix_ms] |
epoch | milliseconds |
[timestamputcunix] |
epoch | seconds |
[value] |
alias | alias for [measurevalue] |
Diagnosing#
| Symptom | Likely cause |
|---|---|
A literal [token] arrives at the destination |
That token's context is not in scope for this publish — check the table above |
| Timestamps are out by your UTC offset | A bare date token was used where the destination expects UTC |
| A number arrives with a comma decimal separator | Not possible here: the engine formats numbers with the invariant culture deliberately |
[attributevalue] is _ |
A calendar value with no attribute breakdown emits an underscore rather than an empty string |
| A token worked on one consumer and not another | Before the shared engine, each consumer had its own token list; they are now identical |