Creating or Changing Connection Pools

If you did not import physical schemas, you must create a database object before you create a connection pool.

Database objects and connection pools are created automatically when you import physical schemas, for both relational and multidimensional data sources.

You create or change a connection pool in the Physical layer of the Administration Tool.

To modify more than one connection pool, use the List Connection Pool Command and the Update Connection Pool Command

If you have already defined an existing database and connection pool, you can right-click the connection pool in the Physical layer and select Import Metadata to import metadata for this data source. The Import Metadata Wizard appears with the information on the Select Data Source screen pre-filled. See Importing Metadata and Working with Data Sources.

To automate connection pool changes for use in a process such as production migration, consider using the XML API. See “About the Oracle BI Server XML API” in XML Schema Reference for Oracle Business Intelligence Enterprise Edition.

  1. In the Physical layer of the Administration Tool, right-click a database and select New Object, then select Connection Pool. Or, double-click an existing connection pool.
  2. Specify or adjust the properties as needed, then click OK.

Setting Connection Pool Properties in the General Tab

You can learn about the properties in the General tab of the Connection Pool dialog.

The properties listed in the General tab vary according to the data source type. For example, XMLA data sources have a connection pool property for URL, while relational and XML data sources have the option Require fully qualified table names.

  • In the Connection Pool dialog, click the General tab, and then complete the fields.

Common Connection Pool Properties in the General Tab

The topic describes connection pool properties in the General tab that are common among most data source types.

The table describes the properties in the General tab of the Connection Pool dialog that are common for different data source types.

Property Description

Name

The name for the connection pool. A name is assigned automatically for connection pools created upon import.

Permissions

Use this option to assign permissions for individual users or application roles to access the connection pool. For example, you can set up a privileged group of users to have its own connection pool.

This feature is not intended for use as data access security. For example, connection pool permissions do not protect cache entries.

See Applying Data Access Security to Repository Objects.

Call interface

Identifies the application programming interface (API) with which to access the data source. You can access some databases using native APIs, some use ODBC, and some work both ways. Java data sources are accessed using JDBC/JNDI.

If the call interface is XML, the XML tab is available but options that do not apply to XML data sources are not available.

Maximum connections

The maximum number of connections allowed for this connection pool. The default is 10. You can determined the value by the database make and model and the configuration of the hardware for the computer on which the database runs, as well as the number of concurrent users who require access.

For Microsoft Analysis Services data sources, you might encounter 503 Service Not Available errors if the Max Connections setting in the connection pool (default 10) is greater than the XMLA MaxThreadsPerClient setting configured in Analysis Services (default 4). To avoid these errors, increase the MaxThreadsPerClient setting in the msmdpump.ini file, or reduce the Max Connections setting in the repository connection pool.

See Improving Use of System Memory Resources with TimesTen Data Sources.

Note:

For deployments with Oracle BI Interactive Dashboards pages, consider estimating this value at 10% to 20% of the number of simultaneous users multiplied by the number of requests on a dashboard. You can adjust the number based on usage. Define the total number of all connections in the repository to less than 800. To estimate the maximum connections needed for a connection pool dedicated to an initialization block, you might use the number of users concurrently logged on during initialization block execution.

Require fully qualified table names

Select this option if the database or database configuration requires fully qualified table names. This option is not available for some data source types.

When this option is selected, all requests sent from the connection pool use fully qualified names to query the underlying database. The fully qualified names are based on the physical object names in the repository. If you are querying the same tables from which the Physical layer metadata was imported, you can safely select this option. If you have migrated your repository from one physical database to another physical database that has different database and schema names, the fully qualified names are invalid in the newly migrated database. In this case, if you do not select this option, the queries succeed against the new database objects.

For some data sources, fully qualified names are a safer because they guarantee that the queries are directed to the desired tables in the desired database. For example, if the RDBMS supports a master database concept, a query against a table named Customer first looks for that table in the master database, and then looks for it in the specified database. If the table named Customer exists in the master database, that table is queried, not the table named Customer in the specified database.

It is sometimes necessary to select this option when you are using an Oracle Database, and you are accessing the database with a user that is not the owner of the schema containing the tables. When the Oracle Database interprets table names in SQL, it assumes that the user that made the query is the owner if the table name is not fully qualified in the query. This can result in an incorrect qualified name.

