NIPO Fieldwork System Version 1.14

Previous Topic

Next Topic

Survey configuration file (INI-file)

Contains the survey configuration settings. Most of these settings are set using the NIPO CATI / Web Manager and the NIPO FMS. Some settings are automatically set by the NIPO CATI / Web Master. In general, [Private] keys are reserved for use by the NIPO CATI / Web Master and should not be changed manually.

Settings that affect the survey or the NIPO CATI Client interface take priority over the CATI / Web Master survey configuration options and the NIPO CATI Client configuration options.

Survey INI file configuration settings

Setting

Description

Default value

Section / Updated by Master /

Configurable via Manager

Activate=n

Number of records currently in waiting status to be activated

0

[Private]

AllowIDA

Allow interviewers to set an appointment to be followed up by themselves

N

[Config]

AlreadyCompletedCode

When interview is started on an InterviewNumber with a completed interview, set the sample record to this code

20

[Config]

APAFT=n

Number of minutes an appointment will be considered on time

60

[Config]

AppointmentExtra

Contacts

When using the KeepAppointment, increases the number of contact attempts that may be made for this record if at least one appointment was made in the first MAXCON records

0

[Config]

APPRE=n

Number of minutes an appointment may be distributed in advance of the appointment time

15

[Config]

AutoCodeDialResult

Auto-code technical non-response automatically (TAPI only)

N

[Config]

AutoResponseNoAnswer

Auto-code 'No answer' automatically (TAPI only)

N

[Config]

Blocked

Survey is blocked and can not be started by interviewers

N

[Config]

ChangeResponseCode=

Sun|Mon|Tue|Wed|Thu|Fri|Sat,n[,m]

[;Sun|Mon|Tue|Wed|Thu|Fri|Sat,n[,m]]

 

When starting a survey, you can automatically change response codes depending on the day of the week.

n = Original response code

m = Change into response code. If m is omitted, the response code will be reset to the last response code. This can be used to reset 'System error' and 'Stratification reached'

 

[Config]

CheckAppInInterval

Check if appointments are within set interview interval

 

[Config]

CheckDefAppInInterval

Check if definite appointments are within set interview interval

 

[Config]

DEF=Y|N

Count definite appointment as successful interview

Y

[Config]

Dialer=Y|N

Use dialer for this survey

N

[Config]

DialerAbandonedRate

Maximum number of abandoned calls allowed in dialer mode

 

[Config]

DialerDialerType

Dialer type:

1= EIS
2= General API
3=Invade + Sytel
4= Invade

 

[Config]

DialerResponse

AnsDev

Response code to use by dialer for 'answer device'

 

[Config]

DialerResponse

Busy

Response code to use by dialer for 'busy'

 

[Config]

DialerResponse

Infotone

Response code to use by dialer for 'information tone'

 

[Config]

DialerResponse

NoAnswer

Response code to use by dialer for 'no answer'

 

[Config]

DialerResponse

WrongNr

Response code to use by dialer for 'wrong phone number'

 

[Config]

DialerRNATime

Number of seconds the phone may ring before it is coded as 'no answer'

 

[Config]

DialerSoundInput

Specifies the wave file format used by the dialer for recording. This is automatically converted to TrueSpeech by the NIPO Fieldwork System.

1= Default

2= Dialogic Vox

3= Pica Vox

4= Alaw (Pix)

5= Don’t convert (for playback purposes, make sure the incoming sound format is a common format).
Setting 1 is headerless sound output. Setting 4 equals setting 1 with header. Setting 4 is required for Sytel

 

[Config]

DialerSurveyType

Dialer mode to use (dialers only)

0= Predictive
1= Preview
3= Power

 

[Config]

DisplayDialerMode

Display dialer mode in use in the NIPO CATI / Web Manager

 

[Config]

DummyTelNr=n

For NIPO CATI Client test mode, this sets the telephone number displayed to the interviewer

999999...

[Config]

EDITOPEN

Allow interviewers to edit the open-ended answers after each interview

N

[Config]

END

End date for survey, no appointments can be made after this date

 

[Config]

F10

Enable display of connect time for the NIPO CATI client (by pressing Start or the F10-button)

N

[Config]

HideTelnr

Hide phone number from interviewer for privacy concerns. Should only be used when a dialer or TAPI solution is used

N

[Config]

IDADefault

If same interviewer appointments are enabled, it is by default on for appointments

