Quick guide on Message Exfiltration (or) triggering external Function on vitalpointz IoT Core Platform

1. Confidential
www.vitalpointz.net1
Porting Out

2. Confidential
www.vitalpointz.net
©2017 , www.vitalpointz.net
vitalpointz IoT Core Lite v1.3 and above
Porting Out data from
vitalpointz IoT Core Lite

3. Confidential
www.vitalpointz.net
 Outport module lets users to trigger API calls based on events occurring in vitalpointz IoT Core
Platform
 Device Messages or Events generated by the Platform can trigger external service using REST API
 Outport Module supports generating 4 REST Methods
 POST
 GET
 PUT
 DELETE
 Optionally, outport can invoke a function with the response of the REST call
3
Overview

4. Confidential
www.vitalpointz.net
 Navigate to OutPort Tab
 Click Create new Outport
4
Defining an Outport

5. Confidential
www.vitalpointz.net5
Fields of Outport Form
Name Typical use case
Description Quick prototyping sandbox
Metadata Analytics and Reporting
Outport Type REST API : Select this if REST API call is to be made
Logstash: applicable for sending data to ELK stack spun up in Workload Tab
URL Fully qualified URL for the API
Return Response Optional.
Enter a name of the function to which response of the REST call will be sent.
Useful in handling GET Response.
Header HTTP Headers can be added here
For e.g., in order to send an Auth Token on every call
Enter in key field, Authorization
Value field, Basic d2VsY29tZTp3ZWxjb21lcGFzc3dvcmQ==

6. Confidential
www.vitalpointz.net
 Navigate to Rules Engine Tab, Click New
Rule
 Event to Forward drop down shows the list of
events platform generates
 Forward to drop down shows the list services
that can receive the events
 Example: if device messages need to be sent
to 3rd party service using Outport,
 Select ‘User Defined’
 Enter Device Topic in ‘custom event’ field
 Enter FROM_DEVICE in ‘source’ field
 Forward To – Select OutPort
 Select the outport object created earlier
 Now, whenever device data is received,
outport triggers the call as per the definition
6
Wiring Events to Outport

7. Confidential
www.vitalpointz.net
 Outport also provides a nifty tool to ease the
pain of using ELK stack within the Platform
 On Outport type in outport create form, select
Logstash
 Enter the Index Name
 Note:
 When used, this creates the Template in ELK
 Whenever data flows to this Outport, Hourly
Index also derived from the same name
 Select the ELK instance that is running in the
platform using workload module
7
Lagstash Feeder

8. Confidential
www.vitalpointz.net
©2017 , www.vitalpointz.net
Questions ?
ask in our Slack support channel
search in our community forum community.vitalpointz.com