Siebel Analytics Installation and Configuration Guide > NQSConfig.INI File Reference > Siebel Analytics Configuration File Parameters and Syntax >

Parameters in the Configuration File General Section

The parameters in the General section contains general server default parameters, including localization and internationalization, temporary space and memory allocation, and other default parameters used to determine how data is returned from the Siebel Analytics Server to a client.

NOTE:  The settings for the parameters LOCALE, SORT_ORDER_LOCALE, SORT_TYPE and CASE_SENSITIVE_CHARACTER_COMPARISON, described in this section are interrelated. They help determine how the Siebel Analytics Server sorts data.

LOCALE

Specifies the locale in which data is returned from the server. This parameter also determines the localized names of days and months. For example, if LOCALE = 'dutch', then names of days and months are returned from the server in Dutch. The localized message strings are written to various log files as well as returned to the user as error messages.

The supported values for LOCALE and SORT_ORDER_LOCALE are shown in Table 10.

Table 10.  Supported Languages for LOCALE and SORT_ORDER_LOCALE
Supported Language
Chinese-simplified
Chinese-traditional
Czech
Danish
Dutch
English-USA
Finnish
French
German
Italian
Japanese
Korean
Portuguese
Portuguese-Brazilian
Spanish
Swedish

The default is English-USA. You need to explicitly set the value of this parameter if you want to use a setting other than english-usa.

Example: LOCALE = "english-usa" ;

The language extensions for all supported languages are shown in Table 11.

Table 11.  Siebel Analytics Language Extensions For All Supported Languages
Language Extension
Language
cs
Czech
da
Danish
de
German
en
English
es
Spanish
fi
Finnish
fr
French
it
Italian
ja
Japanese
ko
Korean
nl
Dutch
pt
Portuguese
pt-br
Brazilian Portuguese
sv
Swedish
zh
Chinese (Simplified)
zh-tw
Chinese (Traditional)

For more information about Analytics Catalog Manager and language extensions, see Siebel Analytics Web Administration Guide.

NOTE:  These two-letter language extensions for Siebel Analytics, shown in Siebel System Requirements and Supported Platforms for Siebel Analytics, are not to be confused with the Siebel eBusiness Applications three-letter language codes shown in Siebel System Requirements and Supported Platforms.

SORT_ORDER_LOCALE

This parameter is used to help determine whether the Siebel Analytics Server can function-ship an ORDER BY clause (used in sorting) to a relational database.

In the Server Administration Tool, the Features table (from the Features tab of the Database dialog) specifies the features and functions that the relational database supports. The settings for SORT_ORDER_LOCALE in the Features table and in the NQSConfig.INI file should match only if the relational database and the Siebel Analytics Server sort data in the same way.

For the relational database and the Siebel Analytics Server to sort data the same way, they must be in agreement on these parameters:

The SORT_ORDER_LOCALE entries in the Features table and in the NQSConfig.INI file match only if the database and the Siebel Analytics Server have equivalent settings in these areas match.

The default value for SORT_ORDER_LOCALE in both the Features table and in the NQSConfig.INI file is english-usa.

If the Siebel Analytics Server and the relational database sort data differently, the Features table entry SORT_ORDER_LOCALE for the relational database needs to be set to a different value than english-usa. Failure to do so can result in wrong answers when multi-database joins are used, or errors using the Union, Intersect and Except operators, which all rely on consistent sorting between the relational server and the Siebel Analytics Server.

Every database defined in the Physical Layer in the Siebel Analytics Server Administration Tool has a features table associated with it. If you want to override the default value in the Features table for a particular type of relational database, you need to do it for all occurrences of it in the Physical Layer.

Example: SORT_ORDER_LOCALE = "english-usa" ;

SORT_ORDER_LOCALE on UNIX Operating Systems

The Analytics Server sets the C-runtime locale during server startup. A value for the setting is specified via the SORT_ORDER_LOCALE entry in the NQSConfig.INI file. You should always enter a platform-independent name and the corresponding platform-specific name is used. Table 12 shows the mappings from the platform-independent name (for example, chinese-simplified) to the specific name for each of the supported UNIX platforms (for example, zh_TW.utf8 for HP-UX for chinese-simplified).

