SampleManagementPropertiesXml/PropertiesXml
The PropertiesXml is an abbreviation of the SampleManagementProperties XML. It is passed into ISampleManagementProvider.Get and ISampleManagementProvider.Return and is a collection of the project, interview, station and interviewer properties.
Project and interview properties
Project properties are a subset of the properties in DPM. These properties can be viewed with
DPM Explorer. The majority of the interview properties are copies of the project properties. These copies can be changed to impact a specific interviewer without impacting the overall project settings.
There are a few interview specific properties that are not project properties. The most important reference for these is
PropertyNames.h and the table of project and interview properties described in
Project and interview properties.
Interview properties
These are some of the more important interview properties:
AmdMode
Answering machine detection mode. Possible values include:
AMD_DISABLED
Answering machine detection algorithms disabled. All calls generating a connect are passed to the interviewer.
Value: 0
AMD_FILTER
Answering machine detection algorithms enabled. If an answering machine is detected, an AnsweringMachine return code is returned.
Value: 1
AMD_CALIBRATE
Answering machine detection algorithms enabled, however all calls generating a connect are passed to the interviewer. This allows the client to compare the interviewer’s manual call disposition with the dialer’s disposition.
Value: 2
AMD_LONGHOLD
Value: 3
AmdParameters
Parameters used for answering machine detection as Name,Value pairs separated by semicolons. These are dialer specific and should to be covered in your supplemental documentation.
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.
AutoDial
Whether the dialing provider should dial the phone number automatically or be returned for preview.
AutoDialTimeout
The number of seconds that auto-dialing should continue trying to dial numbers for an Interviewer. Return after this interval even if a respondent is not connected (allows the interviewer to have a break).
CallerID
The caller ID to send when dialing with a dialer. When set to 0, no caller ID is sent. When set to 1, the dialer’s phone number is sent. Otherwise the contents of this field are sent as the ID.
ConnectedCall
True if a call was connected, False if not. Passed to ReturnSampleRec for use in updating the ConnectCount SampleField.
DialerCallOutcome
The dialer call outcome number, as returned from the dialer, before it is mapped to the return code.
GroupDial
Indicates if the record should be preview or group dialed, 0 for preview dial and 1 for group dial.
IdleTimeDuration
The IdleTimeDuration property is set by Phone Participants and is the time from logging into Phone Participants to the first request for a contact, or the time from returning a contact to requesting another contact. If the option to automatically select the next contact is selected, the IdleTimeDuration should be 0. The IdleTimeDuration property should be used when writing the idle time history record.
InterviewerTimezone
Interviewer Server supports interviewers in multiple time zones accessing the system through Web browsers. This is the interviewer’s time zone as a time zone index. The interviewer time zone is typically used when setting appointments. The dialing provider is unlikely to need the interviewer time zone.
IsTest
Indicates whether or not the interview is a test interview.
MaxPredictive SilentCalls
The maximum percentage of silent calls per total connected calls. This value is used by the Interviewer Server predictive dialing algorithms that calculate how many numbers to over-dial for the UNICOM Intelligence Dialer. Your dialing provider should use this value as an input to any over-dialing calculations. This value is often specified by regulatory bodies.
MinimumRingTime
The minimum number of seconds that the phone must ring before the call can be disconnected.
NoAnswerTimeout
The number of seconds for the dialer to let a number ring before it is considered to be unanswered.
RecordCall
Whether the call should be recorded. This value might be overridden by the RecordingProhibited property if the respondent disallows recording.
RecordingProhibited
Whether the respondent has disallowed recording. Overrides RecordCall if both are set to 1.
RecordInterviewOnly
Whether to record the whole call (0) or just the interview (1)
RespondentTimezone
The respondent’s time zone as a time zone index. This value is used by the sample management script to retrieve respondents in time zones that are currently within the valid calling hours or day parts. The RespondentTimezone might not be useful to the dialer since the sample management script handles returning only those records that are currently valid.
Review
Whether the interview should be restarted for review.
Shutdown
Whether the interview was terminated because the interview engine shut down (0) or not (nonzero).
SilentCallAudioFile
The name of an audio file to play to a participant when predictive dialing results in a silent call. The dialer hangs up the call after playing the file. This setting overrides the dialer setting.
SMRecordsRequired
Number of records to be returned from the sample management script. It is more efficient to return a large number of records at one time than to call Get multiple times. However, multiple calls to Get might be required to retrieve records that meet different sets of interviewer qualifications.
Test
Indicates if this is a test interview.
TimedOut
Whether the interview has timed out. The 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.
TrunkGroup
String that indicates which trunk group should be used on the dialer. The TrunkGroup can be setup in the dialer configuration file and is typically used to connect remote interviewers or supervisors using a particular trunk. The TrunkGroup can also be overridden in the sample management script.
Interviewer properties
Interviewer properties consist of a UserID property containing the interviewer (or supervisor’s) login ID, a Project property containing the name of the project (interviewer’s only), a group of interviewer qualifications, and an InterviewerQualificationsGroup number calculated by the session engine. The InterviewerQualificationsGroup number can be used to identify a unique set of qualifications. The number should be used carefully as it is not the same across session engines and might be different across instantiations of the same session engine.
Station properties
Station properties are described in
StationPropertiesXml, as
StationPropertiesXml is passed into other methods on its own.
Example
The following is an example PropertiesXml string:
<SampleManagementProperties>
<Project>
<Property>
<name>MonitoringAllowed</name>
<type>2</type>
<value>1</value>
</Property>
...and so on
</Project>
<Interview>
<Property>
<name>Language</name>
<value>English</value>
</Property>
<Property>
<name>MonitoringAllowed</name>
<type>2</type>
<value>1</value>
</Property>
<Property>
<name>Project</name>
<value>Cars</value>
</Property>
...and so on
</Interview>
<Interviewer>
<Property
<name>UserID</name>
<value>Interviewer1</value>
</Property>
<Property>
<name>Project</name>
<value>Cars</value>
</Property>
<Property>
<name>InterviewerQualifications</name>
<type>9</type>
<value>
<Property>
<name>Language</name>
<value>Spanish</value>
</Property>
</value>
</Property>
<Property>
<name>InterviewerQualificationsGroup</name>
<type>2</type>
<value>1</value>
</Property>
</Interviewer>
<Station>
StationPropertiesXML (see StationPropertiesXml)
</Station>
</SampleManagementProperties>
See also