Kony MobileFabric Engagement Services QuickStart Guide

Transcription

1 Kony MobileFabric (Building a Sample App - Android) Release 7.0 Document Relevance and Accuracy This document is considered relevant to the Release stated on this title page and the document version stated on the Revision History page. Remember to always view and download the latest document version relevant to the software release you are using by Kony, Inc. All rights reserved 1 of 52

2 Copyright 2015 Kony, Inc. All rights reserved. February, 2016 This document contains information proprietary to Kony, Inc., is bound by the Kony license agreements, and may not be used except in the context of understanding the use and methods of Kony, Inc., software without prior, express, written permission. Kony, Empowering Everywhere, Kony Modeler, and Kony Visualizer are trademarks of Kony, Inc. MobileFabric is a registered trademark of Kony, Inc. Microsoft, the Microsoft logo, Internet Explorer, Windows, and Windows Vista are registered trademarks of Microsoft Corporation. Apple, the Apple logo, itunes, iphone, ipad, OS X, Objective-C, Safari, Apple Pay, Apple Watch, and Xcode are trademarks or registered trademarks of Apple, Inc. Google, the Google logo, Android, and the Android logo are registered trademarks of Google, Inc. Chrome is a trademark of Google, Inc. BlackBerry, PlayBook, Research in Motion, and RIM are registered trademarks of BlackBerry. SAP and SAP Business Suite are registered trademarks of SAP SE in Germany and in several other countries. All other terms, trademarks, or service marks mentioned in this document have been capitalized and are to be considered the property of their respective owners by Kony, Inc. All rights reserved 2 of 52

3 1. Revision History 1. Revision History Date Document Version Description of Modifications/Release 02/27/2016 Document release for Services Quick Start Guide by Kony, Inc. All rights reserved 3 of 52

4 Table of Contents 1. Revision History 3 2. Overview 5 3. Generating the Global Cloud Messaging (GCM) Authorization Code for Android Devices Generating the GCM key for Android devices (using the New Google Console): 6 4. Downloading and Configuring the Engagement Services Demo Client Application Installing the Engagement Demo Client Application on an Android Device Configuring the Engagement Demo Application Using the MobileFabric Engagement Services Console Configuring and SMS Providers Using the MobileFabric Engagement Services Console Subscribing to Push Notifications Using the MobileFabric Engagement Demo Application Sending Adhoc, , SMS and Push Notifications Configuration of a Segment: Sending Adhoc Push Notifications Sending Adhoc Notifications Sending Adhoc SMS Notifications by Kony, Inc. All rights reserved 4 of 52

5 2. Overview 2. Overview This QuickStart Guide provides deep dive instructions to configure, build and run a demo application on an Android device using Kony Studio. In this guide you will download, install and run a sample engagement demo application using the user generated Google Cloud Messaging (GCM) key. The guide will also provide instructions to install and configure the sample engagement application on a separate instance of a Kony engagement server that has been set up for the user. The installed application will subscribe to the engagement server instance and will receive push notifications. This guide assumes the following: a. You have already requested for an instance of an engagement server and have access to it. b. You have already installed the Android SDK and Kony Studio. Below are the steps we will cover in detail: 1. Creating the Google Cloud Messaging (GCM) key that is needed to send push notifications for Android devices. 2. Downloading and configuring the engagement demo client application using Kony Studio. 3. Installing the configured client application on an Android device. 4. Configuring the engagement demo application on the engagement server using the console. 5. Configuring the SMS Provider and SMTP server details on the MobileFabric Engagement Server to send ad hoc notifications. 6. Using the engagement client demo application to subscribe and receive ad hoc , SMS and Push notifications. 7. Sending the ad hoc , SMS and push notification to subscribers via the MobileFabric Engagement Server. This involves creating the segment and sending the ad hoc notifications to individual subscribers and groups of subscribers (segments) by Kony, Inc. All rights reserved 5 of 52

