Service portal & API setup for STOMP trigger notifications

The tutorial describes the necessary steps to trigger and subscribe to service portal STOMP notifications.

Ericsson Device Connection Platform is using Simple Text Orientated Messaging Protocol (STOMP) to push notifications when certain events occur.

Application clients can be developed to subscribe to the service portal STOMP broker, to analyze and to take actions if necessary when STOMP notifications are pushed. The connection to the message broker it’s done over secure WebSockets (using TLS) using the standard port for wss 443.

Hereby are described the steps to trigger and subscribe to service portal STOMP notifications. It is assumed the reader is familiar with STOMP protocol.

How to trigger

Pre-requisites: “STOMP notification for trigger action” permission needed for the user onboarded in Service Portal.

A new trigger group should be created through the menu operation > automation > trigger management, by selecting a target enterprise or a subscription package, defining a category with a rule that has as condition to send a STOMP notification.

More details about how to create triggers can be found at Trigger Management Tutorial.

A STOMP queue name is provided at the end of the process of creating the Trigger Group. This information can be used by an authorized STOMP client to subscribe to.

To view the STOMP queue name, select the created trigger group from the list available in the menu operation > automation > trigger management > general information section.

The STOMP queue name is provided to an authorized STOMP client as destination to subscribe to.

How to subscribe to STOMP notifications

Pre-requisites: “Push API consumer for trigger event service” permission needed for the user onboarded in Service Portal.

Please refer to API: STOMP Notifications Tutorial and specify the following information to connect and to subscribe to the Service Portal message broker:

server Url: wss://<OPERATOR_BRAND_HOST>/dcpapi/push
login: <the user identifier used to authenticate against Service Portal >
passcode: <the password used to authenticate against Service Portal >
destination:< STOMP queue name of the trigger group>

The image on the right shows an example of the interface of a STOMP client.

Example of STOMP messages

CONNECT
accept-version:1.2
heart-beat:10000,
10000
host: <wss://<OPERATOR_BRAND_HOST>/dcpapi/push>
login: <the user identifier used to authenticate against Service Portal >
passcode: <the password used to authenticate against Service Portal >

CONNECTED
version:1.2
heart-beat: 10000,
10000
session:<session id>

SUBSCRIBE
id: <arbitrary unique subscription-id for the used connection>
destination: < STOMP queue name of the trigger group>
ack:client-individual

Example of received STOMP notification payload

{
	"time_stamp":"2020-09-15T13:09:53.867Z",
	"trigger_group_id":"17491dfbcfae7",
	"trigger_group_name":"CUSTOM- DCP Trial One",
	"custom_identifier":"not_vfe_de",
	"subscriptions":[
		{
			"imsi":"238208700343993",
			"msisdn":"45371000472427",
			"iccid":"89450421161020133437",
			"current_imei":"",
			"previous_imei":"8666039040825144",
			"subscription_package_id":"7000562575_20170605_SP_02",
			"subscription_package_description":"Fuzzies 01 SP 02",
			"enterprise_id":"06000270"
		}
	],
	"actions":[
		{
			"action_type":"STOMP_NOTIFICATION"
		},
		{
			"action_type":"LOCALIZE"
		}
	],
	"condition":{
		"condition_type":"networkAgreement",
		"networks":[
			{
				"mcc":"262",
				"mncs":"02"
			}
		],
		"type":"IS"
	}
}