Quota object

In AskiaScript, the quota object is a predefined object that allows you to access information about quotas in your AskiaScript. It is located in the global scope, so is accessible from anywhere in AskiaScript.

See also:

• Quotas
• QuotaLines collection
• QuotaLine object
• Quota methods available for the question object

In this topic:

In draft

• Properties:
  • UseSingleTarget
  • IncludeRunningInterviews
  • CheckingType
  • Root

In draft 

• Methods:
  • FindByTag()
  • ToString()
  • TypeOf()

Properties

UseSingleTarget

Use a single target or a min and max target (total).

Returns a Boolean.

Example

Quota.UseSingleTarget '=> Returns True or False

↑ Top of page ↑

IncludeRunningInterviews

Indicates whether running interviews are included or not as completed.

Returns a Boolean.

Example

Quota.IncludeRunningInterviews '=> Returns True or False

↑ Top of page ↑

CheckingType

Returns the quota checking method being used during interviews, as a number.

Returns a Number.

The possible values are as follows:

• 1: "As they are at the moment": quotas are updated live, during interviews (this is the default setting).
• 2: "From the beginning of the session": a snapshot of the quota values taken at the beginning on an interview session (when the contact was called) will be used, even though there may have been changes to the quota values in the mean-time; changing the quota tree resets these values.
• 3: "From the start of the interview": a snapshot of the quota values taken at the beginning of the interview (when the interview was opened when the contact was called), will be used, even though there may have been changes to the quota values in the mean-time; changing the quota tree resets these values.

Example

Quota.CheckingType -> Returns 1 for "As they are at the moment", 2 for "From the beginning of the session" and 3 for "From the start of the interview"

↑ Top of page ↑

Root

The root QuotaLine (total).

Returns a Quota line.

Example

Quota.Root '=> <TODO>

↑ Top of page ↑

Methods

FindByTag(tag)

The QuotaLine found using the Tag.

Returns a Quota line.

Parameter

• tag [Required] {String}: tag of the quota row to be retrieved.

In the quota view in the supervisor, you can find a column tag with the autopopulated tag. The format of the tag is :

ShorcutOfTheQuestion1:EntryCode;ShorcutOfTheQuestion

ShorcutOfTheQuestion1:EntryCode;ShorcutOfTheQuestion2:EntryCode

• The question shortcut and entry code are separated with a colon sign (":")
• Each node is separated by a semi-colon sign (";")

You can also decide to overwrite these tags in the interface and put in your own.

Example

Autopopulated tag:

age:1;gender
age:1;gender:1

Modified tag:

youngGender
yougMen

Quota.FindByTag("age:1;gender") '=> <TODO>
Quota.FindByTag("age:1;gender:1") '=> <TODO>

Quota.findByTag("youngGender") '=> <TODO>
Quota.FindByTag("youngMen") '=> <TODO>

↑ Top of page ↑

ToString()

Returns a string which represents the quota object (expressed in JSON format).

Returns a String.

Example

' Output in a single line (broken here for sake of the readability)
Quota.FindByTag("YoungGender").ToString() 
' => [{
TODO::CONTINUE HERE
},{
TODO::CONTINUE HERE
}]

↑ Top of page ↑

TypeOf()

Always returns "quota".

Returns a String.

Example

Quota.FindByTag("YoungGender").TypeOf() ' => "quota" 

↑ Top of page ↑