SAP Edge Services, cloud edition Edge Services Overview Guide Version 1802
Table of Contents ABOUT THIS DOCUMENT... 3 INTRODUCTION... 4 Persistence Service... 4 Streaming Service... 4 Business Essential Functions Service... 4 Policy Service... 4 ARCHITECTURE... 5 Policy Service (Edge Services Console)... 5 SAP EDGE SERVICES DOCUMENTATION... 6 Policy Service... 6 Persistence Service... 6 Streaming Service... 6 Business Essential Functions Service... 6 SUPPORTED OPERATING SYSTEMS... 6 Linux x64... 6 Windows x64... 6 SAP EDGE SERVICES INSTALLATION PATH... 7 SAP EDGE SERVICES PREREQUISITES... 7 IOT SERVICES GATEWAY EDGE IMPORTANT NOTE OFFLINE SUPPORT... 7 JAVA_HOME... 7 SAP EDGE SERVICES INTERCEPTOR... 8 Architecture... 8 Configuration... 8 2
ABOUT THIS DOCUMENT This overview guide provides a starting point for understanding and using SAP Edge Services. It describes the primary concepts and key functionality, as well as references to all other relevant documentation. This document is intended for the following audiences: Consultants Partners Customers Developers 3
INTRODUCTION SAP Edge Services is a set of services designed to run on the edge of an enterprise network. SAP Edge Services has been optimized to run inside of SAP IoT Services 4. SAP Edge Services leverages SAP IoT Services 4 to provide solutions that will enable edge computing with minimal software development effort. Leveraging SAP IoT Services 4.x provides many benefits: Runtime that allows for updating services dynamically. Ingestion and protocol conversion of data from things/devices/sensors. Security provided by SAP IoT Services 4. Cloud-based management. The following sections briefly describes the key features of SAP Edge Services. Persistence Service SAP Edge Services Persistence Service provides the ability to store sensor data at the edge. It also allows any other IoT Services based application access to a generic secure persistence service. Streaming Service SAP Edge Services Streaming Service uses complex event processing to analyze IoT sensor data in near realtime. Administrators can rely on a known sensor profile or manually configure SAP Edge Services Streaming Service to monitor the flow of an IoT sensor for a variety of actionable patterns (for example, thresholds, timing patterns, conditional logic, and so on). Business Essential Functions Service Business System functionality is often desirable in locations where connectivity to the Core is not consistently available. SAP Edge Services Business Essential Functions Service extends a subset of Business System functionality to the Edge. This functionality is provided to the developer via an edge-based RESTful API. Policy Service SAP Edge Services Policy Service is a cloud based service to manage the edge services. It provides the deployment and lifecycle management of edge services. The Policy Service also serves as a central repository of policies (configurations). The Policy Service is configured by the Edge Services Console. 4
ARCHITECTURE Policy Service (Edge Services Console) The SAP Edge Services Policy Service contains an Edge Services Console. The Edge Services Console is the primary way an Administrator interacts with the SAP Edge Services Policy Service. The Edge Services Console provides the following key functionality: View active gateways on the configured IoT Services instance/tenant. Initiate and monitor the status of installation of the SAP Edge Services bundles on the active gateways. For information on using the Edge Services Console, refer to the Edge Services Console - Administration Guide. 5
SAP EDGE SERVICES DOCUMENTATION After reviewing this Overview Guide, it is recommended that you review the Edge Services Console - Administration Guide guide. Policy Service The SAP Edge Services Policy Service contains an Edge Services Console. The Edge Services Console is the primary way an Administrator interacts with the SAP Edge Services Policy Service. For information on using the Edge Services Console, refer to the Edge Services Console - Administration Guide. Persistence Service For information on configuring the Persistence Service, refer to the Persistence Service - Guide. Streaming Service For information on configuring the Streaming Service using the UI, refer to the Streaming Service - Administration Guide. For information on additional configuration, refer to the Streaming Service - Configuration Guide. Business Essential Functions Service For information on APIs, refer to the Business Essential Functions Service - API Guide. For information on OSGI requirements and configuration, refer to the Business Essential Functions Service - Edge Guide. SUPPORTED OPERATING SYSTEMS SAP Edge Services is supported on both Linux x64 (x86 64-bit) and Windows x64 (x86 64-bit). Linux x64 Linux is available from several vendors. In addition, a wide variety of Linux installations are possible, which poses a challenge for companies such as SAP, who want to maintain an open and flexible approach to supporting Linux, yet require a practical means of identifying which Linux installations they support. Untested versions of Linux may have slightly different configurations that the IoT edge services installer does not recognize, and therefore may not work without additional support from SAP. Tested Linux distributions: Ubuntu Desktop 16.04 LTS x64 (x86 64-bit) Intel Intelligent Device Platform (IDP) 3.1 Wind River 7 x64 (x86 64-bit) Windows x64 SAP Edge Services supports the following Windows versions: Windows 8.1 x64 (x86 64-bit) Windows 10 x64 (x86 64-bit) Windows 2012 Server x64 (x86 64-bit) Windows 7 x64 (x86 64-bit) 6
SAP EDGE SERVICES INSTALLATION PATH By default, SAP Edge Services is installed in a directory at the same level as the IoT Services Gateway Edge directory. For example, if Gateway Edge is installed at /opt/gateway-v4.xx or C:\SAP\gateway-v4.xx then SAP Edge Services is automatically installed at /opt/edgeservices or C:\SAP\edgeservices. This allows for new versions of the Gateway Edge to also be installed in the /opt or C:\SAP folder and will automatically use the existing SAP Edge Services configuration at /opt/edgeservices or C:\SAP\edgeservices. If new versions of the Gateway Edge are installed in a different folder, then you may be required to move the edgeservices folder as well. Note: Only 1 Gateway Edge process can access a given SAP Edge Services folder. To change the default directory of SAP Edge Services, the following hierarchy is used by SAP Edge Services: 1. Gateway.sh/cmd option ex. -Dcom.sap.iotservices.gateway.ESInstallPath=C:\SAP\edgeservices 2. Gateway property property name - ES_INSTALL_PATH 3. Default location parent folder of the current user directory(gateway), so edgeservices folder would be a peer of the gateway folder. SAP EDGE SERVICES PREREQUISITES The following prerequisites should be noted for SAP Edge Services: Java version 1.8.x 64-bit Streaming Service also requires the following software package to already be installed on the host: Python version 2.7.x 64-bit Please refer to the guides for each service for more details. IOT SERVICES GATEWAY EDGE IMPORTANT NOTE OFFLINE SUPPORT It is strongly recommended to start the IoT Services Gateway Edge with offline support ( Disconnected Startup ) enabled. When offline support is enabled, the Streaming Service and Persistence Service make use of an optimization, and start in offline mode. The IoT Services datamodel is fetched by the Streaming Service and Persistence Service from a local cache stored by the IoT Services Gateway Edge. To configure this important feature, add the following to the IoT Services Gateway Edge start command: JAVA_HOME -Dcom.sap.iotservices.gateway.enableDisconnectedStartup=true The JAVA_HOME environment variable must refer to the same version of Java that the SAP IoT Services Gateway Edge process is started under (and is found on the system path). Note: SAP Edge Services requires JAVA_HOME to be configured on Windows x64. JAVA_HOME can point to a JRE or a JDK folder. 7
SAP EDGE SERVICES INTERCEPTOR The SAP Edge Services Interceptor is referred to as the Edge Interceptor. The Edge Interceptor is deployed automatically by both the Streaming Service and the Persistence Service. The Edge Interceptor receives data from IoT services in a standard format, and publishes the data using OSGI Event Admin. Both the Streaming Service and the Persistence Service receive the data that Edge Interceptor publishes. Once installed, Edge Interceptor forwards all messages to Persistence Service and Streaming Service automatically. Note: Edge Interceptor can block data from sending to IoT Services cloud/cockpit. See the Configuration section below for details. Architecture Configuration The Edge Interceptor has the following configuration values that can be set in the IoT Services cockpit. Property Name: measuresskipped Default Value: nothing (no measures are blocked) The Edge Interceptor passes all data to the IoT cockpit by default. It can also block data from sending to the IoT cockpit. To block data, configure an IoT Services cockpit gateway property with the key measuresskipped. Set the value to either * (asterisk) to block all data, or set the value to a comma separated list of measures that should be skipped. 8
measuresskipped value Behavior (nothing) All data is sent to the IoT Services cloud. * Blocks all measures from going to the IoT Services cloud 1,2 Blocks measures 1 and 2 from going to the IoT Services cloud. Note: Regardless of the measuresskipped setting, Edge Interceptor always sends all data to Persistence Service and Streaming Service. Property Name: refreshtimeperiod Unit of Measure: seconds Default Value: 3600 The IoT gateway properties (measuresskipped, refreshtimeperiod) are read by the Edge Interceptor in a regular time interval. To change this timing, configure an IoT Services cockpit gateway property called refreshtimeperiod. The value is in seconds. refreshtimeperiod value (nothing) Behavior IoT gateway properties (measuresskipped, refreshtimeperiod) read at default value of 3600 seconds 600 IoT gateway properties (measuresskipped, refreshtimeperiod) read every 600 seconds. 9
www.sap.com 2018 SAP SE or an SAP affiliate company. All rights reserved. No part of this publication may be reproduced or transmitted in any form or for any purpose without the express permission of SAP SE or an SAP affiliate company. SAP and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP SE (or an SAP affiliate company) in Germany and other countries. Please see http://www.sap.com/corporate-en/legal/copyright/index.epx#trademark for additional trademark information and notices. Some software products marketed by SAP SE and its distributors contain proprietary software components of other software vendors. National product specifications may vary. These materials are provided by SAP SE or an SAP affiliate company for informational purposes only, without representation or warranty of any kind, and SAP SE or its affiliated companies shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP SE or SAP affiliate company products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty. In particular, SAP SE or its affiliated companies have no obligation to pursue any course of business outlined in this document or any related presentation, or to develop or release any functionality mentioned therein. This document, or any related presentation, and SAP SE s or its affiliated companies strategy and possible future developments, products, and/or platform directions and functionality are all subject to change and may be changed by SAP SE or its affiliated companies at any time for any reason without notice. The information in this document is not a commitment, promise, or legal obligation to deliver any material, code, or functionality. All forward-looking statements are subject to various risks and uncertainties that could cause actual results to differ materially from expectations. Readers are cautioned not to place undue reliance on these forward-looking statements, which speak only as of their dates, and they should not be relied upon in making purchasing decisions.