Nqsconfig

File Path: < OBIEE Install Directory> / Oracle BI/ Server/ Config / NQSConfig.INI

Here I would like to share the importance of this file

First of all  NQSConfig.INI is the main Configuration file for BI Server. Because it contains lots of parameters.

[Note: After changing anything to this file we  have to restart Oracle BI server Services to reflect that changes  ]

1)  General

If Values in the literals, digits or _, they can be given as such. If values contain characters other than literals, digits or _, values must be given in quotes. (Like “”)

2) Repository

All repositories must reside in OracleBI \ server\ Repository directory, where OracleBI is the directory in which the oracle BI server software is installed.

3)  Cache ( Learn in detail about CACHE MANAGEMENT)

Usually Cache ENABLE options = YES , If you change  as “ NO ” then u can not check in Cache Manager about the entries ( means cache will be disable)

( to check in cache manager follow this

Start \ All Programs \ Oracle Business Intelligence \ Administration  then  File \ open \ online

Give Administrator as user and password. Then go to Manage\cache)

We can change parameters like MAX ROWS PER CACHE ENTRY, MAX CACHE ENTRY SIZE, MAX CACHE ENTRIES .

Above parameters are by default. And we can change it to need our need. To check the current caching situation on the server path: Oracle BI Admin tool > Manage > Cache > Go right pane and right click> show info.

You will see the screen as below.

Server Section

###############################################################################
#
#  Server Section
#
###############################################################################

[ SERVER ]

SERVER_NAME = Oracle_BI_Server ;
READ_ONLY_MODE = NO; // default is "NO". That is, repositories can be edited online.
MAX_SESSION_LIMIT = 2000 ;
MAX_REQUEST_PER_SESSION_LIMIT = 500 ;
SERVER_THREAD_RANGE = 40-100;
SERVER_THREAD_STACK_SIZE = 0;               // default is 256 KB, 0 for default
DB_GATEWAY_THREAD_RANGE = 40-200;
DB_GATEWAY_THREAD_STACK_SIZE = 0;           // default is 256 KB, 0 for default
MAX_EXPANDED_SUBQUERY_PREDICATES = 8192;    // default is 8192
MAX_QUERY_PLAN_CACHE_ENTRIES = 1024;        // default is 1024
MAX_DRILLDOWN_INFO_CACHE_ENTRIES = 1024;    // default is 1024
MAX_DRILLDOWN_QUERY_CACHE_ENTRIES = 1024;   // default is 1024
INIT_BLOCK_CACHE_ENTRIES = 20;              // default is 20

CLIENT_MGMT_THREADS_MAX = 5;                // default is 5

# The port number specified with RPC_SERVICE_OR_PORT will NOT be considered if
# a port number is specified in SERVER_HOSTNAME_OR_IP_ADDRESSES.

RPC_SERVICE_OR_PORT = 9703;                 // default is 9703

# If port is not specified with a host name or IP in the following option, the port
# number specified at RPC_SERVICE_OR_PORT will be considered.
# When port number is specified, it will override the one specified with
# RPC_SERVICE_OR_PORT.

SERVER_HOSTNAME_OR_IP_ADDRESSES = "ALLNICS"; # Example: "hostname" or "hostname":port
# or "IP1","IP2":port or
# "hostname":port,"IP":port2.
# Note: When this option is active,
# CLUSTER_PARTICIPANT should be set to NO.


ENABLE_DB_HINTS = YES;                      // default is yes
PREVENT_DIVIDE_BY_ZERO = YES;

CLUSTER_PARTICIPANT = NO; # If this is set to "YES", comment out
# SERVER_HOSTNAME_OR_IP_ADDRESSES. No specific NIC support
# for the cluster participant yet.

// Following required if CLUSTER_PARTICIPANT = YES
#REPOSITORY_PUBLISHING_DIRECTORY = "";
#REQUIRE_PUBLISHING_DIRECTORY = YES;  // Don't join cluster if directory not accessible

DISCONNECTED = NO;
AUTOMATIC_RESTART = YES;

###############################################################################

Security Section

###############################################################################
#
#  Security Section
#
#  Legal value for DEFAULT_PRIVILEGES are:
#    NONE READ
#
###############################################################################

[ SECURITY ]

DEFAULT_PRIVILEGES = READ;
PROJECT_INACCESSIBLE_COLUMN_AS_NULL = NO;
MINIMUM_PASSWORD_LENGTH = 0;

#IGNORE_LDAP_PWD_EXPIRY_WARNING = NO;     // default is no.

#SSL=NO;
#SSL_CERTIFICATE_FILE="servercert.pem";
#SSL_PRIVATE_KEY_FILE="serverkey.pem";
#SSL_PK_PASSPHRASE_FILE="serverpwd.txt";
#SSL_PK_PASSPHRASE_PROGRAM="sitepwd.exe";
#SSL_VERIFY_PEER=NO;
#SSL_CA_CERTIFICATE_DIR="CACertDIR";
#SSL_CA_CERTIFICATE_FILE="CACertFile";
#SSL_TRUSTED_PEER_DNS="";
#SSL_CERT_VERIFICATION_DEPTH=9;
#SSL_CIPHER_LIST="";

