Project and interview properties: Reference
This topic describes all project, interview, and user properties associated with projects that are created or run using any UNICOM Intelligence Interviewer - Server activity or application. For information about properties in general, see
Project and interview properties.
Project, interview, and user properties
ActiveVersion
The active metadata version to use for interviewing.
Data type: Text
Default value: The latest version
Available in interview script? No
Available in AuthenticateSampleRec:
New interviews: No
Restart: No
Available in ReturnSampleRec
New interviews: No
Restart: No
System variable saved in: N/A
Property type: Both project and interview
AmFile
The name of an audio file to play if an answering machine is detected. It is expected that the dialing provider will play this file if an answering machine is detected, then hang up.
Data type: Text
Default value: None
Available in interview script? No
Available in AuthenticateSampleRec:
New interviews: No
Restart: No
Available in ReturnSampleRec
New interviews: No
Restart: No
System variable saved in: N/A
Property type: Interview only
AppointmentCode
The call outcome codes that can be used for setting appointments in CATI interviews. See
Call and contact outcome codes for more information.
Data type: Text
Default value: 11
Available in interview script? No
Available in AuthenticateSampleRec
New interviews: No
Restart: No
Available in ReturnSampleRec
New interviews: No
Restart: No
System variable saved in: N/A
Property type: Project only Created during activation.
AuthenticatePage
The page to display for authentication. This can be a URL or the name of a template. Recommended that you use a template and not a URL for this page.
Data type: Text
Default value: authenticate.htm
Available in interview script? No
Available in AuthenticateSampleRec:
New interviews: Yes
Restart: Yes
Available in ReturnSampleRec
New interviews: Yes
Restart: Yes
System variable saved in: N/A
Property type: Both project and interview
AuthenticateType
The form of the Authenticate Page property; either URL or template.
Data type: Text
Default value: Template
Available in interview script? No
Available in AuthenticateSampleRec
New interviews: Yes
Restart: Yes
Available in ReturnSampleRec:
New interviews: Yes
Restart: Yes
System variable saved in: N/A
Property type: Both project and interview
AuthFailedPage
The page to display when authentication fails. This can be a URL or the name of a template.
Data type: Text
Default value: authfailed.htm
Available in interview script? No
Available in AuthenticateSampleRec
New interviews: Yes
Restart: Yes
Available in ReturnSampleRec:
New interviews: Yes
Restart: Yes
System variable saved in: N/A
Property type: Both project and interview
AuthFailedType
The form of the AuthFailed Page property; either URL or template.
Data type: Text
Default value: Template
Available in interview script? No
Available in Authenticate Sample Rec:
New interviews: Yes
Restart: Yes
Available in ReturnSampleRec:
New interviews: Yes
Restart: Yes
System variable saved in: N/A
Property type: Both project and interview
AuthRetryPage
The page to display when a respondent accesses authentication for the second and subsequent times. This can be a URL or the name of a template. Recommend ed that you use a template and not a URL for this page.
Data type: Text
Default value: authretry.htm
Available in interview script? No
Available in AuthenticateSampleRec:
New interviews: Yes
Restart: Yes
Available in AuthenticateSampleRec
New interviews: Yes
Restart: Yes
System variable saved in: N/A
Property type: Both project and interview
AuthRetryType
The form of the AuthRetry Page property; either URL or template.
Data type: Text
Default value: Template
Available in interview script? No
Available in AuthenticateSampleRec:
New interviews: Yes
Restart: Yes
Available in ReturnSampleRec:
New interviews: Yes
Restart: Yes
System variable saved in: N/A
Property type: Both project and interview
AutoAnswer
Whether the interview is being automatically answered by an automated script testing tool (1) or not (0).
Data type: Boolean
Default value: False
Available in AuthenticateSampleRec:
New interviews: No
Restart: No
Available in ReturnSampleRec:
New interviews: No
Restart: No
System variable saved in: N/A
Property type: Interview only
AutoDial
Whether the dialing provider should dial the phone number automatically.
Data type: Long
Default value: 1
Available in interview script? No
Available in AuthenticateSampleRec:
New interviews: No
Restart: No
Available in ReturnSampleRec:
New interviews: No
Restart: No
System variable saved in: N/A
Property type: Interview only
AutoDialTimeout
The number of seconds that auto-dialing should continue trying to dial numbers for an Interviewer.
Data type: Long
Default value: 600 (10 minutes)
Available in interview script? No
Available in AuthenticateSampleRec:
New interviews: No
Restart: No
Available in ReturnSampleRec:
New interviews: No
Restart: No
System variable saved in: N/A
Property type: Project only
AutoSelectOther
Whether to accept Other responses if the Other check box or radio button is not selected.
Data type: Boolean
Default value: False
Available in AuthenticateSampleRec:
New interviews: No
Restart: No
Available in ReturnSampleRec:
New interviews: No
Restart: No
System variable saved in: N/A
Property type: Interview only
AutoUpdateDataModel
Whether to write data immediately for each value (2), write to the data model for each submitted page (1), or at the end of the interview (0).
Data type: Long
Default value: 1
Available in interview script? No
Available in AuthenticateSampleRec:
New interviews: Yes
Restart: Yes
Available in ReturnSampleRec:
New interviews: Yes
Restart: Yes
System variable saved in: N/A
Property type: Both project and interview
Browser
The browser version used to post the page. The Web Service captures the browser version from the browser. Only available when using the Web player.
Data type: Text
Default value: None
Available in AuthenticateSampleRec:
New interviews: Yes
Restart: No
Available in ReturnSampleRec:
New interviews: Yes
Restart: No
System variable saved in: N/A
Property type: Interview only
BrowserCapabilities
A property collection that contains the respondent's browser capabilities. Unless supplied by the browser, only available for Web interviews.
A Browser Capabilities detection start page example is installed in this folder:
[INSTALL_FOLDER]\IBM\SPSS\DataCollection\7\DDL\Scripts\Interview\Frequently Asked Questions\Browser capabilities and respondent IP address
The example files, provide a template for implementing project start pages that capture respondent browser capabilities. The browser information can be used to perform auto post-back by adding BrowserCapabilities to the query string. For more information, see the comments that are in the start.html file.
To setup the example, do this:
1. Copy the BrowserCaps.js file to [INSTALL_FOLDER]\IBM\SPSS\DataCollection\7\Interviewer Server\Server\mrIWeb\Script.
2. Copy the start.htm file to [INSTALL_FOLDER]\IBM\SPSS\DataCollection\7\Interviewer Server\Server\mrIWeb.
3. Activate the BrowserCaps.mdd project.
4. Test the activation with the following URL:
http://<HostName>/mrIWeb/start.htm?I.PROJECT=BROWSERCAPS
A list of browser capabilities and HTTP server variables in the interview is displayed.
Data type: Text
Default value: None
Available in AuthenticateSampleRec:
New interviews: No
Restart: No
Available in ReturnSampleRec:
New interviews: No
Restart: No
System variable saved in: N/A
Property type: Interview only
CallerID
The caller ID to send when dialing with a dialer. If set to 0, no caller ID is sent. If set to 1, the dialer's phone number is sent. Otherwise the contents of this field are sent as the ID.
Data type: Text
Default value: 1
Available in interview script? No
Available in AuthenticateSampleRec:
New interviews: No
Restart: No
Available in ReturnSampleRec:
New interviews: No
Restart: No
System variable saved in: N/A
Property type: Both project and interview
CancelCode
The call outcome code to use for interviews that are terminated part-way through. See
Call and contact outcome codes for more information.
Data type: Text
Default value: 41
Available in interview script? No
Available in AuthenticateSampleRec:
New interviews: No
Restart: No
Available in ReturnSampleRec:
New interviews: No
Restart: No
System variable saved in: N/A
Property type: Project only
Created during activation.
CAPIAppointmentCode
The contact outcome codes that can be used for setting appointments in CAPI interviews.
Data type: Text
Default value: 11
Available in interview script? No
Available in AuthenticateSampleRec:
New interviews: No
Restart: No
Available in ReturnSampleRec:
New interviews: No
Restart: No
System variable saved in: N/A
Property type: Project only
Created during activation.
CAPICancelCode
The contact outcome code to use for interviews that are terminated part-way through.
Data type: Text
Default value: 41
Available in interview script? No
Available in AuthenticateSampleRec:
New interviews: No
Restart: No
Available in ReturnSampleRec:
New interviews: No
Restart: No
System variable saved in: N/A
Property type: Project only
Created during activation.
CAPIHiddenCodesList
The contact outcome codes that should not appear in the list displayed to interviewers.
Data type: Text
Default value: 1; 2; 4; 5; 6; 7; 35; 41
Available in interview script? No
Available in AuthenticateSampleRec:
New interviews: Yes
Restart: Yes
Available in ReturnSampleRec:
New interviews: No
Restart: No
System variable saved in: N/A
Property type: Project only
Created during activation.
CAPIRunningCodesList
The contact outcome codes that are available during interviews.
Data type: Text
Default value: 8; 11; 15; 27; 31; 32
Available in interview script? No
Available in AuthenticateSampleRec:
New interviews: No
Restart: No
Available in ReturnSampleRec:
New interviews: No
Restart: No
System variable saved in: N/A
Property type: Project only
Created during activation.
ClusterList
The cluster on which the project is activated. Currently, all projects are activated to the same cluster.
Data type: Text
Default value: Default Cluster;
Available in interview script? No
Available in AuthenticateSampleRec:
New interviews: No
Restart: No
Available in ReturnSampleRec:
New interviews: No
Restart: No
System variable saved in: N/A
Property type: Project only
CompletedInterviewPage
The page to display when a respondent completes an interview. This can be a URL or the name of a template.
Data type: Text
Default value: None
Available in interview script? No
Available in AuthenticateSampleRec:
New interviews: No
Restart: No
Available in ReturnSampleRec:
New interviews: No
Restart: No
System variable saved in: N/A
Property type: Both project and interview
CompletedInterviewType
The form of the CompletedInterviewPage property; either URL or template. This property can be used to chain together web surveys by specifying a URL that redirects to the next survey.
Data type: Text
Default value: None
Available in interview script? No
Available in AuthenticateSampleRec:
New interviews: No
Restart: No
Available in ReturnSampleRec:
New interviews: No
Restart: No
System variable saved in: N/A
Property type: Both project and interview
ConfirmHangupOutcomes
A list of call outcomes that do not immediately disconnect the call. Separate multiple outcomes by using a semicolon.This property is only employed when used with IBM SPSS Dialer. Interviewers will need to exit and re-enter the Phone participants activity in order to pick up changes to this property.
Data type: Text
Default value: 15
Available in interview script? No
Available in AuthenticateSampleRec:
New interviews: No
Restart: No
Available in ReturnSampleRec:
New interviews: No
Restart: No
System variable saved in: N/A
Property type: Project only
ConnectionID
The interview's connection ID. Used internally by sample management and should not be changed.
Data type: Text
Default value: None
Available in interview script? No
Available in AuthenticateSampleRec:
New interviews: No
Restart: No
Available in ReturnSampleRec:
New interviews: No
Restart: No
System variable saved in: N/A
Property type: Interview only
Context
The context to use for labels from the MDM.
Data type: Text
Default value: None
Available in interview script? No
Available in AuthenticateSampleRec:
New interviews: No
Restart: No
Available in ReturnSampleRec:
New interviews: No
Restart: No
System variable saved in: N/A
Property type: Interview only
Debug
Whether the interview is being debugged (1) or not (0).
Data type: Boolean
Default value: False
Available in AuthenticateSampleRec:
New interviews: No
Restart: No
Available in ReturnSampleRec:
New interviews: No
Restart: No
System variable saved in: DataCollection. Debug
Property type: Interview only
DefaultCategoryType
The default category type for categorical questions.
Data type: Text
Default value: multi
Available in interview script? No
Available in AuthenticateSampleRec:
New interviews: No
Restart: No
Available in ReturnSampleRec:
New interviews: No
Restart: No
System variable saved in: N/A
Property type: Project only
Created and used by the Build activity only.
DefaultPresentationTemplate
The name of the template to use if no template is specified in an item's definition.
Data type: Text
Default value: None
Available in interview script? No
Available in AuthenticateSampleRec:
New interviews: No
Restart: No
Available in ReturnSampleRec:
New interviews: No
Restart: No
System variable saved in: N/A
Property type: Project only
Created and used by the Build activity only.
DialerCallOutcome
The dialer's call outcome for this interview. Used when the dialer returns a sample record for a disconnected call to the interviewer (for example, a fax machine number).
Data type: Text
Default value: None
Available in interview script? No
Available in AuthenticateSampleRec:
New interviews: No
Restart: No
Available in ReturnSampleRec:
New interviews: No
Restart: No
System variable saved in: N/A
Property type: Interview only
DialingProvider
The name of the dialing sample management provider to use, specified as the ProgID of the provider class. Existing names are QsampExt SM. Provider and QSamp Group SM. Provider. The property is empty when the project does not use a dialer.
Data type: Text
Default value: None
Available in interview script? No
Available in AuthenticateSampleRec:
New interviews: No
Restart: No
Available in ReturnSampleRec:
New interviews: No
Restart: No
System variable saved in: N/A
Property type: Project only
Engine
The session engine on which the interview is running. When starting a new interview, the Web Service attempts to run the interview on this engine before any other. Can optionally be used as part of interview creation to bypass default load balancing.
Data type: Text
Default value: None
Available in interview script? No
Available in AuthenticateSampleRec:
New interviews: Yes
Restart: Yes
Available in ReturnSampleRec:
New interviews: Yes
Restart: Yes
System variable saved in: DataCollection.InterviewEngine
Property type: Interview only
ExpiryDateTime
Specifies a project expiry time that controls the last time that an interview can occur for a project in web or phone mode including prohibiting appointments to be set after the expiry time.
Data type: Date
Default value: None
Available in interview script? No
Available in AuthenticateSampleRec:
New interviews: No
Restart: No
Available in ReturnSampleRec:
New interviews: No
Restart: No
System variable saved in: N/A
Property type: Both project and interview
GroupDial
Indicates if the record should be preview or group dialed, 0 for preview dial and 1 for group dial.
Data type: Boolean
Default value: 0
Available in interview script? Yes if set to 1.
Available in AuthenticateSampleRec:
New interviews: No
Restart: No
Available in ReturnSampleRec:
New interviews: Yes
Restart: Yes
System variable saved in: N/A
Property type: Both project and interview
HiddenCodesList
Call outcome codes that should not appear in the list displayed for interviewers. See
Call and contact outcome codes for more information.
Data type: Text
Default value: 1; 2; 4; 5; 6; 10; 26; 34; 42; 43; 44; 51; 52; 53
Available in interview script? No
Available in AuthenticateSampleRec:
New interviews: Yes
Restart: Yes
Available in ReturnSampleRec:
New interviews: No
Restart: No
System variable saved in: N/A
Property type: Project only
InterviewerID
The ID of the interviewer who conducted the interview.
Data type: Text
Default value: None
Available in AuthenticateSampleRec:
New interviews: Yes
Restart: Yes
Available in ReturnSampleRec:
New interviews: Yes
Restart: Yes
System variable saved in: DataCollection.Interviewer ID
Property type: Interview only
InterviewerTimezone
The interviewer's timezone (as a time zone index).
Data type: Long
Default value: Local timezone
Available in AuthenticateSampleRec:
New interviews: Yes
Restart: Yes
Available in ReturnSampleRec:
New interviews: Yes
Restart: Yes
System variable saved in: DataCollection.Interviewer Time Zone
Property type: Interview only
InterviewRejectedPage
The page to display when authentication fails and no retries are to be offered. This can be a URL or the name of a template.
Data type: Text
Default value: rejected.htm
Available in interview script? No
Available in AuthenticateSampleRec:
New interviews: Yes
Restart: Yes
Available in ReturnSampleRec:
New interviews: Yes
Do not change this property here because you cannot be sure that Return Sample Rec will have finished running by the time UNICOM Intelligence Interviewer - Server displays the page.
Restart: Yes
Do not change this property here because you cannot be sure that Return Sample Rec will have finished running by the time UNICOM Intelligence Interviewer - Server displays the page.
System variable saved in: N/A
Property type: Both project and interview
InterviewRejectedType
The form of the InterviewRejectedPage property; either URL or template.
Data type: Text
Default value: Template
Available in interview script? No
Available in AuthenticateSampleRec:
New interviews: Yes
Restart: Yes
Available in ReturnSampleRec:
New interviews: Yes
Restart: Yes
System variable saved in: N/A
Property type: Both project and interview
InterviewRestart
Whether to restart interviews using the version they started with (0), or the version specified by ActiveVersion (1).
Data type: Boolean
Default value: 1
Available in interview script? No
Available in AuthenticateSampleRec:
New interviews: Yes
Restart: Yes
Available in ReturnSampleRec:
New interviews: Yes
Restart: Yes
System variable saved in: N/A
Property type: Project only
InterviewScriptType
The script type. Always Data Collection.
Data type: Text
Default value: None
Available in interview script? No
Available in AuthenticateSampleRec:
New interviews: No
Restart: No
Available in ReturnSampleRec:
New interviews: No
Restart: No
System variable saved in: N/A
Property type: Project only
InterviewStartURL
The URL used to start an interview on the project.
Data type: Text
Default value:
http://{Site. UNICOM Intelligence URL} /mrIWeb. dll?I. Project={ Project Name}
Available in interview script? No
Available in AuthenticateSampleRec:
New interviews: No
Restart: No
Available in ReturnSampleRec:
New interviews: No
Restart: No
System variable saved in: N/A
Property type: Project only
InterviewStatus
The current status of the interview.
Data type: Text
Default value: None
Available in AuthenticateSampleRec:
New interviews: No
Restart: No
Available in ReturnSampleRec:
New interviews: No
Restart: No
System variable saved in: N/A
Property type: Interview only
InterviewStoppedPage
The page to display when a respondent clicks Stop during an interview or when the interview script forces early termination of the interview. This can be a URL or the name of a template.
Data type: Text
Default value: None
Available in interview script? No
Available in AuthenticateSampleRec:
New interviews: No
Restart: No
Available in ReturnSampleRec:
New interviews: No
Restart: No
System variable saved in: N/A
Property type: Both project and interview
InterviewStoppedType
The form of the InterviewStoppedPage property; either URL or template.
Data type: Text
Default value: None
Available in interview script? No
Available in AuthenticateSampleRec:
New interviews: No
Restart: No
Available in ReturnSampleRec:
New interviews: No
Restart: No
System variable saved in: N/A
Property type: Both project and interview
IsTest
Whether this is a test interview.
Data type: Boolean
Default value: False
Available in AuthenticateSampleRec:
New interviews: Yes
Restart: Yes
Available in ReturnSampleRec:
New interviews: N/A
Restart: N/A
System variable saved in: N/A
Property type: Interview only
IsUploadSample
Used to prevent multiple users from uploading samples, for the same project, at the same time. Resource conflicts can occur when multiple users access the same table. This property contains the two following properties: ExpiryTime Span
Start Time
StartTime = empty OR Current Time > (StartTime + Expiry TimeSpan)
Data type: Long
Default value: Expiry TimeSpan = 1800 (30 minutes). If one user is uploading a sample, the value for StartTime is set as the upload sample start time. Normally, the value is set back to empty once the user is finished uploading the sample.
Available in interview script? No
Available in AuthenticateSampleRec:
New interviews: No
Restart: No
Available in ReturnSampleRec:
New interviews: No
Restart: No
System variable saved in: N/A
Property type: Project only
LabelType
The label type to use for labels from the MDM.
Data type: Text
Default value: None
Available in AuthenticateSampleRec:
New interviews: No
Restart: No
Available in ReturnSampleRec:
New interviews: No
Restart: No
System variable saved in: N/A
Property type: Interview only
Language
The language to use for labels from the MDM. The Web Service attempts to capture the language from the browser.
Data type: Text
Default value: None
Available in AuthenticateSampleRec:
New interviews: Yes
Restart: No
Available in ReturnSampleRec:
New interviews: Yes
Restart: No
System variable saved in: N/A
Property type: Interview only
LastActivatedBy
The name of the user who last activated the project.
Data type: Text
Default value: None
Available in interview script? No
Available in AuthenticateSampleRec:
New interviews: No
Restart: No
Available in ReturnSampleRec:
New interviews: No
Restart: No
System variable saved in: N/A
Property type: Project only
MasterProject
Data type: Text
Default value: None
Available in interview script? No
Available in AuthenticateSampleRec:
New interviews: No
Restart: No
Available in ReturnSampleRec:
New interviews: No
Restart: No
System variable saved in: N/A
Property type: Interview only
MaxAuthRetries
The maximum number of times a respondent can retry authentication; that is, the number of times the respondent can try authentication after first accessing it.
Changes to the value of this property must be specified at both the project and interview level. However, sample management uses only the interview property setting when testing authentication retries.
Data type: Long
Default value: 5
Available in interview script? No
Available in AuthenticateSampleRec:
New interviews: Yes
Restart: No
Available in ReturnSampleRec:
New interviews: No
Restart: No
System variable saved in: N/A
Property type: Both project and interview.
MaxOpCodesExecuted
The maximum number of instructions to process before the script is considered to be in an infinite loop.
Data type: Long
Default value: 1000000
Available in AuthenticateSampleRec:
New interviews: Yes
Restart: Yes
Available in ReturnSampleRec:
New interviews: Yes
Restart: Yes
System variable saved in: N/A
Property type: Interview only
MaxPredictiveSilentCalls
The maximum percentage of silent calls per total connected calls. Predictive dialing is suspended if this value is exceeded.
Data type: Double
Default value: 3.0
Available in interview script? No
Available in AuthenticateSampleRec:
New interviews: No
Restart: No
Available in ReturnSampleRec:
New interviews: No
Restart: No
System variable saved in: N/A
Property type: Project only
MaxQuestionsOnReplay
The maximum number of questions that can be automatically answered before the script is considered to be in an infinite loop.
Data type: Long
Default value: 4000
Available in AuthenticateSampleRec:
New interviews: Yes
Restart: Yes
Available in ReturnSampleRec:
New interviews: Yes
Restart: Yes
System variable saved in: N/A
Property type: Interview only
MaxSilentCalls
The maximum percentage of silent calls per total connected calls that can occur for nonpredictive dialing before group dialing is suspended.
Data type: Double
Default value: 1.0
Available in interview script? No
Available in AuthenticateSampleRec:
New interviews: No
Restart: No
Available in ReturnSampleRec:
New interviews: No
Restart: No
System variable saved in: N/A
Property type: Project only
MessagesDocument
The name of the standard messages file.
Data type: Text
Default value: None
Available in AuthenticateSampleRec:
New interviews: No
Restart: No
Available in ReturnSampleRec:
New interviews: No
Restart: No
System variable saved in: N/A
Property type: Interview only
MinimumRingTime
The minimum number of seconds that the phone must ring before the call can be disconnected.
Data type: Double
Default value: 0
Available in interview script? No
Available in AuthenticateSampleRec:
New interviews: No
Restart: No
Available in ReturnSampleRec:
New interviews: No
Restart: No
System variable saved in: N/A
Property type: Project only
MonitoringAllowed
Whether interviewers can be monitored. Possible settings are:
0= Never allowed
1= Always allowed
2=Ask participant
See "Interviewer Monitoring" in the Interview Settings topic, which is in the Phone Surveys section of the UNICOM Intelligence Interviewer - Server User's Guide, for further information.
Data type: Long
Default value: 2
Available in interview script? No
Available in AuthenticateSampleRec:
New interviews: Yes
Restart: Yes
Available in ReturnSampleRec:
New interviews: Yes
Restart: Yes
System variable saved in: N/A
Property type: Both project and interview
InterviewerServer
Properties associated with the UNICOM Intelligence Interviewer - Server application.
Data type: Text
Default value: None
Available in interview script? No
Available in AuthenticateSampleRec:
New interviews: No
Restart: No
Available in ReturnSampleRec:
New interviews: No
Restart: No
System variable saved in: N/A
Property type: Project only
NoAnswerTimeout
The number of seconds for the dialer to let a number ring before it is considered to be unanswered.
Data type: Long
Default value: 15
This default is for UNICOM Intelligence Interviewer - Server only. The default for the QSAMP dialer interface is 30 seconds.
Available in interview script? No
Available in AuthenticateSampleRec:
New interviews: No
Restart: No
Available in ReturnSampleRec:
New interviews: No
Restart: No
System variable saved in: N/A
Property type: Both project and interview
Notes
Notes about the project. Record any special information, or details of changes between versions, about the project in this property.
Data type: Text
Default value: None
Available in interview script? No
Available in AuthenticateSampleRec:
New interviews: No
Restart: No
Available in ReturnSampleRec:
New interviews: No
Restart: No
System variable saved in: N/A
Property type: Project only
Origin
The origin of the respondent data.
Data type: Categorical
Default value: {other}
Available in AuthenticateSampleRec:
New interviews: Yes
Restart: Yes
Available in ReturnSampleRec:
New interviews: Yes
Restart: Yes
System variable saved in: Respondent.Origin
Property type: Interview only
OriginName
The source software product name. Used when the Other category is specified for Respondent. Origin.
Data type: Text
Default value: None
Available in AuthenticateSampleRec:
New interviews: No
Restart: No
Available in ReturnSampleRec:
New interviews: No
Restart: No
System variable saved in: N/A
Property type: Interview only
PercentCallsRecorded
The percentage of calls to be recorded per project between 0 and 100.
Data type: 0
Default value: Long
Available in interview script? No
Available in AuthenticateSampleRec:
New interviews: No
Restart: No
Available in ReturnSampleRec:
New interviews: No
Restart: No
System variable saved in: N/A
Property type: Project only
Project
The name of the project to which the interview belongs. Used as part of interview creation and restart. If sample management is used, the sample management script can change the project for the new interview. This property is mandatory for an interview to be started.
Data type: Text
Default value: None
Available in AuthenticateSampleRec:
New interviews: Yes
Restart: No
Available in ReturnSampleRec:
New interviews: Yes
Restart: No
System variable saved in: N/A
Property type: Interview only
ProjectInactivePage
The page to display when a respondent attempts to access a project that is not available for interviewing. This can be a URL or the name of a template.
Data type: Text
Default value: projinactive.htm
Available in interview script? No
Available in AuthenticateSampleRec:
New interviews: No
Restart: No
Available in ReturnSampleRec:
New interviews: No
Restart: No
System variable saved in: N/A
Property type: Project only
ProjectInactiveType
The type of the ProjectInactive Page property; either URL or template.
Data type: Text
Default value: Template
Available in interview script? No
Available in AuthenticateSampleRec:
New interviews: No
Restart: No
Available in ReturnSampleRec:
New interviews: No
Restart: No
System variable saved in: N/A
Property type: Project only
QuotaAutoCommit
Whether to commit changes to quota counts automatically when an interview completes (1) or not (0). This property applies only when a project does not use sample management, since this is automatic in those projects.
Data type: Boolean
Default value: True
Available in interview script? No
Available in AuthenticateSampleRec:
New interviews: No
Restart: No
Available in ReturnSampleRec:
New interviews: No
Restart: No
System variable saved in: N/A
Property type: Interview only
QuotaFullPage
The page to display when an interview terminates because the quota is full. This can be a URL or the name of a template.
Data type: Text
Default value: None
Available in interview script? No
Available in AuthenticateSampleRec:
New interviews: Yes
Restart: Yes
Available in ReturnSampleRec:
New interviews: Yes
Restart: Yes
System variable saved in: N/A
Property type: Both project and interview
QuotaFullType
The form of the QuotaFullPage property; either URL or template.
Data type: Text
Default value: None
Available in interview script? No
Available in AuthenticateSampleRec:
New interviews: Yes
Restart: Yes
Available in ReturnSampleRec:
New interviews: Yes
Restart: Yes
System variable saved in: N/A
Property type: Both project and interview
QuotaProjectName
The name of the quota project associated with this project. Blank if quota is not used.
Data type: Text
Default value: None
Available in interview script? No
Available in AuthenticateSampleRec:
New interviews: No
Restart: No
Available in ReturnSampleRec:
New interviews: No
Restart: No
System variable saved in: N/A
Property type: Project only
RaisePositionError
Whether to prevent interviewers logging in on positions that are not defined in the dialer configuration file. If RaisePositionError is False, interviewers logging in on positions not in the dialer configuration file see a warning but might continue to work. This supports sites that have some manual-dial or temporary manual-dial stations that are not in the dialer configuration file.
Data type: Boolean
Default value: False
Available in interview script? No
Available in AuthenticateSampleRec:
New interviews: No
Restart: No
Available in ReturnSampleRec:
New interviews: No
Restart: No
System variable saved in: N/A
Property type: Project only
RecordCall
Whether the call should be recorded. Can be overridden by Recording Prohibited if the respondent disallows recording.
Data type: Boolean
Default value: randomly initialized based on Percent CallsRecorded, but can be overridden in the sample script
Available in interview script? Yes if set to 1.
Available in AuthenticateSampleRec:
New interviews: No
Restart: No
Available in ReturnSampleRec:
New interviews: Yes
Restart: Yes
System variable saved in: N/A
Property type: Interview only
RecordingProhibited
Whether the respondent has disallowed recording. Overrides RecordCall if both are set to 1.
Data type and default values: Boolean: 0 (recording allowed)
Available in interview script? Yes if set to 1.
Available in AuthenticateSampleRec:
New interviews: No
Restart: No
Available in ReturnSampleRec:
New interviews: Yes
Restart: Yes
System variable saved in: N/A
Property type: Interview only
RecordInterviewOnly
Whether to record the whole call (0) or just the interview (1)
Data type: Boolean
Default value: 0
Available in interview script? No
Available in AuthenticateSampleRec:
New interviews: No
Restart: No
Available in ReturnSampleRec:
New interviews: No
Restart: No
System variable saved in: N/A
Property type: Project only
Renderer
The HTML player to use for rendering the interview. Possible settings are:
HTMLPlayer: The default HTML Player
CATIPlayer: The CATI Player
XMLPlayer: The XML Player used by UNICOM Intelligence Interviewer - Server Load Tool
Data type: Text
Default value: HTMLPlayer, but Phone Participants changes this to CATIPlayer.
While it is possible to change the player in script, the player used to create a page should be used to generate the player post XML when posting the page.
Available in AuthenticateSampleRec:
New interviews: Yes
Restart: Yes
Available in ReturnSampleRec:
New interviews: No
Restart: No
System variable saved in: N/A
Property type: Interview only
RespondentID
The respondent ID for this interview.
Data type: Long
Default value: None
Available in AuthenticateSampleRec:
New interviews: No
Restart: No
Available in ReturnSampleRec:
New interviews: Yes
Restart: Yes
System variable saved in: N/A
Property type: Interview only
RespondentTimezone
The respondent's time zone (as a time zone index). The Web Service attempts to capture the time zone from the browser.
Data type: Long
Default value: Local time zone
Available in AuthenticateSampleRec:
New interviews: Yes
Restart: Yes
Available in ReturnSampleRec:
New interviews: Yes
Restart: Yes
System variable saved in: DataColl ection.R esponde ntTime Zone
Property type: Interview only
RestartString
The string for restarting the interview.
Data type: Text
Default value: None
Available in interview script? No
Available in AuthenticateSampleRec:
New interviews: No
Restart: No
Available in ReturnSampleRec:
New interviews: No
Restart: No
System variable saved in: N/A
Property type: Interview only
Review
Whether the interview should be restarted for review.
Data type: Boolean
Default value: False
Available in AuthenticateSampleRec:
New interviews: No
Restart: No
Available in ReturnSampleRec:
New interviews: No
Restart: No
System variable saved in: N/A
Property type: Interview only
RotationValue
The initial rotation and reversal seed value for the interview.
Data type: Long
Default value: None
Available in interview script? and
Available in AuthenticateSampleRec:
New interviews: No
Restart: No
Available in ReturnSampleRec:
New interviews: No
Restart: No
System variable saved in: N/A
Property type: Interview only
RoutingContext
The default routing context to use for interviewing. Typical routing contexts are Paper for printed questionnaires, Web for inbound interviews, and CATI for outbound calling. For more information, see
Adding a routing context .
Data type: Text
Default value: default for interviewing application
Available in interview script? No
Available in AuthenticateSampleRec:
New interviews: Yes
Restart: Yes
Available in ReturnSampleRec:
New interviews: Yes
Restart: Yes
System variable saved in: DataCollection.RoutingContext
Property type: Both project and interview
Created during activation
RunningCodesList
Call outcome codes that are available during interviews. For more information, see
Call and contact outcome codes.
Data type: Text
Default value: 8; 11; 15
Available in interview script? No
Available in AuthenticateSampleRec:
New interviews: No
Restart: No
Available in ReturnSampleRec:
New interviews: No
Restart: No
System variable saved in: N/A
Property type: Project only
Created during activation
RunNumber
A four-byte run number for the interview. This is used as part of the session ID to ensure that the session ID is unique. Set to −1 for restarted interviews.
Data type: Text
Default value: 0001
Available in interview script? No
Available in AuthenticateSampleRec:
New interviews: Yes
Restart: No
Available in ReturnSampleRec:
New interviews: Yes
Restart: No
System variable saved in: N/A
Property type: Interview only
SampleID
The sample ID for sample management. This property is stored on the cache subscription for when an interview is restarted.
Data type: Text
Default value: None
Available in interview script? No
Available in AuthenticateSampleRec:
New interviews: No
Restart: No
Available in ReturnSampleRec:
New interviews: Yes
Restart: No
System variable saved in: N/A
Property type: Interview only
SampleManagementProvider
The name of the sample management provider to use, specified as the ProgID of the provider class. Existing names are mrScriptBasicSM.Provider and VBScriptSM.Provider. The property is empty when the project does not use sample management.
Data type: Text
Default value: mrScriptBasicSM.Provider
Available in interview script? No
Available in AuthenticateSampleRec:
New interviews: No
Restart: No
Available in ReturnSampleRec:
New interviews: No
Restart: No
System variable saved in: N/A
Property type: Project only
SampleParameters
The sample management parameters for this interview.
Data type: Text
Default value: None
Available in interview script? No
Available in AuthenticateSampleRec:
New interviews: No
Restart: No
Available in ReturnSampleRec:
New interviews: Yes
Restart: No
System variable saved in: N/A
Property type: Interview only
SeedValue
The randomization seed value for the interview.
Data type: Long
Default value: Based on the tick count
Available in interview script? No
Available in AuthenticateSampleRec:
New interviews: No
Restart: No
Available in ReturnSampleRec:
New interviews: No
Restart: No
System variable saved in: DataCollection.SeedValue
Property type: Interview only
Serial
The respondent's serial number. Used to identify the respondent's case data record. Write it into the sample record if you want to be able to link the sample and case data records. You can set the serial number in the sample management script. This is typically done when individual respondents can take part in a number of projects and you want to use the same serial number for a respondent in all of the projects. However, you must make sure that the serial number is always unique within each project.
Data type: Long
Default value: NULL
Available in AuthenticateSampleRec:
New interviews: Yes
Restart: Yes
Available in ReturnSampleRec:
New interviews: Yes
Restart: Yes
System variable saved in: Respondent.Serial
Property type: Interview only
Server
The name of the server on which the interview is running.
Data type: Text
Default value: None
Available in interview script? No
Available in AuthenticateSampleRec:
New interviews: No
Restart: No
Available in ReturnSampleRec:
New interviews: No
Restart: No
System variable saved in: N/A
Property type: Interview only
ServerVariables
A collection of properties containing the names and values for the ServerVariables available in IOM.Info.ServerVariables. For an example of how to access the ServerVariables, see the BrowserCaps.mdd example for the
BrowserCapabilities property.
Data type: Text
Default value: None
Available in interview script? Yes, as IOM.Info.ServerVariables
Available in AuthenticateSampleRec:
New interviews: Yes
Restart: Yes
Available in ReturnSampleRec:
New interviews: Yes
Restart: Yes
System variable saved in: N/A
Property type: Interview only
Session
A unique token that identifies a running interview. Used to differentiate new interviews from running interviews. If the Session parameter is not present in the URL, any parameters not namespaced by "Interview." are treated as authentication parameters. If the Session parameter is present, the Post string is passed to the specified HTML Player so the player post XML can be generated. This property is mandatory in order for a page to be posted
Data type: Text
Default value: None
Available in AuthenticateSampleRec:
New interviews: Yes
Restart: Yes
Available in ReturnSampleRec:
New interviews: Yes
Restart: Yes
System variable saved in: N/A
Property type: Interview only
SessionToken
A unique token that identifies the interview.
Data type: Text
Default value: None
Available in AuthenticateSampleRec:
New interviews: No
Restart: No
Available in ReturnSampleRec:
New interviews: No
Restart: No
System variable saved in: N/A
Property type: Interview only
ShowInterviewApps
Whether to display interviewing activities in UNICOM Intelligence Interviewer - Server Admin for this project.
Data type: Boolean
Default value: For Interview projects: True. For Analysis projects: False
Available in interview script? No
Available in AuthenticateSampleRec:
New interviews: No
Restart: No
Available in ReturnSampleRec:
New interviews: No
Restart: No
System variable saved in: N/A
Property type: Project only
ShowTableApps
Whether to display tabulation activities in UNICOM Intelligence Interviewer - Server Admin for this project.
Data type: Boolean
Default value: For Analysis projects: True. For Interview projects: False
Available in interview script? No
Available in AuthenticateSampleRec:
New interviews: No
Restart: No
Available in ReturnSampleRec:
New interviews: No
Restart: No
System variable saved in: N/A
Property type: Project only
Shutdown
Whether the interview was terminated because the interview engine shut down (0) or not (nonzero).
Data type: Long
Default value: None
Available in interview script? No
Available in AuthenticateSampleRec:
New interviews: Yes
Set to 0 on entry to this function and should not be changed.
Restart: Yes
Set to 0 on entry to this function and should not be changed.
Available in ReturnSampleRec:
New interviews: Yes
Restart: Yes
System variable saved in: N/A
Property type: Interview only
SilentCallAudioFile
The name of a .wav file to play to a participant if predictive dialing results in a silent call. The dialer hangs up the call after playing the file.
Data type: Text
Default value: None
Available in interview script? No
Available in AuthenticateSampleRec:
New interviews: Yes
Restart: No
Available in ReturnSampleRec:
New interviews: Yes
Restart: No
System variable saved in: N/A
Property type: Interview only
SMRetryCount
The number of times the respondent has retried authentication.
Data type: Long
Default value: None
Available in interview script? No
Available in AuthenticateSampleRec:
New interviews: Yes
Restart: No
Available in ReturnSampleRec:
New interviews: Yes
Restart: No
System variable saved in: N/A
Property type: Interview only
Test
Whether this is a test interview. 0=No; 1=Yes.
Data type: Boolean
Default value: False
Available in AuthenticateSampleRec:
New interviews: Yes
Restart: Yes. Set to True on restart and to 1 on original start.
Available in ReturnSampleRec:
New interviews: Yes
Restart: Yes. Set to True on restart and to 1 on original start.
System variable saved in: N/A
Property type: Interview only
TestUseQuota
Whether to use quota control for test interviews (1) or not (0).
Data type: Boolean
Default value: True
Available in interview script? No
Available in AuthenticateSampleRec:
New interviews: No
Restart: No
Available in ReturnSampleRec:
New interviews: No
Restart: No
System variable saved in: N/A
Property type: Project only
TestUseSampleMgmt
Whether to use Sample Management for test interviews (1) or not (0). Only used when UseSample Mgmt is 1
Data type: Boolean
Default value: True
Available in interview script? No
Available in AuthenticateSampleRec:
New interviews: No
Restart: No
Available in ReturnSampleRec:
New interviews: No
Restart: No
System variable saved in: N/A
Property type: Project only
TestVersion
The metadata version to use for test interviews.
Default value: The latest version
Available in interview script? No
Available in AuthenticateSampleRec:
New interviews: No
Restart: No
Available in ReturnSampleRec:
New interviews: No
Restart: No
System variable saved in: N/A
Property type: Project only
TextQuestionsOnly
Whether to present all questions or only questions with text and Other Specify responses for review. (Once in this mode you cannot revert to reviewing all questions without restarting the interview.)
Data type: Boolean
Default value: 0
Available in interview script? No
Available in AuthenticateSampleRec:
New interviews: No
Restart: No
Available in ReturnSampleRec:
New interviews: No
Restart: No
System variable saved in: N/A
Property type: Interview only
TimedOut
Whether the interview has timed out. This property is set to 0 on entry to the AuthenticateSampleRec function, and is reset to a nonzero value if the interview is terminated by a time-out. If you want your script to specify the action to be taken when an interview times out, test on the value of this property.
Data type: Boolean
Default value: None
Available in interview script? No
Available in AuthenticateSampleRec:
New interviews: Yes
Restart: Yes
Available in ReturnSampleRec:
New interviews: Yes
Restart: Yes
System variable saved in: N/A
Property type: Interview only
TimeLastActivated
The date and time at which the project was last activated.
Data type: Date
Default value: None
Available in interview script? No
Available in AuthenticateSampleRec:
New interviews: No
Restart: No
Available in ReturnSampleRec:
New interviews: No
Restart: No
System variable saved in: N/A
Property type: Project only
Created during activation.
Timeout
The number of seconds idle time before the interview will be timed out.
Data type: Long
Default value: 600 (10 minutes), defined in the registry in HKEY_L OCAL_MA CHINE\Software\SPSS\mrInterview\3\Interview\Interview Timeout
Available in AuthenticateSampleRec:
New interviews: Yes
Restart: No
Available in ReturnSampleRec:
New interviews: Yes
Restart: No
System variable saved in: N/A
Property type: Interview only
UseCATI
Whether the project uses CATI.
Data type: Boolean
Available in interview script? No
Available in AuthenticateSampleRec:
New interviews: No
Restart: No
Available in ReturnSampleRec:
New interviews: No
Restart: No
System variable saved in: N/A
Property type: Project only
Created during activation.
UseDataModel
Whether to use the Dimensions Data Model. This property is obsolete in UNICOM Intelligence Interviewer - Server 2.1 and later.
Data type: Boolean
Available in interview script? No
Available in AuthenticateSampleRec:
New interviews: No
Restart: No
Available in ReturnSampleRec:
New interviews: No
Restart: No
System variable saved in: N/A
Property type: Project only
UseDefaultURLs
Whether the project uses the default templates and URLs (1) or not (0).
Data type: Boolean
Default value: True
Available in interview script? No
Available in AuthenticateSampleRec:
New interviews: No
Restart: No
Available in ReturnSampleRec:
New interviews: No
Restart: No
System variable saved in: N/A
Property type: Project only
UseImageCache
Whether to use the image cache for project templates and images (1) or not (0).
Data type: Boolean
Default value: True
Available in interview script? No
Available in AuthenticateSampleRec:
New interviews: Yes
Restart: Yes
Available in ReturnSampleRec:
New interviews: Yes
Restart: Yes
System variable saved in: N/A
Property type: Project only
UseInMemoryCache
Whether to hold the data cache in memory (1) or not (0). There is no automatic restart on fail-over when the in-memory cache is used.
Data type: Boolean
Default value: False
Available in interview script? No
Available in AuthenticateSampleRec:
New interviews: Yes
Restart: Yes
Available in ReturnSampleRec:
New interviews: Yes
Restart: Yes
System variable saved in: N/A
Property type: Project only
UsePlayerNavigation
Whether the player can post previous questions. For example, when running browser based interviews, you could allow respondents to use the browser's Back button to return to a previous page of the interview rather than the interviewing program's Previous button.
Data type: Boolean
Default value: True
Available in AuthenticateSampleRec:
New interviews: Yes
Restart: Yes
Available in ReturnSampleRec:
New interviews: Yes
Restart: Yes
System variable saved in: N/A
Property type: Both project and interview
User1 to User9
Pass user-defined parameters to the interview from the URL.
Data type: Text
Default value: None
Available in AuthenticateSampleRec:
New interviews: Yes
Restart: Yes
Available in ReturnSampleRec:
New interviews: Yes
Restart: Yes
System variable saved in: N/A
Property type: Interview only
UseSampleMgmt
Whether the project uses sample management (1) or not (0).
Data type: Boolean
Default value: False
Available in interview script? No
Available in AuthenticateSampleRec:
New interviews: No
Restart: No
Available in ReturnSampleRec:
New interviews: No
Restart: No
System variable saved in: N/A
Property type: Both project and interview
Version
The MDM project version to use when creating the interview.
Data type: Text
Default value: The default version for the project. This is based on the Test Version or Active Version set in DPM. If these are empty, the latest version is used.
Available in AuthenticateSampleRec:
New interviews: Yes
Restart: Yes
Available in ReturnSampleRec:
New interviews: Yes
Restart: Yes
System variable saved in: Data Collection.MetadataVersionNumber
Property type: Interview only
See also