Connecting Bold BI to Oracle Database

Supported Server Versions: Oracle Database (11g, 12c, 18c, and 19c)

Using the Oracle connection type, you can connect an Oracle database.

Click Data Source button in the configuration panel to add a new data connection.

Data button

Click CREATE NEW to launch a new connection from the connection type panel.

Data source button

Click Oracle connection button in the connection type panel.

Set the server Name and port number where the Oracle service is running.

Service Instance Name is an optional parameter. Set the Service Instance Name if you have specific name for Oracle service: otherwise, Oracle connection will be launched with default service name

NOTE: What is Service Instance Name – Service Instance Name is a name given for Oracle Cloud Service. For more details refer Service Instance Name

Enter the user name and password to connect to the Oracle.

Select a database from the drop-down list and click the Connect button to connect the Oracle.

Oracle connect

NOTE: Initially, data will be extracted based on the Max Rows selected in order to proceed with data model creation. The remaining records (there is no limit) will be extracted during the next refresh.

Max rows option

The selected database will be opened in the data design view window.

Oracle database

Drag and drop the table from table list, and click Save button to save the data source with valid name.

Connecting Bold BI to Oracle Data Source via REST API

Prerequisites

Type while creating the data source needs to be oracle.

Rest API - v4.0

Modes

Through the REST API, only the live mode data source can be created and edited.

Parameters for creating Data Source

Parameters	Details
Servername required	`string` Server name or Host name of the connection
Port required	`string` Port number used to connect to oracle
InstanceName required	`string` InstanceName or service name of the connection
Username required	`string` A valid username for the connection
Password required	`string` A valid Password for the connection
Database required	`string` database which needs to be connected
Schemaname required for table mode	`string` Enter a valid Schemaname
Tablename required for table mode	`string` Enter a valid Tablename
Query required for code view mode	`string` Enter a valid Query
AdvancedSettings optional	`string` Additional optional connection parameters can be provided. By default, it is empty.
CommandTimeout optional	`string` Enter a valid Timeout for connection. By default, it is 300
Expressions optional	`Array of Objects`

Parameters for adding expressions when creating Data Source

Parameters	Details
Name required	`string` Name of the Expression
Expression required	`string` Expression

Parameters for editing Data Source

NOTE: For editing Data Source via API. All the parameters are optional. The parameter which needs to be changed can be provided.

Parameters for modifying expressions when editing Data Source

Parameters	Details
Name required	`string` Name of the Expression
Expression required	`string` Expression
Action optional	`string` add/delete/edit By default, it is add.
NewName optional	`string` For renaming the expression. This is applicable only if the Action is edit

Connection Sample for Table Mode

For creating connection:

"Connection": [
{
"Servername": "string",
"Port": "string",
"InstanceName": "string",
"Username": "string",
"Password": "string",
"Database": "string",
"Schemaname": "string",
"Tablename": "string",
"AdvancedSettings": "string",
"CommandTimeout": "string",
"Expressions" : [{
"Name": "Expression1",
"Expression" : "SUM(numeric expression)"
    },
    {
"Name": "Expression2",
"Expression" :  "UPPER(string expression)"
}]
}
]

For editing connection:

"Connection": [
{
"Servername": "string",
"Port": "string",
"InstanceName": "string",
"Username": "string",
"Password": "string",
"Database": "string",
"Schemaname": "string",
"Tablename": "string",
"AdvancedSettings": "string",
"CommandTimeout": "string",
"Expressions" : [{
"Name": "Expression1",
"Expression" : "SUM(numeric expression)",
"NewName" : "Sum",
"Action": "edit"
    },
    {
"Name": "Expression2",
"Expression" :  "UPPER(string expression)"
"Action": "delete"
}]
}
]

NOTE: Through Rest API, the data source can be created or edited with only one table. If different table is provided in edit data source, the table will be replaced. The widgets will be retained only if the schema is same as the previous table.

Connection Sample for Code View Mode

"Connection": [
{
"Servername": "string",
"Port": "string",
"InstanceName": "string",
"Username": "string",
"Password": "string",
"Database": "string",
"Query": "string",
"AdvancedSettings": "string",
"CommandTimeout": "string",
"Expressions" : [{
"Name": "Expression1",
"Expression" : "SUM(numeric expression)"
    },
    {
"Name": "Expression2",
"Expression" :  "UPPER(string expression)"
}]
}
]