| Note |
|---|
Please note the order in which questions are asked during a user session is controlled by the algorithm.json file, it is not the order in which the questions are listed in the questions.json file. |
| Info |
|---|
DEFINITIONS & TERMINOLOGIES Options: Refers to the list of options related to a specific question that the client can pick to answer a question. Keyword: This refrens to the question, in the example we provide below this is “factor1”. |
Please note, C4C is built using POEditor which facilities language translations, this is required even if you do not use this option, to learn more about the C4C multilingual feature, click here.
Work Flow
All questions are stored in the questions.json file, please note| Info |
|---|
DEFINITIONS & TERMINOLOGIES Keyword: The data for this field can be found in the POEditor App, each question has a unique keyword. Options: These fields are the relevant answers available to the user to answer the question being asked. A question will always have a minimum of two options. |
| Note |
|---|
Please note the questions.json file is just a repository of all questions, the order in which questions are listed in the file is irrelevant as the |
algorthm.json file |
supplies the logic |
/order in which questions are asked |
The questions.json file will make a call to the POEditor file to extract and present the human-readable format of the question in ChatBot or WebApp.
. |
Please note you need access to the POEditor App in order to view all Keywords and Options used in the questions.json file. You can request access to the POEditor from your C4C Tecnical Administrator.
Click /wiki/spaces/DHM/pages/8814662 for more details of how POEditor is used with C4C.
JSON Question Structure
JSON Code Example 1 - Nested Keywords And Value
| Code Block |
|---|
"factor1": {
"options": {
"Effectiveness": "",
"Privacy": "",
"FewSideEffects": ""
}
} |
Question Lable (1)
Each question is made up of a two key-value pair, the question is the reference key, and in the example below the key is “factor1”. This label is obtained from the relevant question in the POEditor App, as shown in the screenshot below.
Option Labels (2)
The relevant options labels (2) are also obtained In this example, you will note the first keyword ‘factor1’ is followed by the nested keyword ‘options’ which subsequently lists the three values; Effectiveness, Privacy, FewSideEffects.
The question.json file makes a call to the POEditor App to return the human-readable text of the questions and answers that appear on the ChatBot or WebApp UI.
Below is a screenshot from the POEditor App, please note you will only need to enter the last part of the string as shown in the code snippet abovenote the keyword ‘factor1’ is paired with the text in the right column, this is the text that is displayed to the user on the ChatBot or WebApp.
| Note |
|---|
Please ensure you maintain the json file structure and pay special attention to keep all labels strings you enter or update enclosed in “double quotations marks”. |
within “double quotations” marks. |
| Info |
|---|
Accessing The POEditor AppYou will need to request access to the POEditor from your C4C Tecnical Administrator. Click /wiki/spaces/DHM/pages/8814662 for more details of how to use the POEditor |
Questions
The algorithm.json file controls which questions are presented to the user based on their previous answers, however, the overall logic/order of the questions are shown in the table below.
Please note the actual text shown here may be different to the text you see in on the POEditor App.
Keyword (POEditor App) | Value (Actual text displayed on the ChatBot or WebApp) |
|---|---|
gender | How do you identify yourself? It helps me to better meet your needs. |
futurePregnancy | Do you want to be pregnant in the future? |
breastFeeding | Are you breastfeeding a baby less than 6 months old? |
age | How old are you? |
factor1 | Thanks for that basic information about yourself! Now I want to ask you a few more questions to understand what kind of contraception might be best for you… |
factor2 | I'll ask these questions a few more times to really understand what you want. For example, if you might have trouble remembering to use your contraceptive on a daily basis, you might want a method that you can "Get and Forget"!… |
factors2vs1 | Compared to your first choice, '{{FACTOR_1}}', how important is your second choice, '{{FACTOR_2}}'? |
factor3 | Finally, which of the following things is most important to you? |
factors3vs12 | Compared to your first choices, '{{FACTOR_1}}' AND '{{FACTOR_2}}', how important is '{{FACTOR_3}}'? |
Options for Factor2/2Vs1/3 Questions
Keyword (POEditor App) | Value (Actual text displayed on the ChatBot or WebApp) |
|---|---|
EasyToStop | Easy to stop using |
EasyToForget | I get it and I forget it! |
Effectiveness | Efficiency |
Privacy | Discretion |
FewSideEffects | Few side effects |
SelfAdministered | Self-administered |
Making changes
| Info |
|---|
Modifications should only be made by a qualified developer. |
| Note |
|---|
Never attempt to delete a question or options directly yourself, please contact the C4C Technical administrator to delete items. |
Adding new questions/options
This file is intended to be modified by a developer. If a new question or option is required please contact your ‘C4C Technical Administrator’ and provide the name of the question and options. In case the option is for an existing question, indicate the question (keyword) in which the new option will be located.
Remove questions/options
If a question or option needs to be removed, contact the C4C technical administrator. Provide the keyword or name of the element to remove. Do not attempt to remove the question directly, as this can damage the file.