Attributes
AdapterConfiguration
JSON-serialized adapter-specific configuration that is deployed to the adapter.
Data Type
STRING
AdapterSharingMode
Whether and to whom an adapter pool lends its members, i.e. which part of the tenant tree may be handed a lease on it (AB#4924). NotShared (default) makes the pool private to its owning tenant, which is a legitimate configuration — a pool is still useful as a way to run one tenant's own workloads elastically. The trust direction is fixed by the tenant tree and is never configurable upwards: a descendant can not lend to its ancestors (concept §3).
Data Type
ENUM: System.Communication-4/AdapterSharingMode
Default Values
| Default Value |
|---|
| 0 |
AdminPassword
Grafana Server Admin password.
Data Type
STRING
AdminUser
Grafana Server Admin username for organization management API.
Data Type
STRING
AiModel
AI model identifier to use (e.g. claude-sonnet-4-6, claude-opus-4-1). Mandatory and has no default: a pinned model id goes out of date (a retired "-20250514" snapshot returns HTTP 404), so it must be set explicitly on each AiConfiguration.
Data Type
STRING
AllowDelegation
Whether the identity client carries the on-behalf-of delegation grant (urn:meshmakers:params:oauth:grant-type:on-behalf-of, AB#5026/AB#5031). Absent means true — the pre-AB#5111 behaviour, where every provisioned pipeline service account got the grant. Set to false to make the account strictly client_credentials.
Data Type
BOOLEAN
ApiKey
API key for authenticating with an external service (e.g. Anthropic sk-ant-... key, WeClapp API token). Stored as configuration attribute, not exposed in pipeline data context.
Data Type
STRING
ApiUrl
Base URL of the cluster-shared signal-cli-rest-api bridge this channel is registered against (e.g. http://signal-cli-rest-api.signal-bridge.svc.cluster.local:8080). The bridge API is unauthenticated; only the Communication Controller may call it.
Data Type
STRING
AppHeading
Heading displayed in the application header bar
Data Type
STRING
AppTitle
Browser tab title of the web application
Data Type
STRING
AssignedRoleNames
Declared roles of the identity client (AB#5111). When set, the reconcile syncs the client's AssignedRole edges to exactly this list — missing roles are added, superfluous ones removed. When absent, the account is in legacy (pre-declarative) mode: the reconcile leaves the client's roles completely untouched, so role edges granted by hand or by a blueprint survive. Setting this attribute is the explicit opt-in to declarative role management.
Data Type
STRING_ARRAY
AzureTenantId
The Azure Active Directory tenant ID (GUID) for OAuth2 authentication.
Data Type
STRING
BackgroundColor
Background color of the web application
Data Type
STRING
BankAccountHolder
Account holder of the energy community's own account, as it must appear on a transfer
Data Type
STRING
BankAccountIban
IBAN of the energy community's own account - the one members are asked to pay into. Distinct from Customer.BankAccount, which holds a MEMBER's account and is used for payouts in the opposite direction.
Data Type
STRING
BillingMailServerConfiguration
Well-known name of the EMailSenderConfiguration used for outbound billing mail
Data Type
STRING
BillingReportFilePrefix
Filename prefix for generated billing report files (e.g. Billing_)
Data Type
STRING
BillingReportName
Name of the Telerik billing report template (e.g. Billing.trdp)
Data Type
STRING
BotToken
The bot token used as the Authorization: Bot \{token\} header when calling the Discord REST API.
Data Type
STRING
CallerAccessToken
The invoker's bearer token for delegation, ENCRYPTED with the controller's instance key (enc:v1: sentinel) — never plaintext (AB#5279). Written only when the controller has an encryption key; read back and decrypted at lease grant, dropped there when expired. Unset when no token was carried or no key was configured.
Data Type
STRING
CallerEmail
E-mail claim of the invoker of this queued work item (AB#5279).
Data Type
STRING
CallerName
Display name (name / preferred_username) of the invoker of this queued work item (AB#5279).
Data Type
STRING
CallerRoles
Role claims of the invoker of this queued work item (AB#5279).
Data Type
STRING_ARRAY
Default Values
| Default Value |
|---|
CallerSubjectId
Subject (sub, or client_id for a client-credentials caller) of the invoker this queued work item was created for (AB#5279). Unset when the item was queued without an invoker — a cron tick or an internal caller.
Data Type
STRING
CallerTenantId
Tenant claim of the invoker of this queued work item (AB#5279).
Data Type
STRING
CallerTrustLevel
Trust the invoker established (AB#5279): 2 = strongly authenticated (bearer on the execute route), 1 = weak, 0 = none. Mirrors CallerTrustLevel of the pipeline SDK.
Data Type
INT
Channel
Helm chart distribution channel (Dev or Release). Pure label for UI colour-coding; the operator does not derive behavior from it.
Data Type
ENUM: System.Communication-4/HelmChannel
Default Values
| Default Value |
|---|
| 0 |
ChartName
Helm chart name within the repository (e.g. voest-app, octo-mesh-adapter).
Data Type
STRING
ChartVersion
Helm chart version (e.g. 1.2.3). Runtime-state (AB#4706): set by the CD pipeline (UpdateWorkloadChartVersion) or the operator, not blueprint configuration - a blueprint re-apply preserves the live value instead of resetting it to the seeded version.
Data Type
STRING
ClientId
OAuth2 Client ID for authenticating with the external API. Runtime state (AB#5187): issued to the tenant by the external provider, preserved across blueprint re-apply — a seed can only carry a placeholder.
Data Type
STRING
ClientSecret
OAuth2 Client Secret for authenticating with the external API. Runtime state (AB#5027): issued/rotated at runtime, preserved across blueprint re-apply.
Data Type
STRING
CommunicationState
Current SignalR connection state of the adapter or pool operator.
Data Type
ENUM: System.Communication-4/CommunicationState
Default Values
| Default Value |
|---|
| 0 |
CommunicationStateTimestamp
Timestamp of the last communication state change (online/offline transition).
Data Type
DATE_TIME
CompletedAt
Timestamp when execution completed
Data Type
DATE_TIME
ConfigurationState
Current configuration deployment state of the adapter or pool.
Data Type
ENUM: System.Communication-4/ConfigurationState
Default Values
| Default Value |
|---|
| 0 |
ConsecutiveStatusFailures
Number of failed status reports since the last successful one. Incremented on every error report, reset to 0 by a successful report. Empty until the first status report. Pipelines only for now (AB#5618).
Data Type
INT
ConsumerPrice
Price per kWh for consumers in the energy community
Data Type
DOUBLE
ConsumptionRecordRequestDelay
Delay in days before automatic consumption record requests are sent
Data Type
INT
Default Values
| Default Value |
|---|
| 5 |
CurrentValue
Current value of the data point as a string (numeric conversion happens during mapping evaluation)
Data Type
STRING
DeploymentState
Current deployment state of the entity (undeployed, pending, deployed, or error).
Data Type
ENUM: System.Communication-4/DeploymentState
Default Values
| Default Value |
|---|
| 0 |
DurationCount
Number of folded executions that carried a duration
Data Type
INT
Default Values
| Default Value |
|---|
| 0 |
DurationMs
Execution duration in milliseconds
Data Type
INT
EmailFooterImage
Image placed in the footer or imprint block of outgoing e-mails. Separate from FooterLogo, which brands the web application - the two are set independently on purpose.
Data Type
BINARY_LINKED
EnergyCommunityId
ID of the energy community
Data Type
STRING
Environment
Where the pool's adapter workloads are hosted. Edge (default) means an external operator installs and runs the pool; Cloud means the central Communication Operator auto-deploys it into the OctoMesh cluster.
Data Type
ENUM: System.Communication-4/Environment
Default Values
| Default Value |
|---|
| 0 |
ErrorMessage
Error message if execution failed
Data Type
STRING
ExecutionId
Unique identifier (GUID) for this execution
Data Type
STRING
ExecutionStatus
Current status of the pipeline execution (Running, Completed, Failed, Interrupted, Cancelled).
Data Type
ENUM: System.Communication-4/PipelineExecutionStatus
Default Values
| Default Value |
|---|
| 0 |
ExternalId
External identifier of the data point (e.g. Loxone State UUID, MQTT Topic, OPC-UA NodeId, Modbus Register)
Data Type
STRING
FailureCount
Failed executions folded into this bucket
Data Type
INT
Default Values
| Default Value |
|---|
| 0 |
FarmerTaxRate
Tax rate applied to farmers in the energy community
Data Type
DOUBLE
Default Values
| Default Value |
|---|
| 13.0 |
Favicon
Favicon icon for the web application
Data Type
BINARY_LINKED
FoldedBefore
Hour-aligned fold boundary (AB#5583). HourlyBuckets before this instant are folded history (their executions were deleted); buckets at or after it are a snapshot of the still-retained executions. Unset on statistics written before AB#5583.
Data Type
DATE_TIME
Folder
The mailbox folder to monitor for incoming emails (e.g. INBOX).
Data Type
STRING
FooterGradientEnd
End color of the footer gradient
Data Type
STRING
FooterGradientStart
Start color of the footer gradient
Data Type
STRING
FooterLogo
Icon for the app footer
Data Type
BINARY_LINKED
GrafanaUrl
Base URL of the Grafana instance.
Data Type
STRING
GuildId
The Discord guild (server) snowflake ID. Reserved for future channel-name resolution; not read by the ToDiscord node in v1.
Data Type
STRING
HeaderGradientEnd
End color of the header gradient
Data Type
STRING
HeaderGradientStart
Start color of the header gradient
Data Type
STRING
HeaderLogo
Icon for the app header
Data Type
BINARY_LINKED
HelmRepositoryPurpose
What this repository serves — Adapters (adapter and platform charts) or Applications (tenant-app charts). AB#5295: unlike Channel this DOES drive behaviour: a DeployableWorkload with no HelmRepository association is resolved to the tenant's single repository whose purpose matches the workload type (Adapter/AdapterPool -> Adapters, Application -> Applications). Optional and without a default on purpose — a repository that does not declare its purpose is never chosen by that fallback, so tenants seeded before this attribute keep their exact previous behaviour until the channel blueprint stamps it.
Data Type
ENUM: System.Communication-4/HelmRepositoryPurpose
Host
The host name is the name of the server on which the external system is running.
Data Type
STRING
Hostname
Public hostname used when IngressEnabled=true (e.g. adapter.staging.octo-mesh.com). Adapters get a tenant-scoped path automatically (https://<hostname>/<tenantId>); Applications use the root path. Ignored when IngressEnabled=false. Runtime-state (AB#4706): the productive hostname is tenant-specific (e.g. <tenant>.meshmakers.cloud) and operator-managed - a blueprint re-apply preserves it instead of resetting to the seeded default and silently breaking the deployed ingress/DNS.
Data Type
STRING
HourStartAt
Start of the hour this bucket covers (UTC, minute/second zeroed)
Data Type
DATE_TIME
HourlyBuckets
Per-hour execution buckets (UTC clock hours, rolling 30 days) holding every counted execution of the hour — folded and still-retained alike. Hours before FoldedBefore are folded history; hours at or after it are recomputed from the retained executions on every statistics sweep. The 12h/24h/30d counters are exactly the sum of these buckets over the window (AB#5583).
Data Type
Array of RECORD_ARRAY: System.Communication-4/PipelineStatisticsHourBucket
IdentityServerUrl
URL of the OctoMesh Identity Server for provisioned datasource OAuth configuration.
Data Type
STRING
IdleTimeoutMinutes
Minutes without pipeline activity before an OnDemand workload is drained and scaled to 0 replicas (AB#4914). Ignored for AlwaysOn workloads. Runtime-state (AB#5301), preserved across blueprint re-apply like LifecycleMode.
Data Type
INT
Default Values
| Default Value |
|---|
| 30 |
IngressEnabled
When true, the operator projects ingress.enabled=true plus the workload Hostname into the Helm values. Cluster-wide defaults (className, cluster-issuer, TLS) come from the operator config and are not overridable per workload. Runtime-state (AB#4706): per-tenant operator decision, preserved across blueprint re-apply.
Data Type
BOOLEAN
Default Values
| Default Value |
|---|
| false |
InputData
Optional input data (JSON) for debugging
Data Type
STRING
IsDebuggingEnabled
Whether debugging is enabled for this pipeline
Data Type
BOOLEAN
IsSandbox
If true, the adapter connects to the sandbox environment instead of production. Runtime state (AB#5187): part of the tenant's finAPI connection tuple, preserved with it.
Data Type
BOOLEAN
IsSecret
When true, the ValueOverride.Value is encrypted at rest in MongoDB and rendered as a Kubernetes Secret reference at deploy time.
Data Type
BOOLEAN
Default Values
| Default Value |
|---|
| false |
IsSslEnabled
The Secure Sockets Layer (SSL) protocol is used to secure communication between a client and a server.
Data Type
BOOLEAN
IssuerUri
URI of the OAuth2/OpenID Connect authorization server (e.g. https://identity.example.com)
Data Type
STRING
Last12HoursAvgDurationMs
Average execution duration in the last 12 UTC clock hours including the current partial hour (ms)
Data Type
INT
Default Values
| Default Value |
|---|
| 0 |
Last12HoursFailureCount
Failed executions in the last 12 UTC clock hours including the current partial hour (= sum of the HourlyBuckets in that window; Completed = success, Failed = failure)
Data Type
INT
Default Values
| Default Value |
|---|
| 0 |
Last12HoursSuccessCount
Successful executions in the last 12 UTC clock hours including the current partial hour (= sum of the HourlyBuckets in that window; Completed = success, Failed = failure)
Data Type
INT
Default Values
| Default Value |
|---|
| 0 |
Last24HoursAvgDurationMs
Average execution duration in the last 24 UTC clock hours including the current partial hour (ms)
Data Type
INT
Default Values
| Default Value |
|---|
| 0 |
Last24HoursFailureCount
Failed executions in the last 24 UTC clock hours including the current partial hour (= sum of the HourlyBuckets in that window; Completed = success, Failed = failure)
Data Type
INT
Default Values
| Default Value |
|---|
| 0 |
Last24HoursSuccessCount
Successful executions in the last 24 UTC clock hours including the current partial hour (= sum of the HourlyBuckets in that window; Completed = success, Failed = failure)
Data Type
INT
Default Values
| Default Value |
|---|
| 0 |
Last30DaysAvgDurationMs
Average execution duration in the last 720 UTC clock hours (30 days) including the current partial hour (ms)
Data Type
INT
Default Values
| Default Value |
|---|
| 0 |
Last30DaysFailureCount
Failed executions in the last 720 UTC clock hours (30 days) including the current partial hour (= sum of the HourlyBuckets in that window; Completed = success, Failed = failure)
Data Type
INT
Default Values
| Default Value |
|---|
| 0 |
Last30DaysSuccessCount
Successful executions in the last 720 UTC clock hours (30 days) including the current partial hour (= sum of the HourlyBuckets in that window; Completed = success, Failed = failure)
Data Type
INT
Default Values
| Default Value |
|---|
| 0 |
LastActivityAt
Timestamp of the last observed demand on the workload (pipeline execution, config push, or explicit wake; AB#4914). Input to the idle watchdog. Runtime-state: preserved across blueprint re-apply.
Data Type
DATE_TIME
LastConfigurationError
Last configuration error message. Set when ConfigurationState transitions to Error, cleared automatically when ConfigurationState transitions to Configured. Other state transitions (Pending, Unconfigured) leave this field untouched. Tracked separately from LastDeploymentError because configuration and deployment errors have independent root causes and must not mask each other.
Data Type
STRING
LastConfigurationErrorTimestamp
Timestamp of the LastConfigurationError. Set when LastConfigurationError is set, cleared when LastConfigurationError is cleared.
Data Type
DATE_TIME
LastDeploymentError
Last deployment error message. Set when DeploymentState transitions to Error, cleared automatically when DeploymentState transitions to Deployed. Other state transitions (Pending, Undeployed) leave this field untouched so the user can see the most recent deployment failure cause until a successful deploy resolves it.
Data Type
STRING
LastDeploymentErrorTimestamp
Timestamp of the LastDeploymentError. Set when LastDeploymentError is set, cleared when LastDeploymentError is cleared.
Data Type
DATE_TIME
LastError
Last error reported by the Signal bridge for a register or verify attempt. Cleared on the next successful transition.
Data Type
STRING
LastExecutionAt
Timestamp of the most recent execution
Data Type
DATE_TIME
LastHourAvgDurationMs
Average execution duration in the rolling last 60 minutes (ms)
Data Type
INT
Default Values
| Default Value |
|---|
| 0 |
LastHourFailureCount
Failed executions in the rolling last 60 minutes (Completed = success, Failed = failure)
Data Type
INT
Default Values
| Default Value |
|---|
| 0 |
LastHourSuccessCount
Successful executions in the rolling last 60 minutes (Completed = success, Failed = failure)
Data Type
INT
Default Values
| Default Value |
|---|
| 0 |
LastSuccessfulStatusAt
UTC time of the last status report that was a success (e.g. a mail poll that completed). Unlike StatusMessage it is NOT overwritten by an error report, so "last succeeded at" survives a failing streak. Empty until the first successful status report. Written by the controller's status reporting (AB#5618), which today covers pipelines only; a report counts as a success unless it is flagged as an error or its line starts with "ERROR ".
Data Type
DATE_TIME
LastSyncedSequenceNumber
Last synced sequence number for offline sync
Data Type
INT
Default Values
| Default Value |
|---|
| 0 |
LastUpdate
Timestamp of the last value update for this data point
Data Type
DATE_TIME
LastUpdatedAt
When statistics were last calculated
Data Type
DATE_TIME
LeaseGrantedAt
Timestamp when a pool member was assigned this execution's tenant (AB#4924) — "when did it actually start" as opposed to "when did it stop waiting to be scheduled". Concept §8 Q5. Written on the Queued -> Running transition together with LeaseWaitMs. Unset on a dedicated adapter.
Data Type
DATE_TIME
LeaseReleasedAt
Timestamp when the pool member was handed back after this execution (AB#4924) — "how long did it hold the process". LeaseGrantedAt..LeaseReleasedAt is the span a member was held for one tenant, and concept §4b makes that span, multiplied by the pool's per-member sizing, the exact consumption attributed to the borrowing tenant. It is therefore a BILLING input, not only a diagnostic: it must be stamped on the release path including the TTL-expiry and crash paths, where FinishedAt may never arrive. Unset on a dedicated adapter.
Data Type
DATE_TIME
LeaseWaitMs
Milliseconds the work item spent waiting for a lease (AB#4924), i.e. LeaseGrantedAt - QueuedAt, written once when the lease is granted. Stored rather than derived so it survives the AB#4370 execution fold, which erases the raw execution and keeps only the statistics — without it the queue latency of a leased pool would be unmeasurable a few hours after the fact. Unset on a dedicated adapter.
Data Type
INT
LeasedFromAdapterPoolRtId
RtId of the AdapterPool inside LeasedFromTenantId that served this execution (AB#4924). Bare 24-character hexadecimal RtId. Recorded per execution rather than read back from the adapter's LentFromPoolRtId because the borrowing adapter can be re-pointed at a different pool later, and a cost report over past executions must reflect where the work actually ran.
Data Type
STRING
LeasedFromTenantId
The lending tenant whose adapter pool served this execution (AB#4924). Written when the lease is granted. Together with LeasedFromPoolRtId it is what makes concept §4b's attribution exact: consumption is billed to the tenant whose work ran — this execution's own tenant — and the pool named here is where the per-member sizing that prices it comes from. Unset on a dedicated (AlwaysOn / OnDemand) adapter, which never leases.
Data Type
STRING
LeasedOnMemberId
Identity of the individual pool member (the process) that held the lease for this execution (AB#4924). This is what concept §5 calls "an association from the execution to the assigned member" — it can NOT be an association, because the member belongs to the lending tenant's database and this execution to the borrower's (see the file header). It is also not an RtId: members are replicas of one pool workload, not separate entities, so the value is the member's stable runtime identity (its pool-hub registration id). It exists so the per-adapter queue view — "what is this member holding, what waits behind it" — can be projected out of the pool queue.
Data Type
STRING
Lender
The lending tenant and pool this mirror stands for (AB#5271). Single-valued: a mirror has exactly one lender. Set and cleared as one unit, so a tenant id can never be present without its pool RtId.
Data Type
RECORD: System.Communication-4/LenderReference
LenderAdapterPoolRtId
Member of the LenderReference record (AB#5271): the bare 24-character hexadecimal RtId of the AdapterPool inside LenderTenantId. Names the POOL, never an individual member — membership is elastic, so a reference to a member would dangle the moment that member is drained.
Data Type
STRING
LenderTenantId
Member of the LenderReference record (AB#5271): the tenant that owns the lent AdapterPool. Mirrored from the lending side; never author-set. The controller re-resolves it on every lease, so a stale value produces a refused deploy with a named reason rather than a wrong grant.
Data Type
STRING
LendingAllowedTenantIds
Optional allow-list narrowing the tenants an adapter pool with AdapterSharingMode != NotShared lends to (AB#4924). Absent or empty means "every tenant the sharing mode resolves to". A listed tenant that the sharing mode does NOT resolve to is ignored, never granted — the allow-list is an INTERSECTION with the tenant subtree, never a way around it, so the lending scope can not be widened past the trust boundary the tenant tree establishes.
Data Type
STRING_ARRAY
LendingMaxConcurrentLeasesPerTenant
Optional upper bound on how many of this pool's leases a single borrowing tenant may hold at the same time (AB#4924). Unset means no per-tenant cap — MaxReplicas and the round-robin rotation are the real bounds, which is why concept §8 Q11 deliberately left it without a default rather than inventing a number. Set it where one borrower is known to produce bursts (concept §6, "A borrowed tenant floods the queue"). It caps CONCURRENCY, not queue depth: excess work items stay Queued and visible in all three surfaces instead of being rejected.
Data Type
INT
LentAdapterPoolDeploymentState
Deployment state of the lending pool as last mirrored (AB#5271). A pool that is not Deployed cannot serve a lease, so this is the one mirrored field that explains a queue that never drains. Mirrored rather than resolved on read because the borrower cannot query the lender's database.
Data Type
ENUM: System.Communication-4/DeploymentState
LentAdapterPoolMaxReplicas
Upper bound of the lending pool's replica range as last mirrored (AB#5271). Informational, as above.
Data Type
INT
LentAdapterPoolMinReplicas
Lower bound of the lending pool's replica range as last mirrored (AB#5271). Informational: it tells a borrower how much capacity is kept warm, which is what decides whether a lease is likely to be immediate or queued.
Data Type
INT
LentAdapterPoolSharingMode
The lending pool's sharing mode as last mirrored (AB#5271). Shown so a borrower can see WHY a pool is available to it. 🔴 Display only: the lease-time decision always re-reads the lender's own pool and calls MayLendAsync, so a borrower editing this value in its own database changes what it sees, never what it may use.
Data Type
ENUM: System.Communication-4/AdapterSharingMode
LifecycleMode
Lifecycle policy of the workload (AB#4914). AlwaysOn (default) keeps it running permanently; OnDemand allows the controller to scale it to 0 replicas when idle and wake it on demand; Leased borrows a process from an adapter pool per work item (AB#4924). Runtime-state (AB#5301): an operator decision about the deployed workload, preserved across blueprint re-apply — a blueprint may seed it, but a re-apply never resets it.
Data Type
ENUM: System.Communication-4/LifecycleMode
Default Values
| Default Value |
|---|
| 0 |
LifecycleState
Runtime lifecycle state of the workload (AB#4914): Running, Draining, Hibernated, or Waking. Written exclusively by the Communication Controller (idle watchdog and wake gates). Runtime-state: preserved across blueprint re-apply — resetting a Hibernated workload to Running would break the offline-is-expected semantics.
Data Type
ENUM: System.Communication-4/LifecycleState
Default Values
| Default Value |
|---|
| 0 |
MappingExpression
Optional mXparser expression to transform the source value. Variable value contains the source value.
Data Type
STRING
MappingTargets
Resolved mapping targets for data acquisition. Populated automatically by the BuildMappingTargets pipeline node from DataPointMappings.
Data Type
Array of RECORD_ARRAY: System.Communication-4/MappingTarget
MaxConcurrentConnections
The maximum number of concurrent connections is the maximum number of connections that can be established with an external system at the same time.
Data Type
INT
MaxReplicas
Hard ceiling on adapter pool members (AB#4924). The pool never starts a member beyond this count no matter what the queue does — a pool that could grow without bound would reintroduce, as a cluster-capacity incident, exactly the per-tenant process sprawl this feature exists to remove. When the ceiling is reached the queue simply grows and stays visible in all three surfaces (concept §6, "Pool exhausted"): scale the pool, or move the tenant to a dedicated adapter.
Data Type
INT
Default Values
| Default Value |
|---|
| 3 |
MaxTokens
Maximum number of tokens for the AI response.
Data Type
INT
Default Values
| Default Value |
|---|
| 4000 |
McpServerUrl
URL of the OctoMesh MCP server for AI tool use (e.g. https://localhost:5017). The tenant ID is appended automatically.
Data Type
STRING
MinReplicas
Lower bound on adapter pool members (AB#4924). The default of 1 is the point of the pool: one member stays hot, so the FIRST work item of the day does not pay a cold start — which is exactly the cost that makes plain OnDemand unattractive for periodic work (adapter boot 13 s, or 4.2 s with the AB#4920 warm-up). 0 is permitted and turns the pool into a scale-to-zero pool where every burst pays one cold start; choose it only where work is genuinely rare.
Data Type
INT
Default Values
| Default Value |
|---|
| 1 |
Name
Optional display name for the tag.
Data Type
STRING
NetworkPartnerId
ID of the network partner (Marktpartner
Data Type
STRING
NeutralColor
The neutral color of the theme
Data Type
STRING
NotificationEmailContact
Email address for notifications related to EDA processes and messages
Data Type
STRING
OAuthClientId
OAuth client ID for the Grafana datasource plugin.
Data Type
STRING
OctoMeshUrl
URL of the OctoMesh Asset Repository for provisioned datasource configuration.
Data Type
STRING
OnDemandBlockingReasons
Human-readable reasons why the workload is not OnDemandCapable (AB#4984), e.g. "pipeline X uses process-bound trigger FromPolling@1". Empty when OnDemandCapable=true. Computed by the Communication Controller; shown in the Studio next to the LifecycleMode setting. Runtime-state: preserved across blueprint re-apply.
Data Type
STRING
OnDemandCapable
Whether the workload can safely run with LifecycleMode=OnDemand (AB#4984): true iff none of its deployed pipelines uses a process-bound trigger (e.g. FromPolling, FromWatchRtEntity) that would silently stop at 0 replicas. Computed by the Communication Controller from the registered node descriptors on adapter registration and pipeline deploy. Runtime-state: written exclusively by the controller, preserved across blueprint re-apply.
Data Type
BOOLEAN
Default Values
| Default Value |
|---|
| false |
OutputData
Optional output data (JSON) from pipeline execution result
Data Type
STRING
Password
The password is the secret that is used to authenticate with the external system.
Data Type
STRING
Path
Dotted Helm values path for a ValueOverride entry (e.g. image.tag, service.port, oauth.clientId).
Data Type
STRING
PhoneNumber
Phone number in E.164 format (+ followed by digits, e.g. +436641234567). Unique per OctoMesh instance: exactly one tenant may claim a number.
Data Type
STRING
PipelineDefinition
JSON-serialized pipeline node graph that defines the data processing logic.
Data Type
STRING
Default Values
| Default Value |
|---|
PipelineExecutionClass
Scheduling class of this pipeline on a leased adapter pool (AB#4924), derived from its trigger node on save. Interactive is work a human is waiting for, Batch is everything scheduled or event-driven; within one tenant's turn in the round-robin rotation Interactive is served first, and across tenants the class has no effect at all. Default Batch: a pipeline whose trigger declares no class must never jump a queue. Computed and persisted rather than author-set, exactly like OnDemandCapable — the trigger-node descriptor contract carries the class the way it already carries RequiresRunningProcess (AB#4914 §5), so the reflection-based descriptor scan picks it up and future or third-party nodes self-describe without a controller-side list. Meaningful only for pipelines deployed to a Leased adapter; harmless and ignored everywhere else.
Data Type
ENUM: System.Communication-4/PipelineExecutionClass
Default Values
| Default Value |
|---|
| 1 |
PollIntervalSeconds
Interval in seconds between polling cycles.
Data Type
INT
Default Values
| Default Value |
|---|
| 30 |
PoolMemberCpuLimit
Kubernetes CPU limit of each pool member, e.g. "1" (AB#4924). See PoolMemberCpuRequest for why this is one value per pool and why it is a string.
Data Type
STRING
PoolMemberCpuRequest
Kubernetes CPU request of EACH pool member, e.g. "200m" (AB#4924). One sizing per pool, applied identically to every member it starts (concept §8, Q15) — members are interchangeable by construction, so per-member sizing would have no meaning: the scheduler can hand any lease to any member. Absent means the chart default applies. A string rather than a number because Kubernetes quantities are a notation ("200m", "1", "1.5"), and re-deriving that notation from a number is how sizing bugs get introduced.
Data Type
STRING
PoolMemberMemoryLimit
Kubernetes memory limit of each pool member, e.g. "1Gi" (AB#4924). See PoolMemberMemoryRequest. Size it against the LARGEST tenant that may borrow the pool, not the average: a member serves one tenant at a time but serves each of them in full. AB#5330, measured: a member idles around 124 MiB and gains ~2 MiB per leased run, but the FIRST ExecuteCSharp@1 run costs it ~330 MiB permanently (the Roslyn compiler platform, loaded once per process and never released). A pool whose borrowers may run C# therefore needs at least 1Gi; at 512Mi the member is OOM-killed on the next lease it accepts, and because members are shared it takes another tenant's work down with it.
Data Type
STRING
PoolMemberMemoryRequest
Kubernetes memory request of each pool member, e.g. "512Mi" (AB#4924). This is the number the whole feature is measured against: the prod-1 baseline in concept §1 is 170-200 Mi of pure .NET runtime per process for tenants that execute NOTHING, and a pool exists to stop paying that per tenant. Together with the lease spans (LeaseGrantedAt..LeaseReleasedAt) it is also what prices a borrower's consumption in concept §4b, so it is read for attribution and not only for scheduling.
Data Type
STRING
PoolScaleUpPolicy
Which queue signal starts another member (AB#4924). Default QueueDepthOrWaitSeconds. Scaling is driven by the queue and never by CPU: a member waiting for a lease is I/O-bound, so its CPU utilisation carries no information about whether work is piling up behind it (concept §4a).
Data Type
ENUM: System.Communication-4/PoolScaleUpPolicy
Default Values
| Default Value |
|---|
| 0 |
Port
The port number is the number of the port on which the external system is listening for incoming connections.
Data Type
INT
PrimaryColor
The primary color of the theme
Data Type
STRING
PrivateKey
The private key is a secret key that is used in asymmetric encryption to authenticate with the external system.
Data Type
STRING
PrivateKeyPassphrase
The private key passphrase is a secret that is used to protect the private key.
Data Type
STRING
ProducerPrice
Price per kWh for producers in the energy community
Data Type
DOUBLE
QueuedAt
Timestamp when the work item entered the pool queue (AB#4924). Set together with ExecutionStatus=Queued on a Leased workload and never overwritten afterwards, so QueuedAt..LeaseGrantedAt is the queue wait. Unset on a dedicated adapter, which is created Running.
Data Type
DATE_TIME
ReceivesClusterSecrets
When true, the Communication Operator injects cluster-internal credentials (MongoDB user/admin passwords, CrateDB password) into the workload's Helm release as secret-flagged value overrides. Applies to Adapters and Applications (e.g. backend services that talk to the core MongoDB / CrateDB). Defaults to false so untrusted or edge workloads do not receive cluster credentials by accident; enable only for workloads that run in the same cluster as the OctoMesh core services and need to talk to them directly. The RabbitMQ broker password is NOT controlled by this flag — it is injected unconditionally because every workload needs the controller-to-workload command bus.
Data Type
BOOLEAN
Default Values
| Default Value |
|---|
| false |
RegisteredAt
UTC timestamp of the successful verification (transition to Registered).
Data Type
DATE_TIME
RegistrationEventAction
What was attempted and how it ended (SignalRegistrationAction: RegisterRequested, RegisterFailed, CodeVerified, VerifyFailed, Deleted, DeleteFailed).
Data Type
ENUM: System.Communication-4/SignalRegistrationAction
Default Values
| Default Value |
|---|
| 0 |
RegistrationEventAt
UTC timestamp of the audited registration attempt (SignalRegistrationEvent record).
Data Type
DATE_TIME
RegistrationEventDetail
Outcome detail of the audited attempt, e.g. the bridge message ("captcha required", "rate limited (retry after 30s)", "wrong code") or "registered" on a successful verification.
Data Type
STRING
RegistrationEventUser
Acting user of the audited attempt, resolved from the authenticated principal: display name and/or subject id ("Name (subject)"), or "unknown" for a principal without either claim.
Data Type
STRING
RegistrationHistory
Capped audit trail of registration attempts (AB#5143): SignalRegistrationEvent records, newest first, the newest 50 kept. Appended server-side only; deleted together with the definition (a fresh definition starts with a fresh history).
Data Type
Array of RECORD_ARRAY: System.Communication-4/SignalRegistrationEvent
RegistrationState
Current registration state of the number against the Signal bridge. Driven by the register/verify/delete self-service flow (AB#5143).
Data Type
ENUM: System.Communication-4/SignalRegistrationState
Default Values
| Default Value |
|---|
| 0 |
RepositoryUrl
HTTP(S) URL of a Helm repository index, e.g. https://meshmakers.github.io/octo-helm-core (public) or a private GitHub Pages site.
Data Type
STRING
SapClient
A client is a tenant instance in an SAP system. SAP is multi-tenant, which means that multiple organizations or departments can work on the same system without sharing data with each other.
Data Type
STRING
SapGatewayHost
An SAP gateway host is a server that provides communication services between SAP systems or between SAP systems and external applications.
Data Type
STRING
SapGatewayService
An SAP gateway service provides communication services that are used between SAP systems or between SAP systems and external applications.
Data Type
STRING
SapLanguage
The language key is a two-character code that identifies the language in which the user interface is displayed.
Data Type
STRING
SapProgramId
A program ID is a unique identifier that is used to register a program on an SAP gateway server.
Data Type
STRING
SapRegistrationCount
The registration count is the number of times a program is registered on an SAP gateway server.
Data Type
INT
SapTrace
The trace level is a number that determines the amount of information that is logged during communication with the SAP system.
Data Type
STRING
Default Values
| Default Value |
|---|
| 8 |
ScaleUpQueueDepthThreshold
Number of work items waiting for a lease that makes the pool start another member, when PoolScaleUpPolicy includes the depth signal (AB#4924). Measured across the whole pool queue, not per borrowing tenant — the pool scales because IT is saturated, whereas a single tenant's burst is bounded by round-robin and LendingMaxConcurrentLeasesPerTenant instead.
Data Type
INT
Default Values
| Default Value |
|---|
| 5 |
ScaleUpQueueWaitSeconds
How long the OLDEST waiting work item may wait before the pool starts another member, when PoolScaleUpPolicy includes the wait signal (AB#4924). Catches the case depth alone misses: two items behind one long-running lease never reach a depth threshold but can still wait for minutes. Concept §8 Q14 leaves the averaging window over which this is evaluated to be MEASURED during implementation rather than guessed, which is why the threshold is configuration and not a constant.
Data Type
INT
Default Values
| Default Value |
|---|
| 60 |
SecondaryColor
The secondary color of the theme
Data Type
STRING
SenderEmail
Email address used as the sender (From) for outgoing emails.
Data Type
STRING
SignalDisplayName
Profile display name of the account, shown to Signal users instead of "Unknown". Pushed to the bridge (PUT /v1/profiles/{number}) when the channel reaches Registered (verify success or adoption) and on the displayName self-service endpoint (which also clears it — without a bridge call, since Signal profiles need a non-empty name); stored here so it survives re-registration. Author configuration, not runtime state.
Data Type
STRING
SourceAttributePath
Path to the source attribute to read (e.g., CurrentValue, or nested record.field). If not set, the adapter determines the default.
Data Type
STRING
SourceIdentifier
Identifier of the source entity (e.g. Loxone Control UUID, MQTT device ID)
Data Type
STRING
StartedAt
Timestamp when execution started
Data Type
DATE_TIME
StatusMessage
Human-readable status or error message from the last deployment or configuration attempt. Reflects the current/live status — overwritten on every state change including successful transitions. For persistent error history, use LastDeploymentError / LastConfigurationError.
Data Type
STRING
SuccessCount
Successful executions folded into this bucket
Data Type
INT
Default Values
| Default Value |
|---|
| 0 |
SystemId
The System ID (SID) is the unique technical name of an SAP system. It consists of three letters and uniquely identifies a system within a landscape.
Data Type
STRING
SystemNumber
The system number is a two-digit number assigned to an SAP system during installation. It is used to identify the SAP service (e.g. Dispatcher) on a specific port.
Data Type
STRING
Tag
The tag value used for categorization and filtering.
Data Type
STRING
TargetAttributePath
Path to the target attribute to update on the mapped entity (e.g., Temperature, Humidity, or nested record.field)
Data Type
STRING
TaxRate
Tax rate applied to energy transactions in the community
Data Type
DOUBLE
Default Values
| Default Value |
|---|
| 20.0 |
Temperature
Temperature for AI response generation (0.0 = deterministic, 1.0 = creative).
Data Type
DOUBLE
Default Values
| Default Value |
|---|
| 0.1 |
TertiaryColor
The tertiary color of the theme
Data Type
STRING
TotalDurationMs
Sum of execution durations folded into this bucket (ms)
Data Type
INT_64
Default Values
| Default Value |
|---|
| 0 |
TriggerType
How this pipeline execution was initiated (Manual, Scheduled, Event, or Startup).
Data Type
ENUM: System.Communication-4/PipelineTriggerType
Default Values
| Default Value |
|---|
| 0 |
UiThemeColors
Theme color configuration for an application
Data Type
RECORD: System.Communication-4/UiThemeColors
Username
The username is the name of the user that is used to authenticate with the external system.
Data Type
STRING
Value
String value of a ValueOverride entry. Encrypted at rest when the entry is flagged IsSecret.
Data Type
STRING
Values
Structured Helm value overrides. Deep-merged on top of ValuesYaml during deploy. Entries flagged IsSecret are stored encrypted. Runtime-state (AB#4706): operator-managed overrides (e.g. publicUri, clientId) are preserved across blueprint re-apply; a blueprint that needs to ship NEW default overrides only seeds them on fresh installs.
Data Type
Array of RECORD_ARRAY: System.Communication-4/ValueOverride
ValuesYaml
Full values.yaml content as a YAML string. Edited in a code editor or uploaded as a file in the Studio. Acts as the base layer of Helm values; ValueOverrides are deep-merged on top. Runtime-state (AB#4706): operator-managed, preserved across blueprint re-apply.
Data Type
STRING