LinQ2 P-Series Push Notifications Integration Channel v1.1

LinQ2 P-Series Push Notifications Integration Channel v1.1

Push Notification Integration

1.1 Introduction

Linq2 is integrated with Push Providers (PushWoosh/OneSignal/Google FCM) by using following approach.

  • Push notification can be requested in the XML or Rest request by MQ or WebService integration channels 
  • A push notification can be initiated by using the compose screen 
  • LinQ2 P-Series, extracts the message from incoming requests and sends to the mobile app as per the configurations in the system.


1.1.1 For PushWoosh

  1. Currently tagged push notifications are supported but can be enhanced/customized to use other request types 
  2. Multiple PushWoosh apps can be configured in the system and these configurations can be used to send push notifications

1.1.2 For OnSignal: 

  1. Push notifications are sent using the device/user id. 
  2. Multiple OneSignal apps can be configured in the system send push notifications

1.1.3 For Google FCM: 

  1. Push notifications are sent using the device tokens. 
  2. Multiple FCM apps can be configured in the system to send push notifications

1.2 Configuration

Authorized user can configure service parameter setting from configuration >LinQ2 resources > File - Show List > LinQ2 page. Form this page authorized user can define source, destination and error folder path.  

Ref- Screen 1 – LinQ2 P-Series PushNotification backend management_1

Ref- Screen 2 – LinQ2 P-Series PushNotification backend management_2

Ref- Screen 3 – LinQ2 Define PushNotification backend parameters

Ref- Screen 4 - LinQ2 resource (PushWoosh enumeration) configuration_1

Ref- Screen 5-  LinQ2 resource (OneSignal enumeration) configuration_2

Ref- Screen 6-  LinQ2 resource (Google FCM enumeration) configuration_3

 


Screen 1 – LinQ2 P-Series PushNotification backend management_1
 

   Screen 2 – LinQ2 P-Series PushNotification backend management_2 

 

 

Screen 3 – LinQ2 Define PushNotification backend parameters



 Ref: - Screen 4 – LinQ2   Resources Configuration. 

  

Ref: - Screen 5 – LinQ2   Resources Configuratio 


 

Ref: - Screen 6 – LinQ2   Resources Configuration

 

 

1.3 LinQ2 P-Series Push enumeration description.

     Push notifications can be sent to multiple different PushWoosh, OneSignal and Google FCM applications. Each application has unique APP ID and Authorization Key define on the provider portals. Each app configuration can be defined in the P-Series enumerations. Once configured, these configurations can be selected by either the backends or through the portal. PUSH_TEMPLATE_CODE is the enumeration type used for these configurations.  Following are the details of the enumeration structure

 

Each value should be coma separated from the other values, each value is a key/value pair and the whole string is parsed and converted to JSON. 

 

Sr.

Key

Description

Sample value(s)

1.

name

Name of the push template for display

T01

2.

app_code

APP Code from PushWoosh or OneSignal

Pushwoosh:901FC-6CB92

3.

auth_token

The API access toke from the provider 

Check with provider

4.

userTag

Pushwoosh only, the name of the tag defined in their portal

Tag01

5.

tagType

Pushwoosh only, the type of user tag. Integer and String types are supported by P-Series

Str or String

Int or Integer

6.

tagScope

Pushwoosh only, the scope of the tag. Is it defined at Application scope or General scope.

App or Application 

Gen or General

7.

pushSvc

The target service of this enumeration configuration

pw (for Pushwoosh)

os (for OneSignal) 

fc (for Google FCM)

 

1.4 Monitoring and Control

Push Notification handler service is available in services list. Authorized user can login in to LinQ2 system and can monitor the status of Push Notification handler service and recent errors and warning from status monitor section. User can also start and stop the Push Notification handler service from this section.


Ref: - Screen 4 – LinQ2 Push Notification handler Service Status Monitoring and Control 

 

Screen 5 – LinQ2 PushNotification handler Service Error Monitoring

 

 

  1. Before You Apply Test

  2. Queue Integration can't send messages to group created by other then administrator.
  3. For samples and full structure details of LinQ2 XML format please take a look at “LINQ2 XML STRUCTURE” document.

 

1.5 Test Cases

1.5.1 Test 1 - Duplicate Event Id test  

Test

Duplicate Event Id

Interface

Queue

Pre-conditions

 

  • Request is having duplicate event id

 

Request

Check doc LinQ2 XML Structure Description for samples.

 

Expected Result

 

  • Complain Error for duplicate event in error log.
  • No PUSH NOTIFICATION has been sent.
  • Event has not been logged because of duplicate event.

 

Actual Result

 

 

1.5.2 Test 2: - Invalid XML 

Test

Invalid XML

Interface

Queue

Pre-conditions

XML is not correct according to specify format

Request

Check doc LinQ2 XML Structure Description for samples.

 

Expected Result

 

  • Complain Error for Invalid xml in error log.
  • No PUSH NOTIFICATION has been sent.

Event has not been logged because parsing error.

Actual Result

 

 

 

 

 

 

 

1.5.3 Test 3: - Send push notification to direct recipient.

 

Test

Send push notification to direct recipients

Interface

Queue

Pre-conditions

  • Event id is not duplicate.
  • XML is in the proper format according to the format used by the queue handler
  • Proper push template code is defined in the P-Series portal 
  • The correct push template code is specified in the XML message
  • The Push Notification Queue Handler service is active and running 
  • The push notification handle service is active and running 

 

