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

Was this helpful?

  1. SF Edge
  2. Edge Configuration
  3. Input plugins

REST Plugin

REST Plugin

Configuration manual:

The following files are located in the S7Net plugin's config folder (\configurations\InputPlugins\Rest_Schildknecht)

  • DataMappings.xml (configures, how to build the messages from incoming REST data)

  • RestSettings.xml (basic plugin settings and definition of response message)

RestSettings.xml

The following settings should be configured to ensure plugin operation

  • Url: Endpoint for REST call

  • Method: Define the REST method. Allow: GET, POST, PUT, DELETE. Be aware, that each request is repeated periodically

  • PeriodSecs: Period in which the REST request is repeated, in seconds

  • Username

  • Password

  • ResponseDefinitions: define how the response message looks like. Please be aware, that the REST Schildknecht plugin assumes, the response is in JSON-array format; For each entry in the JSON-array, a ResponseDefinition must be defined. The below example demonstrates a response with three entries. A response may look like [[entry1, entry2, entry3], [entry1, entry2, entry3],....]

    • DataType: Select the datatype of the response entry: Allowed: Double, Integer, Long, Boolean, String, Timestamp

    • TimestampFormat: If DataType Timestamp is used and the timestamp format is not either in unix milliseconds or in standardized teimstamp format ("2018-01-01 10:21:12.234"), define the timestamp format

    • Name: Define the name of the response entry. Used for message creation

    • IsLastReadId: If IsLastReadId is set to true, this entry is used, to determine, which was the last received message. Always the last received entry is persisted on file system and is used to determine, how the next REST request is assembled, in terms of window definition

    • PersistLastReadId: Define FileName and FilePath of the file where the last read id is persisted. Make sure to provide read/write permissions

  • Selects: Define the "Select"-section of the query-string

    • Select: For every select-statement add a select xml tag. (Eg. if your select-statement should look like "select:["ch1", "ch2"]", enter <selects><select>ch1</select><select>ch2</select></selects>

  • UntilMax: Define the maximum "until"-string used in the querystring (eg. if you want to read at must until 22nd of August 2018, chose <UntilMax>20180822</UntilMax>

Also the file location and file name of the log-file as well as the other plugin-specific settings files can be specified here. Please note that the specified settings filenames and paths must correlate with the physical files.DataMappings.xmlThe default configuration is appropriate for most applications. Make sure to note the "IngressKey"-setting (default: RestData). This key is needed for the outgoing message mapping configuration.

PreviousS7 PluginNextTCP Listener Plugin

Last updated 2 years ago

Was this helpful?