# There are 3 types of authentication. The default is NQS
# You can select only one of them
#
#----- 1 -----
#AUTHENTICATION_TYPE = NQS;         // optional and default
#
#----- 2 -----
#AUTHENTICATION_TYPE = DATABASE;
#   [ DATABASE ]
#        DATABASE = "some_data_base";
#
#----- 3 -----
#AUTHENTICATION_TYPE = BYPASS_NQS;


###############################################################################

General Section

###############################################################################
#
#  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 server to a client.
#
###############################################################################

[ GENERAL ]

// Localization/Internationalization parameters.
LOCALE = "English-usa";
SORT_ORDER_LOCALE = "English-usa";
SORT_TYPE = "binary";

// Case sensitivity should be set to match the remote
// target database.
CASE_SENSITIVE_CHARACTER_COMPARISON = OFF ;
// SQLServer65 sorts nulls first, whereas Oracle sorts
// nulls last. This ini file property should conform to
// that of the remote target database, if there is a
// single remote database. Otherwise, choose the order
// that matches the predominant database (i.e. on the
// basis of data volume, frequency of access, sort
// performance, network bandwidth).
NULL_VALUES_SORT_FIRST = OFF;


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


// Temporary space, memory, and resource allocation
// parameters.
// You may use KB, MB for memory size.

WORK_DIRECTORY_PATHS = "C:\OracleBIData\tmp";
SORT_MEMORY_SIZE = 4 MB ;
SORT_BUFFER_INCREMENT_SIZE = 256 KB ;
VIRTUAL_TABLE_PAGE_SIZE = 128 KB ;


// Analytics Server will return all month and day names as three
// letter abbreviations (e.g., "Jan", "Feb", "Sat", "Sun").
// To use complete names, set the following values to YES.
USE_LONG_MONTH_NAMES = NO;
USE_LONG_DAY_NAMES = NO;

UPPERCASE_USERNAME_FOR_INITBLOCK = NO ;   // default is no

// Aggregate Persistence defaults
// The prefix must be between 1 and 8 characters long
// and should not have any special characters ('_' is allowed).

AGGREGATE_PREFIX = "SA_" ;


###############################################################################

Query Result Cache Section Parameters

###############################################################################
#
#  Query Result Cache Section
#
###############################################################################

[ CACHE ]

ENABLE = YES;
// A comma separated list of pair(s)
//   e.g. DATA_STORAGE_PATHS = "d:\OracleBIData\nQSCache" 500 MB;
DATA_STORAGE_PATHS = "C:\OracleBIData\cache" 500 MB;
MAX_ROWS_PER_CACHE_ENTRY = 100000;  // 0 is unlimited size
MAX_CACHE_ENTRY_SIZE = 1 MB;
MAX_CACHE_ENTRIES = 1000;
POPULATE_AGGREGATE_ROLLUP_HITS = NO;
USE_ADVANCED_HIT_DETECTION = NO;

MAX_SUBEXPR_SEARCH_DEPTH = 7;

// Cluster-aware cache
// GLOBAL_CACHE_STORAGE_PATH = "" SIZE;
// MAX_GLOBAL_CACHE_ENTRIES = 1000;
// CACHE_POLL_SECONDS = 300;
// CLUSTER_AWARE_CACHE_LOGGING = NO;

###############################################################################

The parameters in the Query Result Cache Section provide configuration information
for Oracle BI Server caching. The query cache is enabled by default. After deciding on
a strategy for flushing outdated entries, you should configure the cache storage
parameters in Fusion Middleware Control and in the NQSConfig.INI file.
Note that query caching is primarily a run-time performance improvement capability.
As the system is used over a period of time, performance tends to improve due to
cache hits on previously executed queries. The most effective and pervasive way to
optimize query performance is to use the Aggregate Persistence Wizard and aggregate
navigation.

This section describes only the parameters that control query caching. For information
about how to use caching in Oracle Business Intelligence, including information about
how to use agents to seed the Oracle BI Server cache, see Chapter 7, "Managing
Performance Tuning and Query Caching."
 ENABLE

Note: The ENABLE parameter is centrally managed by Fusion
Middleware Control and cannot be changed by manually editing
NQSConfig.INI, unless all configuration through Fusion Middleware
Control has been disabled (not recommended).
The Cache enabled option on the Performance tab of the Capacity
Management page in Fusion Middleware Control corresponds to the
ENABLE parameter. See Section 7.5.1, "Using Fusion Middleware
Control to Enable and Disable Query Caching" for more information.



