Table of Content. CLOUDCHERRY Android SDK Manual

Transcription

1 Table of Content 1. Introduction: cloudcherry-android-sdk 2 2. Capabilities 2 3. Setup 2 4. How to create static token 3 5. Initialize SDK 5 6. How to trigger the SDK? 5 7. How to setup custom legends for NPS Question 6 8. How to set up conditional text 8 9. How to set up conditional flow How to set pre-fills in the SDK How to setup callback to capture analytics data Dynamic Token Generation 14 Configuring Survey token during creation Style Configurations 15 1 of 17

2 1. Introduction: cloudcherry-android-sdk An open-source library that helps you integrate Cloudcherry into your Android app 2. Capabilities 1. Trigger pre-existing surveys and render it on Android phone. 2. Handles visual attributes set up on Cloudcherry dashboard, such as 1. Welcome & Thank you message 2. Company logo 3. Header and Footer color 4. Type face and Text color 3. Dynamic token creation 1. Single/multi use 2. Handles Location 4. Handles underlying question types 1. Single Response 1. Smile Rating 2. Star Rating 3. Range 1. Scale(NPS) 4. Custom Text icons 2. Multiple Response 3. Text Entry 1. Multi-line Text Box 5. Pre-fills 1. Handles pre-fills questions set up on Cloucherry dashboard 2. Configures pre-fill questions locally -using Question Tags as the reference. 6. Handles partial responses. 7. Provides in-app survey analytics. 3. Setup We support API 14 (4.0) and above, and we recommend you use a compilesdkversion of of 17

3 4. How to create static token 1. Login to your Cloudcherry account to access your dashboard 2. Click on Token Management option on the side menu. 3 of 17

4 3. Click on Create a Token button to open token creation window. 4. On token creation window fill the necessary fields and click on Add button. Best Practise: Always create static tokens with unlimited usage(by setting Number of uses field value to -1.), unless you are using it for limited users. For single use per person, you can refer to section 12 - How to create dynamic tokens. 4 of 17

5 5. Initialize SDK You can initialize the SDK by using the underlying code in the oncreate() method of your application class: SurveyCC.initialise(this, "PK-3057"); Note: Here PK-3057 is the static token obtained from the Cloudcherry dashboard. 6. How to trigger the SDK? This is straight forward. All you need to do is call the underlying method. SurveyCC.getInstance().trigger(); Example of triggered survey within the app: 5 of 17

6 7. How to setup custom legends for NPS Question 1. Click on Questionnaire on the side menu. 2. Create an NPS (Net Promoter Score) type question by clicking on the Add Question button. 3. Click on the ACTION button to get a list of edit options. Click 4. Click on Modify option to open Question Edit window. Click 6 of 17

7 5. Now fill in the Optional Legend field and click on Update button to set custom legends for min and max values. Click Example of Custom Legend within the app: 7 of 17

8 8. How to set up conditional text Conditional text is used to display different question text for a particular question based on priorly answered questions. 1. Click on Questionnaire option on the side menu. 2. Click on the ACTION button of a question which needs to display conditional text 3. Click on Conditional Display Texts option to open Conditional Display Text window. Click 8 of 17

9 4. Click on Create to add a Conditional Question Text 5. Click on Set Conditions to define the condition for the Question Text. 6. At last click on Save button to save your changes. Click 9 of 17

10 9. How to set up conditional flow Conditional flow is used to display different questions based on priorly answered questions. 1. Click on Questionnaire option on the side menu. 2. Click on the ACTION button of a question which needs to be displayed or hidden based on certain conditions. 3. Click on Modify option to open Question Edit window. 4. On the Question Edit window click on Advanced Options which opens up the advanced option list. 5. Mark Make this a conditional question option as checked and set the required conditions for the questions whose answer decides whether to display or hide this question. 10 of 17

11 6. Now click on Add Condition button to save the condition that you have set. You can also set multiple conditions on the same or different questions. 7. At last click on Update button at the bottom of the window. 11 of 17

