Skip to main content

Attributes

Version: 3.13.1

AdapterConfiguration

JSON-serialized adapter-specific configuration that is deployed to the adapter.

Data Type

STRING


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-20250514, claude-haiku-4-5-20251001).

Data Type

STRING

Default Values
Default Value
claude-sonnet-4-20250514

ApiKey

API key for authenticating with the AI service (e.g. Anthropic sk-ant-... key). Stored as configuration attribute, not exposed in pipeline data context.

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


AzureTenantId

The Azure Active Directory tenant ID (GUID) for OAuth2 authentication.

Data Type

STRING


BackgroundColor

Background color of the web application

Data Type

STRING


BillingReportName

Name of the Telerik billing report template (e.g. SBEG_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


ClientId

OAuth2 Client ID for authenticating with the external API.

Data Type

STRING


ClientSecret

OAuth2 Client Secret for authenticating with the external API.

Data Type

STRING


CommunicationState

Current SignalR connection state of the adapter or pool operator.

Data Type

ENUM: System.Communication-3/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-3/ConfigurationState

Default Values
Default Value
0

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


Deployment.ImageName

Docker image name of the adapter container (e.g. octo-mesh-adapter).

Data Type

STRING


Deployment.ImageVersion

Docker image version tag of the adapter container.

Data Type

STRING


DeploymentState

Current deployment state of the entity (undeployed, pending, deployed, or error).

Data Type

ENUM: System.Communication-3/DeploymentState

Default Values
Default Value
0

DurationMs

Execution duration in milliseconds

Data Type

INT


EnergyCommunityId

ID of the energy community

Data Type

STRING


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-3/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


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


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


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


Icon for the app header

Data Type

BINARY_LINKED


Host

The host name is the name of the server on which the external system is running.

Data Type

STRING


IdentityServerUrl

URL of the OctoMesh Identity Server for provisioned datasource OAuth configuration.

Data Type

STRING


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.

Data Type

BOOLEAN


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 hours (ms)

Data Type

INT

Default Values
Default Value
0

Last12HoursFailureCount

Failed executions in the last 12 hours

Data Type

INT

Default Values
Default Value
0

Last12HoursSuccessCount

Successful executions in the last 12 hours

Data Type

INT

Default Values
Default Value
0

Last24HoursAvgDurationMs

Average execution duration in the last 24 hours (ms)

Data Type

INT

Default Values
Default Value
0

Last24HoursFailureCount

Failed executions in the last 24 hours

Data Type

INT

Default Values
Default Value
0

Last24HoursSuccessCount

Successful executions in the last 24 hours

Data Type

INT

Default Values
Default Value
0

Last30DaysAvgDurationMs

Average execution duration in the last 30 days (ms)

Data Type

INT

Default Values
Default Value
0

Last30DaysFailureCount

Failed executions in the last 30 days

Data Type

INT

Default Values
Default Value
0

Last30DaysSuccessCount

Successful executions in the last 30 days

Data Type

INT

Default Values
Default Value
0

LastExecutionAt

Timestamp of the most recent execution

Data Type

DATE_TIME


LastHourAvgDurationMs

Average execution duration in the last hour (ms)

Data Type

INT

Default Values
Default Value
0

LastHourFailureCount

Failed executions in the last hour

Data Type

INT

Default Values
Default Value
0

LastHourSuccessCount

Successful executions in the last hour

Data Type

INT

Default Values
Default Value
0

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


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-3/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


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


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


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


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


PipelineDefinition

JSON-serialized pipeline node graph that defines the data processing logic.

Data Type

STRING

Default Values
Default Value

PollIntervalSeconds

Interval in seconds between polling cycles.

Data Type

INT

Default Values
Default Value
30

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


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

SecondaryColor

The secondary color of the theme

Data Type

STRING


SenderEmail

Email address used as the sender (From) for outgoing emails.

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.

Data Type

STRING


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


TriggerType

How this pipeline execution was initiated (Manual, Scheduled, Event, or Startup).

Data Type

ENUM: System.Communication-3/PipelineTriggerType

Default Values
Default Value
0

UiThemeColors

Theme color configuration for an application

Data Type

RECORD: System.Communication-3/UiThemeColors


Username

The username is the name of the user that is used to authenticate with the external system.

Data Type

STRING