TP-Wireless-5.2.2-LRC-OSS Interface Developer Guide (Cellular)

Actility ThingPark
Wireless LRC-OSS Interface

Developer Guide (Cellular)
Under NDA
NOTICE
This document contains proprietary and confidential material of ACTILITY SA. This document
is provided under and governed by either a license or confidentiality agreement. Any
unauthorized reproduction, use, or disclosure of this material, or any part thereof, is strictly
prohibited.
The material provided in this document is believed to be accurate and reliable. However, no
responsibility is assumed by Actility SA for the use of this material. Actility SA reserves the
right to make changes to the material at any time and without notice. This document is
intended for information and operational purposes only. No part of this document shall
constitute any contractual commitment by Actility SA.
© 2019 ACTILITY SA. All rights reserved.
Portions of this documentation and of the software herein described are used by permission
of their copyright owners.
Actility, ThingPark, are registered trademarks of Actility SA or its subsidiaries may also be
registered in other countries.
Other denoted product names of Actility SA or other companies may be trademarks or
registered trademarks of Actility SA or its subsidiaries, or their respective owners.
Headquarters
Actility Lannion,
Actility S.A 4 rue Ampère BP 30225
22300 Lannion France
www.actility.com
Under Non-Disclosure Agreement

Actility S.A. au capital de 1 122 916 € - 4 rue Ampère, 22300 Lannion, France
RCS St Brieuc 522 305 473, Siret 522 305 473 00012, TVA FR62522305473
TP_Wireless_5.2.2_LRC-OSS__Interface _Developer_Guide_Cellular- 2
VERSIONS
Version Date Author Details
01 2018/03/27 G. Lefèvre Initial version for 5.0 Release.
02 2018/08/29 ML Ancelle There is no enhancement for 5.1 Release.
03 2018/08/29 ML Ancelle There is no enhancement for 5.2.2 Release.
REFERENCE DOCUMENTS
Documents Author
01 ref-tpw5.2-epcc-lrc-interface-reporting-rev2 G. Lefèvre
02 ref-tpw5.2-epcc-pgw-interface-reporting-rev1 G. Lefèvre

TABLE OF CONTENTS
NOTICE ............................................................................................................. 2
VERSIONS.......................................................................................................... 3
REFERENCE DOCUMENTS ....................................................................................... 3
TABLE OF CONTENTS ............................................................................................ 4
ACRONYMS AND DEFINITIONS ................................................................................ 5
1 SCOPE........................................................................................................ 6
2 THINGPARK SOLUTION OVERVIEW .................................................................... 7
3 MESSAGE MODE REPORTS .............................................................................. 8
4 REPORTING INTERFACE ................................................................................... 9
4.1 Uplink frame report (REST) .......................................................................................... 9
4.2 Downlink frame report (REST) ................................................................................... 11
5 DIRECT IP MODE .........................................................................................13
5.1 Microflow document ................................................................................................. 13
5.2 Kafka Integration ....................................................................................................... 15
ABOUT ACTILITY ................................................................................................16

ACRONYMS AND DEFINITIONS
Acronyms Definitions
DDR Device Data Record
EPCC Evolved Packet Call Connector
HSS Home Subscriber Server
IMEI International Mobile Equipment Identity
IMSI International Mobile Subscriber Identity
MSISDN Mobile Station International Subscriber Directory Number
LRC Long Range Controller
LTE Long-Term Evolution
P-GW or PDN-
Packet Data Network Gateway
GW
SPR Subscriber Profile Repository
UE User Equipement
TWA ThingPark Wireless Application

1 SCOPE
This document describes the Evolved Packet Call (EPC) Connector reports. It aims at providing
an end-to-end integration of the EPCC sub-system into ThingPark.

2 THINGPARK SOLUTION OVERVIEW
The ThingPark set consists of four main key components:

▪ ThingPark Wireless – Core network and OSS
▪ ThingPark OS
▪ ThingPark X
▪ ThingPark Enterprise
The ThingPark platform is a modular solution enabling Network Operators to:
▪ Deploy LPWANs based on LoRaWAN™ or LTE with ThingPark Wireless.
▪ Manage, activate and monetize IoT bundles (device, connectivity and application)
with ThingPark OS.
▪ Provide value-added data layer services, such as protocol drivers and storage with
ThingPark X.
ThingPark OSS acts as the central System Management Platform (SMP), enabling all other
ThingPark platform modules with base capabilities such as subscriber management,
centralized authentication and access rights, and workflow management.
ThingPark Enterprise is an Internet of Things (IoT) platform that manages private LoRa®
Networks. The ThingPark Enterprise edition is used by companies to support their specific
business.
Operator & Enterprise Application Servers

