Difference between revisions of "Custom Field Type: Special - Question Set Builder"

From SmartWiki
Jump to: navigation, search
m
m (Configuration)
 
(17 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<span id="bs_template:@@@TPL3@@@" class="mceNonEditable template" data-bs-name="Banner-UnderConstruction" data-bs-type="template" data-bs-id="3">{{ Banner-UnderConstruction }}</span>
+
__TOC__
  
 +
==General Description==
 +
The '''Special - Question-Set Builder''' custom field allows end users without '''Global Administrator''' privileges to create their own set of questions on a record and have responses stored in the the corresponding child records.
  
 +
To see individual answers, navigate to the specific activity to view the results.
  
__TOC__
+
<u>'''Note:'''</u>
 +
 
 +
* Answers for the '''Special - Question-Set Builder''' custom field have limited support in list views and reporting. If you need to report on answers, consider creating each question as its own custom field instead.
  
==General Description==
+
* The '''Special – Question Set Builder''' does not support test to production (T2P). This custom field creates custom fields with IDs for each new question. If you add/delete a question on one server and then transfer the data to another server via T2P, field IDs will not match and as such data loss may occur or data may be transferred into an unintended field.
The Question Set Builder custom field allows end users without Administrator privileges to create their own set of questions on a record and have the corresponding child records story the responses to those questions.
 
  
 
==Field Options==
 
==Field Options==
Line 16: Line 20:
 
Options listed below are unique and specific to this particular field type (if applicable).
 
Options listed below are unique and specific to this particular field type (if applicable).
  
==Set Up==
+
==Configuration==
To start using the question set builder, create a custom field of type '''Special - Question Set Builder'''<br />
+
===Setting up Question Set Builder===
[[Image:QuestionSetBuilderCustomField.png|border]]
+
# To start using the question set builder, create a custom field of type '''Special - Question Set Builder'''<br /> [[Image:QuestionSetBuilderCustomField.png|border]]
 
+
# Next, navigate to a record from which you'd like to collect answers, and add the questions within the builder.<br /> [[Image:QuestionSetBuilderEdit2.png|border]]
 
+
# Then, create a level two custom field of type 'Special - Question Set'.<br /> [[Image:QuestionSetNew.png|border]]
Next, navigate to a record from which you'd like to collect answers, and add the questions within the builder.<br />
+
# After saving the custom field, set the Source Field to the level one Question Set Builder previously created.<br /> [[Image:QuestionSetSource.png|border]]
[[Image:QuestionSetBuilderEdit2.png|border]]
+
# The question set should now be visible to any level two under the level one.<br /> [[Image: QuestionSet.png|border]]
 
 
 
 
Then, create a level two custom field of type 'Special - Question Set'.<br />
 
[[Image:QuestionSetNew.png|border]]
 
  
 +
===Setting up Question Set Scoring===
 +
Question sets can also have scoring enabled. Follow these steps to get started:
  
After saving the custom field, set the Source Field to the level one Question Set Builder previously created.<br />
+
# Create a Level 1 custom field of type '''Special - Question Set Builder. '''Ensure you have toggled on '''Enable Scoring''' in the configuration settings.
[[Image:QuestionSetSource.png|border]]
+
# Go to any Level 1 record and set up the questions you would like to ask. Use the '''Correct Answer''' and '''Score''' attributes to indicate the correct test answer as well as assign a specific score for each question.
 +
# Create a new Level 2 custom field of type''' Special - Question Set'''. Under the''' Source Field''' setting, be sure to select the '''Question Set Builder''' custom field we created in Step 1. 
 +
# Create a new Level 2 custom field of type '''Special - Scoring Results'''. Ensure the '''Field Name''' for this new custom field does not contain any spaces as it will need to be referenced later.
 +
# Navigate to '''UTA Settings''' > '''Level 2''' tab > '''Features and Options''' section >''' Formula'''. Inside the '''Formula''' field, enter the following logic: <code>@level2.mycustomfield@="@evaluate_score()@";</code> where "mycustomfield" is the '''Field Name''' you assigned to the '''Special - Scoring Results''' custom field.
 +
# To test your fields are working properly, save a Level 2 record with some of the test questions filled out. You will see the score and answers listed as below.
  
  
The question set should now be visible to any level two under the level one.<br />
+
[[File:2022-03-ticket-130455.png|thumb|none|800px|A new custom field to display test scores]]
[[Image: QuestionSet.png|border]]
 
  
  
 
[[Category:Custom Fields]]
 
[[Category:Custom Fields]]
 
[[Category:Custom Field Types]]
 
[[Category:Custom Field Types]]

Latest revision as of 16:00, 20 April 2023

General Description

The Special - Question-Set Builder custom field allows end users without Global Administrator privileges to create their own set of questions on a record and have responses stored in the the corresponding child records.

To see individual answers, navigate to the specific activity to view the results.

Note:

  • Answers for the Special - Question-Set Builder custom field have limited support in list views and reporting. If you need to report on answers, consider creating each question as its own custom field instead.
  • The Special – Question Set Builder does not support test to production (T2P). This custom field creates custom fields with IDs for each new question. If you add/delete a question on one server and then transfer the data to another server via T2P, field IDs will not match and as such data loss may occur or data may be transferred into an unintended field.

Field Options

All common options:
General Settings
Permissions & Availability
Classic Options
For further information, please refer to Custom Fields – General Information.

Options listed below are unique and specific to this particular field type (if applicable).

Configuration

Setting up Question Set Builder

  1. To start using the question set builder, create a custom field of type Special - Question Set Builder
    QuestionSetBuilderCustomField.png
  2. Next, navigate to a record from which you'd like to collect answers, and add the questions within the builder.
    QuestionSetBuilderEdit2.png
  3. Then, create a level two custom field of type 'Special - Question Set'.
    QuestionSetNew.png
  4. After saving the custom field, set the Source Field to the level one Question Set Builder previously created.
    QuestionSetSource.png
  5. The question set should now be visible to any level two under the level one.
    QuestionSet.png

Setting up Question Set Scoring

Question sets can also have scoring enabled. Follow these steps to get started:

  1. Create a Level 1 custom field of type Special - Question Set Builder. Ensure you have toggled on Enable Scoring in the configuration settings.
  2. Go to any Level 1 record and set up the questions you would like to ask. Use the Correct Answer and Score attributes to indicate the correct test answer as well as assign a specific score for each question.
  3. Create a new Level 2 custom field of type Special - Question Set. Under the Source Field setting, be sure to select the Question Set Builder custom field we created in Step 1. 
  4. Create a new Level 2 custom field of type Special - Scoring Results. Ensure the Field Name for this new custom field does not contain any spaces as it will need to be referenced later.
  5. Navigate to UTA Settings > Level 2 tab > Features and Options section > Formula. Inside the Formula field, enter the following logic: @level2.mycustomfield@="@evaluate_score()@"; where "mycustomfield" is the Field Name you assigned to the Special - Scoring Results custom field.
  6. To test your fields are working properly, save a Level 2 record with some of the test questions filled out. You will see the score and answers listed as below.


A new custom field to display test scores