Differences

This shows you the differences between two versions of the page.

--- captureranks [2022/09/20 16:44] – [textOnly] admin
+++ captureranks [2024/01/24 16:12] (current) – admin
@@ Line 1: / Line 1: @@
 ====== captureRanks - Capture ranks for piping into other questions ======
-The captureRanks function captures ranks and recodes from any type of ranking question into embedded data fields. For example, the label and recode of the top ranked item will be saved in embedded data fields named something like 'Q1.rank.text.1' and 'Q1.rank.recode.1', the label and recode of the second ranked item will be saved in embedded data fields named something like 'Q1.rank.text.2' and 'Q1.rank.recode.2', etc.
+The captureRanks function captures ranks and recodes from **__any__** type of ranking question into embedded data fields. For example, the label and recode of the top ranked item will be saved in embedded data fields named something like 'Q1.rank.text.1' and 'Q1.rank.recode.1', the label and recode of the second ranked item will be saved in embedded data fields named something like 'Q1.rank.text.2' and 'Q1.rank.recode.2', etc.
 The captureRanks function gets added to the ranking question itself, so later sorting is not needed and ranks are available for piping on the next page.
 It's primary use is piping ranked items in order or piping any ranked items for follow-up questions (only the first and last item are natively available for piping in Qualtrics). It also provides an alternative way of saving ranking data (i.e., a field for the top ranked item instead of items with their ranks).
-  * Supports rank order questions in ANY format - Drag and drop, Radio buttons, Text box, and Select box.
+  * Supports rank order questions in **__any__** format - Drag and drop, Radio buttons, Text box, and Select box.
   * Supports Pick, Group, Rank (PGR) questions with any number of groups.
-  * Supports [[bubbleburst|Bubble Burst]] ranking.
+  * Supports **[[bubbleburst|Bubble Burst]]** ranking.
   * Saves labels of ranked choices to embedded data fields. Labels can be saved as HTML or text only.
   * Saves recodes of ranked choices to embedded data fields.
   * Ranked items can be piped on the next page - no additional questions, blocks, or survey flow logic needed.
-This function is available for a reasonable fee. Contact [[https://community.qualtrics.com/XMcommunity/messages/add/TomG|TomG]] on the Qualtrics Community to learn more.
+Here is a demo of a Pick, Group, Rank question:
+{{ :captureranks.mp4?600 |captureRanks Demo}}
+This function is available for a reasonable fee. Contact **[[https://community.qualtrics.com/XMcommunity/messages/add/TomG|TomG]]** on the Qualtrics Community to learn more.
 ===== Set-up Instructions =====
 ==== Survey Header ====
-To make the function available to all questions in the survey, copy the function to the Survey Header inside a script tag:
+Add the captureRanks function to the survey header to make it available to any question in the survey. Go to Look & Feel -> General -> Header edit -> {{::icon_source.jpg?20|}} and paste the provided captureRanks function JS:
-Add the captureRanks function to the survey header to make it available to any question in the survey.   Go to Look & Feel -> General -> Header edit -> {{::icon_source.jpg?20|}} and paste the provided captureRanks function JS:
 <code>
 <script>/*Paste captureRanks function JS here*/</script>
@@ Line 29: / Line 31: @@
 </code>
-To override the default options, specify the desired [[captureRanks#options|options]] in the second function argument as an object. For example:
+To override the default options, specify the desired **[[captureRanks#options|options]]** in the second function argument as an object. For example:
 <code>
 Qualtrics.SurveyEngine.addOnload(function() {
@@ Line 36: / Line 38: @@
 </code>
 ===== Embedded Fields =====
-The captureRanks function saves both labels (html) and ranks of ranked items into embedded data fields.
+The captureRanks function saves both labels (html or text) and recodes of ranked items into embedded data fields.
 ==== Embedded Field Names ====
 Embedded data field names are in two formats. For PGR questions with more than one group, the embedded field names include a 'group' section.  For all other questions types (basic) there is no 'group' section.
@@ Line 53: / Line 55: @@
 **delim** is a delimiter used to break the embedded data field names into sections. The delimiter is placed between each section.
-Default: "."
+Default: %%"."%%
 ==== groupText ====
 **groupText** is the text used in the group section of the embedded data field names. The group section in only used for Pick, Group, Rank (PGR) questions with more than one group.
-Default: "group"
+Default: %%"group"%%
 ==== labelText ====
 **labelText** is used in embedded data field names that capture labels of ranked items.
-Default: "text"
+Default: %%"text"%%
 ==== prefix ====
 **prefix**, if not blank, is used at the beginning of embedded data field names.
-Default: "" (empty)
+Default: %%""%% (empty)
 ==== rankText ====
 **rankText** is the text used to in the rank section of embedded data field names.
-Default: "rank"
+Default: %%"rank"%%
 ==== recodeText ====
 **recodeText** is used in embedded data field names that capture recodes of ranked items.
-Default: "recode"
+Default: %%"recode"%%
 ==== textOnly ====
 **textOnly** is a boolean used to remove HTML from labels when set to true.