Lua Scripting Resources

Important Update to Custom Scripting

SurveyGizmo's CustomScript Action now supports the LUA programming language.


Legacy Custom Scripting Language Deprecation Plans 

  1. New accounts (created after October 29, 2018) will only have the option to use Lua in scripts.
  2. As of October 29, 2018 Custom Scripting Actions will default to Lua as the scripting type in the Custom Scripting Action for accounts created before this date. You will be able to switch to the Legacy Custom Scripting; though we highly encourage using Lua.
  3. In the long term, Legacy Custom Scripting Actions will be switched to read-only. Read-only scripts will continue to function; you will just be prevented from editing. The exact date on this is to be determined; we will send notifications well ahead of time.


 Go to our Legacy Scripting Documentation.

While SurveyGizmo is one of the most flexible survey tools around, we get requests for customizations that are not available out of the box. This is where JavaScript and Custom Scripting can save the day. If you have scripting chops you can use the JavaScript action or the Custom Scripting action to achieve the survey of your dreams.


[article("bodfy")]

This function hides an answer option by reporting value. The true/false parameter can be used to support changes in answer options when respondents use the back button.

See this function in action in an example survey.
Parameters*
Description
Required
questionID
the ID of the question
true
reportingvalue
the reporting value of the option you wish to affect
true
true/false
true hides the option, false shows the optiontrue

*Provide parameters in the above order.

Example

Here, we use the function hideoption to hide an option from question 2 based on the answer to question 1. If the back button is used and the answer option is changed the else condition with the false parameter will unhide the hidden option.

For the example script below, the survey is set up as follows:

Page 1: Source question (Question ID #2)

Page 2: Custom Script and Target question (Question ID#3)

Your script should be at the top of the page with the target question.

q1 = 2 -- Question ID for question 1 (source question)
q2 = 3 --Question ID for question 2 (target question)
q2value_1='1' --Reporting value for option 1
q2value_2='2' --Reporting value for option 2

q1value=getvalue(q1)
 
if (q1value == '1') then

  hideoption(q2, q2value_1, true)

else
  
  hideoption(q2, q2value_1, false)
  
end

if (q1value == '2') then

  hideoption(q2, q2value_2, true)

else

  hideoption(q2, q2value_2, false)
  
end

See also the following working examples for use of this function: