Skyresponse ThingWorx Extension. Version 1.0. User Guide

Transcription

1 Skyresponse ThingWorx Extension Version 1.0 User Guide

2 Software Change Log...1 Introduction...1 About Skyresponse...1 Installation...2 Importing the Skyresponse ThingWorx Extension...2 Configuration and Setup...4 Setting up authentication with Skyresponse...4 Setting up ThingWorx...6 Troubleshooting...7 Compatibility...9 Document Revision History...9

3 Software Change Log Version Release Date Changes th SEPTEMBER 2017 Initial Release Introduction Through the ability to add Extensions to ThingWorx, partners and other users of the platform can enhance their own solutions with a wide range of functions. This guide provides instructions on how to add the Skyresponse Extension to bring professional event resolution to your IoT projects, with a guaranteed response to Alarm and Alerts. About Skyresponse Skyresponse is a cloud based ARC (Alarm Receiving Center) for the Internet of Things. It is useful for cases where an alert or alarm must be responded to by a person within a short, specific timeframe. For example, in the healthcare environment Skyresponse provides a critical link between events generated by sensors close to patients and medical personnel. Use Skyresponse to send alarms to distribute your important or critical IoT alerts, alarms and events to ensure they reach the right response group. Skyresponse follows rules for how alarms are handled and escalated. All alarms responded to and the actions taken are logged for review in a secure audit trail. This enables tracking of how events were handled, by which personnel and at what time - for billing or auditing purposes. Skyresponse provides full flexibility on where and how to process each alarm either through a full suite of alarm handling software for web and mobile or by integrating with existing third-party response centers and other IT systems. 1

4 Figure 1 Overview Skyresponse Service The Skyresponse Extension add a Thing Shape in ThingWorx. You can implement the Skyresponse Thing Shape in any Thing or Thing Template including other Thingworx shapes. The Skyresponse extension allows you to send alarms and critical alerts to the Skyresponse cloud and third party ARC (Alarm Receiving Center) personnel based on any event generated from any Thing. The extension makes use of the Skyresponse cloud service API for sending alerts. Skyresponse also includes an Administrative API for integrating administration and other advanced functions to define how alarms should be handled and escalated. Installation In order to use Skyresponse you will require an account from and a set of valid Object IDs mapped to the ThingWorx entity that you are monitoring. Refer to the Troubleshooting section of this guide for help with frequently asked questions. Importing the Skyresponse ThingWorx Extension Step 1: Log in to ThingWorx Composer in your web browser 2

5 Step 2: Open the Import/Export menu and select Import 3

6 Step 3: Click Choose File and select SkyresponseExtension.zip Step 4: Click Import. An import successful message should appear. Step 5: Click Yes when prompted to refresh Composer Step 6: Confirm that the extension has been properly imported. Check the application log for details. Configuration and Setup After importing the Skyresponse Thingworx Extension you will see a new ThingShape on the list named SkyresponseExtension. You will need to create and configure a Thing in ThingWorx in order to use this extension Setting up authentication with Skyresponse For every unique Thing that sends an alarm or alert, there should be a corresponding object ID in Skyresponse. You can set this up through the Admin portal accessible at or with the use of the Admin API and your administration credentials. Each object that you configure will have the following: An identifier : which is a unique ID A secret : which is a secret key associated with the identified A product : which identifies the product in Skyresponse These are used when you send alarms to Skyresponse (see below how to apply these when setting up the extension in Thingworx) You can obtain an account and further instructions on using Skyresponse by sending an to sales@skyresponse.com 4

7 5

8 Setting up ThingWorx Create a new Thing and add the Skyresponse Extension to the list of implemented shapes. You can also create a Thing Template that implements the Skyresponse Extension ThingShape and base your Things on that. Go to the Properties section on the side bar. Fill the values of identifier (transmitter id), secret (your Skyresponse secret key), product (the Skyresponse product code) and baseurl (Skyresponse service URL) with the appropriate values from your Skyresponse Object. You may also fill in optional parameters such as the Thing s location, which will be used when creating alarms. 6

9 Go back to your Thing and then to the Services section by clicking on the sidebar button. Under ThingShapes Services > SkyresponseExtension you will see the services provided by the Skyresponse Extension. Click on Test on the Skyresponse_send_alarm service to create an alarm. Fill in the fields and click the Execute Service button. The parameter fields for Skyresponse_send_alarm are as follows: globalalarmid: Client provided alarm id. If left blank, a unique id will be generated server side classifications: The alarm type code. It s made up of the digits 10 and a 3-digit alarm code, e.g is Smoke Detected alarm. See the Skyresponse Alarm Client API documentation for details. latitude, longitude and altitude: Numbers describing the position coordinates of the alarm horizacc: Horizontal accuracy value of the position positionmethod: The position method. Refer to the Alarm Client API documentation for details textmessage: An optional text message to include with the alarm timestamp: A timestamp of the Thing s latest position and location The parameter fields for Skyresponse_alarm_status are as follows: globalalarmid: The unique alarm id of the alarm to obtain status from To use the Skyresponse Extension, invoke the Skyresponse_send_alarm service. The screenshots below from Skyresponse show the Alarm Receiving Center alarm view Figure 2 Skyresponse Alarm Response Center (Web View) showing details of a temperature alert received from Thingworx. Figure 3 Skyresponse Mobile showing details of temperature alarm shows one of the views of the same alarm from seen from the mobile handset of a response team member. 7

10 Figure 2 Skyresponse Alarm Response Center (Web View) Figure 3 Skyresponse Mobile showing details of temperature alarm 8

11 Troubleshooting Problem Solution(s) 1. Hi IaG 1. Solution1 2. Solution2 3. Solution3 2. Problem2 1. Solution1 2. Solution2 3. Solution3 Compatibility This guide has been tested for compatibility with Skyresponse and the following ThingWorx platform and operating system: ThingWorx Platform Version ThingWorx OS Android, ios, Windows 10 Document Revision History Revision Date Version Description of Change September 21, Initial draft candidate for publication 9