For example, if the user SAMPLE creates a table called CUSTOMER, the fully qualified table name is SAMPLE.CUSTOMER. When the SAMPLE user references the CUSTOMER table in a query, the Oracle Database assumes the fully qualified table name is SAMPLE.CUSTOMER, and the access is successful. However, if the JANEDOE user references the CUSTOMER table in a query, the Oracle Database assumes the fully qualified table name is JANEDOE.CUSTOMER, and a Table or view not found error can result. To enable access for JANEDOE, you must select Require fully qualified table names in the connection pool so that the Oracle BI Server specifies SAMPLE.CUSTOMER in all queries.

Data source name

The name of the data source to which you want this connection pool to connect and send physical queries. The value you enter in this field depends on the selected call interface:

  • If the call interface is OCI, enter a full connect string or a net service name from the tnsnames.ora file you set up within the Oracle Business Intelligence environment, in BI_DOMAIN/config/fmwconfig/bienv/core.

  • If you are using a native interface for a different database, enter the name of the database for that system.

  • If the call interface is ODBC, the data source name field displays a list containing all the User and System DSNs defined for ODBC on the local computer. Select the correct one for the data source to which you want connect.

If you are using Microsoft SQL Server, then enter an ODBC data source name or a full connect string. The following is the syntax for the full connect string:

Driver={Driver Name};Address=Host Name;Database=Database Name

Where Driver Name refers to the Microsoft SQL Server ODBC driver name. This driver name must exist in odbcinst.ini, and the environment variable ODBCINST should point to odbcinst.ini.

Shared logon

Select this option if you want all users whose queries use the connection pool to access the underlying database using the same user name and password.

If this option is selected, then all connections to the database that use the connection pool use the user name and password specified in the connection pool, even if the user has specified a database user name and password in the DSN (or in user configuration).

If this option is not selected, connections through the connection pool use the database user ID and password specified in the DSN or in the user profile.

The Shared logon option is enabled by default in Essbase connection pools. You cannot disable this option.

Enable connection pooling

When selected, allows a single database connection to remain open for the specified time for use by future query requests. Connection pooling saves the overhead of opening and closing a new connection for every query. If you do not select this option, each query sent to the database opens a new connection.

Timeout

Specify the amount of time and in what increment (such as minutes) that a connection to the data source remains open after a request completes. During this time, new requests use this connection rather than open a new one (up to the number specified for the maximum connections). The time is reset after each completed connection request.

If you are using an ADF data source and the call interface is OracleADF_HTTP and the query mode is SQLBypass, then Timeout specifies the maximum execution time before the connection is canceled.

Use multithreaded connections

When this option is selected, the Oracle BI Server terminates idle physical queries (threads). When not selected, one thread is tied to one database connection, number of threads = maximum connections. Even if threads are idle, they consume memory.

The parameter DB_GATEWAY_THREAD_RANGE in the Server section of NQSConfig.ini establishes when the Oracle BI Server terminates idle threads. The lower number in the range is the number of threads that are kept open before the Oracle BI Server takes action. If the number of open threads exceeds the low point in the range, the Oracle BI Server terminates idle threads. For example, if DB_GATEWAY_THREAD_RANGE is set to 40-200 and 75 threads are open, the Oracle BI Server terminates any idle threads.

Parameters supported

If this option is not selected, and the database features table supports parameters, special code executes that allows the Oracle BI Server to push filters (or calculations) with parameters to the database. The Oracle BI Server does this by simulating parameter support within the gateway/adapter layer by sending extra SQLPrepare calls to the database.

Isolation level

For ODBC and DB2 gateways only. The value sets the transaction isolation level on each connection to the back-end database. The isolation level setting controls the default transaction locking behavior for all statements issued by a connection. You can only set one at a time. It remains set for that connection until it is explicitly changed.

The following options are available:

Dirty read. Implements dirty read, isolation level 0 locking. This is the least restrictive isolation level. When this option is set, it is possible to read uncommitted or dirty data, change values in the data, and have rows appear or disappear in the data set before the end of the transaction.

Dirty data is data to clean before executing a query to obtain correct results, for example, duplicate records, records with inconsistent naming conventions, or records with incompatible data types.

Committed read. Specifies that shared locks are held while the data is read to avoid dirty reads. You can change the data before the end of the transaction, resulting in non repeatable reads or phantom data.

Repeatable read. Places locks on all data that is used in a query, preventing other users from updating the data. You can insert new phantom rows into the data set by another user and are included in later reads in the current transaction.

Serializable. Places a range lock on the data set, preventing other users from updating or inserting rows into the data set until the transaction is complete. This is the most restrictive of the four isolation levels. Because concurrency is lower, use this option only if necessary.

