Versions Compared

Version Old Version 25 New Version 26
Changes made by

Rodolfo Melia

Shrab Sahota

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

questions

algorthm.json file

is not important as

supplies the logic

for

/order in 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

.

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 here for more details of how POEditor is used with C4C.

JSON Question Structure

JSON Code Example 1

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 from the POEditor App, please note you will only need to enter the last part of the string as shown in the code snippet aboveIn 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 question and answers that appear on the ChatBot or WebApp.

The strings for the keywords are created in the POEditor App, if you do not already have access to the POEditor, please contact your C4C Technical Administrator.

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

Image Removed

Multilingual

Questions

quotations” marks.

Image Added

Info

Accessing The POEditor App

You will need to request access to the POEditor from your C4C Tecnical Administrator.

Click here for more details of how to use the POEditor

Questions

The sequence of questions is predefined by the algorthm.json file, the table below shows the order in which questions are presented in the ChatBot or WebApp.

Keyword (PO editor term)

Sample EN full text
(actual text will be retrieved from PO editor)

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 for Factor2/2Vs1/3 Questions

Keyword (PO editor term)

Sample EN full text
(actual text will be retrieved from PO editor)

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.

Workflow

Overview

Algorithm