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 returns the given property for the current survey.

Parameters
Description
Required
property
property to gettrue
Available PropertiesDescription
Return Values
survey_interaction_desktopDesktop survey interactionINTERACTION_STANDARD,INTERACTION_VIRTUAL_PAGE
survey_interaction_mobileMobile survey interactionINTERACTION_STANDARD,INTERACTION_VIRTUAL_PAGE
dNumberingDynamic Numberingboolean
account_currencyCurrency account default for currency validationstring (e.g. dollar)
internal_titleInternal survey title specified in Survey Settingsstring
report-value-methodReporting value method specified in Survey Settingsauto, sequential, custom
language-barLanguage bar settingboolean
save_n_continueSave & Continue settingboolean
has_quotasIndicates overall quota is setboolean

Example

The below script gets the internal_title property for the current survey.

propertyname = 'internal_title'

getsurveyproperty(propertyname)