Brand Mobiliser Using the USSD States
Contents
1. Loads all available Languages and puts it into a menu 7 public class SmappStateSendUssdMenu extends AbstractDynamicUssdMenu protected static final Logger LOG LoggerFactory getLogger SmappStateSendUssdMenu class Private static final Stringi OPTIONS T Oae ion A Oe en EAS Oe on NT privatceLligt lt srring gt listoroOpeions Arrays aslase OPTIONS gt private Static Attribute stateAttr Sire twee 4 stateAttr new Attributel Override protected Attribute getStateAttributeList return StaveAttr clone g Override publie long getrstacerci return 485002 Override Brand M obiliser Using the USSD States Version 1 3 October 2012 publie string getstateName q return send USSD Menu Override public String getStateNotes return This state generates a sample USSD Menu n Use the following follow up states n OK it user gelectecd a menu icem m F Y PALL IE an error oCcCurg s lOverride publie boolean supportsOkTransition return true lOvyerride publie String getReyvisionstcringl return SRevils lone 28120 vs Override protected SmappState init SmappStateProcessingAction action throws DBException AMO loems Null 4 returna Continuerail s return null Override protected int getMmasxMenurltems q return this LlistOTOptLONS SLZze e Override Protected Mist keyvalmiePalrssering srring gt eonseruerMenuLrse2. throws DBException Eise lt keyvalwecbalr sSering stering gt list new Arraylbist lt KeyValucePalr lt String sering gt int optionNumber 1 tor String option 3 ListOFOptLONS 4 KeyValuePair lt String String gt keyVal new KeyValuePair lt String String gt keyVal setKey Integer toString optionNumber keyVal setValue option listada keyval optionNumber rerurn ask Override protected SmappState saveSessionVariables SmappStateProcessingContext context String key String value throws MwizProcessingmxceptiom DBException RequiredParameterMissingException return null Brand M obiliser Using the USSD States 3 Version 1 3 October 2012
3. v A U Y Name Send USSD Menu Au Notes Message Menu Options Money Mobiliser 13 160 characters Input Variables Showing 1 1 0 Show Exit menu item 1 yes O no Default 1 Output Variables Showing 1 2 VAR_SELECTED_KEY Variable name of the selected KEY VAR_SELECTED_VALUE Variable name of the selected VALUE Y Follow up States A OK Send Response Fail Select a follow up state Select a follow up state y Add Follow up v lt gt Figure 4 Sample Send USSD M enu Application the screenshot is from an earlier version of Brand Mobiliser Brand M obiliser Using the USSD States Version 1 3 October 2012 The configuration of the Send USSD M enu state comprises of Message This is the text for the menu header Input Variables The standard input variables as described by the abstract dynamic menu are Show Exit menu item show or hide the menu item for end exit Output Variables The standard output variables as described by the abstract dynamic menu are Variable name of the selected KEY is the session variable where the selected option key will be placed Variable name of the selected VALUE is the session variable where the selection option value will be placed Follow Up States OK this transition is normally used when the menu is created successfully and the user has sent a valid response key Fail this transition is only used when there
4. mobtlt ser brand plugin channel pr i Pikes uncle app lic ataron mo pilas ex lola ane Plugin ap lla Seal eeu cle Miles Dune aplication MoO Is er brand Processing ls sll Jar O O Es E NENE Start or restart your Brand server for the plugins to be recognized If states are installed correctly then they will appear in the Follow Up state list drop down as shown below E Test USSD e APPLICATION DETAILS APPLICATION COMPOSER EA Application Actions gt SAVE LAYOUT Gridlines Al v Zoom 100 v N v Name Test USSD BO Notes Start Applicatior Mobiliser Regex New Mobiliser Set Blacklist Reason New Mobiliser Set Customer Attribute New Mobiliser Set Identity New Mobiliser Set Info Mode New Mobiliser Set Language Session amp Customer New Mobiliser Set Customer Name New Mobiliser Set Primary PI New Mobiliser Set Receipt Mode New Mobiliser Set Language Session only New Mobiliser Txn Authorise Transaction New Mobiliser Txn Charge Fee New Mobiliser Tn Pay Invoice New Mobiliser Txn Pre Authorise Send Money New Mobiliser Txn Send Money New Send USSD Text New Add Follow up Send USSD Text New Send USSD Input New Send USSD Menu New Test USSD v Figure 1 Installed Sample USSD States the screenshot is from an earlier version of Brand M obiliser NOTE All of the following states are interoperable across the SM PP and the JMS chan
5. the USSD States Version 1 3 October 2012 if you want to use the conticured dynamic following transitions simply override this method and return continueDyn key otherwise override this method and return null to follow the OK transition when the user selected an entry 7 protected abstract SmappState saveSessionVariables SmappStateProcessingContext context String key String value throws MwizProcessingException DBException RequiredParameterMissingException 2 4 2 Sample USSD Menu Code As an example of acomplete implementation of the Send USSD M enu the following code can be used as a reference This code produces a menu based on the option values Option 1 Option 2 Option 3 and Option 4 com sybase365 mobiliser brand plugins ussd impl SmappStateSendUssdM enu package eom sybase365 mob l ser brand plugins ussd impl com Sybase365 mobiliser brand dac DBException com sybase365 mobiliser brand jpa SmappState com sybase365 mobiliser brand plugins api smapp SmappStateProcessingAction Som sybase o gt mobiliser brand plugins smapp eontrols Artr bur com sybase365 mobiliser brand plugins useful KeyValuePair Java util array est Java Ut ll Arrays java util ee Site org slf4j Logger org slf4j LoggerFactory BS SS OROROORO R OB K K me er me ar H H peo peo pe pe pe pe pe ope 2 B Ss OROROORO 0292070 R B5 B K Ca r e
6. OYBASE An INV company www sybase com DOCUM ENT ID DC60006 01 0130 01 LAST REVISED October 2012 Copyright O 2012 by Sybase Inc All rights reserved This publication pertains to Sybase software and to any subsequent release until otherwise indicated in new editions or technical notes Information in this document is subject to change without notice The software described herein is furnished under a license agreement and it may be used or copied only in accordance with the terms of that agreement Upgrades are provided only at regularly scheduled software release dates No part of this publication may be reproduced transmitted or translated in any form or by any means electronic mechanical manual optical or otherwise without the prior written permission of Sybase Inc Sybase trademarks can be viewed at the Sybase trademarks page at http www sybase com detail id 1011207 Sybase and the marks listed are trademarks of Sybase Inc indicates registration in the United States of America SAP and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and in several other countries all over the world Java and all Java based marks are trademarks or registered trademarks of Oracle and or its affiliates in the U S and other countries Unicode and the Unicode Logo are registered trademarks of Unicode Inc All other company and product nam
7. d USSD Text This state should be used when interfacing with USSD services through the Channel Manager and JMS For this configuration it will send the text message to the JMS queue with a type of MVVizMtUssdText Follow up states are used to branch the application based on the customer response Session variables may be added to the message using syntax of name Use the Ussd Session Handling option to control the outcome of the USSD session after sending the message Message This is a USSD text message lt end gt 34 160 characters Input Variables Showing 1 1 O Selectanenty USSD Session Handling Add Follow up Select an entry Continue End Figure 3 Sample Send USSD Text State the screenshot is from an earlier version of Brand M obiliser The Send USSD Text allows the configuration of an option to specify how any associated USSD session is managed by Channel M anager NOTE This configuration option is only relevant when Channel Manager is customized and configured to manage the USSD session information The options for the USSD Session Handling are None this is the standard option which will be used in no other option is selected With this option no specific processing for USSD session handling is performed Default when this option is selected the type of session handling is based on the follow up transitions from this state If there are no follow up tran
8. es mentioned may be trademarks of the respective companies with which they are associated Use duplication or disclosure by the government is subject to the restrictions set forth in subparagraph c 1 11 of DFARS 52 227 7013 for the DOD and as set forth in FAR 52 227 19 a d for civilian agencies Sybase Inc One Sybase Drive Dublin CA 94568 Brand M obiliser Using the USSD States Version 1 3 October 2012 Contents 1 IMEROCH CHION ee a nn innen A RA oo 2 NS SSID SALES a a a daa A AE A SS A en ee Se OR 23 Send USSD TSE ud e a do ie eds E 24 SeA USD MEN AA ee N O a ce ea ea ee tt a Brand Mobiliser Using the USSD States Version 1 3 October 2012 1 Introduction Sybase Brand M obiliser supports two internal channels where messages may be received and sent and interactive applications will be executed e SMPP For standard SMS e JMS For interface to additional channels The JMS interface is specifically used to communicate to the Channel Manager currently a separately running component of the M obiliser stack external to the Brand M obiliser installation The Channel M anager can be used to interface to anumber of standard interfaces such as e Jabber XMPP e MSN and e HIIP but it can also be customized to communicate to interfaces for which standards vary such as e USSD and e Non standard SM PP This document describes the options within Brand M obiliser for generating interactive applica
9. ger will strip off this text before passing the message text onto the USSD Gateway 2 4 Send USSD Menu This type of state allows the creation of a dynamic menu which will be presented to the subscriber as a series of options with relevant responses The menu is formed from e Header text this is the text that is provided in the text input field on the state editor panel e Options these are provided programmatically by instances of this state type as provided by a state developer e Paging Options this type of state will automatically end Next and Previous options to the menu list if the number of options go beyond the allowable number e End Option an option can be added to each menu which is the end or exit option This state type is actually an abstract type of which instances can be developed so that the dynamic menu capability can be developed This state is similar to the Send USSD Input state because it expects a response from the subscriber However the response is expected to be one of the menu options The following diagram shows an Application Composer view of an application using a sample implementation of the Send USSD Menu state Test USSD Menu e z APPLICATION DETAILS Kevworos APPLICATION COMPOSER MA panies Application Actions TEST USSD SEND USSD SEND RESPONSE MENU MENU Start Application Delete SAVE LAYOUT REVERT LAYOUT Gridlines Al v Zoom 100
10. is an internal processing error of the abstract dynamic menu NOTE Dynamic transitions M AY be implemented but they will not be followed unless specifically coded for in the implementation of the menu as described below 2 4 1 Implementing the Send USSD Menu To provide an implementation of the abstract menu requires creating a state that extends from the class com sybase365 mobiliser brand plugins ussd impl AbstractDynamicUssdMenu This abstract super class manages all the creation and structuring of the message It relies on overridden and implemented abstract methods to provide the information required The following methods are required to be implemented Refer to the method comments for more information The normal state attribute list is already set in the protected abstract Attribute getStateAttributeList DO any initialization of the dynamite list pos sol based on subseriper Mmrormaer on ay protected abstract SmappState init SmappStateProcessingAction action throws MwizProcessingException DBException JAXBException IOException ServiceException RequiredParameterMissingException Return the list of options Ln a format key textl a protected abstract List lt KeyValuePair lt String String gt gt getMenuList throws NumberFormatException DBException RequiredParameterMissingException x Allow the branching of processing based on selected key 6 8 Brand M obiliser Using
11. nels When a SM PP channel is configured the message is processed in the same way as plain SM S message If a JMS channel 2 Brand M obiliser Using the USSD States Version 1 3 October 2012 is configured the message is processed by the Channel M anager understanding the underlying J MS object type 2 2 Send USSD Input This state is used to send a prompt for input The input prompt is a regular message that can be specified in the state configuration You may optionally specify an input validation value and a mask input setting The input validation value and or URL will be some form of validation of response values expected The mask input will allow response inputs made by the subscriber to be masked on the phone NOTE The use of input validation and mask input is dependent on the Channel Manager interfaces into the USSD Gateway Please refer to your USSD Gateway capability and Channel M anager interfaces to check whether input validation and mask input are supported The following diagram shows an Application Composer view of an application using a Send USSD Input state E Test USSD Input APPLICATION DETAILS TEST USSD INPUT Start Application Application Actions y SAVE LAYOUT REVERT LAYOUT Gridlines All v J Zoom 100 v A APPLICATION COMPOSER APPLICATION EDITOR SEND USSD SEND RESPONSE INPUT 7 Delete Money Mobiliser U TE Send USSD Input Ja notes Message Press 0
12. sitions from this state then the application terminates and the user s Brand M obiliser session will terminate which will mean that the Channel M anager should instruct the USSD Gateway it is interfacing with to also terminate the USSD session for this user If there are follow up transitions from this state then the application continues and the user s Brand M obiliser session will also continue which will mean that the Channel M anager should instruct the USSD Gateway it is interfacing with to continue the USSD session for this user Continue this option can be used to override the default behavior so that Channel M anager should instruct the USSD Gateway it is interfacing with to continue the USSD session for this user regardless of whether there are follow up transitions or not 4 Brand M obiliser Using the USSD States Version 1 3 October 2012 End this option can be used to override the default behavior so that the Channel M anager should instruct the USSD Gateway it is interfacing with to also terminate the USSD session for this user regardless of whether there are follow up transitions or not NOTE In the situation where this type of state will require Channel Manager to end the USSD session this state will suffix the text of the message sent with the text End This must be used by the Channel M anager interacting with the USSD Gateway to instruct it to end the USSD session It is expected that Channel Mana
13. tions that use all the features and functions of USSD This document assumes that the audience is familiar with the concepts of Brand M obiliser development as described in 1 2 and has a basic knowledge of the Brand M obiliser State Development API as described in 2 1 1 References 1 Sybase Brand M obiliser User M anual Version 1 3 October 2012 2 Sybase Brand M obiliser Development M anual Version 1 3 October 2012 3 Sybase Brand M obiliser State Developers Guide Version 1 3 October 2012 Brand M obiliser Using the USSD States Version 1 3 October 2012 This section describes how to build applications that use the sample USSD states 2 1 Installation To install the USSD states requires the following 1 Check that the JAR file for the USSD states is installed in the relevant Brand installation location Ensure the Jar file mobiliser brand plugin ussd 1 3 1 jar Is in the location lt brandroot gt application bundle 2 Update the list of install plugin bundles Open the file in your chosen editor lt brandroot gt conf config properties And add the following line in bold below to this file felix auto start 9 file bundle application smppapi 1 0 4 jar fie Oo uncite apple e tato amo pra ete bernd Ollie ns map er sales Jar file bundle application mobiliser brand plugin ussd 1 3 1 jar Pike buncdle appl teak ton mobiles es brand plugin jms e nene ll Pile bundle application
14. to continue 79 160 characters Showing 1 3 v Mask the response eg password glo O Fail ds Target Expression Target Follow up States Select a follow up state 0 Expression Input validation string Input validation handler URL Send Response Assign To Assign To Figure 2 Sample Send USSD Input State the screenshot is from an earlier version of Brand Mobiliser The Send USSD Input state allows the use of the on Fail follow up This follow up state is only used if there is an internal problem formatting the state text Other follow up states will be used to branch based on the response received back from the subscriber Brand M obiliser Using the USSD States Version 1 3 October 2012 2 3 Send USSD Text This state is used to send a simple text notification to the subscriber The text is sent asa notification that requires no subscriber input other than following a simple accept or confirm This confirmation may be sent back to Channel M anager The following diagram shows an Application Composer view of an application using a Send USSD Text state EF Test USSD Text n APPLICATION DETAILS Kevworos APPLICATION COMPOSER IT Application Actions TEST USSD TEXT SEND USSD TEXT Start Application Delete SAVE LAYOUT REVERT LAYOUT Gridlines Al wv Zoom i00 v A U Name Send USSD Text a0 Hotes Sen
Download Pdf Manuals
Related Search