6 3. Generating the Global Cloud Messaging (GCM) Authorization Code for Android Devices 3. Generating the Global Cloud Messaging (GCM) Authorization Code for Android Devices The first step in the installation and configuration of the sample engagement application on an Android device is the generation of the GCM code. Android devices use the GCM code to register with Google and receive notifications. 3.1 Generating the GCM key for Android devices (using the New Google Console): 1. Open the Google developers console window by logging into: 2. Click Create Project to enter the project details. The New Project window appears. 3. Enter the Project name and the Project ID. Note that the project name is used only in the Google console and project ID is used to uniquely identify the project name. Once created the identifier cannot be changed by Kony, Inc. All rights reserved 6 of 52

7 3. Generating the Global Cloud Messaging (GCM) Authorization Code for Android Devices 4. Click Create to complete the creation of the project. 5. Next, a page appears that displays your project ID and project number, for example Make a note of the project number, as this will be used later. The API Manager page appears. 6. On API Manager page, in the Overview section, under Mobile APIs header click Google Cloud Messaging by Kony, Inc. All rights reserved 7 of 52

8 3. Generating the Global Cloud Messaging (GCM) Authorization Code for Android Devices The Enable API button appears. 7. Click the Enable API button by Kony, Inc. All rights reserved 8 of 52

9 3. Generating the Global Cloud Messaging (GCM) Authorization Code for Android Devices 8. The system displays the confirmation message that enabling is in progress. After enabling, the system displays the message that the API is enabled but you need to create your credentials to use this API in your project. 9. Click Go to Credentials. The Credentials section appears by Kony, Inc. All rights reserved 9 of 52

10 3. Generating the Global Cloud Messaging (GCM) Authorization Code for Android Devices 10. Under Add credentials to your projectheader, click API Key. The Create a new key window appears. 11. Click the Server Key button to create the server key that is needed for the GCM key. The Credentials section appears by Kony, Inc. All rights reserved 10 of 52

11 3. Generating the Global Cloud Messaging (GCM) Authorization Code for Android Devices 12. Click the Create button. The API key window appears. The API Key window displays the API key. 13. Click OK to continue. 14. Copy the API key that is shown under Credentials section. This API key will be used to configure the application using the MobileFabric Engagement Server console by Kony, Inc. All rights reserved 11 of 52

12 3. Generating the Global Cloud Messaging (GCM) Authorization Code for Android Devices 2015 by Kony, Inc. All rights reserved 12 of 52

13 4. Downloading and Configuring the Engagement Services Demo Client Application 4. Downloading and Configuring the Engagement Services Demo Client Application This section explains how to download the engagement demo application from GitHub and configure the app using Kony Studio for Android devices. We assume that Android SDK and Kony Studio IDE are installed. To download and configure the engagement demo client application, follow these steps: 1. Connect to the URL where the application is located. Click Download ZIP on the right side bottom and save the zip file on your local hard drive by Kony, Inc. All rights reserved 13 of 52

14 4. Downloading and Configuring the Engagement Services Demo Client Application 2. Open Kony Studio and import the project into your workspace. 3. Choose Existing Projects into Workspace, shown below.click Next by Kony, Inc. All rights reserved 14 of 52

15 4. Downloading and Configuring the Engagement Services Demo Client Application 4. Click the Browse option in the screen below to select the project to be imported. 5. Select the KMSAppfrom the installed folder and click Open to import the project into the workspace. 6. Once the project is imported into the workspace, make sure that application is opened in the Kony Perspective of Studio. In the Applications browser, open the configproperties.js file under the modules/js folder. The data in the file should be as below: 2015 by Kony, Inc. All rights reserved 15 of 52

16 4. Downloading and Configuring the Engagement Services Demo Client Application kmsserverurl : This is the URL of where the engagement server is deployed and running. senderid: Sender Id is generated when the GCM key is generated in the earlier step. appid: This application Id is generated on the engagement server console when the engagement application is deployed on the engagementserver. The appid should be copied from the engagement server console and pasted into this file. 7. Save the file. 8. Right-click the KMSApp application and select Properties as shown below, to display all the existing application properties by Kony, Inc. All rights reserved 16 of 52

17 4. Downloading and Configuring the Engagement Services Demo Client Application 9. Since the application will be installed on an Android device, in the Application Properties dialog, choose Native and Android options. In the SDK Versions section, choose the Target version and Maximum version for which the binary will need to be generated. 10. Click the Kony Server Details tab, as shown in the screen below, and select the server instance where the engagement demo application is installed. Click Finish by Kony, Inc. All rights reserved 17 of 52

18 4. Downloading and Configuring the Engagement Services Demo Client Application 11. Right-click the KMSApp in the Applications browser of Studio and click Build. Choose the Clean and Build option to build the application by Kony, Inc. All rights reserved 18 of 52

19 4. Downloading and Configuring the Engagement Services Demo Client Application 12. After the build is successful, right-click the KMSApp project and click Publish to publish the application to the previously configured server by Kony, Inc. All rights reserved 19 of 52

20 5. Installing the Engagement Demo Client Application on an Android Device 5. Installing the Engagement Demo Client Application on an Android Device This section explains how to install a configured engagement application to Android devices. Follow these steps: 1. Connect the android device using a USB cable to the computer where the application to be installed is located. 2. In the Kony perspective of the IDE, the Devices option is seen, under the KMS Application Emulators on the left. 3. To install the application on an Android device, right-click the Devices and select Get Connect Devices via USB by Kony, Inc. All rights reserved 20 of 52

21 5. Installing the Engagement Demo Client Application on an Android Device 4. This will connect to the android device and the device id is displayed. 5. Right-click the device id by Kony, Inc. All rights reserved 21 of 52

22 5. Installing the Engagement Demo Client Application on an Android Device 6. Click the Build and Launch option to deploy and launch the application on the device by Kony, Inc. All rights reserved 22 of 52

23 6. Configuring the Engagement Demo Application Using the MobileFabric Engagement Services Console 6. Configuring the Engagement Demo Application Using the MobileFabric Engagement Services Console This section explains how to provision demo application using the MobileFabric Engagement Services console. 1. Type manage.kony.com in the browser to enter the and the password. Click Sign in to display the information of the provisioned cloud. 2. Log in with the and password that were used to provision the account. Click Engagement Services under the Administration section to launch the console by Kony, Inc. All rights reserved 23 of 52

24 6. Configuring the Engagement Demo Application Using the MobileFabric Engagement Services Console 3. Click Apps under the Overview section on the left to display all the configured applications and to configure new applications. 4. Click the Add New App button next to the Apps you want to add. Enter the application name, application Id and App category information (required attributes). Note that the application id should be the same as the id that was entered in the configuration.js file,explained earlier. 5. Click on Settings tab and choose Android to display the Android screen. Enter the GCM Authorization Key that was generated in the earlier in this guide (we asked you to remember). Google GCM key is required to send push notifications to Apps. Click on Test Connectivity with the Cloud to be able to test the GCM key that was entered by Kony, Inc. All rights reserved 24 of 52

25 6. Configuring the Engagement Demo Application Using the MobileFabric Engagement Services Console 6. If the GM key entered is correct, a notification dialog like below is shown. Click on OK by Kony, Inc. All rights reserved 25 of 52

26 6. Configuring the Engagement Demo Application Using the MobileFabric Engagement Services Console 7. After the GCM key is entered and successfully tested, click Save to save the application. 8. Once the application is successfully saved, it will be seen in the Apps section. In the example below, the new application that was added was TestApp. As you can see, this application is currently in the Unpublished state and will need to be published so that itr can be invoked by the client application by Kony, Inc. All rights reserved 26 of 52

