Show TOC

Background documentationOffline Content of the Question Library

 

When you export the content of the question library, you do this in two steps: On the Questions tab and on the Sections tab. Therefore, you have two separate files for questions (including answer options) and sections.

Questions: Content of an Exported XML File

For questions, the table lists the following data:

  • Under line:

    • “Q” — Question

    • “QT” — Translation of a question

    • “A” — Possible answer to a question (only available for single-answer and multiple-answer questions)

    • “AT” — Translation of a possible answer to a question (only available for single-answer and multiple-answer questions)

  • Under name:

    Name specified for the question

  • Under id:

    Numerical identifier of the question and the answer options belonging to a question

  • Under language_code:

    ISO Code for the language in which the text exists

  • Under text:

    Question text (visible to recipients and translatable)

  • Under explanation:

    Explanatory text for the question (visible to recipients, can be translated)

  • Under type:

    • “1” — Free Text

    • “2” — Single Answer

    • “3” — Yes/No

    • “4” — Certificate

    • “5” — Multiple Answers

  • Under translation_status:

    • “0” — Not Relevant for Translation

    • “1” — To be Translated

    • “2” — In Translation

    • “3” — Translated

    Note Note

    • For lines starting with “QT” and “AT”, the translation status refers to the translation into a specific language. You must change the value for this status after translating offline to “2” or “3”, as appropriate.

    • For lines starting with “Q”, the translation status indicates whether a question has been translated into all languages for which a translation is required. This status is calculated by the system from the status of the individual languages and cannot be modified offline.

    End of the note.

  • Under answer_id

    Numerical identifier of the answer option

  • Under answer

    Text of the answer option (visible to recipients and translatable)

  • Under ordinal number

    Number that defines the sequence of the answer options. Note: The answer option that appears at the top of the list has the highest number, the answer option at the bottom of the list has the lowest number.

  • Under score

    Score that is associated with the answer option

  • Under yes_is_preferred

    For yes/no questions, the entry “X” indicates that “Yes” has been defined as the preferred answer.

  • Under attachments

    • “0” — Disabled

    • “1” — Optional

    • “2” — Mandatory

  • Under comment

    • “0” — Disabled

    • “1” — Enabled

Note Note

When making entries in the attachments and comment columns, note that you must do so in the question line (starting with “Q”). If you make the entries in the answer lines “A”, in the lines for question translations “QT”, or in the lines for answer translations “AT”, the XML file cannot be imported.

End of the note.
Sections: Content of an Exported XML File

For sections, the table lists the following data:

  • Under line:

    • “S” — Section

    • “ST” — Translation of a section

  • Under name:

    Name specified for the section

  • Under id:

    Technical identifier of a section

  • Under language_code:

    ISO Code for the language in which the section exists

  • Under title:

    Title of the section (visible to recipients and translatable)

  • Under explanation:

    Explanatory text for the section (visible to recipients and translatable)

  • Under translation_status:

    • “0” — Not Relevant for Translation

    • “1” — To be Translated

    • “2” — In Translation

    • “3” — Translated

    Note Note

    • For lines starting with “ST”, the translation status refers to the translation into a specific language. You must change the value for this status after translating offline to“2” or “3”, as appropriate.

    • For lines starting with “S”, the translation status indicates whether a section has been translated into all languages for which a translation is required. This status is calculated by the system from the statuses of the individual languages and cannot be modified offline.

    End of the note.
Sequence of Lines in the XML Files

The sequence of the lines in the XML files containing the content of the question library is clearly defined and must be observed when you insert new questions, answer options, or sections.

Sequence of Questions

  1. “Q” for a question

  2. “QT” for the translations belonging to the this question; depending on the number of the translation languages, there can be one or several “QT” lines.

  3. “A” for the first answer option belonging to the question above.

  4. “AT” for the translations of the first answer option. Depending on the number of the translation languages, there can be one or several “AT” lines.

  5. “A” for the second answer option belonging to the question above.

  6. “AT” for the translations of the second answer option. Depending on the number of the translation languages, there can be one or several “AT” lines.

This pattern is repeated for further questions and answers.

Note Note

The translation lines for a question or answer must be grouped together; that is, you must not insert “Q” or “A” lines between “QT” or “AT” lines.

End of the note.
Sequence of Sections

  1. “S” for a section.

  2. “ST” for the translations belonging to this section; depending on the number of the translation languages, there can be one or several “ST” lines that must follow each other directly.

This pattern is repeated for further sections.