Multidimensional Connection Pool Properties in the General Tab

Learn how to use the connection pool properties.

The table describes the properties in the General tab of the Connection Pool dialog that are specific to multidimensional data sources. Some properties only appear for certain types of multidimensional data sources.

Property Description

URL

This property is only displayed for XMLA data sources. Specify the URL to connect to the XMLA provider. This URL points to the XMLA virtual directory of the computer hosting the cube. This virtual directory must be associated with msxisapi.dll, part of the Microsoft XML for Analysis SDK installation. For example, the URL might look like the following:

http://SDCDL360i101/xmla/msxisap.dll

Essbase Server

This property is only displayed for Essbase data sources. Specify the host name of the computer where the Essbase Server is running.

If the Essbase Server is running on a non-default port, or if it is part of an Essbase Cluster, you must include the port number in the Essbase Server field, in the format hostname:port.

Note:

You can import metadata from an Essbase Cluster, but you must still specify an individual Essbase Server host name and port number in the Essbase Server field.

SSO

This property is only displayed for Essbase, Hyperion Financial Management, and Hyperion Planning data sources.

For Essbase, select this option if you want Essbase to be able to enforce security policies that provide different cube access or member-level access to different users. If you select this option then you must also select the Shared logon option.

Do not select this option if all users are expected to have the same access to the Essbase cube. In this case all the users will have the same access to the cube based on the shared credentials specified in the connection pool. If you do not select this option then you must also select the Shared logon option.

For Hyperion Financial Management or Hyperion Planning, select this option and be sure that the Shared logon option is unchecked to authenticate against Hyperion Financial Management or Hyperion Planning using a shared token, rather than using a set of shared credentials in the connection pool.

If you select this option, you should also select Virtual Private Database in the corresponding database object to protect cache entries.

For Essbase, Hyperion Financial Management, and Hyperion Planning data sources installed with the EPM System Installer, preconfiguration is required before you select this option. See Configuring SSO for Essbase, Hyperion Financial Management.

Shared logon

This property is only displayed for Essbase, Hyperion Financial Management, and Hyperion Planning data sources.

For all Essbase data sources, it is required that you select this option. See Configuring Essbase to Use a Shared Logon.

For Hyperion Financial Management or Hyperion Planning, you set this option based on how you set the SSO property.

  • If you checked the SSO property, then do not check this option. Not checking this option causes authentication against Hyperion Financial Management or Hyperion Planning using a shared token, rather than using a set of shared credentials in the connection pool.

  • If you did not check the SSO property, then check this option to enable the Oracle BI Server to use the same shared logon credentials to connect to the data source for all Oracle BI users. All users share the same access to the data source.

Data Source Information: Data Source

Specify the vendor-specific information used to connect to the multidimensional data source. Consult your multidimensional data source administrator for setup instructions because specifications can change. For example, if you use v1.0 of the XML for Analysis SDK, then the value should be Provider-MSOLAP;Data Source-local. If you use v1.1, then it should be Local Analysis Server.

Data Source Information: Catalog

Specify the list of catalogs available, if you imported data from your data source. The cube tables correspond to the catalog you use in the connection pool.

System IP or Hostname

This property is only displayed for SAP/BW data sources. Provide the host name or IP address of the SAP data server. This field corresponds to the parameter ashost in the SAP/BW connect string.

System Number

This property is only displayed for SAP/BW data sources. Provide the SAP system number. This is a two-digit number assigned to an SAP instance, also called Web Application Server, or WAS. This field corresponds to the parameter sysnr in the SAP/BW connect string.

Client Number

This property is only displayed for SAP/BW data sources. Provide the SAP client number. This is a three-digit number assigned to the self-contained unit called Client in SAP. A Client can be a training, development, testing, or production client, or it can represent different divisions in a large company. This field corresponds to the parameter client in the SAP/BW connect string.

Language

This property is only displayed for SAP/BW data sources. Provide the SAP language code used when logging in to the data source, for example, EN for English or DE for German. This field corresponds to the parameter lang in the SAP/BW connect string.

Additional Parameters

This property is only displayed for SAP/BW data sources. Optionally, provide additional connection string parameters in the format param=value. Delimit multiple parameters with a colon.

Use session

An option that controls whether queries go through a common session. Consult your multidimensional data source administrator to determine whether this option should be enabled. Default is Off, not selected.

Setting Connection Pool Properties in the Connection Scripts Tab

