NIPO Fieldwork System Version 1.14

Previous Topic

Next Topic

NIPO ODIN Servlet Configuration Settings

Alphabetic overview of parameters in WEB.XML

Entry Description Example value / Default value

BiDi

The default setting for bi-directional languages such as Hebrew and Arabic

0 = LTR (left to right, default)

1= RTL (right to left)

false

ButtonImages

Boolean field determining if translations for buttons should be interpreted as being URLs to alternative images

(See Database.Translations.*)

false

Compressor

Enables compression of the HTML sent to the browser, enable the following filter and the corresponding filter-mapping and change the url-pattern to match the OdinServlet's real pattern (see the "servlet-mapping" tag at the bottom of this file)

com.niposoftware.

odinservlet.util.

ZipFilter

 

and

 

/Interview

Database.ConnectionString

Connection string for database (depends on driver in use)

jdbc:driver:

serverconnection

Database.DB

Optional database name to be used when default database in the DSN is not the actual database to be used. This setting becomes mandatory if either Databse.DriverClass or Database.SQLServer are to be used. For the Database.DSN setting (see below) it is optional

ExampleDB

Database.DriverClass

Fields that allows custom or third party JDBC drivers to be used.

If it is configured, Database.ConnectionString and Database.DB are mandatory.

example.package.

ExampleClass

Database.DSN

ODBC name of database

ExampleDSN

Database.PWD

Password for database

ExamplePassword

Database.UID

Username for database

ExampleUsername

Database.EmailManagement.ID

Field name of ID field in EmailManagement table.

RespondentID

Database.EmailManagement.Language

Optional. Field name of Language field in EmailManagement table. Determines the language that will be used when starting an interview for that respondent. Note that the language can also be set for the complete survey

Language

Database.EmailManagement.Survey

Field name of Survey field in EmailManagement table

SurveyName

Database.EmailManagement.Table

Table name for EmailManagement table

RespSurv

Database.Relocations.

Language

Language specific relocations. Optional.

Language

Database.Relocations.

Relocation

Field name of Relocation field in Relocations table.

Relocation

Database.Relocations.

SurveyName

Field name of SurveyName field in Relocations table.

SurveyName

Database.Relocations.

Table

Table name for Relocations table

Relocations

Database.Relocations.

TerminateCode

Field name of TerminateCode field in Relocations table.

TerminateCode

Database.SQLServer

These fields configure the Microsoft SQL Server 2000 Driver for JDBC.

Only use these if you have an MS SQL Server. Using this driver makes configuring the Database.DB mandatory.

PC-name

or

IP-address

Database.SQLServerPort

TCP / IP port that your SQL Server is listening on

1433

Database.Survey.

BiDi

Field name of the BiDi field for specific surveys (for bi-directional languages, Hebrew and Arabic)

BiDi

Database.Survey.

ButtonImages

Field name for boolean field determining if translations for buttons should be interpreted as being urls for alternative images. See Database.Translations.* settings.

ButtonImages

Database.Survey.

ErrorDefinitionCSS

Field name for boolean field determining if in-line CSS for error definitions will be generated

ErrorDefinitionCSS

Database.Survey.

FontTableCSS

Field name for boolean field determining if in-line CSS for font tables will be generated

FontTableCSS

Database.Survey.

HideClear

Field name for boolean field determining if clear button will be visible

HideClear

Database.Survey.

HideCopyrightNotice

Field name for boolean field determining if copyright notice 'Powered by NIPO Software' will be visible

No default

Database.Survey.

ID

Field name of ID field

in Survey table

SurveyID

Database.Survey.Language

Optional. Field name of Language field in Survey table. Determines the language that will be used when starting an interview for that survey. Note that the language can also be set for each respondent.

Language

Database.Survey.

Name

Field name of SurveyName field in Survey table

SurveyName

Database.Survey.

QuestionCSS

Field name for boolean field determining if in-line CSS for question elements will be generated

QuestionCSS

Database.Survey.

ShowClose

Field name for boolean field determining if close button is shown on introduction screen

ShowClose

Database.Survey.

Suspendable

Field name of Suspendable field in Survey table. Sets whether survey can be suspended by respondent.

Suspendable

Database.Survey.

SuspendTime

Field name of SuspendTime field in Survey table. Integer field determining the 'time-to-suspend' an inactive client in minutes. When a respondent does not answer any question the client will be suspended in the set time. When the respondent tries to continue a new client will be started.

SuspendTime

Database.Survey.

SuspendTimeAnonymous

Field name of SuspendTimeAnonymous field in Survey table Integer field determining the 'time-to-suspend' for anonymous surveys in minutes.

SuspendTimeAnonymous

Database.Survey.

SuspendTimeFirstScreen

Field name of SuspendTimeFirstScreen field in Survey table. Integer field determining the 'time-to-suspend' when respondent is still on the first screen in minutes

SuspendTimeFirst

Screen

Database.Survey.

Table

Table name for Survey table

Surveys

Database.Survey.

TabStopCSS

Field name for boolean field determining if in-line CSS for tab stops is generated

TabStopCSS

Database.Translations.

ButtonPrefix

Text used as a prefix for button captions. Actual fields in database will appear like ButtonOK, ButtonBACK, ButtonSUSPEND et cetera. Note that it is also possible to use translations as a means to specify URL's to image files that will be used as an alternative to buttons. See also Database.Survey.ButtonImages setting.

Button

Database.Translations.

ConjointProgress