On-Line Shops
OSS & BSS Management
API Layer
ThingPark OS ThingPark Wireless Core NW & OSS ThingPark X

ThingPark Enterprise
User Portal Store (E-Shop) Operator Connectivity Address Usage Record Supervision, System OCP Edition SaaS Edition RMC
Manager Manager Manager Manager (UDR) Monitoring, Management
Alarms Platform (SMP)
BPM Engine Market
Drivers Connectors
Wireless Device Network

Logger Manager Manager LTE Security Geo-Location
Vendor Supplier Billing & EPC Server Server
Manager Charging ETSI M2M ETSI M2M
Manager Connectors
Net GSCL NSCL
Spectrum Network LoRaWANTM LoRaWANTM

Analysis Tool Survey Network Join Server ²
Local GW (GSCL)
Server
LoRaWANTM LRR (Gateway)

Any Device
Radio Network TPW Air Interface Message Broker Cluster Computing
Planning Tool Dimensioning Tool (Kafka) (Spark) LoRaWANTM /LTE Devices
Figure 1 - ThingPark Solution Architecture Description High Level Product Illustration

Note that the modules above may be representing a physical server, a function, a service or a business support layer
as part of the overall ThingPark solution and not necessarily a physical HW server.

3 MESSAGE MODE REPORTS
This section specifies the Device reporting interface (Message Mode) between the Long Range
Controller (LRC) and the OSS sub-systems exposed through Kafka.
This interface is designed to expose UL and DL reports to the OSS Sub-Systems for the
following purposes:
▪ Usage reporting
▪ Key performance indicator computing
▪ Alarms processing
▪ Troubleshooting
The interface cannot be used to exploit data reported by devices. For this purpose, the LRC/AS
tunneling interface must be used.
The following diagram describes the message flow between the P-GW and the LRC. The Device
reporting interface (Message Mode) is the interface between the LRC and the Client.

4 REPORTING INTERFACE
4.1 Uplink frame report (REST)
LRC → TWA: Uplink packet reporting towards the ThingPark System (Kafka cluster).
EUI_uplink document:
Important Always use a JSON document on Kafka interface.
Attributes C
Time 1 Uplink packet reception timestamp on the P-GW.
Syntax: STRING (ISO date/time)

For instance, 2016-09-06T12:00:53.602+02:00
DevEUI 1 IMEI terminal identifier.
Syntax: STRING
For instance, 354567890123456
DevAddr 0..1 UE IP address.
Syntax: STRING (IPv4)

For instance, 10.10.0.10
LRC 1 LRC ID that processes the packet.
Syntax: STRING (Hexadecimal string)

For instance, 00000ABC
MTC 1 P-GW ID that processes the packet.
Note This attribute is used as
discriminant between LoRa node and Syntax: STRING (Hexadecimal string)
LTE UE.
For instance, 00000001
CustomerID 1 Customer ID (as provided when the Device has been
provisioned).
Syntax: STRING
CustomerData 0..1 ASCII customer data set by provisioning. Currently, the
customer data returns the administrative location of the UE.
Syntax: STRING (JSON)

For instance, {"loc":{"lat":"43.58081",
"lon":"1.4421667"}}
MType 0..1 Type of the uplink packet.
Unsigned integer (0...3):
- 1: Session creation,
- 2: Session deletion,
- 3: Session update,
- 0: IPv4 packet.

Attributes C
Syntax: NUMBER (Unsigned integer)

For instance, 0
Cause 0..1 Session deletion cause (applicable when MType=2).

For instance, 10
EBI 0..1 EPS Bearer ID.

APN 0..1 APN.
Syntax: STRING
For instance, internet
payload_hex 0..1 Hexa dump of the IPv4 packet (applicable when MType=0).
This includes IP Header and TCP/UDP Headers.

For instance,
45c0004c5dac40003f11bf670a0b000a9
7507c68007b007b 003846f4e3030ae90
0000a1100011db297507c68db78ee2162
c0f74e000000000000000000000000000
00000db78f79e5e881b12
Late 0..1 Indicates that this is a late reporting of an uplink frame

from the long term queue.
Syntax: NUMBER (0..1)

For instance, 1
MSISDN 0..1 MSISDN number E.164.
Syntax: STRING
For instance, 1234567890123456
IMEI 0..1 IMEI terminal identifier.
Syntax: STRING (Digit string)

For instance, 354567890123456
IMSI 0..1 IMSI of the SIM card.
Syntax: STRING (Digit string)

For instance, 41004123456789
RAT 0..1 Radio Access Type.
Syntax: STRING
For instance, EUTRAN
CELLID 0..1 Cell ID.

