In order to create or modify a questionnaire in Questionnaire Manager for SIG (QM for SIG), a Questionnaire Definition XML Document must be created. An example Questionnaire Definition is below. Most of the fields are optional.
If you are using a standardized questionnaire and you want to customize it for your company, it is highly recommended that you change the questionnaire’s version (questionnaireVersion) to something that will not conflict with current or future versions of a standardized questionnaire.
| Element | Definition |
|---|---|
| questionnaireName | The name of the survey or questionnaire. |
| questionnaireVersion | The version of the questionnaire. It is recommended that shared questions across different versions of a questionnaire have the same GUID. |
| revision | The revision number. This attribute is intended to be merely for edits/bug fixes of a particular questionnaire version. |
| targetQFrameVersion | The intended QM for SIG version. This field will be used by future versions of QM for SIG for forward-compatibility. |
| pages | Contains page elements |
| page | Contains page-specific elements |
| pageHeader | The title of the page |
| pageGUID | A globally unique identifier for this page. This is helpful for tracking and importing responses from previous questionnaire version. |
| seqNumber | The order in which the page, section, or question is displayed |
| description | A description of the page, section, or question |
| headerText | Text that is displayed before questions in a page. This field accepts the Markdown markup language. |
| footerText | Text that is displayed after questions in a page. This field accepts the Markdown markup language. |
| cloneable | Determines whether the page, section, or question can be cloned (copied) with different responses. Accepts 1 (yes) or 0 (no). Default is 0. |
| sections | Contains section elements |
| section | Contains section-specific elements |
| sectionHeader | The title of the section |
| sectionGUID | A globally unique identifier for this section. This is helpful for tracking and importing responses from previous questionnaire version. |
| questions | Contains question and questionGroup elements |
| question | Contains question-specific elements |
| qText | Contains the question text |
| questionGUID | A globally unique identifier for this question. This is helpful for tracking and importing responses from previous questionnaire version. |
| questionNumber | This optional field is used for creating a custom numbering scheme (e.g. A, B, C instead of 1, 2, 3). |
| questionType | The type of response a question expects. QM for SIG currently supports the types ‘T’, ‘S’, ‘D’, and ‘V’. The T type is for free-form text. The S type is for a question that expects one from a set of responses (see questionPrompt). The D type is for date responses consisting of month, day, and year. The V type is for virtual questions. A virtual question is a question that points to another question. Virtual questions are normally defined when it is helpful to display the same question (and response) on multiple pages. The questionGUID for virtual questions identifies the question to which the virtual question refers. Virtual questions are read-only and can only be answered via the real question. |
| questionReferences | Contains questionReference elements. |
| reference | Contains reference-specific elements. |
| referenceName | A long name to identify a reference. |
| shortName | A short name to identify a reference. |
| item | The specific section of a document, manual , website, etc being referenced. |
| referenceURL | The URL containing the reference text. |
| referenceText | The text being referenced. |
| questionPrompt | For questions that have the ‘S’ questionType, contains questionPrompt-specific elements. |
| promptText | A response text for questions that are the ‘S’ questionType. |
| requireAdditionalInfo | If set, the additional info text box must contain a response. Accepts 1 (yes) or 0 (no). Default is 0. |
| disablePage | For questionPrompt elements, accepts a pageGUID value. If the questionPrompt is selected as a response, the specified page is disabled. |
| disableSection | For questionPrompt elements, accepts a sectionGUID value. If the questionPrompt is selected as a response, the specified section is disabled. |
| disableQuestion | For questionPrompt elements, accepts a questionGUID value. If the questionPrompt is selected as a response, the specified question is disabled. |
| questionGroup | A group of related questions. Contains multiple question elements. |
<?xml version="1.0" encoding="utf-8"?>
<csi:questionnaire xmlns:csi="http://www.csinitiative.com/ns/csi-qframe"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
questionnaireName="Demo Questionnaire" questionnaireVersion="1"
revision="1" targetQFrameVersion="1.0">
<csi:pages>
<csi:page>
<csi:pageHeader>this page has 2 references</csi:pageHeader>
<csi:pageGUID>1</csi:pageGUID>
<csi:seqNumber>1</csi:seqNumber>
<csi:pageReferences>
<csi:reference>
<csi:shortName>ABC</csi:shortName>
<csi:referenceName>Alpha Bravo Charlie</csi:referenceName>
<csi:item>1.2.3</csi:item>
<csi:referenceURL>http://abc.org/123</csi:referenceURL>
<csi:referenceText>Lorem ipsum dolor sit amet</csi:referenceText>
</csi:reference>
<csi:reference>
<csi:shortName>XYZ</csi:shortName>
<csi:referenceName>Xray Yankee Zulu</csi:referenceName>
<csi:item>7.8.9</csi:item>
<csi:referenceURL>http://xyz.org/789</csi:referenceURL>
<csi:referenceText>Ut enim ad minim veniam</csi:referenceText>
</csi:reference>
</csi:pageReferences>
<csi:sections>
<csi:section>
<csi:sectionHeader>this section has 2 references</csi:sectionHeader>
<csi:sectionGUID>1</csi:sectionGUID>
<csi:seqNumber>1</csi:seqNumber>
<csi:sectionReferences>
<csi:reference>
<csi:shortName>ABC</csi:shortName>
<csi:referenceName>Alpha Bravo Charlie</csi:referenceName>
<csi:item>1.2.3</csi:item>
<csi:referenceURL>http://abc.org/123</csi:referenceURL>
<csi:referenceText>Lorem ipsum dolor sit amet</csi:referenceText>
</csi:reference>
<csi:reference>
<csi:shortName>XYZ</csi:shortName>
<csi:referenceName>Xray Yankee Zulu</csi:referenceName>
<csi:item>7.8.9</csi:item>
<csi:referenceURL>http://xyz.org/789</csi:referenceURL>
<csi:referenceText>Ut enim ad minim veniam</csi:referenceText>
</csi:reference>
</csi:sectionReferences>
<csi:questions>
<csi:question>
<csi:qText>this question has 1 reference</csi:qText>
<csi:questionGUID>1</csi:questionGUID>
<csi:seqNumber>1</csi:seqNumber>
<csi:questionReferences>
<csi:reference>
<csi:shortName>ABC</csi:shortName>
<csi:referenceName>Alpha Bravo Charlie</csi:referenceName>
<csi:item>1.2.3</csi:item>
<csi:referenceURL>http://abc.org/123</csi:referenceURL>
<csi:referenceText>Lorem ipsum dolor sit</csi:referenceText>
</csi:reference>
</csi:questionReferences>
<csi:questionType>T</csi:questionType>
</csi:question>
</csi:questions>
</csi:section>
</csi:sections>
</csi:page>
<csi:page>
<csi:pageHeader>rules</csi:pageHeader>
<csi:pageGUID>2</csi:pageGUID>
<csi:seqNumber>2</csi:seqNumber>
<csi:sections>
<csi:section>
<csi:sectionHeader>
this section contains questions with rules to disable things
</csi:sectionHeader>
<csi:sectionGUID>2</csi:sectionGUID>
<csi:seqNumber>2</csi:seqNumber>
<csi:questions>
<csi:question>
<csi:qText>
answering "disable" will disable the section called
"target section" while
answering "enable" will enable this section.
</csi:qText>
<csi:questionGUID>2</csi:questionGUID>
<csi:seqNumber>2</csi:seqNumber>
<csi:questionType>S</csi:questionType>
<csi:questionPrompt>
<csi:promptText>disable</csi:promptText>
<csi:disableSection>3</csi:disableSection>
</csi:questionPrompt>
<csi:questionPrompt>
<csi:promptText>enable</csi:promptText>
</csi:questionPrompt>
</csi:question>
<csi:question>
<csi:qText>
answering "disable" will disable the question called
"target question" while
answering "enable" will enable this question.
</csi:qText>
<csi:questionGUID>3</csi:questionGUID>
<csi:seqNumber>3</csi:seqNumber>
<csi:questionType>S</csi:questionType>
<csi:questionPrompt>
<csi:promptText>disable</csi:promptText>
<csi:disableQuestion>2</csi:disableQuestion>
</csi:questionPrompt>
<csi:questionPrompt>
<csi:promptText>enable</csi:promptText>
</csi:questionPrompt>
</csi:question>
<csi:question>
<csi:qText>
answering "disable" will disable the page called
"target page" while
answering "enable" will enable this page.
</csi:qText>
<csi:questionGUID>4</csi:questionGUID>
<csi:seqNumber>4</csi:seqNumber>
<csi:questionType>S</csi:questionType>
<csi:questionPrompt>
<csi:promptText>disable</csi:promptText>
<csi:disablePage>3</csi:disablePage>
</csi:questionPrompt>
<csi:questionPrompt>
<csi:promptText>enable</csi:promptText>
</csi:questionPrompt>
</csi:question>
</csi:questions>
</csi:section>
<csi:section>
<csi:sectionHeader>
target section
</csi:sectionHeader>
<csi:sectionGUID>3</csi:sectionGUID>
<csi:seqNumber>3</csi:seqNumber>
<csi:questions>
<csi:question>
<csi:qText>target question</csi:qText>
<csi:questionGUID>5</csi:questionGUID>
<csi:seqNumber>1</csi:seqNumber>
<csi:questionType>T</csi:questionType>
</csi:question>
<csi:question>
<csi:qText>this question is merely a placeholder</csi:qText>
<csi:questionGUID>6</csi:questionGUID>
<csi:seqNumber>2</csi:seqNumber>
<csi:questionType>T</csi:questionType>
</csi:question>
</csi:questions>
</csi:section>
</csi:sections>
</csi:page>
<csi:page>
<csi:pageHeader>target page</csi:pageHeader>
<csi:pageGUID>3</csi:pageGUID>
<csi:seqNumber>3</csi:seqNumber>
<csi:headerText>This is just a placeholder page to act
as a target for rules</csi:headerText>
</csi:page>
</csi:pages>
</csi:questionnaire>
 Getting Started for Service ProvidersSet Up, View, Edit, Approve & Export |
| Getting Started for Financial Institutions Set Up, Import, View, Edit, Approve & Compare |
| Role & User Management Roles & Users |
| Data Administration Questionnaire, Instance & Encryption Management |
| XML Reference XML Element Glossary & Questionnaire Definition |