Request

Check doc LinQ2 XML Structure Description for samples.

 

Expected Result

 

  • 1 push notification has been sent successfully
  • Event has been logged with event id

 

Actual Result

 

 

 

 

 

 

 

 

 1.5.4 Test 4- Arabic push notification message from Queue

  

Test

Extract message and his parameter from xml content 

Interface

Queue

Pre-conditions

  • Proper Queue handler is used for accepting UTF format messages 
  • Database is configured to support Arabic language contents (either on database level or on column level) 

 

Request

Check doc LinQ2 XML Structure Description for samples.

 

Expected Result

Message will be sent and will be showing in message report.

Actual Result

 

 

 

 

1.5.5 Test 5- Send Push SMS with the Message Tag

 

Test

Extract message and his parameter from xml content 

Interface

Queue

Pre-conditions

  • LinQ2 Push Notification Service should be enabled and running.
  • XML Should valid.
  • XML should contain Push recipient.
  • Message tag should exist is the PushWoosh portal and its value should be correctly set on the mobile device.
  • Notification Method value should be 00001.

 

Request

Check doc LinQ2 XML Structure Description for samples.

 

Expected Result

  • Message will be sent and will be showing in push message report.

Record will be updated in PUSH_OUT in column SMS_STATUS (702).

Actual Result

 

 

 

1.5.6 Test 6- Rejecting message after specified number of tries. 

 

Test

Extract message and his parameter from xml content 

Interface

Queue

Pre-conditions

  • LinQ2 Push Notification Service should be enabled and running.
  • XML Should valid.
  • XML should contain Push recipient.
  • Message tag should exist is the PushWoosh portal and its value should be correctly set on the mobile device.
  • Notification Method value should be 00001.
  • The Push Notification Queue Handler service is active and running 
  • The push notification handle service is active and running 
  • Max tries for sending message fails.

 

Request

Check doc LinQ2 XML Structure Description for samples.

 

Expected Result

  • P-Series tries to send the push notification for configured number of tries
  • After failure attempts the message is marked as rejected 

Record will be updated in PUSH_OUT in column SMS_STATUS (703).

Actual Result

 

 

 

 

 

1.5.7 Test 6- Rejecting message after specified number of tries.

 

Test

Extract message and his parameter from xml content 

Interface

Queue

Pre-conditions

  • LinQ2 Push Notification Service should be enabled and running.
  • XML Should valid.
  • XML should contain Push recipient.
  • Message tag should exist is the PushWoosh portal and its value should be correctly set on the mobile device.
  • Notification Method value should be 00001.
  • The Push Notification Queue Handler service is active and running 
  • The push notification handle service is active and running 
  • Max tries for sending message fails.

 

Request

Check doc LinQ2 XML Structure Description for samples.

 

Expected Result

  • P-Series tries to send the push notification for configured number of tries
  • After failure attempts the message is marked as rejected 

Record will be updated in PUSH_OUT in column SMS_STATUS (703).

Actual Result

 

 

 

1.5.8 Test 7- Receive INVALID_REQUEST while sending Push notification.


Test
Internal Error occurred while processing your request due to any reason
Interface
Queue
Pre-conditions
  • LinQ2 Push Notification Service should be enabled and running.
  • Notification Method value should be 00001.
  • The Push Notification Queue Handler service is active and running 
  • The push notification handle service is active and running 
  • Max tries for sending message fails.
 
Request
Check doc LinQ2 XML Structure Description for samples.
 
Expected Result
  • P-Series tries to send the push notification for configured number of tries
  • After failure attempts the message is marked as rejected 
  • Record will be updated in PUSH_OUT in column SMS_STATUS (703).
Actual Result
 

 


© 2024 Cerebra All Copyrights Reserved

    • Related Articles

    • LinQ2 P-Series Voice Integration Channel v1.0

      Voice Integration Introduction Now Linq2 P Series supports automated voice calling feature through standard SIP providers e.g. FreePBX. Linq2 P Series is integrated with SIP Providers by using the following approach/steps. Configure SIP account ...

    • LinQ2 P-Series XML Structure Description v 2.0

      This document explains LinQ2's XML structure, which uses ar XML File Channel Element Type Max. Len Rep Allowed Values Mandatory Description Evnt_Id Text 10 1 N/A Y Unique Event Identifier. Evnt_Source Text 10 1 ‘OMS’, ‘CRM’ Y Event source. Put here a ...

    • LinQ2 P-Series Xml File Integration Channel

      XML File Integration 1.1 Introduction This interface allows sending requests to LinQ2 through xml file saved in UTF 8 format. Linq2 application will read this file from already defined source directory. In case of successful processing this file will ...

    • LinQ2 P-Series Database Integration Channel

      Data base Integration 1.1 Introduction LinQ2 application has a database monitor component to pull messages from database other then linQ2 database. LinQ2 database monitor can pull message information from the database table and send it to appropriate ...

    • Release Note - Voice Module [P-Series - V 4.1.0] - Internal

      LinQ2 P-Series Voice Release Notes This release contains Voice module & integration in LinQ2 P-Series: Introduction: Now Linq2 P Series supports automated voice calling feature through standard SIP providers e.g. FreePBX. Linq2 P Series is integrated ...