Lumi Say code structure

Created: - Updated:

This article covers these topics:

Introduction

This article describes the code structure used by Lumi Say. Please refer to the code editor for details of viewing your and editing your survey's code.

Survey code

The top-most item is the survey itself; clicking this allows you to view and edit the code for the survey as a whole.

Warning: when editing the code for the survey, you can change the survey name and description, but do not change the survey ID.

The <survey> tag describes a survey, and contains a list of questions and items belonging to that survey.

Survey attributes

Attribute

Description

id

The ID of the survey, managed by the system.

name

The survey name.

status

The survey status (see project status).

description

A free text description of the survey.

order

Indicates the folder's question order; can be fixed or randomized (see working with folders).

start_publish

The time at which this survey should go live, expressed in the following format: "dd.MM.yyyy HH.mm.ss".

stop_publish

The time at which this survey should go offline (i.e. not be live anymore).

Survey Example

<survey id="1" name="Consumption survey" start_publish="25.02.2012 16:34:16" stop_publish="25.06.2012 16:34:16" wave="1">                          
    <item id="1"/>
    <item id="2"/>
    <folder name="My folder of randomized questions" alias="folder1" order="randomize">
        <item id="3"/>
        <item id="4"/>
        <item id="5"/>
    </folder>
    <item id="6"/>
</survey>

For further information, see project properties.

Folder code

For more information on each attribute, see using folders in script.

Question code

The left-hand pane in the code editor shows alias for each question. When you click a question alias, you can edit any of the question details in the right-hand pane.

Note: if you change the question text, bear in mind the question length, and how this might appear on a mobile device. For a guaranteed result, we have set a limit on the question text field (see adding a question) that is suitable for all platforms.

You can edit the choice texts, and any of their attributes, except for the IDs.

<question type="...">

A question is an abstract base type used for questions inside a survey.

Attribute

Description

id

The question ID. This must be an integer value and is usually managed by the system.

alias

A text string that can be used as an alternate ID for the question.

type

Specifies the question type, for example text for a text question or info for an information screen.

text

The question text shown to the user.

Choice code

<choice>

Defines a choice in a single-choice or multi-choice question.

Attribute

Description

id

The numerical ID for this choice.

label

The choice's label text. If this attribute is not set, but the text attribute is, then the compiler will move the text value to the label.

text

Optional text that can be used to give more detailed text for a choice. (Optional)

alias

An alias (alternative labe) for the choice. (Optional)

icon

The resource ID of an image that will be displayed beside this choice. (Optional)

selected

A flag that controls whether the choice is initially selected or not. The default value is false.

anchored

A flag that controls whether the position of this choice should be fixed even if the choice order is randomized. (Optional)

exclusive

A flag that controls whether this choice can be combined with other choices. Applies only on choices in multiple-choice questions. (Optional)

Adding comments to your script

You can add comments to your script, in order to help you keep track of the survey logic, and to make it easier for your co-workers to understand your script. You can add in comments (notes) to any part of the script using the tag <note>.

<note> this is a comment </note>