Quota Control Functions

Top  Previous  Next

Lighthouse Studio includes a number of functions that can be used when employing Quota Control.  The standard quota control options available in Lighthouse Studio's interface give a great deal of control.  However, advanced users may wish to use additional functions having to do with quota control.

 

The "Sawtooth Script" column below gives the syntax for Quota Control Functions.  

                 

Sawtooth Script:

Description:

GetValue(QuestionName)

Returns the quota cell value to which the respondent has been assigned for the quota question referred to by QuestionName.

 

An empty string (nothing) is returned if unassigned. A "-1" is returned if the respondent did not qualify due to logic or they qualified for a cell that already had its limit met.  A "-2" is returned if all of the quota cell limits for the quota were met and the respondent could not get in.  A "-3" is returned if the respondent qualified for a quota cell but then left the survey.  While they were gone all of the quota cell limits were met.

QuotaCellName(QuestionName)

Returns the quota cell name to which the respondent has been assigned; returns empty string (nothing) if unassigned

IsQuotaCellOpen

 (QuestionName, QUOTA_CELL_NAME)

IsQuotaCellOpen

 (QuestionName, QUOTA_CELL_VALUE)

Returns true (1) if the cell is open, false (0) if the cell is closed

QuotaCellRemaining

 (QuestionName, QUOTA_CELL_NAME)

QuotaCellRemaining

 (QuestionName, QUOTA_CELL_VALUE)

Returns the number of completes left to fill the quota cell.  Returns 0 if quota cell is full.

QuotaCellLimit

 (QuestionName, QUOTA_CELL_NAME)

QuotaCellLimit

 (QuestionName, QUOTA_CELL_VALUE)

Returns the quota cell limit

QuotaCellCompletes

(QuestionName, QUOTA_CELL_NAME)

QuotaCellCompletes

(QuestionName, QUOTA_CELL_VALUE)

Returns number of completes in the quota cell

AreAllQuotasClosed()

Returns true if all cells have been closed for all quotas.  This might be useful if you don't want to show a "survey closed" message but would like to skip the respondent to a different survey.

AreAllQuotaCellsClosed

 (QuestionName)

Returns true if all cells have been closed for the specified quota.

 

AreAnyQuotasClosed()

 

Returns true if all cells have been closed in any quota.

 

Page link: http://www.sawtoothsoftware.com/help/lighthouse-studio/manual/index.html?hid_web_quotacontrolfunctions.html