Types

Version: 4.6.0

Adapter

Inheritance: System-2.5.0/Entity-1 ➔ System.Communication-4.6.0/DeployableEntity-1 ➔ System.Communication-4.6.0/DeployableWorkload-1 ➔ System.Communication-4.6.0/Adapter-1

An external client that connects via SignalR to execute data pipelines. Adapters are assigned to a deployment site and receive pipeline configurations from the Communication Controller. Deployed to Kubernetes by the Communication Operator via Helm (chart/values inherited from DeployableWorkload). An adapter with LifecycleMode = Leased has no process of its own and borrows one per work item from an AdapterPool in another tenant (AB#4924).

ID	Auto Complete Values	Auto Increment Reference	Is Optional
System.Communication-4/CommunicationStateTimestamp			True
System.Communication-4/CommunicationState			False
System.Communication-4/ConfigurationState			False
System.Communication-4/LastConfigurationError			True
System.Communication-4/LastConfigurationErrorTimestamp			True
System.Communication-4/AdapterConfiguration			True
System.Communication-4/LastSyncedSequenceNumber			False

Outbound Associations

Outbound Name	Outbound Multiplicity	CkRoleId	TargetCKTypeId	Target Attributes
LentFrom	ZeroOrOne	System.Communication-4/LentFrom	System.Communication-4/LentAdapterPool

Inbound Associations

Inbound Name	Inbound Multiplicity	CkRoleId	TargetCKTypeId	Target Attributes
Executes	N	System.Communication-4/Executes	System.Communication-4/Pipeline

AdapterPool

Inheritance: System-2.5.0/Entity-1 ➔ System.Communication-4.6.0/DeployableEntity-1 ➔ System.Communication-4.6.0/DeployableWorkload-1 ➔ System.Communication-4.6.0/AdapterPool-1

A pool of interchangeable adapter processes owned by one tenant and leased to tenants in its subtree, one work item per lease (AB#4924). The pool declares how many members may exist (MinReplicas..MaxReplicas), how big each member is, what queue pressure starts another one, and which tenants may borrow. Members are replicas of this one workload rather than separate entities: a lease binds a member to a tenant for the duration of one work item and the member retains nothing tenant-scoped afterwards. Not to be confused with DeploymentSite, which is where a workload is deployed and which was itself called Pool before 4.0.0.

ID	Auto Complete Values	Auto Increment Reference	Is Optional
System.Communication-4/MinReplicas			False
System.Communication-4/MaxReplicas			False
System.Communication-4/PoolMemberCpuRequest			True
System.Communication-4/PoolMemberCpuLimit			True
System.Communication-4/PoolMemberMemoryRequest			True
System.Communication-4/PoolMemberMemoryLimit			True
System.Communication-4/PoolScaleUpPolicy			False
System.Communication-4/ScaleUpQueueDepthThreshold			False
System.Communication-4/ScaleUpQueueWaitSeconds			False
System.Communication-4/AdapterSharingMode			False
System.Communication-4/LendingAllowedTenantIds			True
System.Communication-4/LendingMaxConcurrentLeasesPerTenant			True

Outbound Associations

Outbound Name	Outbound Multiplicity	CkRoleId	TargetCKTypeId	Target Attributes
PoolServiceAccount	ZeroOrOne	System.Communication-4/PoolServiceAccount	System.Communication-4/ServiceAccountConfiguration

AiConfiguration

Inheritance: System-2.5.0/Entity-1 ➔ System-2.5.0/Configuration-1 ➔ System.Communication-4.6.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-4/ApiKey			False
System.Communication-4/AiModel			False
System.Communication-4/MaxTokens			True
System.Communication-4/Temperature			True
System.Communication-4/McpServerUrl			True

Application

Inheritance: System-2.5.0/Entity-1 ➔ System.Communication-4.6.0/DeployableEntity-1 ➔ System.Communication-4.6.0/DeployableWorkload-1 ➔ System.Communication-4.6.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. Ingress (IngressEnabled + Hostname) is inherited from DeployableWorkload.

DataFlow

Inheritance: System-2.5.0/Entity-1 ➔ System.Communication-4.6.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.5.0/Entity-1 ➔ System.Communication-4.6.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-4/SourceAttributePath			True
System.Communication-4/MappingExpression			True
System.Communication-4/TargetAttributePath			True

Outbound Associations

Outbound Name	Outbound Multiplicity	CkRoleId	TargetCKTypeId	Target Attributes
MappedAsSource	N	System.Communication-4/MapsFrom	System-2/Entity

DeployableEntity

Inheritance: System-2.5.0/Entity-1 ➔ System.Communication-4.6.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-4/DeploymentState			False
System-2/Name			True
System-2/Description			True
System.Communication-4/StatusMessage			True
System.Communication-4/LastDeploymentError			True
System.Communication-4/LastDeploymentErrorTimestamp			True
System.Communication-4/LastSuccessfulStatusAt			True
System.Communication-4/ConsecutiveStatusFailures			True

DeployableWorkload

Inheritance: System-2.5.0/Entity-1 ➔ System.Communication-4.6.0/DeployableEntity-1 ➔ System.Communication-4.6.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-4/ChartName			True
System.Communication-4/ChartVersion			True
System.Communication-4/ValuesYaml			True
System.Communication-4/Values			True
System.Communication-4/ReceivesClusterSecrets			False
System.Communication-4/IngressEnabled			False
System.Communication-4/Hostname			True
System.Communication-4/LifecycleMode			False
System.Communication-4/IdleTimeoutMinutes			False
System.Communication-4/LifecycleState			False
System.Communication-4/LastActivityAt			True
System.Communication-4/OnDemandCapable			False
System.Communication-4/OnDemandBlockingReasons			True

Outbound Associations

Outbound Name	Outbound Multiplicity	CkRoleId	TargetCKTypeId	Target Attributes
HelmRepository	ZeroOrOne	System.Communication-4/HelmRepository	System.Communication-4/HelmRepositoryConfiguration

DeploymentSite

Inheritance: System-2.5.0/Entity-1 ➔ System.Communication-4.6.0/DeployableEntity-1 ➔ System.Communication-4.6.0/DeploymentSite-1

A deployment location that the Communication Operator serves — a cloud environment or a named edge site. Workloads are assigned to a site via the Hosts role, and the operator responsible for the site registers via SignalR to deploy and monitor them. Renamed from Pool in 4.0.0; the old name described a grouping the type never had and collided with the adapter pool introduced by AB#4924.

ID	Auto Complete Values	Auto Increment Reference	Is Optional
System.Communication-4/CommunicationStateTimestamp			True
System.Communication-4/CommunicationState			False
System.Communication-4/ConfigurationState			False
System.Communication-4/LastConfigurationError			True
System.Communication-4/LastConfigurationErrorTimestamp			True
System.Communication-4/Environment			False

DiscordConfiguration

Inheritance: System-2.5.0/Entity-1 ➔ System-2.5.0/Configuration-1 ➔ System.Communication-4.6.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-4/BotToken			False
System.Communication-4/GuildId			True

EMailReceiverConfiguration

Inheritance: System-2.5.0/Entity-1 ➔ System-2.5.0/Configuration-1 ➔ System.Communication-4.6.0/EMailReceiverConfiguration-1

IMAP email receiver configuration for polling a mailbox

ID	Auto Complete Values	Auto Increment Reference	Is Optional
System.Communication-4/Host			False
System.Communication-4/Port			False
System.Communication-4/Username			False
System.Communication-4/Password			False
System.Communication-4/IsSslEnabled			False
System.Communication-4/Folder			True

EMailSenderConfiguration

Inheritance: System-2.5.0/Entity-1 ➔ System-2.5.0/Configuration-1 ➔ System.Communication-4.6.0/EMailSenderConfiguration-1

SMTP email sender configuration for outgoing email delivery.

ID	Auto Complete Values	Auto Increment Reference	Is Optional
System.Communication-4/Host			False
System.Communication-4/Port			False
System.Communication-4/SenderEmail			True
System.Communication-4/Username			False
System.Communication-4/Password			False
System.Communication-4/IsSslEnabled			False

EdaConfiguration

Inheritance: System-2.5.0/Entity-1 ➔ System-2.5.0/Configuration-1 ➔ System.Communication-4.6.0/EdaConfiguration-1

Configuration for EDA integration

ID	Auto Complete Values	Auto Increment Reference	Is Optional
System.Communication-4/NetworkPartnerId			False
System.Communication-4/NotificationEmailContact			True

EnergyCommunityConfiguration

Inheritance: System-2.5.0/Entity-1 ➔ System-2.5.0/Configuration-1 ➔ System.Communication-4.6.0/EdaConfiguration-1 ➔ System.Communication-4.6.0/EnergyCommunityConfiguration-1

Configuration for an energy community

ID	Auto Complete Values	Auto Increment Reference	Is Optional
System-2/Name			True
System.Communication-4/EnergyCommunityId			False
System.Communication-4/HeaderLogo			True
System.Communication-4/FooterLogo			True
System.Communication-4/EmailFooterImage			True
System.Communication-4/UiThemeColors			True
System.Communication-4/AppTitle			True
System.Communication-4/AppHeading			True
System.Communication-4/BillingReportName			True
System.Communication-4/BillingReportFilePrefix			True
System.Communication-4/BillingMailServerConfiguration			True
System.Communication-4/HeaderGradientStart			True
System.Communication-4/HeaderGradientEnd			True
System.Communication-4/FooterGradientStart			True
System.Communication-4/FooterGradientEnd			True
System.Communication-4/BackgroundColor			True
System.Communication-4/Favicon			True
System.Communication-4/ConsumptionRecordRequestDelay			False
System.Communication-4/ConsumerPrice			False
System.Communication-4/ProducerPrice			False
System.Communication-4/TaxRate			False
System.Communication-4/FarmerTaxRate			False
System.Communication-4/BankAccountIban			True
System.Communication-4/BankAccountHolder			True

FinApiConfiguration

Inheritance: System-2.5.0/Entity-1 ➔ System-2.5.0/Configuration-1 ➔ System.Communication-4.6.0/FinApiConfiguration-1

Configuration for the finAPI banking adapter connection.

ID	Auto Complete Values	Auto Increment Reference	Is Optional
System.Communication-4/Host			False
System.Communication-4/ClientId			False
System.Communication-4/ClientSecret			False
System.Communication-4/Username			False
System.Communication-4/Password			False
System.Communication-4/IsSandbox			True

GrafanaConfiguration

Inheritance: System-2.5.0/Entity-1 ➔ System-2.5.0/Configuration-1 ➔ System.Communication-4.6.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-4/GrafanaUrl			False
System.Communication-4/AdminUser			False
System.Communication-4/AdminPassword			False
System.Communication-4/OctoMeshUrl			False
System.Communication-4/IdentityServerUrl			False
System.Communication-4/OAuthClientId			True

HelmRepositoryConfiguration

Inheritance: System-2.5.0/Entity-1 ➔ System-2.5.0/Configuration-1 ➔ System.Communication-4.6.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-4/RepositoryUrl			False
System.Communication-4/Channel			False
System.Communication-4/HelmRepositoryPurpose			True
System.Communication-4/Username			True
System.Communication-4/Password			True

LentAdapterPool

Inheritance: System-2.5.0/Entity-1 ➔ System.Communication-4.6.0/LentAdapterPool-1

A borrower-local mirror of an AdapterPool owned by an ancestor or sibling tenant (AB#5271). Exists so a borrowing tenant can see, list and reference the pools lent to it, none of which is possible against an entity in another tenant database. Display and association only: the lease-time decision always re-reads the lending tenant's own pool, so this mirror can never widen what a borrower is allowed to use. Provisioned and kept in sync by the Communication Controller; never author-set.

ID	Auto Complete Values	Auto Increment Reference	Is Optional
System-2/Name			False
System-2/Description			True
System.Communication-4/Lender			False
System.Communication-4/LentAdapterPoolSharingMode			False
System.Communication-4/LentAdapterPoolMinReplicas			True
System.Communication-4/LentAdapterPoolMaxReplicas			True
System.Communication-4/LentAdapterPoolDeploymentState			False

LoxoneConfiguration

Inheritance: System-2.5.0/Entity-1 ➔ System-2.5.0/Configuration-1 ➔ System.Communication-4.6.0/LoxoneConfiguration-1

Configuration for connecting to a Loxone Miniserver via REST API

ID	Auto Complete Values	Auto Increment Reference	Is Optional
System.Communication-4/Host			False
System.Communication-4/Port			False
System.Communication-4/Username			False
System.Communication-4/Password			False
System.Communication-4/IsSslEnabled			False
System.Communication-4/PollIntervalSeconds			True
System.Communication-4/MappingTargets			True

MicrosoftGraphConfiguration

Inheritance: System-2.5.0/Entity-1 ➔ System-2.5.0/Configuration-1 ➔ System.Communication-4.6.0/MicrosoftGraphConfiguration-1

Microsoft Graph API configuration for OAuth2 client credentials authentication

ID	Auto Complete Values	Auto Increment Reference	Is Optional
System.Communication-4/AzureTenantId			False
System.Communication-4/ClientId			False
System.Communication-4/ClientSecret			False

Pipeline

Inheritance: System-2.5.0/Entity-1 ➔ System.Communication-4.6.0/DeployableEntity-1 ➔ System.Communication-4.6.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-4/PipelineDefinition			False
System.Communication-4/IsDebuggingEnabled			True
System.Communication-4/PipelineExecutionClass			False

Outbound Associations

Outbound Name	Outbound Multiplicity	CkRoleId	TargetCKTypeId	Target Attributes
Parent	One	System-2/ParentChild	System.Communication-4/DataFlow

Inbound Associations

Inbound Name	Inbound Multiplicity	CkRoleId	TargetCKTypeId	Target Attributes
SendsDataTo	N	System.Communication-4/SendsDataTo	System.Communication-4/Pipeline

PipelineExecution

Inheritance: System-2.5.0/Entity-1 ➔ System.Communication-4.6.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. On a leased adapter pool (AB#4924) the entity exists from the moment the work item is enqueued, so one work item is one PipelineExecution from Queued through Running to completion.

ID	Auto Complete Values	Auto Increment Reference	Is Optional
System.Communication-4/ExecutionId			False
System.Communication-4/ExecutionStatus			False
System.Communication-4/TriggerType			False
System.Communication-4/QueuedAt			True
System.Communication-4/LeaseGrantedAt			True
System.Communication-4/LeaseReleasedAt			True
System.Communication-4/LeaseWaitMs			True
System.Communication-4/StartedAt			True
System.Communication-4/CompletedAt			True
System.Communication-4/DurationMs			True
System.Communication-4/LeasedFromTenantId			True
System.Communication-4/LeasedFromAdapterPoolRtId			True
System.Communication-4/LeasedOnMemberId			True
System.Communication-4/CallerSubjectId			True
System.Communication-4/CallerTenantId			True
System.Communication-4/CallerEmail			True
System.Communication-4/CallerName			True
System.Communication-4/CallerRoles			True
System.Communication-4/CallerTrustLevel			True
System.Communication-4/CallerAccessToken			True
System.Communication-4/ErrorMessage			True
System.Communication-4/InputData			True
System.Communication-4/OutputData			True

Outbound Associations

Outbound Name	Outbound Multiplicity	CkRoleId	TargetCKTypeId	Target Attributes
PipelineExecutions	One	System.Communication-4/ExecutedPipeline	System.Communication-4/Pipeline

PipelineStatistics

Inheritance: System-2.5.0/Entity-1 ➔ System.Communication-4.6.0/PipelineStatistics-1

Aggregated execution statistics for a pipeline across multiple time windows (rolling 60 min; 12, 24 and 720 UTC clock hours including the current partial hour — the latter three are exactly the sum of HourlyBuckets over the window, AB#5583). Tracks success/failure counts and average duration per period.

ID	Auto Complete Values	Auto Increment Reference	Is Optional
System.Communication-4/LastHourSuccessCount			False
System.Communication-4/LastHourFailureCount			False
System.Communication-4/LastHourAvgDurationMs			False
System.Communication-4/Last12HoursSuccessCount			False
System.Communication-4/Last12HoursFailureCount			False
System.Communication-4/Last12HoursAvgDurationMs			False
System.Communication-4/Last24HoursSuccessCount			False
System.Communication-4/Last24HoursFailureCount			False
System.Communication-4/Last24HoursAvgDurationMs			False
System.Communication-4/Last30DaysSuccessCount			False
System.Communication-4/Last30DaysFailureCount			False
System.Communication-4/Last30DaysAvgDurationMs			False
System.Communication-4/LastUpdatedAt			True
System.Communication-4/LastExecutionAt			True
System.Communication-4/HourlyBuckets			True
System.Communication-4/FoldedBefore			True

Outbound Associations

Outbound Name	Outbound Multiplicity	CkRoleId	TargetCKTypeId	Target Attributes
PipelineStatistics	ZeroOrOne	System.Communication-4/StatisticsForPipeline	System.Communication-4/Pipeline

PipelineTrigger

Inheritance: System-2.5.0/Entity-1 ➔ System.Communication-4.6.0/DeployableEntity-1 ➔ System.Communication-4.6.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-4/DataFlow

SapConfiguration

Inheritance: System-2.5.0/Entity-1 ➔ System-2.5.0/Configuration-1 ➔ System.Communication-4.6.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-4/Host			False
System.Communication-4/SystemNumber			False
System.Communication-4/SystemId			True
System.Communication-4/Username			False
System.Communication-4/Password			False
System.Communication-4/SapClient			False
System.Communication-4/SapLanguage			False
System.Communication-4/SapTrace			False
System.Communication-4/SapGatewayHost			True
System.Communication-4/SapGatewayService			True
System.Communication-4/SapProgramId			True
System.Communication-4/SapRegistrationCount			True

ServiceAccountConfiguration

Inheritance: System-2.5.0/Entity-1 ➔ System-2.5.0/Configuration-1 ➔ System.Communication-4.6.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-4/IssuerUri			True
System.Communication-4/ClientId			False
System.Communication-4/ClientSecret			True
System-2/TenantId			True
System.Communication-4/AssignedRoleNames			True
System.Communication-4/AllowDelegation			True

SftpConfiguration

Inheritance: System-2.5.0/Entity-1 ➔ System-2.5.0/Configuration-1 ➔ System.Communication-4.6.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-4/Host			False
System.Communication-4/Port			False
System.Communication-4/Username			False
System.Communication-4/Password			True
System.Communication-4/PrivateKey			True
System.Communication-4/PrivateKeyPassphrase			True
System.Communication-4/MaxConcurrentConnections			True

SignalChannel

Inheritance: System-2.5.0/Entity-1 ➔ System-2.5.0/Configuration-1 ➔ System.Communication-4.6.0/SignalChannel-1

Tenant-owned Signal phone-number channel (AB#5143). Exactly ONE per tenant (singleton, enforced by the Communication Controller service layer), and a number may be claimed by only one tenant per instance. Managed exclusively through the tenant self-service REST endpoints ({tenant}/v1/signal/channel) — the controller is the only component allowed to talk to the unauthenticated signal-cli-rest-api bridge.

ID	Auto Complete Values	Auto Increment Reference	Is Optional
System.Communication-4/PhoneNumber			False
System.Communication-4/ApiUrl			False
System.Communication-4/SignalDisplayName			True
System.Communication-4/RegistrationState			False
System.Communication-4/RegisteredAt			True
System.Communication-4/LastError			True
System.Communication-4/RegistrationHistory			True

Tag

Inheritance: System-2.5.0/Entity-1 ➔ System.Communication-4.6.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-4/Tag			False
System.Communication-4/Name			True

Outbound Associations

Outbound Name	Outbound Multiplicity	CkRoleId	TargetCKTypeId	Target Attributes
IsTagging	N	System.Communication-4/Tag	System-2/Entity

WeClappConfiguration

Inheritance: System-2.5.0/Entity-1 ➔ System-2.5.0/Configuration-1 ➔ System.Communication-4.6.0/WeClappConfiguration-1

Configuration for the WeClapp cloud ERP API connection. Stores the tenant-specific base URL and API key. Referenced by WeClapp adapter nodes via apiConfiguration.

ID	Auto Complete Values	Auto Increment Reference	Is Optional
System.Communication-4/Host			False
System.Communication-4/ApiKey			False