Additional survey elements and features for IntelliBuilder

The following article contains information on various survey elements and features Survey Creators (SCs) commonly use creating their surveys in IntelliBuilder that do not fit the steps outlined in Creating survey elements with IntelliBuilder. The topics in this section do not require the use of condition logic.

For information on survey elements that include condition logic, see Conditioned survey elements and features for IntelliBuilder.

Users should note that some of the topics included here will require Advanced mode programming rights. For additional information on User Modes, see Getting started with IntelliBuilder. New users should also review the Survey elements overview for IntelliBuilder article for information on survey element types, properties, and attributes.

Display Text 

The Display Text element allows SCs to create text that is displayed to the respondent (also known as "free text"). This type of text is often used as introductory text or transition text to begin new survey sections.

Unlike other survey elements, Display Text only requires an ID and the text message to display. The system will default to assigning the next available numerical ID. Since free text is not for referencing or repeated use, the ID can be any alphanumeric combination and is only for storage purposes.

Lists 

Lists can be used for defining question and table options or table row-questions. Standalone lists are also known as setlists, and when created within a question or table, they are referred to as inline lists. Generally when a list of options is required for repeated usage, creating a standalone list is recommended.

Lists require an alphanumeric ID that is used for referencing them in other survey elements. List IDs do not permit spaces, but do allow for underscores. List IDs are often capitalized as well to distinguish them from other element types.

Like most element types, list options support attributes as needed. 

"Other" options 

Autoother options are options that provide a text field for respondents to include their own option instead of, or in addition to, those provided. These options are created by including the Other Specify attribute on an option, either in a setlist (standalone list) or inline list (defined within a question or table).

Autoother options are often given a higher option ID outside the range of the other list options so that, if need be, additional options can be added before the autoother option, or to help the option stand out from other list options. IDs such as '91' or '97' are commonly used, and each element may include multiple autoothers – e.g., '91. Other type 1' and '92. Other type 2', etc.

 

When an Other Specify attribute is added to an option or row element, the Other specify properties modal will appear, allowing the SC to specify various configurations or requirements for the text input field.

 

The following parameters can be configured as needed. Any parameters with input will be listed in the Autoother directive after the option text in Builder view as shown above.

Add to 100% tables 

Add to 100% tables are numeric input tables that require respondents to have the sum of their responses equal 100. As respondents enter values, the Total row will dynamically display the sum of the rows' inputs. If the respondent attempts to submit a total that doesn't equal "100," a validation error will occur, and the respondent will be prompted to make sure their total equals 100. Like other numeric tables, options are not included, and row-questions may be defined inline as part of the table or by using the Rows From property to reference a standalone list.

 

The following properties and inputs are included by default via the add_to_100_percent class. Since these are predefined elsewhere, all of these properties may be added and redefined locally except for the Show Total property.

Piped Text 

Piped Text is text that is pulled in (or "piped" in) from one location to another. The most common usage is to use a respondent's answer from one question and pipe it into a later question's text, but SCs can also create Piped Text elements that allow for repeated usage of text. Often this latter scenario is used in properties such as Instructions or Prefaces, but can also be used in Explains or Footnotes as well.

 

Piped Text can also be added to question text or option text. The Piped Text icon will appear once you have clicked into a field that allows for piped text to be applied. 

Creating Piped Text elements

To create Piped Text for reuse, select the Piped Text element from the Add Element modal. SCs will be required to enter a Reference or name by which the piped text can be referenced, and the text that will be displayed to respondents. Additionally, the properties Explain and Same Page (an Advanced property) can be included with the piped text.

 

Once saved, the Piped Text will appear as follows in Builder View.

Applying Piped Text

Piped Text elements (and previous responses) can be applied in question text, option text, and properties that require text input such as Instructions, Prefaces, Explains, and Footnotes. To include piped text in another element, click in the text field of one of these locations. This will activate the Insert Piped Text icon. Clicking this icon will bring users to the Insert Piped Text modal.

From this modal, SCs may select Piped Text elements or questions from which they may pipe previous responses. The reference name will appear with underscores as __reference_name__ in the case of Piped Text elements, or $QID_text in the case of piped responses. If need be, additional text can be added both before and after the reference. After selecting the text to pipe, click Apply.

 

The Piped Text reference name will then be shown with underscores in the location it has been applied within the Element Editor (left). Once the element is saved, the Piped Text's text will be shown in brackets with gray font (right).

 

Piped responses will instead be shown as "$QID_text", both in the location they were added in the Element Editor and in the completed element. Note that like Piped Text references, piped responses are also shown in brackets and gray font.

Customized Questions (classes) 

Often times surveys may require a consistent format to a specific question type. Rather than having to repeatedly add the same code or features to each question that follows this format, SCs can instead use a class. Classes are labeled sets of properties which can be referenced by other survey elements. Elements referencing a class inherit all of that class' properties and values. Classes promote a consistent, streamlined, and standardized appearance to surveys, and make it easy to modify many elements at one time, if needed.

Classes in IntelliBuilder are assigned to a specific question type. As such, if multiple question types need similar features, a class must be created for each question type. No matter when a class is created in the survey programming process, all classes are stored at the beginning of the survey in IntelliBuilder.

 

Classes are created via the Add question configuration option in the Actions menu, then applied to questions via the Customized Questions button found on the Add Element modal.

Creating classes

To create a class, click Actions > Add question configuration. This will launch the Customize Standard Question Types modal at the top of the survey. 

 

Use the Element Selector menu to select which type of element the class will be used for. Selecting an element activates the Class Name field. Class names should be alphanumeric, and are case in-sensitive. Spaces are allowed as well.

The type of element dictates which properties can be included in the class definition. The optional Class Description property is available for all element types and is useful for providing additional information about the class that may be helpful when searching for which class to apply.

 

Next, begin adding the properties required for the class. SCs should note that the Options, Options From, and Rows From properties are not allowed in classes, and must be added at the element level when applying the class.

Once all required properties have been added, click Apply to finish or Apply + Add New to save the class and create another one.

 

Classes are listed as CLASS: CLASSNAME with the element type listed immediately after the name. Additional properties are listed after it, similar to other element types.

Applying classes (Customized Questions)

Once a class has been created, it can be applied to a question by clicking Add > Customized Questions. This launches the Class Selection grid, which provides a list of all classes and their descriptions (if added via the Class Description property). The grid is also keyword searchable.

Select the desired class, and click Apply to continue.

 

Selecting a class will open the Element Editor, and the class will be listed below the question text/element description as its first property. The element will automatically be assigned the question type for which the class was made. Any properties normally associated with that question type will be available in the Properties menu. 

 

After saving the Customized Question, the element will display the class name and element type in brackets as shown below.