NIPO Fieldwork System Version 1.14

Previous Topic

Next Topic

NIPO CATI / Web Master

All registry setting for the NIPO CATI / Web Master are of the String type.

Key 64-bit: [HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\NIPO\CatiMaster]

Key 32-bit: [HKEY_LOCAL_MACHINE\SOFTWARE\NIPO\CatiMaster]

Survey settings that can be set in the survey configuration are not listed here.

NIPO CATI / Web Master registry keys

Entry Description / Example value Configurable with Manager

AssignmentChannel

Field name forChannel in Assignment table

N

AssignmentDatabase

Database name for the Assignment table

N

AssignmentInterview

Number

Field name for InterviewNumber in Assignment table

N

AssignmentResponse

Field name for Response in Assignment table

N

AssignmentSurvey

Field name for Survey in Assignment table

N

AssignmentTable

Table name for Assignment table

N

BaseDestinationDir

Folder on NIPO Web Server where subfolders Template, CSS and TemplateRelatedFiles are transmitted by the NIPO ODIN Demon

N

BaseSourceDir

Folder on NIPO CATI / Web Master, where subfolders Template, CSS and TemplateRelatedFiles are stored

N

BlackListFile

Full blacklist path and filename

Y

ConLogAppointmentTime

Field name for AppointmentTime in ContactLog table

N

ConLogContactNumber

Field name for ContactNumber in ContactLog table

Y

ConLogDatabase

Database for ContactLog table

Y

ConLogDate

Field name for ContactDateTime in ContactLog table

Y

ConLogEditTime

Field name for EditTime in ContactLog table

Y

ConLogInterviewerNumber

Field name for InterviewerNumber in ContactLog table

Y

ConLogInterviewNumber

Field name for InterviewNumber in ContactLog table

Y

ConLogIntroTime

Field name for IntroductionTime in ContactLog table

Y

ConLogNetID

Field name for AreaCodeRespondent in ContactLog table

Y

ConLogResponseStatus

Field name for ResponseStatus in ContactLog table

Y

ConLogScreenCount

Field name for NumberOfScreens in ContactLog table

Y

ConLogStationID

Field name for StationID in ContactLog table

Y

ConLogSurveyName

Field name for SurveyName in ContactLog table

Y

ConLogTable

Table name for ContactLog table

Y

ConLogTelTime

Field name for TelephoneTime in ContactLog table

Y

ConLogTotalTime

Field name for TotalTime in ContactLog table

Y

ConLogWaitTime

Field name for WaitingTime in ContactLog table

Y

ConLogWrite=0|1|2|3

Write Contact.Log file or ContactLog table:

0 = only Contact.Log file

1 = only ContactLog table (default)

2 = both Contact.Log file and ContactLog table

3 = ContactLog table, if connection fails write to Contact.Log file

N

ContactLogFile

Full contact log file path and filename

Y

CSSDestinationDir

Destination folder for stylesheets (CSS)

Y

CSSSourceDir

Source folder for stylesheets (CSS)

Y

DatabaseUser

User name for database

Y

DatabasePassword

Password for database

Y

DemonReadWriteDir

Read/write directory for the NIPO ODIN Demon

N

Dialer

System default for dialer use
Y= Use dialer for survey

N= Do not use dialer (default)

Y

DialerDialerAbandoned

Rate

Defines abandoned call rate per thousand calls, default 20

Y

DialerDialerAddress

IP-address or computer name of dialer

When SYTEL is used, the port number must be specified after the name

N

DialerDialerType

Defines the type of dialer used.
1 = EIS
2 = Standard Interface (default)
3 = Invade / Sytel combination
4 = Invade (for older COM interface)

Y

DialerEISDelimiter

EIS dialer delimiter

N

DialerEISTerminator

EIS dialer terminator

N

DialerNrAsAgentName

Use the interviewer number as the dialer agent name (Y/N)

Y

DialerNumberIpPrefix

Prefix to be used by dialer (IP-connection), default 0

N

DialerNumberPrefix

Prefix to be used by dialer, default 0

N

DialerNumberRPrefix

Prefix to be used by dialer (for remote connections), default 0

N

DialerRecordingDir

Directory to save into when recording using a dialer

N

DialerResponse%D

