Introduction to Quota Functions for Scripting

Overview

This how-to will introduce you to the functions of QuotaMgr.
These set of functions allow you to communicate with your quotas throughout your scripts, dynamically while an interview is conducted.
This might come in handy when the script logics are quota dependent.

The QuotaMgr functions:

• QuotaMgr.GetQuotaCurrent(“name of your quota”);
  This function will get the current number filled by the given quota name.

• QuotaMgr.GetQuotaTotal(“name of your quota”);
  This function will get the current target of the given quota name.

• QuotaMgr.HasCurrentSetQuota(“Male”);
  This function will return ‘true’ if the current interview has set the given quota and ‘false’ if it hasn’t.

• QuotaMgr.HasFilledQuota(“Female”);
  This function will return ‘true’ if the current quota is full and ‘false’ if it isn’t full.

You can use these functions in any script, but please note, that the quota name must be exactly as it is written in your quota configuration’s, if it is not the same, it would not work.

 

Quotas Functions and Multiple Languages

Here's a clearer and more concise version for your knowledge base article:

Using Quota Functions in Multi-Language Surveys

Quota functions rely on the quota name as an input parameter. When working with surveys that support multiple languages (see Multiple Languages in SurveyToGo), additional scripting may be required.

In most cases, quota names are retrieved dynamically rather than hard-coded in the script. For example, suppose you have a Gender question (Question 1) with the answer options Male and Female, and this question is part of your quota structure.

If you want to check whether the quota for the selected answer has already been filled, you cannot hard-code the quota name because the respondent's selection is not known in advance. Instead, retrieve the selected answer text dynamically:

[Insert code example for retrieving the selected answer text]

You can then use the retrieved value to check whether the corresponding quota has been filled:

[Insert code example for checking the quota]

Multi-Language Considerations

When a survey supports multiple languages, the displayed answer text is translated, but quota names are not. Quota names always remain in the survey's default language.

As a result, using the translated answer text as the quota name will cause the quota functions to fail because the translated text no longer matches the actual quota name.

To avoid this issue, retrieve the original (default language) text of the selected answer instead of the translated text:

[Insert code example for retrieving the original answer text]

This returns the answer text exactly as it was defined in the survey's default language, ensuring it matches the corresponding quota name and allowing the quota functions to work correctly in multilingual surveys.

NOTE: The quota names can be seen in the Quota tab by selecting the Show Quota Names option on the Design Mode field: