| 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: (Answers) A Refers to the list of options related to a specific question that the client can pick to answer a question, these are presented as multiple choice. 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, each question is made up of two parts;
Question
Options
please note the order in which questions are listed in the questions.json file is not important as the logic for which questions are asked in which order is controlled by the algorithm.json file.
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.
Question Structure
| 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 (1) factor1“factor1”. This label is obtained from the relevant question that can be found in the POEditor app, as shown below.
Option Labels (2)
The relevant options label labels (2) are also obtained from the POEditor app, please note you will only need to enter the last part of the label string as shown below;
The options are also key-value pairs, in the example below the keys are Effectiveness, Privacy and FewSideEffects.
"factor1": {
"options": {
"Effectiveness": "",
"Privacy": "",
"FewSideEffects": ""
}
}
In the example below, the key used for the question is "factor1" the value is the text that will appear as the question.
KEY
VALUE
factor1
I'll give you some options to choose from. Tell me which one is most important to you when considering contraception.
has 3 options: "Effectiveness" (Efficient method), "Privacy" (Discrete method), and "FewSideEffects" (Method with few side effects).
The file is written using JSON notation. To learn more about the basic notation used in JSON, click here.
The following tables present the terms (keywords) available for the algorithm file:
Questions
Keyword
Translation
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
I'll give you some options to choose from. Tell me which one is most important to you when considering contraception.
factor2
And which of the following three options is the most important to you?
factors2vs1
Compared to '{{FACTOR_1}}', how important is '{{FACTOR_2}}'?
factor3
Finally, which of the following three options is most important to you?
factors3vs12
Compared to '{{FACTOR_1}}' AND '{{FACTOR_2}}', how important is '{{FACTOR_3}}'?
Options
Methods
Keyword
Translation
Sterilization
Sterilization
IUD
IUD
IUD
IUD
Implant
Implant
Injectables
Injectables
POP
Progesterone Pills
COP
Combined Pills
EC
EC
Condoms
Condoms
Cyclebeads
Cyclebeads
Factor 1
Keyword
Translation
Effectiveness
Efficient method
Privacy
Discrete method
FewSideEffects
Method with few side effects
Factor 2
Keyword
Translation
EasyToStop
Easy to stop using
EasyToForget
I get it and I forget it!
Effectiveness
Efficiency
Privacy
Discretion
FewSideEffects
Few side effects
SelfAdministered
Self-administered
Factor 3
Keyword
Translation
EasyToStop
Easy to stop using
EasyToForget
I get it and I forget it!
Effectiveness
Efficiency
Privacy
Discretion
FewSideEffects
Few side effects
SelfAdministered
Self-administered
in the code snippet above.
| Note |
|---|
Please ensure you maintain the json file structure and pay attention to keep all labels you enter or update enclosed in “double quotations marks”. |
Changes
Adding new questions/options
This file is intended to be modified by a developer. If a new question or option is required contact the C4C technical administrator and provides the names of the questions 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 intend to remove the question directly, as this can damage the file.