Tenant Attributes

Use this node to inject tenant-level configuration into messages — for example, fetching a tenant-wide alertEmail server attribute or a global threshold that applies to all devices in the tenant. This is useful when you want to avoid duplicating configuration across many device profiles or customer attributes.

• Mapping type — what to fetch from the tenant:
  • Attributes — fetches server-side attributes.
  • Latest telemetry — fetches the latest time series value.
• Attributes/Latest telemetry mapping — a list of source → target key pairs:
  • Source key — the attribute or telemetry key on the Tenant entity. Supports templatization — use ${metadataKey} or $[dataKey].
  • Target key — the key to write the value under in the outgoing message. Also supports templatization.
• Add mapped data to — destination for the fetched values:
  • Message — adds to message data. Fails if message data is not a valid JSON object.
  • Metadata — adds to message metadata.

1. Identify the Tenant associated with the message originator.
2. Resolve templates in source and target key names using message data and metadata.
3. Fetch the specified attributes or latest telemetry from the Tenant entity asynchronously.
4. Add the fetched key–value pairs to message data or metadata per the destination setting.
5. Forward via Success. Route via Failure on error (e.g., data destination is Message but payload is not a JSON object).

{
  "dataToFetch": "ATTRIBUTES",
  "fetchTo": "METADATA",
  "dataMapping": { "exampleSourceKey": "exampleTargetKey" }
}

Tenant has server attribute exampleSourceKey = "exampleValue". Outgoing metadata gains "exampleTargetKey": "exampleValue".

Device type is boiler. Tenant has server attribute boilerSourceKey = "exampleValue".

{
  "dataToFetch": "ATTRIBUTES",
  "fetchTo": "DATA",
  "dataMapping": { "${deviceType}SourceKey": "exampleTargetKey" }
}

${deviceType} resolves to boiler → fetches boilerSourceKey → adds "exampleTargetKey": "exampleValue" to message data.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "TbGetTenantAttributeNodeConfiguration",
  "type": "object",
  "required": ["dataToFetch", "fetchTo", "dataMapping"],
  "additionalProperties": false,
  "properties": {
    "dataToFetch": { "type": "string", "enum": ["ATTRIBUTES", "LATEST_TELEMETRY"] },
    "fetchTo": { "type": "string", "enum": ["DATA", "METADATA"] },
    "dataMapping": {
      "type": "object",
      "additionalProperties": { "type": "string" },
      "description": "Map of source key on the tenant to target key in the message."
    }
  }
}