Editing DPM’s site properties
This topic describes how to carry out the following tasks:
▪Changing the settings in DPM’s site properties
▪Adding a call or contact outcome to DPM’s site properties
▪Changing the mapping of autodialer status codes to call outcomes
To change the settings in DPM’s site properties
1 In Windows Explorer, run DPMExplorer.exe, which by default is in Code\Tools\VB.NET\DPM Explorer.Net.
2 In the left pane, expand the top-level node (the site name) and then expand the Properties node.
3 In the left pane, click the DPM collection that contains the property that you want to change.
4 In the upper-right pane, click the DPM property that you want to change.
5 In the lower-right pane, change the value as required, and then click Apply.
Participants required fields
The required participant fields as displayed in Desktop Activate or Participants are defined in DPM.
Corresponding DPM collection
Properties
Corresponding DPM property
CATISMFieldsReqd
Valid values
A list of required fields, separated by semicolons. Do not remove any of the following fields:
Id;Queue;Active;Serial;PreviousQueue;AppointmentTime;RecallTime;ReturnTime;TryCount;AppointmentTryCount;PhoneNumber;InterviewMode;CallOutcome;TimeZone;Comments;Audit;Test;PreviousInterviewerId;SortId;CallRecordingsCount;DayPart;Screener;ExpirationTime;NoAnswerCount;ConnectCount;InternalDialerFlags;ActivityStartTime;UserId;TrunkGroup
Participants default definition for any field
The field type, length, and default value can be defined for any field. This is particularly useful for required fields, and it also provides consistency for other fields that users might upload.
Corresponding DPM collection
DefaultSampleManagementFields
Corresponding DPM property
Create a collection for each field where you want to define defaults. The name of collection is the same as the name of the field. The collection must contain these properties: DefaultValue, FieldLength, and FieldType.
Valid values
FieldType: Long, Bool, Date, Text. For information about mapping SQL types to data model types, see
Data type mapping for columns in sample tables.
FieldLength: If the FieldType is Text, the length of the field. For other field types, empty.
DefaultValue: Any value that matches the FieldType and FieldLength, or empty.
Parameters: No preference for appointments / Give preference to the interviewer who arranged the appointment
Corresponding DPM collection
DefaultCatiParameters
Corresponding DPM property
AppointmentPreferArranger
Valid values
1 to select “Give preference to the interviewer who arranged the appointment” or 0 to select “No preference for appointments”. If the AppointmentPreferArranger property does not exist, then “No preference for appointments” is implied.
Parameters: Before an appointment, by any interviewer and Before an appointment, by the arranger only (both settings are controlled by the Appointment MarginBefore property)
Corresponding DPM collection
DefaultCatiParameters
Corresponding DPM property
AppointmentMarginBefore
Valid values
The number of minutes. The installation value is 5.
Parameters: After an appointment, by any interviewer
Corresponding DPM collection
DefaultCatiParameters
Corresponding DPM property
AppointmentMarginAfter
Valid values
The number of minutes. The installation value is 5. This setting applies only if the AppointmentPreferArranger property is set to 1.
Call Time: After project activation
Corresponding DPM collection
DefaultCatiParameters
Corresponding DPM property
DayPartConfiguration
Valid values
In the Activate server component, the property checks if the activate document XML is null. A null setting means the collection is not set in the user interface. The default day part configuration collection is obtained from: _agent.Server.Properties.Item ("DefaultCatiParameters") and set to the current sample management object.
In the Activate client component, when opening desktop activation, the property reads sample management properties, including CATI parameters from DPM (if the property exists for the CATI project in DPM server). If no such CATI project exists (new project or existing project is not a CATI project), the property reads the default CATI parameters, including the day parts collection, from agent site properties. The property can display the day part configuration collection in the user interface.
Parameters: Before a recall
Corresponding DPM collection
DefaultCatiParameters
Corresponding DPM property
RecallMarginBefore
Valid values
The number of minutes. The installation value is 10.
When RecallMarginBefore is greater than, or equal to, the smallest specified delay, this message appears: “The time before a recall value must be less than the defined delay times”.
A delay value of 0 is the same as no delay setting. As such, a delay value of 0 is not compared to the RecallMarginBefore value.
Other setting on the Parameters page
Corresponding DPM collection
DefaultCatiParameters
Corresponding DPM property
The DPM property names are very similar to the folder setting names.
Valid values
In general, the valid values for a property are the same as the values that can be entered on the Parameters folder for the corresponding setting. However, for the PrioritizeRecalls and UseInterviewerQualifications properties, enter 1 to select the check box on the Parameters folder or 0 to clear the check box.
Outcomes: “Text”
Corresponding DPM collection
Expand the DefaultCati Sample–RecReturnCodes collection, and then, and in the left pane, click the call outcome required.
Corresponding DPM property
Text
Valid values
A string value that describes the call outcome.
Outcomes: Show When Interview Running
Corresponding DPM collection
DefaultCatiProjectProperties
Corresponding DPM property
RunningCodesList
Valid values
One or more call outcome code numbers, separated by semicolons.
Outcomes: Show Appointment Page
Corresponding DPM collection
DefaultCatiProjectProperties
Corresponding DPM property
AppointmentCode
Valid values
One or more call outcome code numbers, separated by semicolons.
Outcomes: Cancel Code
Corresponding DPM collection
DefaultCatiProjectProperties
Corresponding DPM property
CancelCode
Valid values
A call outcome code number.
Outcomes: Confirm Hangup Outcomes
Corresponding DPM collection
DefaultCatiProjectProperties
Corresponding DPM property
ConfirmHangupOutcomes
Valid values
One or more call outcome code numbers, separated by semicolons. The default value is 15. This property is only employed when used with UNICOM Intelligence Dialer. Interviewers will need to exit and reenter the Phone participants activity in order to pick up changes to this property.
Outcomes: Always Hidden
Corresponding DPM collection
DefaultCatiProjectProperties
Corresponding DPM property
HiddenCodesList
Valid values
One or more call outcome code numbers, separated by semicolons.
Phone Interview Settings: Enable monitoring/recording and The interviewer must get approval for monitoring/recording (both settings are controlled by the Monitoring Allowed property)
Corresponding DPM collection
DefaultCatiProjectProperties
Corresponding DPM property
MonitoringAllowed
Valid values
0 to clear “Enable monitoring/recording”
1 to select “Enable monitoring/recording” and clear “The interviewer must get approval for monitoring/recording”
2 to select both “Enable monitoring/recording” and “The interviewer must get approval for monitoring/recording”.
The installation value is 2.
Dialer Settings: Send caller identification and Phone number to send (both settings are controlled by the CallerID property)
Corresponding DPM collection
DefaultCatiProjectProperties
Corresponding DPM property
CallerID
Valid values
Set the value to False to clear “Send caller identification”, or True to select “Send caller identification” and clear “Phone number to send”, or set the value to a string that specifies the value of “Phone number to send”. If specified, the string can contain only the digits 0 to 9 and the following characters: # * . ( ) - /
The installation value is True.
Dialer Settings: Error if login position is not in configuration
Corresponding DPM collection
DefaultCatiProjectProperties
Corresponding DPM property
RaisePositionError
Valid values
True or False. The installation value is False.
Dialer Settings: Ring time
Corresponding DPM collection
DefaultCatiProjectProperties
Corresponding DPM property
NoAnswerTimeout
Valid values
The number of seconds. The installation value is 15. Do not set a value lower than that for MinimumRingTime.
Dialer Settings
(There is no corresponding setting in Interviewing Options, but the MinimumRing Time property defines the minimum value that can be specified in the Ring time setting)
Corresponding DPM collection
Properties
Corresponding DPM property
MinimumRingTime
Valid values
The minimum value that can be set in Ring time. The installation value is 0.
Dialer Settings: Name of silent call announcement file
Corresponding DPM collection
DefaultCatiProjectProperties
Corresponding DPM property
SilentCallAudioFile
Valid values
The name of a .wav file, including the full path. The installation value is an empty string.
Dialer Settings
The number of seconds that auto-dialing should continue trying to dial numbers for an Interviewer.
Corresponding DPM collection
DefaultCatiProjectProperties
Corresponding DPM property
AutoDialTimeout
Valid values
The number of seconds. The installation value is 600 (10 minutes).
Dialer Settings: Percentage of calls to record
Corresponding DPM collection
DefaultCatiProjectProperties
Corresponding DPM property
PercentCallsRecorded
Valid values
A whole number between 0 and 100. The installation value is 0 (that is, no calls are recorded).
Dialer Settings: Dialing aggressiveness, Maximum percentage of silent calls, Target percentage of silent calls
Corresponding DPM collection
These three settings do not have corresponding DPM site properties
To add a call or contact outcome to DPM’s site properties
2 In DPM Explorer’s left pane, click the DefaultCatiSampleRecReturnCodes collection for telephone interviews; in DPM Explorer’s left pane, click the DefaultCapSampleRecReturnCodes collection for personal interviews
3 From the Add menu, choose Property Collection.
4 Enter a name for the outcome, and then click OK.
5 In the left pane, click the collection you have just created.
6 Click Add > Property.
7 In Name, type Code. In Value, type a unique code number for the outcome, and then click OK.
8 Repeat the last three steps, but in Name, type Text, and in Value, enter a short description of the outcome.
To change the mapping of autodialer status codes to call outcomes
When a project uses an autodialer, the autodialer returns a status code at the end of each call attempt to indicate whether a successful call was generated. UNICOM Intelligence Interviewer then maps the status code to one of the call outcomes for the project. For example, if the autodialer returns the status code Congested (meaning that it was unable to make the call because the telephone network is congested), UNICOM Intelligence Interviewer maps that code to the NetworkBusy call outcome and as a result the participant record is assigned to the RECALL queue by the sample management script.
You can change the default mapping of autodialer status codes to call outcomes as follows:
2 In the left pane, expand the DefaultDialerCallOutcomes collection, and then click the autodialer status code whose mapping you want to change.
3 In the upper right pane, double‑click ReturnCode.
4 In the lower right pane, change the value to the name of the call outcome that should be mapped to this autodialer status code.
5 Click Apply.
See also