Maps a dialer response %D to a custom CATI response code

N

DialerResponseAnsdev

Response code to use for 'answer device'

Y

DialerResponseBusy

Response code to use for 'busy'

Y

DialerResponseInfotone

Response code to use for 'info tone'

Y

DialerResponseNoanswer

Response code to use for 'no answer'

Y

DialerResponseWrongnr

Response code to use for 'wrong telephone number'

Y

DialerRNATime

Ring no answer time

N

DialerSoundInput

Format in which the dialer should save sound recordings.

1 = Default (Pix format, do not use)

2 = Dialogic Vox

3 = Pika Vox

4 = Alaw (8 bit ALAW 8000 SRate)

N

DialerSupervisor

Set phone number for supervisor, that interviewer can call using the Call supervisor button

N

DialerSurveyType

Dialer mode

0=Predictive
1=Preview
2=Inbound
3=Power

Y

DialerTapiDevice

Device name for TAPI dialer

N

DisplayDialerMode

Display dialer mode in NIPO CATI / Web Manager

Y

IDATimeOut

Time (in minutes) after which same interviewer appointments will be distributed to another interviewer, if the dedicated interviewer is not available

Y

IntDataDLL

Points to INTDB32.DLL

N

IntervalInTRecord

Interviewing interval in sample record

Y

InterviewerActiveCATI

Field name for ActiveCATI in Interviewer table

N

InterviewerDatabase

Database for Interviewer table

Y

InterviewerFile

Full path and filename to interviewer file

Y

InterviewerFileAccess

 

N

InterviewerGroupID

Field name for GroupID in Interviewer table

N

InterviewerID

Field name for InterviewerNumber in Interviewer table

Y

InterviewerLastLogin

Field name for InterviewerLastLogin in Interviewer table

Y

InterviewerLogFile

Full path and filename to interviewer log file

Y

InterviewerName

Field name for FirstName in Interviewer table

Y

InterviewerOdinAll

Versions

Field name for InterviewerOdinAllVersions in Interviewer table (stores versions of all components of the NIPO CATI Client at last log-in)

Y

InterviewerOdinClient

Version

Field name for InterviewerOdinClientVersion in Interviewer table (NIPO CATI Client version at last log-in)

Y

InterviewerPrefix

Field name for Prefix in Interviewer table (prefix for surname)

Y

InterviewerSurname

Field name for LastName in Interviewer table

Y

InterviewerTable

Table name for Interviewer table

Y

InterviewerTelephone

Number

Field name for TelephoneNumber in Interviewer table (remote clients)

Y

IntLogContactTime

Field name for ContactTime in InterviewerLog table

Y

IntLogDatabase

Database for InterviewerLog table

Y

IntLogDate

Field name for DateTime in InterviewerLog table

Y

IntLogInterviewerNumber

Field name for InterviewerNumber in InterviewerLog table

Y

IntLogNumberOfContacts1

Field name for NumberOfContacts1 in InterviewerLog table

Y

IntLogNumberOfContacts2

Field name for NumberOfContacts2 in InterviewerLog table

Y

IntLogNumberOfContacts3

Field name for NumberOfContacts3 in InterviewerLog table

Y

IntLogNumberOfPhoneNrs

Field name for NumberOfPhoneNrs in InterviewerLog table

Y

IntLogNumberOfScreens

Field name for NumberOfScreens in InterviewerLog table

Y

IntLogPauseTime

Field name for PauseTime in InterviewerLog table

Y

IntLogSuccessful

Interviews

Field name for SuccessfulInterviews in InterviewerLog table

Y

IntLogSurveyName

Field name for SurveyName in InterviewerLog table

Y

IntLogTable

Table name for InterviewerLog table

Y

IntLogType

Field name for Type in InterviewerLog table

Y

IntLogWaitingTime

Field name for WaitingTime in InterviewerLog table

Y

IntLogWrite=0|1|2|3

Store interviewer log data in file or table:

0 = only Interviewer.Log file (default without table configuration)
1 = only InterviewerLog table (default with table configuration)
2 = both Interviewer.Log file and InterviewerLog table

3 = use InterviewerLog table only, but if connection fails write to Interviewer.Log file

N

Location

Location name for the NIPO CATI / Web Master

N

LoglastSurvey