Attributes C
Syntax: STRING
CMCCMNC 0..1 Cell MCCMNC.
Syntax: STRING
For instance, 20810
CELLTAC 0..1 Cell Tracking Area number.
Syntax: STRING
SERVNET 0..1 Serving Network MCCMNC.
Syntax: STRING
For instance, 20810
Kafka topic:
• OSS.DEV.v1 (partition key: IMEI)
• OSS.LRR.v1 (partition key: P-GW ID)
4.2 Downlink frame report (REST)
LRC → TWA: Downlink frame reporting towards the ThingPark System (Kafka cluster).
EUI_downlink document:
Important Always use a JSON document on Kafka interface.
Attributes C
Time 1 Downlink packet reception timestamp on the LRC.
Syntax: STRING (ISO date/time)

For instance, 2016-09-06T12:00:53.602+02:00
DevEUI 1 IMEI terminal identifier.
Syntax: STRING
For instance, 354567890123456
LRC 1 LRC ID that processes the packet.
Syntax: STRING(Hexadecimal string)

For instance, 00000ABC
MTC 1 P-GW ID that processes the packet.
Note This attribute is used as
discriminant between LoRa node and Syntax: STRING (Hexadecimal string)
LTE UE.
CustomerID 1 Customer ID (as provided when the Device has been
provisioned).

Attributes C
Syntax: STRING
MType 0..1 Type of the uplink packet.
Unsigned integer (0):

- 0: IPv4 packet (only this value is supported in
PHASE1).

For instance, 0
payload_hex 0..1 Hexa dump of the IPv4 packet (applicable when MType=0).
This includes IP Header and TCP/UDP Headers.

For instance,
45c0004c5dac40003f11bf670a0b000a9
7507c68007b007b 003846f4e3030ae90
0000a1100011db297507c68db78ee2162
c0f74e000000000000000000000000000
00000db78f79e5e881b12
Kafka topic:
• OSS.DEV.v1 (partition key: IMEI)
• OSS.LRR.v1 (partition key: P-GW ID)

5 DIRECT IP MODE
This section specifies the Device reporting interface (Direct IP Mode) between P-GW and OSS
sub-systems exposed through Kafka.
This interface is designed to expose UL and DL reports to the OSS Sub-Systems for the
following purposes:
▪ Usage reporting
▪ Key performance indicator computing
▪ Alarms processing
▪ Troubleshooting
The interface cannot be used to exploit data reported by devices. For this purpose, the P-
GW/AS tunneling interface must be used.
The following diagram describes the message flow between the P-GW and Client.
5.1 Microflow document
The Microflow event is a structured JSON document.

A Microflow can be opened either by an UP or DOWN IP packet. A Microflow cannot be
closed before the minimal duration. When the minimal duration has been reached, a
Microflow can be closed either when the Maximal duration is reached or when the Maximal
volume (sum of the UP and DOWN traffic) is reached.

A Microflow event is generated when the Microflow is closed.
No Microflow are emitted when the device does not generate any traffic (for example,
when the device switches off the radio).
P-GW → TWA: Microflow reporting (KAFKA structured JSON).
Microflow JSON document. The column R (Retrieve) gives the cardinality of the JSON
elements for a given verb (for instance, 0..1 means optional, 1 means mandatory, 1..n
means at least 1, empty means not applicable):
XML elements R
Microflow/Date 1 ISO 8601 data/time
Syntax: STRING
Microflow/IMEI 1 Device IMEI
Syntax: STRING
Microflow/IMSI 1 Device IMSI
Syntax: STRING
Microflow/BytesUp 1 Bytes messages up of the Microflow (in Byte).
Syntax: NUMBER (Unsigned LONG)

Microflow/BytesDown 1 Bytes messages down of the Microflow (in Byte).
Syntax: NUMBER (Unsigned LONG)
Microflow/Duration 1 Duration of the Microflow (in second).
Syntax: NUMBER (Unsigned INT)

Microflow/CELLID 1 Cell ID valid at the end of the Microflow.
Syntax: STRING
Microflow/OpeID 1 ThingPark Operator ID
Syntax: STRING
Microflow/SubsID 1 ThingPark Subscriber ID
Syntax: STRING
Microflow/CpID 1 ThingPark Connectivity Plan ID
Syntax: STRING
Microflow/MTC 1 P-GW ID
Syntax: STRING

Note Microflow/OpeID, Microflow/SubsID and Microflow/CpID are mandatory
when the P-GW is deployed in the end-to-end ThingPark solution.
Sample
{
"Microflow": {
"Date": "2014-04-01T14:19:56.38+02:00",
"IMEI": "1234567890123456",
"IMSI": "41004123456789",
"BytesUp": 896587,
"BytesDown": 45821,
"Duration": 10,
"CELLID": "897988",
"OpeID": "kpn-ope",
"SubsID": "199906959",
"CpID": "kpn-cs/cp1",
"MTC": "00000001"
}
}
5.2 Kafka Integration
Microflow documents are associated with a Kafka record as: Record (topic,
partition, timestamp, key, value):
▪ Record topic: OSS.DEV.v1
▪ Record timestamp: Publication timestamp.
▪ Record key: Consistent hashing on the IMEI.
▪ Record value: Microflow document.