Specifies whether the cache system is enabled. When set to NO, caching is disabled.
When set to YES, caching is enabled. The query cache is enabled by default.
Example: ENABLE = YES;
A.3.2 DATA_STORAGE_PATHS
Specifies one or more paths for where the cached query results data is stored and are
accessed when a cache hit occurs and the maximum capacity in bytes, kilobytes,
megabytes, or gigabytes. The maximum capacity for each path is 4 GB. For optimal
performance, the paths specified should be on high performance storage systems.
Each path listed must be an existing, writable path name, with double quotes ( " )
surrounding the path name. Specify mapped directories only. UNC path names and
network mapped drives are allowed only if the service runs under a qualified user
account.
You can specify either fully qualified paths, or relative paths. When you specify a path
that does not start with "/" (on UNIX) or ":" (on Windows), the Oracle BI
Server assumes that the path is relative to the local writable directory. For example, if
you specify the path "cache," then at run time, the Oracle BI Server uses the following:
ORACLE_INSTANCE/bifoundation/OracleBIServerComponent/coreapplication_obisn/cache
Specify multiple directories with a comma-delimited list. When you specify multiple
directories, they should reside on different physical drives. (If you have multiple cache

Repository Section

Repository Section
#
#  Repositories are defined as logical repository name - file name
#  pairs.  ODBC drivers use logical repository name defined in this
#  section.
#
#  All repositories must reside in OracleBI\server\Repository
#  directory, where OracleBI is the directory in which the Oracle BI
#  Server software is installed.
#
###############################################################################

[ REPOSITORY ]

Star = newone.rpd, DEFAULT;

Note: The default repository is centrally managed by Fusion Middleware Control and cannot be changed by manually editing NQSConfig.INI, unless all configuration through Fusion Middleware
Control has been disabled (not recommended).
The Repository tab of the Deployment page in Fusion Middleware
Control controls the default repository. The logical name of the default
repository is always "Star." See Section 10.1, "Using Fusion
Middleware Control to Upload a Repository and Set the Oracle BI
Presentation Catalog Location" for more information.
Note that you can manually add additional repository entries in
NQSConfig.INI without having these entries overridden by Fusion
Middleware Control. However, hosting multiple repositories on a
single Oracle BI Server is not recommended for production systems.

The Repository section contains one entry for every repository that is loaded when the
server starts.
Syntax: logical_name = repository_name.rpd;
Optional syntax: logical_name = repository_name.rpd, DEFAULT;
where:
■ logical_name: A logical name for the repository. Client tools use this name to
configure the ODBC data sources that connect to the repository. To use a reserved
keyword for the name, such as OCI7 or OCI8, enclose it in single quotes.
■ repository_name.rpd: The file name of the repository. The file name must
have the .rpd file extension, and the file must reside in the repository subdirectory.
The demonstration repository file, SampleApp.rpd, is installed with the Simple
installation type.
When DEFAULT is specified for a repository, connections that do not specify a logical
repository name in the DSN connect to the default repository.
Example: Star = SampleApp.rpd, DEFAULT;

About Parameters in the NQSConfig.INI File

Each instance of the Oracle BI Server has its own NQSConfig.INI file. When you
update NQSConfig.INI parameters for a clustered deployment, ensure that you make
the change in the NQSConfig.INI file for each instance of the Oracle BI Server.
Some parameters in NQSConfig.INI are centrally managed by Fusion Middleware
Control and cannot be updated manually in NQSConfig.INI. Instead, use Fusion
Middleware Control to change these parameters. Parameters that are centrally

managed by Fusion Middleware Control are marked as such in this appendix, and are
also identified by comments in the NQSConfig.INI file.
See Appendix G, "Mapping User Interface Labels with Configuration File Elements"
for additional information.
Note the following rules and guidelines for NQSConfig.INI file entries:
■ The Oracle BI Server reads the NQSConfig.INI file each time it is started.
■ Each parameter entry in NQSConfig.INI must be within the section to which the
parameter belongs (Repository, Cache, General, and so on).
■ Each entry must be terminated with semicolon ( ; ).
■ You can add comments anywhere in the NQSConfig.INI file. Comments must
begin with either of the following:
#
//
Any text following these comment characters up to the end of the line is ignored
when the Oracle BI Server reads the file.
■ Any syntax errors prevent the Oracle BI Server from starting. The errors are
logged to the nqserver.log file, which is located in:
ORACLE_INSTANCE/diagnostics/logs/OracleBIServerComponent/coreapplication_obisn
There might also be a summary message in the system log that relates to the error.
If you get an error, then correct the problem and start the Oracle BI Server again.
Repeat this process until the server starts with no errors.
A.1.1 How to Update Parameters in NQSConfig.INI
The following procedure explains how to update parameters in NQSConfig.INI.
To update parameters in NQSConfig.INI:
1. Open the NQSConfig.INI file in a text editor. You can find this file at:
ORACLE_INSTANCE/config/OracleBIServerComponent/coreapplication_obisn
Make a backup copy of the file before editing.
2. Locate and update the parameter you want to change.
3. Save and close the file.
4. Restart the Oracle BI Server. For more information, see Section 4.1, "About Starting
and Stopping Oracle Business Intelligence."

5. If you have multiple Oracle BI Server instances, then repeat these steps in each
NQSConfig.INI file for all Oracle BI Server instances.

NQSConfig.INI

The Oracle BI Server software uses an initialization file called NQSConfig.INI to set
parameters upon startup. This initialization file includes parameters to customize
behavior based on the requirements of each individual installation. This appendix lists
the NQSConfig.INI file parameters and gives a brief description and any required
syntax for each parameter. The parameters are generally listed in the order they appear
in the configuration file.