27 6. Configuring the Engagement Demo Application Using the MobileFabric Engagement Services Console 9. Click on the hamburger menu next to the application and choose Publish to publish the application. 10. Next when prompted with a question if you would like the application to be published, click on Yes by Kony, Inc. All rights reserved 27 of 52

28 6. Configuring the Engagement Demo Application Using the MobileFabric Engagement Services Console 11. Once the application is successfully published you will see the screen below by Kony, Inc. All rights reserved 28 of 52

29 7. Configuring and SMS Providers Using the MobileFabric Engagement Services Console 7. Configuring and SMS Providers Using the MobileFabric Engagement Services Console This section explains how to configure and SMS providers using the MobileFabric Engagement Services console so you can send out and SMS notifications to audience members and subscribers. Follow these steps: 1. Type manage.kony.com in the browser to display the login screen. Click Sign in to display the information of the provisioned cloud. 2. Login with the and password that were used to provision the account. This will display the screen with the provisioned cloud name. Click Engagement Services under the Administration section to launch the Engagement Services console by Kony, Inc. All rights reserved 29 of 52

30 7. Configuring and SMS Providers Using the MobileFabric Engagement Services Console 3. Click Configuration under the Settings section on the left side of the screen. From the tabs, click Configuration. Please choose the correct protocol and security mode for the configuration. Also note that host name, port, default sender Id are required. Click Save to save the configuration. 4. Click the SMS Configuration tab next. Chose Twilio as the SMS provider. Note that you will need to sign up with Twilio for a free trial or a paid account so that the Account SID, Auth Token, Account Name and Host URL are provided.the SMS setting screens can vary based on the SMS provider chosen. The screen below assumes that Twilio was chosen as service provider by Kony, Inc. All rights reserved 30 of 52

31 7. Configuring and SMS Providers Using the MobileFabric Engagement Services Console 2015 by Kony, Inc. All rights reserved 31 of 52

32 8. Subscribing to Push Notifications Using the MobileFabric Engagement Demo Application 8. Subscribing to Push Notifications Using the MobileFabric Engagement Demo Application This section explains subscription details for ad hoc push, and SMS notifications using the application that is installed on the Android device. The application displays the screens that are used to subscribe to the notifications, after the login is complete, as seen in the earlier section of this guide. Follow these steps: 1. Launch the engagement demo that was installed earlier on the Android device. 2. The first screen of the application prompts the user to accept push notifications. Click Ok to be able to receive push notifications by Kony, Inc. All rights reserved 32 of 52

33 8. Subscribing to Push Notifications Using the MobileFabric Engagement Demo Application 3. The next screen is a request to receive push notifications. Click Ok to be able to receive push notifications by Kony, Inc. All rights reserved 33 of 52

34 8. Subscribing to Push Notifications Using the MobileFabric Engagement Demo Application 4. The next screen prompts the user to enter the URL of the MobileFabric Engagement Server for which the user has been provisioned on the cloud. Enter the URL and click Done to move to next screen by Kony, Inc. All rights reserved 34 of 52

35 8. Subscribing to Push Notifications Using the MobileFabric Engagement Demo Application 5. Next, enter profile information like first name, last name, address, mobile number, country and the state if the country chosen is USA. This information is used to create the user and the subscription in the MobileFabric Engagement Server.. Click Done. Note: You can also import users using a CSV file through the Kony MobileFabric Engagement Services Admin console by Kony, Inc. All rights reserved 35 of 52

36 8. Subscribing to Push Notifications Using the MobileFabric Engagement Demo Application 6. The next screen allows the user to subscribe to the various types of notifications like push, , and SMS. Subscribe to all the type of notifications by choosing all. Click Done to create a subscription on the MobileFabric Engagement Server for all the selected types of notifications by Kony, Inc. All rights reserved 36 of 52

37 8. Subscribing to Push Notifications Using the MobileFabric Engagement Demo Application 2015 by Kony, Inc. All rights reserved 37 of 52