NOTE:  This table is valid for 7.5.3 and later releases.

Table 12.  SORT_ORDER_LOCALE Settings on UNIX Platforms
SORT_ORDER_LOCALE
Solaris
AIX
HP-UX
English-USA
en_US.UTF-8
EN_US.UTF-8
univ.utf8
French
fr_FR.UTF-8@euro
FR_FR.UTF-8
fr_FR.utf8
German
de_DE.UTF-8@euro
DE_DE.UTF-8
de_DE.utf8
Italian
it_IT.UTF-8@euro
IT_IT.UTF-8
it_IT.utf8
Japanese
ja_JP.UTF-8
JA_JP.UTF-8
ja_JP.utf8
Portuguese-Brazilian
pt_BR.UTF-8
PT_BR.UTF-8
univ.utf8
Spanish
es_ES.UTF-8@euro
ES_ES.UTF-8
es_ES.utf8
Swedish
sv_SE.UTF-8
SV_SE.UTF-8
sv_SE.utf8
Chinese-simplified
zh_CN.UTF-8
ZH_CN.UTF-8
zh_CN.utf8
Chinese-traditional
zh_TW.UTF-8
ZH_TW.UTF-8
zh_TW.utf8
Czech
cs_CZ.UTF-8
CS_CZ.UTF-8
univ.utf8
Danish
da_DK.UTF-8
DA_DK.UTF-8
univ.utf8
Dutch
nl_NL.UTF-8@euro
NL_NL.UTF-8
univ.utf8
Finnish
fi_FI.UTF-8@euro
FI_FI.UTF-8
univ.utf8
Greek
el_GR.UTF-8@euro
EL_GR.UTF-8
univ.utf8
Korean
ko_KR.UTF-8
KO_KR.UTF-8
ko_KR.utf8
Portuguese
pt_PT.UTF-8@euro
PT_PT.UTF-8
univ.utf8

If you do not have the proper locale installed, the Siebel Analytics server does not start, and the NQSServer.log file contains the following error:

[47013] NLS locale xxx is not supported by the operating system.

where xxx is the locale specified in the NQSConfig.INI file for the SORT_ORDER_LOCALE parameter.

The response to this error is to install the locale indicated in the table for the requested language.

The error can also occur with a Windows platform. For Windows, the fix is to add the corresponding language pack using the Regional Settings dialog.

SORT_TYPE

Specifies the type of sort to perform. The default value is BINARY. Binary sorts are faster than non-binary sorts.

Valid values are BINARY and DEFAULT. If you specify DEFAULT, a non-binary sort is performed; this yields better sort results for data that contains accented characters.

Example: SORT_TYPE = "BINARY" ;

CASE_SENSITIVE_CHARACTER_COMPARISON

Specifies whether the Siebel Analytics Server differentiates between uppercase and lowercase characters when performing comparison operations. Valid values are ON and OFF. When set to OFF, case is ignored. When set to ON, case is considered for comparisons. For binary sorts, case sensitivity for the server and for the relational database should set the same way.

Example: CASE_SENSITIVE_CHARACTER_COMPARISON = OFF ;

NULL_VALUES_SORT_FIRST

Specifies if NULL values sort before other values (ON) or after (OFF). ON and OFF are the only valid values. The value of NULL_VALUES_SORT_FIRST should conform to the underlying database. If there are multiple underlying databases that sort NULL values differently, set the value to correspond to the database that is used the most in queries.

Example: NULL_VALUES_SORT_FIRST= OFF ;

DATE_TIME_DISPLAY_FORMAT

Specifies the format for how date/time stamps are input to and output from the Siebel Analytics Server.

Example: DATE_TIME_DISPLAY_FORMAT = "yyyy/mm/dd hh:mi:ss" ;

DATE_DISPLAY_FORMAT

Specifies the format for how dates are input to and output from the Siebel Analytics Server.

NOTE:  Specify the year as either 2-digit (yy) or 4-digit (yyyy). Separators can be any character except y, m, or d.

Example: DATE_DISPLAY_FORMAT = "yyyy/mm/dd" ;

TIME_DISPLAY_FORMAT

Specifies the format for how time of day is input to and output from the Siebel Analytics Server.

Example: TIME_DISPLAY_FORMAT = "hh:mi:ss" ;

WORK_DIRECTORY_PATHS

Specifies one or more directories for temporary space. Each directory listed needs to be an existing fully-qualified, writable directory pathname, with double quotes ( " ) surrounding the pathname. Specify mapped directories only. UNC path names and network mapped drives are allowed only if the service runs under a qualified user account. To change the account under which the service is running, see Changing the Account Under Which a Windows Service Runs. Specify multiple directories with a comma separated list. Valid values are any fully qualified pathname to an existing, writable directory.

For optimum performance, temporary directories should reside on high performance storage devices. If you specify more than one directory, they should reside on different drives.

Syntax: WORK_DIRECTORY_PATHS = "<full_directory_path_1>" [, "<full_directory_path_2>"{, "<full_directory_path_n>"}] ;

Example 1: WORK_DIRECTORY_PATHS = "C:\Temp" ;

Example 2: WORK_DIRECTORY_PATHS = "D:\temp", "F:\temp" ;

NOTE:  Specifying more than one directory per drive does not improve performance because file I/O takes place through the same I/O controller. In general, specify only one directory per disk drive. Specifying multiple directories on different drives improves the overall I/O throughput of the Siebel Analytics Server because internally, the processing files are allocated using a round robin algorithm that balances the I/O load across the given disk drives.

SORT_MEMORY_SIZE

Specifies the maximum amount of memory to be used for each sort operation. Multiple operations can each use memory up to the value specified. The limit for SORT_MEMORY_SIZE is determined by the physical memory of the server machine and on the number of sort operations that might occur simultaneously. Specify KB for kilobytes, MB for megabytes, and no units for bytes. For more information, see the section How the SIZE Parameters Affect Siebel Analytics Performance.

Example: SORT_MEMORY_SIZE = 4 MB ;

SORT_BUFFER_INCREMENT_SIZE

Specifies the increment that the sort memory size is increased by as more memory is needed. As more memory is required, the size increases by the value specified until it reaches the value of SORT_MEMORY_SIZE. For more information, see the section How the SIZE Parameters Affect Siebel Analytics Performance.

Example: SORT_BUFFER_INCREMENT_SIZE = 256 KB ;

VIRTUAL_TABLE_PAGE_SIZE

Specifies the size of a memory page for the Siebel Analytics Server internal processing. A higher value reduces I/O but increases memory usage, especially in a multi-user environment. For more information, see the section How the SIZE Parameters Affect Siebel Analytics Performance.

Example: VIRTUAL_TABLE_PAGE_SIZE = 128 KB ;

How the SIZE Parameters Affect Siebel Analytics Performance

This section explains the interrelationships among the SIZE parameters and how they affect the performance of Siebel Analytics.

USE_LONG_MONTH_NAMES

This specifies whether month names are returned as full names, such as JANUARY and FEBRUARY, or as three-letter abbreviations, such as JAN and FEB. Valid values are YES and NO. Specify YES to have month names returned as full names or NO to have months names returned as three-letter abbreviations. The default value is NO.

Example: USE_LONG_MONTH_NAMES = NO ;

USE_LONG_DAY_NAMES

This specifies whether day names are returned as full names, such as MONDAY and TUESDAY, or as three-letter abbreviations, such as MON and TUE. Valid values are YES and NO. Specify YES to have day names returned as full names or NO to have day names returned as three-letter abbreviations. The default value is NO.

Example: USE_LONG_DAY_NAMES = NO ;


 Siebel Analytics Installation and Configuration Guide
 Published: 09 September 2004