Available Functions

Below is a list of the functions available in Data Processing:

Function	Description	Example
AddLogError(string message)	Adds an error message to the task log, highlighted with red error icon.	AddLogError(“Error”);
AddLogMessage(string message)	Adds a message to the task log, highlighted with information icon.	If (Gender == “female”) { AddLogMessage(“female found”); }
AddLogWarning(string message)	Adds a warning to the task log, highlighted with question mark icon.	AddLogWarning(“Warning!”);
Average(object[] values)	Returns the average of the specified values.	var avg = Average(“10”,15, Field1); if (avg >= 15.2) { MyAverageVariable = avg; }
CleanLoopRecords(string variableId)	Sets the value of the specified variableId to NULL for all answers in a question variableid with loop reference answerlist.	CleanLoopRecords("m1");
CurrentResponseId	Returns an int containing the responseid of the current record.	If (CurrentResponseId > 10) Gender = “female”;
DeleteCurrentContact()	Can be used in addition to execution mode “delete data” in Data processing rules to delete contacts from a contact database.	DeleteCurrentContact()
DeleteCurrentResponse()	Permanently deletes the current response record from the survey database. Note: Survey database (same project) must be selected as Source and Target in the Data Processing rule, a filter must be applied in the Source Tab, and “Delete Data” must be selected as Execution Mode in the Target tab.	DeleteCurrentResponse()
DeleteCurrentResponseAndRespondent()	Permanently deletes both the current response record from the survey database and the corresponding respondent record from the respondent database. Note: Survey database (same project) must be selected as Source and Target in a Data Processing rule, a filter must be applied in the Source Tab, and “Delete Data” must be selected as Execution Mode in the Target tab.	DeleteCurrentResponseAndRespondent()
DeleteNotAnswered()	Permanently deletes the current respondent record from the respondent database if it is not answered and also meets the Source tab record filter. Note that respondent Data (same project) must be selected as the Source and Target in the Data Processing rule. Additionally, a filter must be applied in the Source Tab, and “Delete Data” must be selected as Execution Mode in the Target tab.	DeleteNotAnswered()
GetCodes(string formName)	Returns the codes of the specified question where the question uses a normal answerlist. This is not supported for hierarchy and table lookup questions.	var multiQCodes = GetCodes("multiQ");
GetLabelFromCode (“q1”, code)	Retrieves answer label for provided code
GetCodeFromLabel(“q1”, label);	Retrieves code for provided label
GetQuestions()	Returns all questions which were selected as columns in the Data Processing rule.
GetQuestionsByCategory(string category)	Returns all questions which have the question category specified as variable property and are selected as columns in the Data Processing rule.	var questions = GetQuestionsByCategory("NeedsCleaning");
GetQuestionsByType(QuestionType type)	Returns an array of QuestionInfo objects for all the questions of a specific type (Single, Multi, Grid, Numeric, Date, OpenText, OpenTextList, Ranking, NumericList). QuestionInfo objects has the following properties: string : Name, QuestionType : Type, string[] : Codes, string[] : Scale, string : Category	var questions = GetQuestionsByType(QuestionType.Numeric); for (var i = 0; i < questions.length; i++ ) { var value = GetValue(questions[i].Name); }
GetScale(string gridFormName)	Returns the scales of the specified Grid question.	var scaleGrid = GetScale("gridQ");
GetValue(string fieldName)	Returns the value of the current respondent for a specified question.	var val = GetValue("singleQ"); var val = GetValue("multiQ_precode3");
IsNull(string fieldname)	Returns true if a variable doesn't have any data (null in the database), and false if not.	If (IsNull(“Gender”) ) { Gender = “male”; }
SendMail(string from, string to, string subject, string bodyText, string CC, string bcc, int mailFormat, int bodyFormat, int codepage)	Function for sending an email. Parameters are: • from: Message sender address • to: Recipient’s address • subject: Message subject line • bodyText: Message body • cc: cc address • bcc: bcc address • mailFormat: Deprecated, not in use • bodyFormat: Body format, where 0 = HTML, 1 = Plain text • codepage: Code page	SendMail("[e-mail]", "[e-mail]", “Test email”, “Can <b>you</b> read this?”)?”,,,,1);
SetInterviewStatus( status)	Used for setting status, it will also update the system field "state" correctly, so that for example when switching from complete to incomplete, the respondent will be allowed to open the survey when "Allow recipient to re-enter a complete interview" is not set. SetInterviewStatus( status); where status is one of the predefined statuses in the InterviewStatus object: • InterviewStatus.Incomplete • InterviewStatus.Complete • InterviewStatus.QuotaFull • InterviewStatus.Screened • InterviewStatus.Error	SetInterviewStatus( InterviewStatus.Incomplete);
SetLoopRecord(string variableId, string iterationId, object value)	Adds or updates a loop record of current respondent with specified value for the specified variable in the specified loop iteration. The value used depends on the variable type. If the specified loop record already exists then it will be updated, if it doesn’t yet exist it will be added – it is not possible to do both for the same respondent record in the same action script. Note that nested loops are not supported.	SetLoopRecord("m1", "iter2", true); SetLoopRecord ("s1", "iter1", "singleAnswer3");
SetNull(string fieldname)	Used to assign the null value to a variable.	If (!IsNull(“Gender)) { SetNull(“Gender”); }
SetValue(string fieldName, object value)	Sets the value of the current respondent for a specified question. Depending of the question type, the value needs to be set accordingly. Example: If a Multi question is used the value needs to either set to true or false, if a Numeric question is used a decimal value can be applied.	SetValue("singleQ","precode1"); SetValue("multiQ_2", true); SetValue("numericQ", 123.45); SetValue("dateQ", DateTime.Now);
SkipCurrentRecord()	Skips the record and moves to the next in the DP rule.	if (Gender=”female”) SkipCurrentRecord();
Weights(object[] fields)	Returns an array containing the weights for the given fields. The fields must be questions having a weighted answer list, otherwise the script will fail.	var weights = Weights(q1, q2, q3); var avg = Average (Weights);