38 9. Sending Adhoc, , SMS and Push Notifications Services QuickStart Guide 9. Sending Adhoc, , SMS and Push Notifications This section explains how to set up the demo application on the Android device to receive ad hoc push, and SMS messages after the subscription is complete. Details of configuring a segment are also provided. 9.1 Configuration of a Segment: This section describes the execution steps needed to create a segment, which will then be used to send ad hoc , SMS and push notifications. 1. Click the Segments that are contained in the Engagement section on left. Click + Add Segment to display the screen to add a new segment by Kony, Inc. All rights reserved 38 of 52

39 9. Sending Adhoc, , SMS and Push Notifications Services QuickStart Guide 2. Enter the name of the segment. The Owner and Created Date are automatically populated. 3. Under the Define Conditions section, for the condition No.1, choose First Name for the Audience Member Attribute, Contains for the Operator and type the first name of the user in the Value box. In the sample below the first name is Muralidhar. You will see the Users column gets updated with the number of the users that match the condition. Note: Condition No. is a reference to the audience member attributes added in the grid that help to define conditional logic in the Segment Definition area by Kony, Inc. All rights reserved 39 of 52

40 9. Sending Adhoc, , SMS and Push Notifications Services QuickStart Guide 4. Select the required condition from the drop-down list to use for segment definition. 5. If you select the execute condition as Match all conditions or Match any condition, then based on the fulfilled condition(s), the system inserts the number of users under the Users column. 6. If you select the executive condition as Advanced, then five logic buttons appears. Based on your requirement, select the logical operators. 7. Click the Validate button. The system validates whether the conditional logic follows the BODMAS (Brackets Of Division Multiplication Addition Subtraction) rule of selection. System displays the confirmation message if the logic is correct. It states that the validation is successful. Click OK to continue. System displays the View Segment screen. The number of added users appears under the Users column by Kony, Inc. All rights reserved 40 of 52

41 9. Sending Adhoc, , SMS and Push Notifications Services QuickStart Guide 8. Click Save to save the segment. The system adds the new segment into the segments grid on Segments screen. System displays the confirmation message, informing that segment is saved successfully. 9.2 Sending Adhoc Push Notifications The ability to send push notifications is one of the most important features of engagement services. The push message feature lets you configure and send push messages based on the preferences and personalization attributes for targeted subscribers or segments. Push messages are sent only to subscribed apps that are active and installed on mobile devices Sending Adhoc Push Notifications to Subscribers This section describes how to configure push notifications to be sent to the individual subscribers. 1. Click Adhoc under the Engagement section on the left side of the page. The Push Message option selects by default in the Channel Type on the right side of the page. In the Published Applications dropdown of the Associated Applications section, choose the KMSDemo application by Kony, Inc. All rights reserved 41 of 52

42 9. Sending Adhoc, , SMS and Push Notifications Services QuickStart Guide 2. In Define Message Target section, choose Subscribers as Message Audience. This will show the list of the subscribers that who currently subscribed to the KMSDemo application. Select the subscribers to whom the push message will be sent. 3. In the Push Message Section, enter the Message Title and the push message in the Message Box. If required, select the personalization attributes. Choose the option Now to have the notification immediately sent. Click Send to have the push message immediately delivered by Kony, Inc. All rights reserved 42 of 52

43 9. Sending Adhoc, , SMS and Push Notifications Services QuickStart Guide 4. If you would like to schedule the message delivery at a later day and time, choose the Later option in the Set Start and Expiry Time section.after the day and time are chosen, enter the Start Date and Time and Expiry Data and Time. click Schedule Notification for the message delivery to be scheduled for later by Kony, Inc. All rights reserved 43 of 52

44 9. Sending Adhoc, , SMS and Push Notifications Services QuickStart Guide Sending Adhoc Push Notifications to Segments This section describes how to configure push notifications to be sent to the segments (which is a group of subscribers). 1. Click Message Audience option as Segment in the Define Message Target section. This will allow you to add segments associated to this application. Click on Add Segments to add the segments to which the message will be sent to by Kony, Inc. All rights reserved 44 of 52