Optional field for Conjoint profile compare

ConjointProgress

Database.Translations.

ErrorPrefix

Text used as a prefix for error messages. Actual fields in database will appear like ErrorNOANSWER for "An answer is required" et cetera

Error

Database.Translations.

Language

Field name of Language field in Translations table

Language

Database.Translations.

RangelimitTo

Optional field for range limit string

RangelimitTo

Database.Translations.

Survey

Field name of Survey field in Translations table

Survey

Database.Translations.

Table

Table name for Translations table.

This table contains the translations for all messages that appear in the browser during an interview. Translations can be created for separate surveys or per user language.

Translations

DatabasePoolLimit

Optional. Maximum number of concurrent database connections to be used. Lower values than 5 not recommended for performance reasons.

5

DefaultSurvey

When getting values from the database the the survey name configured here will be considered to be the default. So if a certain setting cannot be found (value is NULL)

for the requested survey it will be taken from this survey.

Default

ErrorDefinitionCSS

Sets whether CSS definitions should be generated for error messages.

true

FontTableCSS

Sets whether CSS definitions should be generated for defined fonts

 

HideClear

Hide the Clear button in the page during an interview.8

false

HideCopyrightNotice

Hide the copyright notice 'Powered by NIPO Software'9

false

Language

The default language to be used for a survey if a language is not specified in the Survey table

English

LogDirectory

Folder on the NIPO Web Server where OdinServlet log files are stored. Folder must exist.

c:\temp

LogLevel

Log level for OdinServlet

3

LogNumFiles

Maximum number of files. File with extension .001 is always the latest file.

5

NipoSoftware

AuthenticationLevel

Authentication level for NIPO Software support

1

OdDecomLocation

File and path of the OdDecom.DLL file

[Tomcat]\webapps\

OdinServlet\WEB-INF\

OdDemon

OdinServletManager

Template

Optional. Template to be used for the NIPO ODIN Servlet Manager. Uses absolute path.

[Tomcat]\webapps\

OdinServlet\WEB-INF\

OdinServletManager.

odintemplate

ProfileProgress

 

Default replacement text in conjoint session when comparing profiles

[profile {0} of {1}]

QuestionCSS

Sets whether default CSS definitions should be generated for question elements.

No default

RangelimitTo

 

Default replacement for the word TO in a range string (*RANGE) Note: should include leading and trailing space

' TO '

RelocationDocument

Optional. URL of the ASP/JSP/PHP, that handles the relocation after running an interview. The TerminateCode and ID from the EmailManagement table are passed as parameters using [URL]?End?ID=<ID>&ExitCode=

<TerminateCode>

<none>

SecuredSettings

Field for secured settings

Database.PWD

ShowClose

Show a Close button on the introduction page of an interview

true

Suspendable

Show a Suspend button in the page during an interview. Note that by closing the browser a respondent can always suspend. An interview will only be resumed at the same question when a sample table is used and not for anonymous surveys / respondents.

true

SuspendTime

Setting determining the 'time-to-suspend' in minutes. When a respondent does not answer any question the client is suspended in the set time. When the respondent tries to continue a new session is started.

15

SuspendTimeAnonymous

Determines the 'time-to-suspend' for anonymous surveys in minutes

30

SuspendTimeFirstScreen

Determines the 'time-to-suspend' for the first screen in minutes

5

TabStopsCSS

Generate width values for defined tab stops

False

TRUEFALSE_0

Possible alternative for False label.

Name should be in CAPITALS and must have the form TRUEFALSE_<real-value>, while value must be 'false'.

False

TRUEFALSE_1

Possible alternative for True label.

Name should be in CAPITALS and must have the form TRUEFALSE_<real-value>, while value must be 'true'.

Any other value will be considered 'false'.

True

ValidationCode

APPCONSTRAINT

 

Validation text

Appointment not within constraints

ValidationCodeCODMAX

Validation text if *MAX is used in *CODES *MULTI

Too many categories, maximum is {0}

ValidationCodeCODMIN

Validation text if *MIN is used in *CODES *MULTI

Too few categories, minimum is {0}

ValidationCodeDUPCD

 

Validation text if code number is used more than once

Duplicate code: {0}

ValidationCodeILLCD

 

Validation text if unknown code number is typed

Unknown code: {0}

ValidationCode

ILLEGALFORMAT

 

Validation text for illegal format

System error, illegal format

ValidationCode

INVALIDANSWER

 

Validation text for an invalid answer

Invalid answer: {0}

ValidationCodeMAXDEC

Validation text if *NUMBER Ln.m is used

Maximum number of decimals is {0}

ValidationCodeNAN

Validation text if anything other than a valid number is entered in a numeric question

{0} is not a number

ValidationCodeNAVIGATE

Validation text If Back button of browser is used.

Navigation error. Do not use BACK button on browser, but use buttons on interview instead.

ValidationCodeNOANSWER

Validation text If OK or Next is pressed without and answer

An answer is required

ValidationCodeNUMANSWER

Validation text if *MIN, *MAX of *RANGE is used

Answer must be in range {0}

ValidationCodeSELECTALL

Validation text in NIPO Conjoint Measurement level ordering questions

All levels must be ordered

ValidationCodeSNGCD

Validation text if an *NMUL is selected with other codes

This category cannot be used with other categorie(s)

ValidationCodeSPECANSWER

Validation text if no answer is filled on a *OPEN on a checked category

An answer must be specified

 

 

 

See Also