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 sets the given property to the given value for the given question.

See this function in action in an example survey.
Parameters*
Description
Required
questionID
the ID of the question
true
property
the question property you wish to set
true
value
the value you wish to set
true

*Provide parameters in the above order.

Available Question PropertiesDescriptionTypePossible Values
exclude_numberExclude question numberbooleantrue false
labels_rightDisplay label to the right of inputbooleantrue false
orientationOrientation of answer optionsstringVERTHORZSTACKED
question_description_aboveDisplay question description/instructions abovebooleantrue false
custom_cssCustom CSS Classstring
requiredRequired settingbooleantrue false
force_percentPercent validationbooleantrue false
force_currencyCurrency validationbooleantrue false
min_numberMin number validationinteger
max_numberMax number validationinteger
min_answers_per_rowMinimum answers required per row if answeredinteger
minimum_responseMinimum answers requiredinteger
defaulttextDefault answer (text or reporting value for questions with options)string
max_totalMax total value for Continuous Sum questionsvalue
max_total_noshowHide max total setting for Continuous Sum questionsbooleantrue false
email_attachmentsEmail attachment setting for Send Email Actionsstring
xnumber


Example

The below script sets the required property for question ID 2.

questionID = 2
property = 'required'
value='true'

setquestionproperty(questionID, property, value)

This script utilizes the rand PHP function in combination with the setquestionproperty function to randomize the orientation of the target question.

questionID = 2
property = "orientation"
random = rand(0,1)

if random == 0 then
	value = "VERT"
else
	value = "HORZ"
end

setquestionproperty(questionID,property,value)

Using the "email_attachments" property you can attach a custom-built PDF (learn more about the functions for building PDFs) to an existing send email action. In this example, we set the "email_attachments" property of the send email action (ID 3) equal to the attachment custom PDF that we created.

pdf = "Example PDF"
text = "Hello World!"
size = 14
options = {['spacing'] = 1.5}
table = {row1={1,2,3,4}, row2={5,6,7,8}, row3={9,10,11,12}}
columns = {'Column A','Column B','Column C','Column D'}

newpdf(pdf,'letter','portrait')
setfontpdf(pdf,'courier','Bold')
setcolorpdf(pdf,0,0,0)
imagepdf(pdf,'https://surveygizmolibrary.s3.amazonaws.com/library/160589/communitylogo.png')
textpdf(pdf,text,size,options)
tablepdf(pdf,table,columns,'Table Title')

formattedpdf = pdfoutput(pdf)

attachment = {}

attachment['example.pdf'] = formattedpdf

setquestionproperty(3,"email_attachments",attachment)

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