You can create connection scripts and set the scripts to run before the connection is established, before a query is run, after a query is run, or after the connection is disconnected.

For example, you can create a connection script that, on connect, inserts the name of the user and the connection time into a table.

This topic describes the properties in the Connection Scripts tab of the Connection Pool dialog. The Connection Scripts tab is available for ODBC, OCI, Oracle OLAP, ADF, and DB2 data sources.

Connection scripts can contain any commands accepted by the database, such as a command to turn on quoted identifiers. In a mainframe environment, a script could be used to set the secondary authorization ID when connecting to DB2 to force a security exit to a mainframe security package such as RACF. This enables mainframe environments to maintain security in one central location.

Because the connection script is sent directly to the data source, the script should use native SQL or another language understood by the data source, not Oracle BI Server Logical SQL.

  • In the Connection Pool dialog, click the Connection Scripts tab, and then complete the fields using the information in the following table.

    To enter a new connection script, click New next to the appropriate script type. Then, enter or paste the SQL statements for the script and click OK.

    You can edit existing scripts by clicking the ellipsis button to launch the Physical SQL window. Use the Up Arrow and Down Arrow buttons to reorder existing scripts.

    Click Delete to remove a script.

The table describes the properties in the Connection Scripts tab of the Connection Pool dialog.

Property Description

Execute on connect

Contains SQL queries that are executed before the connection is established.

Execute before query

Contains SQL queries that are executed before the query is run.

Execute after query

Contains SQL queries that are executed after the query is run.

Execute on disconnect

Contains SQL queries that are executed after the connection is closed.

Setting Connection Pool Properties in the XML Tab

Use the Connection Pool Properties in the XML tab to set properties for XML and XML Server data sources.

Caution:

The XML tab of the Connection Pool dialog provides the same functionality as the XML tab of the Physical Table dialog. However, the properties in the XML tab of the Physical Table dialog override the corresponding settings in the Connection Pool dialog.

  • In the Connection Pool dialog, click the XML tab, and then complete the fields using the information in the table that follows.

The table describes the properties in the XML tab of the Connection Pool dialog.

Property Description

Connection method:

Search script

This property is only displayed for XML Server data sources. Click Browse to locate the appropriate search script.

Connection properties:

URL refresh interval

This property is used for XML data sources and is not available for XML Server data sources. The refresh interval is analogous to setting cache persistence for database tables. The URL refresh interval is the time interval after which the XML data source is queried again directly rather than using results in cache. The default setting is infinite, meaning the XML data source is never refreshed.

If you specified a URL to access the data source, set the URL refresh interval.

  • Select a value from the list (Infinite, Days, Hours, Minutes or Seconds).

  • Specify a whole number as the numeric portion of the interval.

Connection properties:

URL loading time-out

The timeout interval for queries. The default is 15 minutes.

If you specified a URL to access the data source, set the URL loading time-out as follows:

  • Select a value from the list (Infinite, Days, Hours, Minutes or Seconds).

  • Specify a whole number as the numeric portion of the interval.

Connection properties:

Maximum connections

The maximum number of connections. The default is 10.

Query input supplements:

Header file/Trailer file

This property is only displayed for XML Server data sources. Click Browse to locate the header and trailer files.

Query output format

For XML data sources, choose only XML.

Other output formats are available for XML Server data sources.

Setting Connection Pool Properties in the Write Back Tab

Use the Write Back tab to set write back properties for ODBC, OCI, Oracle OLAP, ADF, and DB2 data sources.

  • In the Connection Pool dialog, click the Write Back tab, and then complete the fields using the information in the table.

See About Setting the Buffer Size and Transaction Boundary.

The table describes the properties in the Write Back tab of the Connection Pool dialog.

Property Description

Temporary table:

Prefix

When the Oracle BI Server creates a temporary table, these are the first two characters in the temporary table name. The default value is TT.

Temporary table:

Owner

Table owner name used to qualify a temporary table name in a SQL statement, for example to create the table owner.tablename. If left blank, the user name specified in the writeable connection pool is used to qualify the table name and the Shared logon field on the General tab should also be set.

Temporary table:

Database name

Database where the temporary table will be created. This property applies only to IBM OS/390 because IBM OS/390 requires database name qualifier to be part of the CREATE TABLE statement. If left blank, OS/390 defaults the target database to a system database for which the users may not have Create Table privileges.

Temporary table:

Tablespace name

