Senseforce 2.0 Manual
  • Welcome to Senseforce 2.0
  • SF MQTT API
  • SF Edge
    • Edge Package Overview
    • Edge Installation
      • Using the SF Edge Service installer in command shell
      • Headless SF Edge Servie execution
    • Edge Configuration
      • Which Plugins to load (appsettings.xml)
      • Edge Data Routing (EventDefinition.xml)
      • OTA configuration (otasettings.xml)
      • Edge Logging
      • Input plugins
        • SQL Plugin
        • SQLite Plugin
        • OPC UA Plugin
          • OPC UA server browser
        • SIEMENS S7/SINUMERIK Plugin
          • Creating connection definition file
        • S7 Plugin
        • REST Plugin
        • TCP Listener Plugin
        • XML File Parsing Plugin
        • Heidenhain Plugin
      • Output Plugins
        • MQTT Plugin
        • SQLite Plugin
    • Edge Compute plugins
      • Creating compute plugins
      • Using compute plugins
  • SF Edge Asset Management
    • Edge version repository
  • SF Platform
    • Navigation
      • Overview Screen
    • Dataset Builder
      • Filters, Aggregations and Groupings
      • Functions of the Formula Editor
      • Additional Settings
      • Special Events
      • FAQ and Troubleshooting
    • Script Editor
      • Details of the Script Editor
      • Installed Packages
      • Working with Timestamps
        • Working with Timestamps in Python
        • Working with Timestamps in R
      • FAQ and Troubleshooting
    • Widgets
      • Text
      • Headline
      • Image
      • Progress Bar & Gauge Chart
      • Table
      • Map
      • Line, Bar, Scatter and Area Chart
      • Pie Chart
      • Gantt Chart
      • Histogram
      • Overview
      • Log
      • Default colors and color conditions
      • FAQ and Troubleshooting
    • Dashboards
      • Dashboard Filters
      • Favorites
      • Data Drilldown & Widget Interaction
      • Editing multiple dashboard widgets
      • Time Zones
      • Synchronized Zooming
      • Sharable Dashboard URL
      • Multi-chart layout options
      • Default sort for table widgets
      • Releases
      • Reporting
      • FAQ and Troubleshooting
      • Applying zoom to global timestamp filter
      • Optimise the layout for different devices
    • Machine Master Data
      • Dimensions
      • Instances
      • Things
      • Use Case
      • FAQ and Troubleshooting
    • Automation
      • Trigger
      • Scheduling overview
      • Actions
      • Test your Automation
      • Zapier integration (necessary internal steps)
      • Zapier integration
      • Subscriptions
      • FAQ and Troubleshooting
    • Event Schema Management
      • Importing a Event Schema
      • FAQ and Troubleshooting
    • Virtual Events
      • Creating a Virtual Event
      • Scheduling Overview
      • Permissions and Data Access
      • FAQ and Troubleshooting
    • Details modal for elements
    • Copy / Duplicate elements
    • Whitelabeling
    • Edge Device Management
    • Element History
    • Public API
      • Get your access token
      • Endpoints
      • Debugging scripts
      • FAQ and Troubleshooting
    • User & Group Management
      • FAQ and Troubleshooting
    • Active Directory & SSO Setup
Powered by GitBook
On this page
  • General Information
  • Matching Schema to SF Edge Configurations

Was this helpful?

  1. SF Platform

Event Schema Management

PreviousFAQ and TroubleshootingNextImporting a Event Schema

Last updated 2 years ago

Was this helpful?

General Information

With the Event Schemas, you define how the data coming from the SF Edge devices should be structured. Meaning that depending on your Event Schemas the representation of the data points sent by the SF Edge devices will be different in the Dataset Builder.

An event schema consists of a schema name, key, and its attributes. Every attribute consists of a name, key, data type, and a unit (and if the data type is double a number of decimals). You can picture the schema as a table and the attributes as columns of this table.

The following picture shows how the definition of the schema affects the structure in the dataset builder.

The data type of the attributes defines how the data should be interpreted and if the data is valid. The unit helps you describe your data and can make widgets more explanatory.

Note that you do not need to represent all data points of a machine in one schema you can use multiple schemas. For example one schema for sensor data and one for alarms. On the other hand, not everything a machine sends must have all attributes. Every column is allowed to have NULL entries. In general, it depends on your data how many schemas are practical for you.

If you have admin permissions you are able to mark attributes in an event schema for deletion. During the next publishing of the event schema, all the marked attributes will get removed.

As an admin, you can also remove a complete event schema via the event schema list.

After saving your schema you need to publish it if you want an edge client to be able to send data for this schema.

The status displayed next to every attribute tells you the state the attribute is currently in. There are three states that an attribute can have:

  • Inactive: This attribute hasn't been published yet

  • Active: This attribute is published

  • To delete: This attribute is published and marked for deletion. During the next publish of the event schema, this attribute will get removed.

It is not allowed to create attributes with the metadata keys (Id, Inserted, Size, Thing, Timestamp, Type) explicitly. Every schema will have those attributes automatically.

Matching Schema to SF Edge Configurations

Invalid Messages

If you configured an edge that is supposed to send data to the platform but you can not find any entries in the respective schemas in the dataset builder have a look at the invalid messages. The following video shows you how to access them.

If a SF Edge is supposed to send data to the platform (via MQTT) some configurations need to match the defined event schemas, basically, we need to define which data point goes into which attribute. For detail have a look at .

Edge Data Routing