Versions Compared

Version Old Version 17 New Version Current
Changes made by

Shrab Sahota (Unlicensed)

Shrab Sahota (Unlicensed)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
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 list of options the client can pick to answer a question, these are presented as multiple choice.

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.

File Structure - questions.json

All questions are stored in the questions.json file, each question is made up of two parts;

  • Question

  • Options

Each question is a key-value pair, the question (shown in ”red“) is the reference key, in the example below the key is factor1.

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
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.

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": ""
        }
    }

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, you will note 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 strings you enter or update within “double quotations” marks.

Image Added

Info

Accessing The POEditor App

You 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.

factor2

And which of the following three options is the most important to you?

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

I'll give you some options to choose from. Tell me which one is most important to you when considering contraception.

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

three options

things is most important to you?

factors3vs12

Compared to your first choices, '{{FACTOR_1}}' AND '{{FACTOR_2}}', how important is '{{FACTOR_3}}'?

Options

Methods

for Factor2/2Vs1/3 Questions

Factor 2

Keyword

Translation

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

(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

Factor 3

Making changes

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

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 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 attempt to remove the question directly, as this can damage the file.

Workflow

Overview

Algorithm