Documentation
Demos
Support
Blog
Download Free Trial
Search results

Connecting Bold BI to Amazon RDS data source

The Bold BI Dashboard Designer supports connecting Amazon RDS database using SQL Live Query .

Choose Amazon RDS data source

To configure the Amazon RDS data source, follow these steps:

  1. Click Data Sources in the configuration panel to add a new data connection.

    Data source icon

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

  3. Select the Amazon RDS connection in the connection panel.

    Choose data source

NOTE: You can also create a data source from the home page by clicking the Data Sources menu from left menu panel and Create Data Source from the data sources page.

Choose data source from server

Connect to Amazon RDS

Create Amazon RDS data source

After clicking a data source, the NEW DATA SOURCE configuration panel opens. Follow the given steps to create a Amazon RDS data source:

  1. Enter a name and description (optional) for the data source.

  2. Select a database engine you want to use with the given Amazon RDS Server from the Database Engine combo box.

  3. Enter a valid Amazon RDS server or host name in the ServerName text box.

  4. Enter a valid Amazon RDS user name in the UserName text box.

  5. Enter a valid Amazon RDS password in the Password text box.

  6. Enter a valid Amazon RDS Database in the Database text box or select in the combo box.

    DataSourcesView

Amazon RDS supported database engine in Bold bi

  • MySQL
  • MariaDB
  • Amazon Aurora MySQL
  • SQL server
  • PostgreSQL
  • Amazon Aurora PostgreSQL
  • Oracle

Database Engine

Amazon RDS Connection

There are two connection types available in a data source:

* Live mode
* Extract mode

Live mode connection

In this connection type, a data source is directly fetched from source. Choose the Live mode option for this connection.

Live Connection

Data Preview

  1. Click Connect to connect the Amazon RDS server with configured details.

The schema represents the collection list retrieved from the Amazon RDS server. This dialog displays a list of schemas in treeview and their corresponding values.

Treeview schema

  1. Now, the data design view page with the selected table schema opens. Drag and drop the table.

    Query designer

    You can use the Code View options for passing query to display data.

    Codeview mode

  2. Click Save to save the data source with a relevant name.

Extract mode connection

In this connection type, a data source is fetched from source periodically. Choose the Extract mode option for this connection.

Extract Connection

Refresh Settings

Steps to configure the data source refresh settings:

  1. Click Refresh Settings in the configuration panel.

    Refresh Setting

  2. Select the recurrence type, recurrence start and end dates in the Refresh Setting dialog box.

    • Data refresh can be scheduled hourly, daily, weekly, and monthly.
    • Application Time Zone is displayed below the date picker. Start time of the schedule is converted to the client Time Zone and shown in the right side for users convenience. After selecting, click Schedule.

    Save Schedule

Preview and data import

  1. Click Connect to connect the Amazon RDS server with configured details.

  2. The Extract Data dialog opens. This dialog has two modes of connection either via Table or Custom query.

    • Under custom query option, write the required query and click Connect.
    • Under the Table option, This dialog displays list of tables and views in treeview. Select the required table(s) or view(s) from treeview to use in the designer. The option is available for configuring incremental refresh column (The table must have a primary key column and date column to configure this option) for the selected items in the right side panel. If you configured it, then the data source will work on Incremental update, otherwise works on Full load concept. And finally click Connect.

    Preview

  3. Now, the data design view page with the selected table schema opens. Drag and drop the table.

    Query Editor

    You can use the Code View options for passing query to display data.

    Codeview mode

  4. Click Save to save the data source with a relevant name.

NOTE: In future, you can edit the connection information for both Live and Extract mode connections using the Edit Connection option.

Connecting Bold BI to Amazon RDS Data Source via REST API

Prerequisites

Type while creating the data source needs to be one of the following

* amazonrdsmysql
* amazonrdsmariadb
* amazonrdsamazonauroramysql
* amazonrdsamazonaurorapostgresql
* amazonrdspostgresql
* amazonrdssqlserver
* amazonrdsoracle

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 Amazon RDS
InstanceName

optional 		`string`

InstanceName or service name of the connection. Required for the oracle database engine.
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
IsEnableSSL

optional 		`string`

Enable or disable SSL. Applicable only for the sqlserver database engine.
IsSshConnection

optional 		`boolean`

Enable or disable SSH. By default, it is false.
SshServerName

optional 		`string`

Enter a valid Ssh Server name. By default, it is empty.
SshPort

optional 		`integer`

Enter a valid Ssh Port number.
SshUserName

optional 		`string`

Enter a valid Ssh Username. By default, it is empty.
SshPassword

optional 		`string`

Enter a valid Ssh Password. By default, it is empty.
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",
"IsEnableSSL": "string",
"IsSshConnection": "false",
"SshServerName": "string",
"SshPort": 0,
"SshUsername": "string",
"SshPassword": "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",
"IsEnableSSL": "string",
"IsSshConnection": "false",
"SshServerName": "string",
"SshPort": 0,
"SshUsername": "string",
"SshPassword": "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",
"IsEnableSSL": "string",
"IsSshConnection": "false",
"SshServerName": "string",
"SshPort": 0,
"SshUsername": "string",
"SshPassword": "string",
"Expressions" : [{
"Name": "Expression1",
"Expression" : "SUM(numeric expression)"
    },
    {
"Name": "Expression2",
"Expression" :  "UPPER(string expression)"
}]
}
]

Data Transformation

Editing a Data Connection

Dashboard Designer Walkthrough

Amazon RDS Integration

Previous
Next