N

[Config

IntervalInTRecord

Obsolete

 

[Config]

InterviewAppInterval

Set interval for appointments. These are the times between which a regular appointment may be made

 

[Config]

InterviewAppIntervalFri

Set interval for appointments on

Friday

 

[Config]

InterviewAppIntervalMon

Set interval for appointments on

Monday

 

[Config]

InterviewAppIntervalSat

Set interval for appointments on

Saturday

 

[Config]

InterviewAppIntervalSun

Set interval for appointments on

Sunday

 

[Config]

InterviewAppIntervalThu

Set interval for appointments on

Thursday

 

[Config]

InterviewAppIntervalTue

Set interval for appointments on

Tuesday

 

[Config]

InterviewAppIntervalWed

Set interval for appointments on

Wednesday

 

[Config]

InterviewDefAppInterval

Set interval for definite appointments. These are the times between which a definite appointment may be made

 

[Config]

InterviewDefAppIntervalFri

Set interval for definite appointments on

Friday

 

[Config]

InterviewDefAppIntervalMon

Set interval for definite appointments on

Monday

 

[Config]

InterviewDefAppIntervalSat

Set interval for definite appointments on

Saturday

 

[Config]

InterviewDefAppIntervalSun

Set interval for definite appointments on

Sunday

 

[Config]

InterviewDefAppIntervalThu

Set interval for definite appointments on

Thursday

 

[Config]

InterviewDefAppIntervalTue

Set interval for definite appointments on

Tuesday

 

[Config]

InterviewDefAppIntervalWed

Set interval for definite appointments on

Wednesday

 

[Config]

InterviewInterval

Set interval for interviewing. No fieldwork can be performed outside this interval. The InterviewAppInterval and / or InterviewInterval<Day> settings may overrule this interval for appointments and / or on specific days of the week

 

[Config]

InterviewIntervalFri

Set interval for interviewing on

Friday

 

[Config]

InterviewIntervalMon

Set interval for interviewing on

Monday

 

[Config]

InterviewIntervalSat

Set interval for interviewing on

Saturday

 

[Config]

InterviewIntervalSun

Set interval for interviewing on

Sunday

 

[Config]

InterviewIntervalThu

Set interval for interviewing on

Thursday

 

[Config]

InterviewIntervalTue

Set interval for interviewing on

Tuesday

 

[Config]

InterviewIntervalWed

Set interval for interviewing on

Wednesday

 

[Config]

Is32BitSurvey=Y|N

Left for backward compatibility, do not change

 

[Config]

KeepAppoint

Sets whether or not appointment response codes are 'sticky'.

0 = After an appointment the response code changes for every new contact attempt.

1 = After an appointment the response code stays the same for the next 4 contact attempts or until a definite response code is given

2 = After an appointment, the response code stays the same as long as no definite response code is given

1

[Config]

KeepDefAppoint

Sets whether or not definite appointment response codes are 'sticky'.

0 = After a definite appointment the response code changes for every new contact attempt.

1 = After a definite appointment the response code stays the same for the next 4 contact attempts or until a definite response code is given

2 = After an appointment, the response code stays the same as long as no definite response code is given

1

[Config]

Load=n

Starting position of new records in omnibus survey. Lower positions are copied from the first (screener) questionnaire

 

[Config]

Load

Before starting a survey, run specified application or batch-file. Specify a full path. The path must be accessible locally to the NIPO CATI / Web Master

 

[Trigger]

LogLastSurveyName

In an omnibus survey save the survey name of the last survey in the contact file, instead of the name of the first survey

N

[Config]

MAXCON

Maximum number of contact attempts allowed for a sample record. Counting is reset after an appointment

5

[Config]

MaxInterviewsFri

Maximum number of interviews on

Friday. Counts are reset each week

 

[Config]

MaxInterviewsMon

Maximum number of interviews on

Monday. Counts are reset each week

 

[Config]

MaxInterviewsSat

Maximum number of interviews on

Saturday. Counts are reset each week

 

[Config]

MaxInterviewsSun

Maximum number of interviews on

Sunday. Counts are reset each week

 

[Config]

MaxInterviewsThu

Maximum number of interviews on

Thursday. Counts are reset each week

 

[Config]

MaxInterviewsTue

Maximum number of interviews on

Tuesday. Counts are reset each week

 

[Config]

MaxInterviewsWed

Maximum number of interviews on

Wednesday. Counts are reset each week

 

[Config]

MaxInterviewsWeek

Maximum number of interviews on

Weekdays. Counts are reset each week

 

[Config]

MaxIntroTime

Maximum time in seconds the introduction screen will be on screen before the NIPO CATI / Client is put in Pause mode

 

[Config]

MinOdinVersion

Minimum NIPO ODIN engine version required for survey

 

[Config]

PlayUsingDialer

Play sound files using the dialer rather than the locally configured sound card

 

[Config]

PPCMaximum

The maximum number of completed interviews for this survey for a pay-per-complete license. Web interviewing only

 

[Config]

PreLoad

Before loading a survey, run specified application or batch-file. Specify a full path. The path must be accessible locally to the NIPO CATI / Web Master

 

[Trigger]

Q=""nameQ""

Questionnaire name if not the same as survey name

 

[Files]

Q=""name1Q" "name2Q""

Questionnaire names in case of omnibus survey. Note the embedded quotes

 

[Files]

RecordUsingDialer

Using dialer for recording in interview rather than the sound card

 

[Config]

RESPA

Response codes to be shown in appointment list (appears when an appointment must be made)

6,7

[Config]

RESPC<n>

Properties for the response code with number <n> (see next paragraph)

 

[Config]

RESPC<nr>T

Label text for the response code with number <n>

 

[Config]

RESPE

Response codes to be shown in non-response list (appears when an interview is interrupted)

1,2,3,4,5,6,7,8,9,10,11,12,13,

14,15,

16,17

[Config]

RESPI

Response codes to be shown at the start of a CATI interview

1,2,3,4,5,6,7,8,9,10,11,12,13,

14,15,

16,17

[Config]

RESPO

Sets the order in which response codes appear on screen

 

1,2,3,4,5,6,7,8,9,10,11,12,13,

14,15,

16,17

[Config]

RespondentAnsdata

Field name in sample table for SuspendImage (if not default)

 

[Config]

RespondentDatabase

Database ODBC name where sample table and omnibus tables are stored. Set by the NIPO FMS

 

[Config]

RespondentFields

Set fields to use in the sample table for stratification. Set by using *SAMPLEDATA in the NIPO ODIN questionnaire

 

 

RespondentKey

Field name for key field in sample table

(usually InterviewNumber). Set by NIPO FMS

 

[Config]

RespondentMxCon

Maximum number of simultaneous database connections allowed on database , i.e. reading or writing from the database for this survey. When the maximum is reached the client is paused

 

[Config]

RespondentResponseCode

Field name in sample table for

ResponseCode. Only set when the name is not default.

 

[Config]

RespondentStatus

Field name in sample table for:

Status. Only set when the name is not default.

 

[Config]

RespondentSubFields

Sets fields to use in the omnibus table for stratification. Set by using *SAMPLEDATA in the NIPO ODIN questionnaire

 

 

RespondentSubTable

Table name for omnibus table. Set by the NIPO FMS

 

[Config]

RespondentTable

Table name for sample table. Set by the NIPO FMS

 

 

[Config]

ResponseButton<n>

Configure speed button with number <n>. Example:

ResponseButton1=1,"&No answer"

 

[Config]

SecondNumberInAppDlg

Show the second telephone number field in the appointment dialog

 

[Config]

ShowQuotaDialog

Show the quota dialog automatically before each interview start

 

[Config]

StartIntnr=n

When starting the survey, start with specified interview number. May be overruled when predefined numbers are used in the sample table. If the U-file contains higher numbers, the highest number+1 is used

 

[Private]

STARTOPEN=n

Save texts at indicated horizontal position in open answer file (max 100)

 

[Config]

STData

Field name in omnibus table for

extra data (12 positions). Requires the STData setting on the NIPO CATI / Web Master. Set by the NIPO FMS

 

[Config]

STInterviewNumber

Field name in omnibus table for

InterviewNumber. Set by the NIPO FMS

 

[Config]

StoreDialNumber

When the interviewer dials a number that is different from the telephone number, store it as second phone number

N

[Config]

STQuestionnaireName

Field name in omnibus table for

QuestionnaireName, when different from the default

 

[Config]

STREXT

Maximum number of sample records that may be distributed on top of the stratification totals

 

[Config]

STSuccess

Field name in Omnibus table for

Success. Used only when the name is not the default

 

[Config]

SytelType

Type number for Sytel dialer (Sytel dialers only)

 

[Config]

T=""nameT""

Obsolete

 

[Config]

T=""nameT.001" "nameT.002""

Obsolete

 

[Files]

TelnrSurvey

Use sample records from another survey, for example for using one sample for daily new surveys

 

[Config]

TimeDifLen

Obsolete

 

[Config]

TimeDifPos

Obsolete

 

[Config]

TRecordGroupID

Sets the interviewer group IDs to use for this survey. Only interviewers who have at least one of the selected group IDs -or none at all - are selected. Requires the group field in the Interviewer table and the values that may appear in them. Example:

TRecordGroupId=Language,EN,NL,DE,FR

 

[Config]

TTAppointmentName

Field name in sample table for

AppointmentName, if not the default

 

[Config]

TTAppointmentTime

Field name in sample table for

AppointmentTime, if not the default

 

[Config]

TTAvailabilityCode

Field name in sample table for

AvailabilityCode, if not the default

 

[Config]

TTCallIntervalBegin

Field name in sample table for

CallIntervalBegin, if not the default

 

[Config]

TTCallIntervalEnd

Field name in sample table for

CallIntervalEnd, if not the default

 

[Config]

TTChannel

Field name in sample table for

Channel, if not the default

 

[Config]

TTContactTime

Field name in sample table for

ContactTime, if not the default

 

[Config]

TTDisplayField1

Field name in sample table for

DisplayField1, if not the default

 

[Config]

TTDisplayField2

Field name in sample table for

DisplayField2, if not the default

 

[Config]

TTDisplayField3

Field name in sample table for

DisplayField3, if not the default

 

[Config]

TTDisplayField4

Field name in sample table for

DisplayField4, if not the default

 

[Config]

TTExtraData

Field name in sample table for

TTExtraData, if not the default

Requires the TTExtraData setting to be configured on the NIPO CATI / Web Master registry

 

[Config]

TTGroupID

Field name in sample table for

TTGroupID, if not the default

 

 

[Config]

TTID

Field name in sample table for

TTGroupID, if not the default

 

 

 

TTIndicator2ndNumber

Field name in sample table for TTIndicator2ndNumber, if not the default

 

[Config]

TTInterviewerNumber

Field name in sample table for InterviewerNumber, if not the default

 

[Config]

TTLanguage

Field name in sample table for Language, if not the default

 

 

TTNumberOfContacts

Field name in sample table for NumberOfContacts, if not the default

 

[Config]

TTRecordGroupID

Field name in sample table for RecordGroupID, if not the default

 

[Config]

TTSecondPhoneNumber

Field name in sample table for SecondPhoneNumber, if not the default

 

[Config]

TTShowDisplayFields

Field name in sample table for ShowDisplayFields, if not the default

 

[Config]

TTShowSecond

PhoneNumber

Field name in sample table for ShowSecondPhoneNumber, if not the default

 

[Config]

TTStatusCode

Field name in sample table for Status, if not the default

 

[Config]

TTSystemData

Field name in sample table for SystemData, if not the default

 

[Config]

TTTargetInterviewer

Field name in sample table for TargetInterviewer, if not the default

 

 

TTTelephoneNumber

Field name in sample table for TelephoneNumber, if not the default

 

[Config]

TTTimeDifference

Field name in sample table for TimeDifference, if not the default

 

[Config]

UnicodeData

Store answer data files in Unicode. If non-unicode answer data files already exist, changing this setting has no effect

N

[Config]

UnLoad

After stopping a survey, run specified application or batch-file. Specify a full path. The path must be accessible locally to the NIPO CATI / Web Master

 

Trigger]

UnLoadMod

After stopping a modified survey, run specified application or batch-file. Specify a full path. The path must be accessible locally to the NIPO CATI / Web Master

 

[Trigger]

UsedSampleFirst

When looking for non-appointment sample records to contact, first use sample records that have already been tried and are available now before proceeding to use new sample

N

[Config]

UseTarget

Reaching target stops interviewing

N

[Config]

Vars

Define variable to pass to the NIPO CATI Client

 

[Config]

WaitDialConnected

Show dialing progress (TAPI only)

N

[Config]

 

 

 

 

Note:
Appointment settings are used for definite appointments if no definite appointment settings have been set. Similarly, day settings override week settings.

See Also