In this article
Use this template to document an account type ONLY IF there are more than three account types. Document each account type to be documented separately. Maintain them as child pages of the main Accounts page. Remove Prerequisites, Limitations, and Troubleshooting from the main Accounts page if using this template.
Provide an overview of the account type.
Use this account type to connect Oracle Snaps with datasources that use Oracle accounts.
Provide all prerequisites for configuring the account type or use 'None.' if there are no prerequisites.
List all account-based limitations as bullets. Use "None." if there are no limitations.
Include a screenshot of the fully configured account. Do this for each account type.
Parameter Name | Data Type | Description | Default Value | Example | ||
---|---|---|---|---|---|---|
Label | String | Required. Unique name for the account. | N/A | Oracle123DB | ||
JDBC URL Source | String | Required. Select the source of the JDBC URL.
| Snap Generated | N/A | ||
Account properties | String | Required. Enter the information to create a connection to the database. | N/A | N/A | ||
Hostname | String | Required if JDBC URL Source is Snap Generated. The server address to which the application must connect. | N/A | oratestdb2.cwztruwzzvnq.us-east-1.rds.amazonaws.com | ||
Port Number | String | Required if JDBC URL Source is Snap Generated. The database server's port number to which the application must connect. | 1521 | 1521 | ||
Database name | String | Required if JDBC URL Source is Snap Generated. The database name to which the application must connect. | N/A | MYDB | ||
Custom JDBC URL | String | Required if JDBC URL Source is User Provided. The JDBC URLs that you want to use to connect to your Oracle account.
| N/A | N/A | ||
Username | String | The user name that is allowed to connect to the database. It is used as the default username when retrieving connections. The user name must be valid in order to set up the data source. | N/A | TECTONIC | ||
Password | String | The password used to connect to the data source. It is used as the default password when retrieving connections. The password must be valid in order to set up the data source. | N/A | N/A | ||
JDBC JARs | String | List of JDBC JAR files to be loaded. Click to add a JDBC Driver; click to remove a JDBC Driver. | N/A | N/A | ||
JDBC Driver | String | Enter the JDBC jar file to be loaded. Use to select an existing file. A different driver binary for a driver must have a different name, the same name can not be reused for a different driver. If this property is left blank, a default JDBC driver is loaded.
| N/A | N/A | ||
JDBC Driver Class | String | Required. The name of the JBDC driver to use. | oracle.jdbc.OracleDriver | oracle.jdbc.OracleDriver | ||
Database specifier type | String | Specify the database specifier type to use. The selected option decides which format of URL for JDBC is to be used internally. The valid options are:
| Service name | Service name | ||
SSL/ TCPS | String | Opt for or against connecting through SSL to the Oracle instance. If selected, the following format of URL is used internally: jdbc:oracle:thin@(DESCRIPTION=(ADDRESS=(PROTOCOL=TCPS)(HOST=<HOST>)(PORT=<PORT>))(CONNECT_DATA=(<SID/ SERVICE_NAME>=<DATABASE_NAME>))) | Not Selected | Not Selected | ||
Advanced properties | N/A | Specify advanced properties to connect to the database. | N/A | N/A | ||
Auto commit | String | Opt for or against setting the auto-commit property for a database.
| Selected | Selected | ||
Batch size | Integer | Required. Set the number of statements that the Snap must execute at a time.
| 50 | 100 | ||
Fetch size | Integer | Required. Set the number of rows that the Snap must fetch at a time when executing a query.
| 100 | 100 | ||
Max pool size | Integer | Required. Set the maximum number of connections that a pool must maintain at a time. | 50 | 50 | ||
Max life time | Integer | Required. Set the maximum time (in minutes) of a connection in the pool. Ensure that the value you enter is a few seconds shorter than any database or infrastructure-imposed connection time limit. A value of 0 indicates an infinite lifetime, subject to the Idle Timeout value. An in-use connection is never retired. Connections are removed only after they are closed. | 30 | 35 | ||
Idle Timeout | Integer | Required. Set the maximum time (in seconds) that a connection is allowed to sit idle in the pool. A value of 0 indicates that idle connections are never removed from the pool. | 5 | 5 | ||
Checkout timeout | Integer | Required. Set the time in milliseconds to wait for a connection to be available when the pool is exhausted. Zero waits forever. An exception is thrown after the wait time has expired. | 10000 | 10000 | ||
URL Properties | N/A | Specify input regarding URL properties. | N/A | N/A | ||
URL property name | String | Name for the URL property. | N/A | Batch_Refresh_Time | ||
URL property value | N/A | Value for the URL property. | N/A | 10 |
Error | Reason | Resolution |
---|---|---|
Failed to validate account: Failed to retrieve a database connection. | ORA-00604: error occurred at recursive SQL level 1 ORA-12705: Cannot access NLS data files or invalid environment specified | Configuring your Windows Registry key value, HKEY_CURRENT_USER\Control Panel\International\LocaleName , in the environment to true or en-US might work for certain Windows-based Groundplex instances. Additional probable solutions can be found here. |
Provide links to the endpoint's official documentation, any relevant or related internal documentation, and any other links you have referred to on this page. Care should be taken when referencing external sites/documentation that it is an official site/documentation. Do not refer to forums such as stackoverflow.