In omnibus surveys, use last survey name instead of first survey name in log-files

N

MinOdinVersionRemote

Minimum NIPO ODIN version for remote agents (Remote interviewers clients)

N

NetbiosName

Obsolete

Y

NetservFilesDirectory

C:\NIPOSoftware\CatiWeb\NetservFiles

N

NetworkDomain

Network domain to log in to

Y

NetworkPassword

Password of domain user to log in as

Y

NetworkUser

Domain user to be used by NIPO CATI / Web Master service to access the network. User must have permission log in as a service

Y

NoAppointments

 

 

NumberTariffs

3

N

NumberWages

1

N

OdmasLogDirectory

Folder to store NIPO CATI / Web Master log files. Folder must exist. A local path is recommended

N

OdmasLogLevel

The information level to log. The higher the number the more information (common is 3 to 5). Levels higher than 3 may degrade performance

N

OdmasLogNumFiles

The maximum number of log files to create. Oldest are deleted

N

PlayRecordedData

Not yet supported

N

PlayUsingDialer

Use dialer when playing multimedia files in a questionnaire (default N)

Y

PPCTreshold

The threshold number of completes at which the NIPO CATI / Web Master must be stopped when a pay-per-complete license is used

Y

PPCWarning

Send Email warning message when exceeding the set number in the PPCTreshold when using pay-per-complete

Y

RecoveryDirectory

Folder where $o$ and $x$ recovery files of interrupted NIPO CATI Client sessions are saved after a disconnection with the client has been restored

N

RemoteThirdPartIpAddress

The NIPO CATI / Web Master distinguishes NIPO CATI Clients on the LAN from remote workstations on the basis of the first two octets in the IP address. If local workstations should be considered remote you can use this setting. If the value of RemoteThirdPartIpAddress matches the third octet in the IP address, they are considered remote. For example if RemoteThirdPartIpAddress is 66, any local IP address 172.31.66.x will be considered remote

N

RespondentAnswerData

Field name for SuspendImage in sample table

N

RespondentDatabase

Driver

Database driver name for connecting to a database containing sample tables

N

RespondentFields

Sets mappings of sample table fields towards *SAMPLEDATA variables, for example:
TTExtraData:ExtraData
Creates a new *SAMPLEDATA variable TTExtraData and maps it to the ExtraData field in the sample table.

 

ServerName

Master name for RPC communication (default NIPOCATIMASTER)

Y

ServerPort

Port number to use for ServerName

Y

Shifts

Shift name and values. Default value: MORNING:0800,

AFTERNOON:1300, EVENING:1800

Y

SMTPCCAddresses

Carbon-copy (CC) Email address to send a warning message when the maximum number of completes for pay-per-complete has been reached

Y

SMTPMailAccount

SMTP mail account to use when sending pay-per-complete warning messages

Y

SMTPPassword

Password for SMTP mail account to use when sending pay-per-complete Email warning messages (if required by SMTP server)

Y

SMTPServer

Server to use to send pay-per-complete Email warning messages

Y

SMTPUser

SMTP user to send pay-per-complete Email warning messages (if required by SMTP server)

Y

StationKeyDatabase

Database for the StationKeys table

N

StationKeyTable

Table name for the StationKeys table

N

StationKeyTableKey

Field name for StationKey in StationKeys table

N

StationKeyTableRemote

Telnr

Field name for RemoteTelnr in StationKeys table

N

StationKeyTableStation

Field name for StationName in StationKeys table

N

StationKeyTableStatus

Field name for Status in StationKeys table

N

StationKeyTableWatch

Survey

Field name for WatchSurvey in StationKeys table

N

SurveyDatabase

Database for the Survey table

Y

SurveyDBCount

Field name for SuccessfulCount in Survey table

Y

SurveyDBDescription

Field name for Description in Survey table

Y

SurveyDBDialerParam

Field name for DialerParam in Survey table

N

SurveyDBIncrement

Field name for SuccessfulIncrement in Survey table

Y

SurveyDBName

Field name for SurveyName in Survey table

Y

SurveyDBPaymentVersion

Field name for PaymentVersion in Survey table

Y

SurveyDBStatus

Field name for Status in Survey table

Y

SurveyDBSwitched

Field name for Switched in Survey table