ABOUT ACTILITY
Actility is an industry leader in LPWAN (Low Power Wide Area) large scale infrastructure with
ThingPark™, the new generation standard-based M2M communication platform. Actility’s
ThingPark Wireless™ network provides long-range coverage for low-power sensors used in
SmartCity, SmartBuilding and SmartFactory applications. Actility also provides the ThingPark
X which provides big data storage for sensor data and exposes sensor function through an
open API allowing developers to provide vertical applications on top of rolled out sensors. To
help vendors transform their sensors, Actility provides the ThingPark IoT platform which
include embedded software solutions and cloud solutions to help devices connect to
innovative applications. Via the ThingPark Market, an online marketplace engine dedicated to
the IoT sensors, applications and network solutions, Actility enables the roll-out of new
innovative IoT services for sensor vendors and network solution vendors. Actility is a founding
member of the LoRa Alliance™: the largest, most powerful standards-based effort to enable
the Internet of Things (IoT). Visit www.actility.com.
LoRaWAN™, the LoRa Alliance™, and LoRa Alliance Certified™ are trademarks of Semtech
Corporation, used with permission under a sublicense granted to the LoRa Alliance™ and its
members.


TP-Wireless-5.2.2-LRC-OSS Interface Developer Guide (Cellular)

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

TP-Wireless-5.2.2-LRC-OSS Interface Developer Guide (Cellular)

Uploaded by

Copyright:

Available Formats

Actility ThingPark

Wireless LRC-OSS Interface

© 2019 ACTILITY SA. All rights reserved.

Under Non-Disclosure Agreement

Version Date Author Details

01 2018/03/27 G. Lefèvre Initial version for 5.0 Release.

02 2018/08/29 ML Ancelle There is no enhancement for 5.1 Release.

03 2018/08/29 ML Ancelle There is no enhancement for 5.2.2 Release.

Under Non-Disclosure Agreement

Under Non-Disclosure Agreement

Under Non-Disclosure Agreement

Under Non-Disclosure Agreement

The ThingPark set consists of four main key components:

Operator & Enterprise Application Servers

ThingPark OS ThingPark Wireless Core NW & OSS ThingPark X

Wireless Device Network

Spectrum Network LoRaWANTM LoRaWANTM

LoRaWANTM LRR (Gateway)

Figure 1 - ThingPark Solution Architecture Description High Level Product Illustration

Under Non-Disclosure Agreement

▪ Key performance indicator computing

Under Non-Disclosure Agreement

4.1 Uplink frame report (REST)

Syntax: STRING (ISO date/time)

Syntax: STRING (IPv4)

Syntax: STRING (Hexadecimal string)

Syntax: STRING (JSON)

Under Non-Disclosure Agreement

Syntax: NUMBER (Unsigned integer)

Syntax: NUMBER (Unsigned integer)

Syntax: NUMBER (Unsigned integer)

Syntax: STRING (Hexadecimal string)

Late 0..1 Indicates that this is a late reporting of an uplink frame

Syntax: NUMBER (0..1)

Syntax: STRING (Digit string)

Syntax: STRING (Digit string)

Under Non-Disclosure Agreement

4.2 Downlink frame report (REST)

Syntax: STRING (ISO date/time)

Syntax: STRING(Hexadecimal string)

Under Non-Disclosure Agreement

Unsigned integer (0):

Syntax: NUMBER (Unsigned integer)

Syntax: STRING (Hexadecimal string)

Under Non-Disclosure Agreement

▪ Key performance indicator computing

5.1 Microflow document

The Microflow event is a structured JSON document.

Under Non-Disclosure Agreement

Microflow/Date 1 ISO 8601 data/time

Microflow/IMEI 1 Device IMEI

Microflow/IMSI 1 Device IMSI

Microflow/BytesUp 1 Bytes messages up of the Microflow (in Byte).

Syntax: NUMBER (Unsigned LONG)

Syntax: NUMBER (Unsigned LONG)

Microflow/Duration 1 Duration of the Microflow (in second).

Syntax: NUMBER (Unsigned INT)

Microflow/OpeID 1 ThingPark Operator ID

Microflow/SubsID 1 ThingPark Subscriber ID

Microflow/CpID 1 ThingPark Connectivity Plan ID

Under Non-Disclosure Agreement

5.2 Kafka Integration

▪ Record topic: OSS.DEV.v1