Tablespace where the temporary table will be created. This property applies to OS/390 only as OS/390 requires tablespace name qualifier to be part of the CREATE TABLE statement. If left blank, OS/390 defaults the target database to a system database for which the users may not have Create Table privileges.

Bulk insert:

Buffer size (KB)

Used for limiting the number of bytes each time data is inserted in a database table. For optimum performance, consider setting this parameter to 128.

Bulk insert:

Transaction boundary

Controls the batch size for an insert in a database table. For optimum performance, consider setting this parameter to 1000.

Unicode database type

Select this option when working with columns of an explicit Unicode data type, such as NCHAR, in a Unicode database. This makes sure that the binding is correct and that data is inserted correctly. Different database vendors provide different character data types and different levels of Unicode support. Use the following general guidelines to determine when to set this option:

  • On a database where CHAR data type supports Unicode and there is no separate NCHAR data type, do not select this option.

  • On a database where NCHAR data type is available, it is recommended to select this option.

  • On a database where CHAR and NCHAR data type are configured to support Unicode, selecting this option is optional.

Unicode and non-Unicode data types cannot coexist in a single non-Unicode database. For example, mixing the CHAR and NCHAR data types in a single non-Unicode database environment is not supported.

Connection Pool Properties in the Miscellaneous Tab

Use the Miscellaneous tab of the Connection Pool dialog to set application properties for ADF, JDBC, and JNDI data sources.

To set application properties, see Specifying Application Properties for JDBC (Direct Driver) or JDBC (JNDI) Data Sources.

The table describes the properties in the Miscellaneous tab of the Connection Pool dialog.

Property Description

AppModule Definition

The fully qualified Java package name of the Root Application Module to which you want to connect, such as oracle.apps.fii.receivables.model.RootAppModule.

AppModule Config

Determines which application configuration is used in the connection, such as RootAppModuleShared.

URL

The URL to the Oracle Business Intelligence broker servlet, in the format:

http://host:port/APP_DEPLOYMENT_NAME/obieebroker

For example:

http://localhost:7001/SnowflakeSalesApp/obieebroker

The URL is case-sensitive.

SQL Bypass Database

(Optional) The name of the SQL Bypass database. The SQL Bypass database must be a physical database in the Physical layer of the repository. The database object for the SQL Bypass database must have a valid connection pool, with connection information that points to the same database that is being used by the JDBC Data source defined in the WebLogic Server.

The SQL Bypass database does not need to have any tables under it. After a valid database name is supplied, the SQL Bypass feature is enabled for all queries.

The SQL Bypass feature directly queries the database so that aggregations and other transformations are pushed down where possible, reducing the amount of data streamed and worked on in Oracle Business Intelligence . See About Specifying a SQL Bypass Database.

Specifying Application Properties for JDBC (Direct Driver) or JDBC (JNDI) Data Sources

Use the steps to set application properties for JDBC (Direct Driver) or JDBC (JNDI) data sources.

  1. In the Oracle BI Administration Tool, double-click the physical database to set application properties for JDBC (Direct Driver) or JDBC (JNDI) data sources.
  2. In Properties, click the Connection Pools tab.
  3. Select the Connection and click Edit to open the Connection Pool dialog.
  4. In the Connection Pool dialog, click the Miscellaneous tab.
  5. Complete the fields using the following information:
    • Required Cartridge Version defaults to 12.1.

    • Use SQL Over HTTP for JDBC (JNDI) call interface, only. If you are using Oracle BI Cloud Service, set this field to false to use HTTP to communicate between networks. For example, set this field to false if the Oracle BI Server and the data source you are accessing reside on different Oracle clouds.

    • Javads Server URL for JDBC (Direct Driver) call interface, only. The field is populated with the hostname and port that was specified in the Connect to Java Datasource Server dialog. The Javads Server URL is the URL for the Java Datasource server that supplies the Java metadata into the Physical layer.

    • Driver Class for JDBC (Direct Driver) call interface, only. Specify the driver to connect to the database such as the DB2 JDBC driver. You must select a driver that is deployed in Oracle WebLogic Server.

      By default the Oracle JDBC driver, oracle.jdbc.OracleDriver, is available in Oracle WebLogic Server.

EXECUTE PHYSICAL DATABASE

Use EXECUTE PHYSICAL DATABASE statement to send physical SQL to the Oracle BI Server to connect to data sources.

The EXECUTE PHYSICAL DATABASE statement enables executing physical queries from the client without knowing the connection pool information.

Syntax

EXECUTE PHYSICAL DATABASE DatabaseName /*add a valid SQL statement