N

SurveyDBTarget

Field name for Target in Survey table

Y

SurveyDir

Folder where the NIPO CATI / Web Master retrieves and stores survey data and questionnaires

Y

SurveyTable

Table name for Survey table

Y

SytelType

Type number for Sytel dialer (Sytel dialer only)

Y

TemplateDestinationDir

Destination folder for templates

Y

TemplateRelatedFiles

SourceDir

Source folder for template related files

Y

TemplateRelatedFiles

DestinationDir

Destination folder for template related files

Y

TemplateSourceDir

Source folder for templates

N

TotalSurveyName

Field name in for TotalSurveyName inContactLog table. Only used for Omnibus surveys

Y

TTExtraData

Field name for ExtraData in sample tables. If this setting exists, a field with the name specified here is created in the sample table.

N

UnicodeData

Save survey data in Unicode (default N)

N

UseDefaultGroup

 

N

UserDefinedTemplate

SourceDir

Folder on the NIPO CATI / Web Master where template related files are stored

Y

WatchShowType

Display information in title bar of watch stations:

0= Show interviewer number
1= Show station ID (default)
2= Show station ID and interviewer name

N

 

 

 

Note:
The NIPO CATI / Web Master stores domain username and password information in unencrypted format in the registry. Restrict registry access and access to the NIPO CATI / Web Master for unauthorized users.

The field ExtraData is only created in your Sample table by NIPO FMS, when the setting TTExtraData=’ExtraData’ is specified in the registry of the NIPO CATI / Web Master or when the setting: RespondentFields=TTExtraData:ExtraData is specified in the Registry/survey.INI.

Triggers are stored in the following sub-key:

Key: [HKEY_LOCAL_MACHINE\SOFTWARE\NIPO\CatiMaster\Triggers]

Note that the OnlogsFull setting cannot be configured using the NIPO CATI / Web Manager.

Trigger registry keys

Entry Description

PreLoad

Executable or batch-file to run before loading (starting) a survey

Load

Executable or batch-file to run when loading (starting) a survey

Unload

Executable or batch-file to run when stopping a survey

UnloadMod

Executable or batch-file to run when stopping a survey that has had changes (for example interviews have been performed)

OnError

Executable or batch-file to run when an error is reported. Useful to send a mail to a fieldwork manager or system administrator

OnLogsFull

Executable or batch-file to run when the NIPO CATI / Web Master is restarted and when the maximum number of log files is reached. Useful to make automated backups of log files

 

 

A number of other sub-keys exist for workstation, user and permission registration. Only the sub-key names are listed here.

Sub-keys

Entry Description

HKEY_LOCAL_MACHINE\SOFTWARE\NIPO\CatiMaster\StationExtension

Stores phone extension numbers for telephones in a CATI enter using a dialer. Includes interviewers and watch workstations

[HKEY_LOCAL_MACHINE\SOFTWARE\NIPO\CatiMaster\StationId]

Stores workstation names (based on network ID)

[HKEY_LOCAL_MACHINE\SOFTWARE\NIPO\CatiMaster\Security]

Stores security settings for users and profiles

[HKEY_LOCAL_MACHINE\SOFTWARE\NIPO\CatiMaster\Security\Profiles]

Stores profiles that contain sets of permissions for either users or workstations. Ensure that an "allow all" profile exists for the system administrator

[HKEY_LOCAL_MACHINE\SOFTWARE\NIPO\CatiMaster\Security\Stations]

Stores network user names when permissions are based on workstations rather than users

[HKEY_LOCAL_MACHINE\SOFTWARE\NIPO\CatiMaster\Security\Users]

Stores network user names when permissions are based on network user login

[HKEY_LOCAL_MACHINE\SOFTWARE\NIPO\CatiMaster\SynchronizeDirs]

Stores synchronization folders for use with the NIPO Web Server

 

 

Whether permissions are applied to network users rather than physical workstations is configured in the following setting:

Key: [HKEY_LOCAL_MACHINE\SOFTWARE\NIPO\CatiMaster\Security]

Security registry keys

Entry Description Default value

PermissionsBasedOnUsers

By default permissions for the NIPO CATI / Web Manager are based on computer names. Use this setting to base the permissions on login names

N

 

 

 

See Also