Skip to main content

Search

Code

  • Updated

The code widget allows survey programmers (SPs) to insert customized Perl code into a survey page, and thereby change the basic functionality of IntelliSurvey. Use this only in special circumstances where it is necessary to accomplish tasks that cannot normally be performed with standard IntelliSurvey functions.

Note: SPs can use the code widget to override nearly any standard behavior, or even to write custom software applications. This requires significant programming experience, however, and such use is beyond the scope of this documentation. Certain security restrictions also apply to the use of the code widget.

Syntax

code: <<END
#Perl code here
END

Tags

The following tags are commonly used with the code widget.

Tag

Input

Description

all

 y/n

 When set to "y", applies the code to every form/page of the survey. Set to "n" to only run the code on the form where the widget is featured.

code

 Perl code

Specifies the starting point of special Perl code and a label that identifies where the Perl expression ends. (The Perl expression ends at the next instance of the label you specify.) The code tag allows you to insert special Perl code in the survey source text that changes the basic functionality of the IntelliSurvey software.

#

 Any text

Allows a single line programming comment to be placed inline within a widget.

onload

Accepts 'y' or 'n'

Execute the widget function on page load (yes), rather than page submit (no).

phase

String

Acceptable values are: setdata, validate, and action.

template

Filename

The template tag allows survey programmers to reference pre-built templates in the appID/theme/parent directory.

template_data

Perl code

The template_data tag works in conjunction with custom templates. It is used to tailor the custom template to the given application, if applicable. Consult the documentation for a particular template to see if there are any variables that can be customized via template_data.If there are, such variables may be accessed with a hashref.

translate

Accepts 'y' or 'n'

Specifies whether to include a question, list or group in the Excel output file that is generated by the translation tool. If you use the translate: n tag, the item will not be translated.

class

Element ID

A class is a set of source code that can be reused repeatedly throughout a survey. The class tag allows you to reference one of these predefined classes.

Phase

The 'phase' can be one of 'setdata', 'validate', or 'action'. When loading a page, the phases are executed in that order. The 'setdata' phase should be used when data needs to be set; the 'validate' phase should be used when field responses need to be validated; and the 'action' phase should be used when handling logic after data setting and validation (e.g., sending email, redirecting to another page). The phases can be specified to run when the page is loading ('onload: y', the default) or when the page is being submitted ('onload: n').

Related to

Related articles

Comments

0 comments

Please sign in to leave a comment.