Connecting Bold BI to Amazon RDS data source

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

Choose Amazon RDS data source

To choose an Amazon RDS data source, follow these steps:

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

   

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

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

   

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

Connect to Amazon RDS

Create Amazon RDS data source

After clicking on a data source, the NEW DATA SOURCE configuration panel opens. Follow the given steps to create an 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 username 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 it from the combo box.

   

Connect using custom attribute and dashboard parameter

We have added support for custom attributes and dashboard parameters to the data source connection. You can connect to the data source using custom attributes or dashboard parameters.

Custom Attribute

Dashboard Parameter

Note: Refer to the Dashboard Parameter Documentation and Custom Attributes Documentation for more details.

Amazon RDS supported database engine in Bold bi

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

Database Engine

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 the source. Choose the Live mode option for this connection.

Data Preview

1. Click Connect to connect to 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.

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

   

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

   

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

Extract mode connection

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

Refresh Settings

Steps to configure the data source refresh settings:

1. Click on Refresh Settings in the configuration panel.

   

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.
   • The Application Time Zone is displayed below the date picker. The start time of the schedule is converted to the client Time Zone and shown on the right side for users’ convenience. After selecting, click Schedule.

   

Preview and data import

1. Click Connect to connect to 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 Table option, the 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.

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

   

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

   

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

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

Connect using custom attribute and dashboard parameter

We have added support for custom attributes and dashboard parameters to the data source connection. You can connect to the data source using custom attributes or dashboard parameters.

Custom Attribute

Dashboard Parameter

Note: Refer to the Dashboard Parameter Documentation and Custom Attributes Documentation for more details.

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

Only the live mode data source can be created and edited through the REST API.

Parameters for creating Data Source

NOTE: Join support can only be provided during the creation of a new data source. Join in edit connection mode is not supported.

Parameters for edit the connection while upload the dashboard via API

Parameters for adding expressions when creating Data Source

Parameters for editing Data Source

NOTE: When editing a Data Source via API, all parameters are optional. Only the parameter that needs to be changed should be provided.

Parameters for modifying expressions when editing Data Source

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 creating connection with multiple tables :

"Connection":
{
"Servername": "string",
"Port": "string",
"InstanceName": "string",
"Username": "string",
"Password": "string",
"Database": "string",
"Tables": [
            {
                "Tablename": "string",
                "Schemaname": "string"
            },
            {
                "Tablename": "string",
                "Schemaname": "string"
            }
        ],
"JoinInfo": [
            {
                "JoinType": "string",
                "LeftTable": "string",
                "RightTable": "string",
                "JoinFieldInfos": [
                    {
                        "Condition": "string",
                        "LeftField": "string",
                        "Operator": "string",
                        "RightField": "string",
                        "Value": "string"
                    },
                    {
                        "Condition": "string",
                        "LeftField": "string",
                        "Operator": "string",
                        "RightField": "string",
                        "Value": "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 the REST API, the data source can be created or edited with only one table. If a different table is provided in editing the data source, the table will be replaced. The widgets will be retained only if the schema is the 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)"
}]
}

Sample connection for editing the connection while uploading the dashboard via API.

"Connection":  {
  "ServerName": "", 
  "Database": "",
  "UserName": "",
  "Password": "",
  "Port": "",
  "SslMode": "",
  "TrustServerCertificate": "",
  "AdvancedSettings": "",
  "CommandTimeout": "" ,
  "Schema": "" 
 } 

Related links

Data Transformation

Editing a Data Connection

Dashboard Designer Walkthrough

Amazon RDS Integration