Types
Adapter
Inheritance: System-2.2.0/Entity-1 ➔ System.Communication-3.20.0/DeployableEntity-1 ➔ System.Communication-3.20.0/DeployableWorkload-1 ➔ System.Communication-3.20.0/Adapter-1
An external client that connects via SignalR to execute data pipelines. Adapters manage pools and receive pipeline configurations from the Communication Controller. Deployed to Kubernetes by the Communication Operator via Helm (chart/values inherited from DeployableWorkload).
| ID | Auto Complete Values | Auto Increment Reference | Is Optional |
|---|---|---|---|
| System.Communication-3/CommunicationStateTimestamp | True | ||
| System.Communication-3/CommunicationState | False | ||
| System.Communication-3/ConfigurationState | False | ||
| System.Communication-3/LastConfigurationError | True | ||
| System.Communication-3/LastConfigurationErrorTimestamp | True | ||
| System.Communication-3/AdapterConfiguration | True | ||
| System.Communication-3/LastSyncedSequenceNumber | False |
AiConfiguration
Inheritance: System-2.2.0/Entity-1 ➔ System-2.2.0/Configuration-1 ➔ System.Communication-3.20.0/AiConfiguration-1
Configuration for AI services (e.g. Anthropic Claude API). Stores API credentials and default model settings. Referenced by pipeline nodes via ApiKeyConfigurationName.
| ID | Auto Complete Values | Auto Increment Reference | Is Optional |
|---|---|---|---|
| System.Communication-3/ApiKey | False | ||
| System.Communication-3/AiModel | True | ||
| System.Communication-3/MaxTokens | True | ||
| System.Communication-3/Temperature | True | ||
| System.Communication-3/McpServerUrl | True |
Application
Inheritance: System-2.2.0/Entity-1 ➔ System.Communication-3.20.0/DeployableEntity-1 ➔ System.Communication-3.20.0/DeployableWorkload-1 ➔ System.Communication-3.20.0/Application-1
A tenant-specific web application deployed by the Communication Operator via Helm. Examples: energy-community, voest-app, maco-app. Most configuration (URIs, env vars, secrets) lives in ValuesYaml / Values inherited from DeployableWorkload; only operator-relevant fields are exposed as typed attributes.
| ID | Auto Complete Values | Auto Increment Reference | Is Optional |
|---|---|---|---|
| System.Communication-3/Hostname | True |
DataFlow
Inheritance: System-2.2.0/Entity-1 ➔ System.Communication-3.20.0/DataFlow-1
A logical grouping of pipelines and triggers that belong together. DataFlows organize the data integration logic within a tenant.
| ID | Auto Complete Values | Auto Increment Reference | Is Optional |
|---|---|---|---|
| System-2/Name | False | ||
| System-2/Description | True |
DataPointMapping
Inheritance: System-2.2.0/Entity-1 ➔ System.Communication-3.20.0/DataPointMapping-1
Maps a source entity attribute to a target entity attribute with optional expression transformation
| ID | Auto Complete Values | Auto Increment Reference | Is Optional |
|---|---|---|---|
| System-2/Name | True | ||
| System-2/Enabled | False | ||
| System.Communication-3/SourceAttributePath | True | ||
| System.Communication-3/MappingExpression | True | ||
| System.Communication-3/TargetAttributePath | True |
Outbound Associations
| Outbound Name | Outbound Multiplicity | CkRoleId | TargetCKTypeId | Target Attributes |
|---|---|---|---|---|
| MappedAsSource | N | System.Communication-3/MapsFrom | System-2/Entity |
DeployableEntity
Inheritance: System-2.2.0/Entity-1 ➔ System.Communication-3.20.0/DeployableEntity-1
Abstract base type for entities that can be deployed to adapters or pools. Tracks deployment state, name, description, and status messages.
| ID | Auto Complete Values | Auto Increment Reference | Is Optional |
|---|---|---|---|
| System.Communication-3/DeploymentState | False | ||
| System-2/Name | True | ||
| System-2/Description | True | ||
| System.Communication-3/StatusMessage | True | ||
| System.Communication-3/LastDeploymentError | True | ||
| System.Communication-3/LastDeploymentErrorTimestamp | True |
DeployableWorkload
Inheritance: System-2.2.0/Entity-1 ➔ System.Communication-3.20.0/DeployableEntity-1 ➔ System.Communication-3.20.0/DeployableWorkload-1
Abstract base type for workloads that the Communication Operator deploys to Kubernetes via Helm. Carries the chart reference, base values.yaml, and structured value overrides shared by Adapter and Application.
| ID | Auto Complete Values | Auto Increment Reference | Is Optional |
|---|---|---|---|
| System.Communication-3/ChartName | True | ||
| System.Communication-3/ChartVersion | True | ||
| System.Communication-3/ValuesYaml | True | ||
| System.Communication-3/Values | True | ||
| System.Communication-3/ReceivesClusterSecrets | False |
Outbound Associations
| Outbound Name | Outbound Multiplicity | CkRoleId | TargetCKTypeId | Target Attributes |
|---|---|---|---|---|
| HelmRepository | ZeroOrOne | System.Communication-3/HelmRepository | System.Communication-3/HelmRepositoryConfiguration |
DiscordConfiguration
Inheritance: System-2.2.0/Entity-1 ➔ System-2.2.0/Configuration-1 ➔ System.Communication-3.20.0/DiscordConfiguration-1
Configuration for Discord bot integration used by the ToDiscord pipeline node (POST /channels/{id}/messages).
| ID | Auto Complete Values | Auto Increment Reference | Is Optional |
|---|---|---|---|
| System.Communication-3/BotToken | False | ||
| System.Communication-3/GuildId | True |
EMailReceiverConfiguration
Inheritance: System-2.2.0/Entity-1 ➔ System-2.2.0/Configuration-1 ➔ System.Communication-3.20.0/EMailReceiverConfiguration-1
IMAP email receiver configuration for polling a mailbox
| ID | Auto Complete Values | Auto Increment Reference | Is Optional |
|---|---|---|---|
| System.Communication-3/Host | False | ||
| System.Communication-3/Port | False | ||
| System.Communication-3/Username | False | ||
| System.Communication-3/Password | False | ||
| System.Communication-3/IsSslEnabled | False | ||
| System.Communication-3/Folder | True |
EMailSenderConfiguration
Inheritance: System-2.2.0/Entity-1 ➔ System-2.2.0/Configuration-1 ➔ System.Communication-3.20.0/EMailSenderConfiguration-1
SMTP email sender configuration for outgoing email delivery.
| ID | Auto Complete Values | Auto Increment Reference | Is Optional |
|---|---|---|---|
| System.Communication-3/Host | False | ||
| System.Communication-3/Port | False | ||
| System.Communication-3/SenderEmail | True | ||
| System.Communication-3/Username | False | ||
| System.Communication-3/Password | False | ||
| System.Communication-3/IsSslEnabled | False |
EdaConfiguration
Inheritance: System-2.2.0/Entity-1 ➔ System-2.2.0/Configuration-1 ➔ System.Communication-3.20.0/EdaConfiguration-1
Configuration for EDA integration
| ID | Auto Complete Values | Auto Increment Reference | Is Optional |
|---|---|---|---|
| System.Communication-3/NetworkPartnerId | False |
EnergyCommunityConfiguration
Inheritance: System-2.2.0/Entity-1 ➔ System-2.2.0/Configuration-1 ➔ System.Communication-3.20.0/EdaConfiguration-1 ➔ System.Communication-3.20.0/EnergyCommunityConfiguration-1
Configuration for an energy community
FinApiConfiguration
Inheritance: System-2.2.0/Entity-1 ➔ System-2.2.0/Configuration-1 ➔ System.Communication-3.20.0/FinApiConfiguration-1
Configuration for the finAPI banking adapter connection.
| ID | Auto Complete Values | Auto Increment Reference | Is Optional |
|---|---|---|---|
| System.Communication-3/Host | False | ||
| System.Communication-3/ClientId | False | ||
| System.Communication-3/ClientSecret | False | ||
| System.Communication-3/Username | False | ||
| System.Communication-3/Password | False | ||
| System.Communication-3/IsSandbox | True |
GrafanaConfiguration
Inheritance: System-2.2.0/Entity-1 ➔ System-2.2.0/Configuration-1 ➔ System.Communication-3.20.0/GrafanaConfiguration-1
Configuration for Grafana integration. Used by the GrafanaProvisionTenant and GrafanaDeprovisionTenant pipeline nodes.
| ID | Auto Complete Values | Auto Increment Reference | Is Optional |
|---|---|---|---|
| System.Communication-3/GrafanaUrl | False | ||
| System.Communication-3/AdminUser | False | ||
| System.Communication-3/AdminPassword | False | ||
| System.Communication-3/OctoMeshUrl | False | ||
| System.Communication-3/IdentityServerUrl | False | ||
| System.Communication-3/OAuthClientId | True |
HelmRepositoryConfiguration
Inheritance: System-2.2.0/Entity-1 ➔ System-2.2.0/Configuration-1 ➔ System.Communication-3.20.0/HelmRepositoryConfiguration-1
Configuration of a Helm chart repository (HTTP, typically GitHub Pages — public or private). Referenced by DeployableWorkload entities so the Communication Operator knows where to pull the chart from. Tenant-scoped.
| ID | Auto Complete Values | Auto Increment Reference | Is Optional |
|---|---|---|---|
| System.Communication-3/RepositoryUrl | False | ||
| System.Communication-3/Channel | False | ||
| System.Communication-3/Username | True | ||
| System.Communication-3/Password | True |
LoxoneConfiguration
Inheritance: System-2.2.0/Entity-1 ➔ System-2.2.0/Configuration-1 ➔ System.Communication-3.20.0/LoxoneConfiguration-1
Configuration for connecting to a Loxone Miniserver via REST API
| ID | Auto Complete Values | Auto Increment Reference | Is Optional |
|---|---|---|---|
| System.Communication-3/Host | False | ||
| System.Communication-3/Port | False | ||
| System.Communication-3/Username | False | ||
| System.Communication-3/Password | False | ||
| System.Communication-3/IsSslEnabled | False | ||
| System.Communication-3/PollIntervalSeconds | True | ||
| System.Communication-3/MappingTargets | True |
MicrosoftGraphConfiguration
Inheritance: System-2.2.0/Entity-1 ➔ System-2.2.0/Configuration-1 ➔ System.Communication-3.20.0/MicrosoftGraphConfiguration-1
Microsoft Graph API configuration for OAuth2 client credentials authentication
| ID | Auto Complete Values | Auto Increment Reference | Is Optional |
|---|---|---|---|
| System.Communication-3/AzureTenantId | False | ||
| System.Communication-3/ClientId | False | ||
| System.Communication-3/ClientSecret | False |
Pipeline
Inheritance: System-2.2.0/Entity-1 ➔ System.Communication-3.20.0/DeployableEntity-1 ➔ System.Communication-3.20.0/Pipeline-1
A data processing pipeline that defines a sequence of processing nodes. Pipelines are deployed to adapters for execution and can be organized within data flows.
| ID | Auto Complete Values | Auto Increment Reference | Is Optional |
|---|---|---|---|
| System-2/Enabled | True | ||
| System.Communication-3/PipelineDefinition | False | ||
| System.Communication-3/IsDebuggingEnabled | True |
Outbound Associations
| Outbound Name | Outbound Multiplicity | CkRoleId | TargetCKTypeId | Target Attributes |
|---|---|---|---|---|
| Parent | One | System-2/ParentChild | System.Communication-3/DataFlow |
Inbound Associations
| Inbound Name | Inbound Multiplicity | CkRoleId | TargetCKTypeId | Target Attributes |
|---|---|---|---|---|
| SendsDataTo | N | System.Communication-3/SendsDataTo | System.Communication-3/Pipeline |
PipelineExecution
Inheritance: System-2.2.0/Entity-1 ➔ System.Communication-3.20.0/PipelineExecution-1
Records an individual pipeline execution with its status, timing, trigger type, and optional input/output data. Linked to the executed pipeline and the adapter that performed the execution.
| ID | Auto Complete Values | Auto Increment Reference | Is Optional |
|---|---|---|---|
| System.Communication-3/ExecutionId | False | ||
| System.Communication-3/ExecutionStatus | False | ||
| System.Communication-3/TriggerType | False | ||
| System.Communication-3/StartedAt | False | ||
| System.Communication-3/CompletedAt | True | ||
| System.Communication-3/DurationMs | True | ||
| System.Communication-3/ErrorMessage | True | ||
| System.Communication-3/InputData | True | ||
| System.Communication-3/OutputData | True |
Outbound Associations
| Outbound Name | Outbound Multiplicity | CkRoleId | TargetCKTypeId | Target Attributes |
|---|---|---|---|---|
| PipelineExecutions | One | System.Communication-3/ExecutedPipeline | System.Communication-3/Pipeline |
PipelineStatistics
Inheritance: System-2.2.0/Entity-1 ➔ System.Communication-3.20.0/PipelineStatistics-1
Aggregated execution statistics for a pipeline across multiple time windows (1h, 12h, 24h, 30d). Tracks success/failure counts and average duration per period.
Outbound Associations
| Outbound Name | Outbound Multiplicity | CkRoleId | TargetCKTypeId | Target Attributes |
|---|---|---|---|---|
| PipelineStatistics | ZeroOrOne | System.Communication-3/StatisticsForPipeline | System.Communication-3/Pipeline |
PipelineTrigger
Inheritance: System-2.2.0/Entity-1 ➔ System.Communication-3.20.0/DeployableEntity-1 ➔ System.Communication-3.20.0/PipelineTrigger-1
A scheduled trigger that executes one or more pipelines based on a cron expression. Organized within data flows alongside the pipelines they trigger.
| ID | Auto Complete Values | Auto Increment Reference | Is Optional |
|---|---|---|---|
| System-2/Enabled | False | ||
| System.Bot-3/CronExpression | False |
Outbound Associations
| Outbound Name | Outbound Multiplicity | CkRoleId | TargetCKTypeId | Target Attributes |
|---|---|---|---|---|
| Parent | One | System-2/ParentChild | System.Communication-3/DataFlow |
Pool
Inheritance: System-2.2.0/Entity-1 ➔ System.Communication-3.20.0/DeployableEntity-1 ➔ System.Communication-3.20.0/Pool-1
A group of managed devices or entities. Pool operators register via SignalR to handle device communication within the pool.
| ID | Auto Complete Values | Auto Increment Reference | Is Optional |
|---|---|---|---|
| System.Communication-3/CommunicationStateTimestamp | True | ||
| System.Communication-3/CommunicationState | False | ||
| System.Communication-3/ConfigurationState | False | ||
| System.Communication-3/LastConfigurationError | True | ||
| System.Communication-3/LastConfigurationErrorTimestamp | True | ||
| System.Communication-3/Environment | False |
SapConfiguration
Inheritance: System-2.2.0/Entity-1 ➔ System-2.2.0/Configuration-1 ➔ System.Communication-3.20.0/SapConfiguration-1
The SAP configuration type is used to configure the connection to an SAP system.
| ID | Auto Complete Values | Auto Increment Reference | Is Optional |
|---|---|---|---|
| System.Communication-3/Host | False | ||
| System.Communication-3/SystemNumber | False | ||
| System.Communication-3/SystemId | True | ||
| System.Communication-3/Username | False | ||
| System.Communication-3/Password | False | ||
| System.Communication-3/SapClient | False | ||
| System.Communication-3/SapLanguage | False | ||
| System.Communication-3/SapTrace | False | ||
| System.Communication-3/SapGatewayHost | True | ||
| System.Communication-3/SapGatewayService | True | ||
| System.Communication-3/SapProgramId | True | ||
| System.Communication-3/SapRegistrationCount | True |
ServiceAccountConfiguration
Inheritance: System-2.2.0/Entity-1 ➔ System-2.2.0/Configuration-1 ➔ System.Communication-3.20.0/ServiceAccountConfiguration-1
Client credentials for service-to-service authentication (OAuth2 client credentials grant)
| ID | Auto Complete Values | Auto Increment Reference | Is Optional |
|---|---|---|---|
| System.Communication-3/IssuerUri | False | ||
| System.Communication-3/ClientId | False | ||
| System.Communication-3/ClientSecret | False | ||
| System-2/TenantId | False |
SftpConfiguration
Inheritance: System-2.2.0/Entity-1 ➔ System-2.2.0/Configuration-1 ➔ System.Communication-3.20.0/SftpConfiguration-1
Configuration for connecting to an SFTP server. Supports password and private key authentication.
| ID | Auto Complete Values | Auto Increment Reference | Is Optional |
|---|---|---|---|
| System.Communication-3/Host | False | ||
| System.Communication-3/Port | False | ||
| System.Communication-3/Username | False | ||
| System.Communication-3/Password | True | ||
| System.Communication-3/PrivateKey | True | ||
| System.Communication-3/PrivateKeyPassphrase | True | ||
| System.Communication-3/MaxConcurrentConnections | True |
Tag
Inheritance: System-2.2.0/Entity-1 ➔ System.Communication-3.20.0/Tag-1
A label that can be associated with any entity for categorization and filtering purposes.
| ID | Auto Complete Values | Auto Increment Reference | Is Optional |
|---|---|---|---|
| System.Communication-3/Tag | False | ||
| System.Communication-3/Name | True |
Outbound Associations
| Outbound Name | Outbound Multiplicity | CkRoleId | TargetCKTypeId | Target Attributes |
|---|---|---|---|---|
| IsTagging | N | System.Communication-3/Tag | System-2/Entity |