12 10. How to set pre-fills in the SDK Pre-fill answers can be set before triggering the SDK via a HashMap. HashMap<String, Object> aanswers = new HashMap<>(); aanswers.put("prefillmobile", "988*******"); aanswers.put("prefill ", "abc@gmail.com"); SurveyCC.getInstance().setPreFill(aAnswers); SurveyCC.getInstance().trigger(); Note: Here prefillmobile is a Tags created on the Cloudcherry Dashboard. This Tag is used as a filter to pre-fill answers. 1. In the dashboard click on Questionnaire option on the side menu. 2. Click on the ACTION button of a question for which you want to pre-fill answers in the SDK. 3. Click on Modify option to open Question Edit window. 4. On the Question Edit window click on Advanced Options which opens up the advanced option list. 5. Add the Tag(Ex: prefillmobile) that acts as a filter to pre-fill answer while submitting answer to server. 6. At last click on Update button at the bottom of the window. 12 of 17

13 11. How to setup callback to capture analytics data Register analytics listener in the oncreate() method of your protected void oncreate(bundle savedinstancestate) { super.oncreate(savedinstancestate); SurveyCC.getInstance().setAnalyticsListener(this); } Un-Register analytics listener in the ondestroy() method of your protected void ondestroy() { super.ondestroy(); SurveyCC.getInstance().removeAnalyticsListener(this); } 13 of 17

14 12. Dynamic Token Generation Dynamic-tokens can be created while initialising the SDK using the underlying syntax. SurveyCC.initialise(this, "Cloudcherry Username", "Cloudcherry Password, SurveyToken itokenconfig); Configuring Survey token during creation SurveyToken class constructor takes two parameters. * validuses - Number of times the generated token can be used. * location - Location Tag to filter questions based on location If you want to configure SDK to capture partial response and create a single use token then pass validuses = 1 If you want to create SurveyToken for unlimited usage then pass validuses = -1 If configuration parameters are not set, then the default value for validuses = -1 and location = null. Note: 1. Enabling partial response ensures that the user response is collected after each question and does not wait until the user hits submit button at the end of the survey. This is ideal for mobile app users, as the users may be interrupted by phone calls. 2. Creating unlimited use token is not recommended. This creates junk tokens in your account. SurveyToken atokenconfig = new SurveyToken(1, mobile"); public class SampleAppApplication extends Application public void oncreate() { super.oncreate(); SurveyToken atokenconfig = new SurveyToken(1, "mobile"); SurveyCC.initialise(this, "abcd", "test12345", atokenconfig); } } 14 of 17

15 13. Style Configurations 1. Custom Text Icon Question: Style for Custom Text Icon options can be configured by using setcustomtextstyle() method. Custom text style has two options 1. CustomTextStyle.STYLE_CIRCLE (default) 2. CustomTextStyle.STYLE_RECTANGLE. Example is shown below: SurveyCC.getInstance().setCustomTextStyle(CustomTextStyle.STYLE_CIRCLE); 15 of 17

16 CLOUDCHERRY 2. Star Rating Question: Style for Star Rating Question can be configured by using setstarratingselector() method. Star Rating uses yellow star asset by default. To use your own assets for the star, please provide ArrayList of resource IDs of your selector drawables with selected and unselected state while initialising SDK. Example is shown below: SurveyCC.getInstance().setStarRatingSelector(aStarRatingSelector); Example for star rating selector is shown below: <?xml version="1.0" encoding="utf-8"?> <selector xmlns:android=" <item android:state_selected="false" /> <item android:state_selected="true" /> <item /> </selector> 16 of 17

17 CLOUDCHERRY 3. Smiley Rating Question: Style for Smiley Rating Question can be configured by using setsmileyratingselector() method. Smiley Rating uses emoji unicode by default. To use your own assets, please provide ArrayList of resource IDs of your selector drawables with checked and unchecked state while initialising SDK. Example is shown below: SurveyCC.getInstance().setSmileyRatingSelector(aSmileyRatingSelector); Example for smiley rating selector is shown below: <?xml version="1.0" encoding="utf-8"?> <selector xmlns:android=" <item android:state_checked="false" /> <item android:state_checked="true" /> <item /> </selector> Thank you. 17 of 17