45 9. Sending Adhoc, , SMS and Push Notifications Services QuickStart Guide 2. In the Add Segment(s) to Message screen, select the segment from the Unassigned section and click the > (greater than) button to add the segment to the Assigned section. Click Save to save the segment. 3. In the Selection Criteria drop down, select the required condition from the drop-down list to use for segment definition. If you select the execute condition as Match all conditions or Match any condition, then based on the fulfilled condition(s), the system inserts the number of users under the Users column by Kony, Inc. All rights reserved 45 of 52

46 9. Sending Adhoc, , SMS and Push Notifications Services QuickStart Guide 4. In the Message Section, enter the Title and Message for the push notification to be sent. Choose Now in the Set Time section for the message to be sent immediately. Click Send. 5. If you would like to schedule the message delivery at a later day and time, choose the Later option in the Set Start and Expiry Time section.after the day and time are chosen, enter the Start Date and Time and Expiry Data and Time. click Schedule Notification for the message delivary to be scheduled for later by Kony, Inc. All rights reserved 46 of 52

47 9. Sending Adhoc, , SMS and Push Notifications Services QuickStart Guide 9.3 Sending Adhoc Notifications The Message feature allows you to configure and send messages based on the preferences and personalization attributes for the targeted audience members or segments Sending Adhoc Notifications to Audience Members 1. Click Adhoc under the Engagement section on the left side of the page. This will display the page as below. Select Message option in the Channel Type on the right side of the page by Kony, Inc. All rights reserved 47 of 52

48 9. Sending Adhoc, , SMS and Push Notifications Services QuickStart Guide 2. In the Define Message Target section, there is an option to choose Users or predefined Segments in the TO, CC and BCC sections of the . Choose the user to whom the notifications are to be sent. 3. Type the Sender Name, Sender information in the corresponding fields at the end of Defining Message Target section. Note: Choose the Send to Me option if the sender needs to be copied on the or the Send Copy to Others option if a copy of the needs to be sent to multiple addresses. 4. Next, in the Message section, compose a new message along with the subject as shown below. Select Now in the Set Time section and click Send by Kony, Inc. All rights reserved 48 of 52

49 9. Sending Adhoc, , SMS and Push Notifications Services QuickStart Guide 5. If you would like to schedule the message delivery at a later day and time, choose the Later option in the Set Start and Expiry Time section.after the day and time are chosen, enter the Start Date and Time and Expiry Data and Time. Click Schedule Notification for the message delivery to be scheduled for later by Kony, Inc. All rights reserved 49 of 52

50 9. Sending Adhoc, , SMS and Push Notifications Services QuickStart Guide Sending Adhoc Notifications to Segments The steps involved to send the adhoc notifications are similar to sending adhoc push notifications to segments. 9.4 Sending Adhoc SMS Notifications The SMS message feature allows you to configure and send SMS messages based on the preferences and personalization attributes for the targeted audience members or segments. 1. Click Adhoc under Engagement section on the left side of the page. Select the SMS Message option in the Channel Type on the right side of the page by Kony, Inc. All rights reserved 50 of 52

51 9. Sending Adhoc, , SMS and Push Notifications Services QuickStart Guide 2. In the Define Message Target section, choose the User option. Select the user to send the text message to from the list view. 3. In the Message section, type the message in the message box and Set Time to Now. Click Send to send the notification by Kony, Inc. All rights reserved 51 of 52

52 9. Sending Adhoc, , SMS and Push Notifications Services QuickStart Guide 4. Choose the Later option in the Set Time section to schedule the day and time when the SMS notification will be sent. After the day and time are chosen, click Schedule Notification to schedule the notification to be sent at a later day and time by Kony, Inc. All rights reserved 52 of 52