Connecting Bold BI to Azure Synapse Analytics data source

The Bold BI Dashboard Designer supports connecting Azure Synapse Analytics database using SQL Live Query (C# API).

Choose Azure Synapse Analytics data source

To configure the Azure Synapse Analytics data source, follow these steps:

Click Data Sources in the configuration panel to add a new data connection.
Click CREATE NEW to launch a new connection from the connection panel.
Select the Azure Synapse Analytics connection in the connection panel.

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 Azure Synapse Analytics

Create Azure Synapse Analytics data source

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

Enter a name and description (optional) for the data source.
Enter a valid server or host name in the ServerName text box.
Enter a valid username in the UserName text box.
Enter a valid password in the Password text box.
Select a database that you want to query in the listed database associated with the given Azure Synapse Analytics server in the database combo box.

NOTE: Azure Synapse Analytics supports live mode connection only.

Data Preview

Click Connect to connect the Azure Synapse Analytics server with configured details.

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

Treeview schema

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

You can use the Code View option for passing a query to display data.
Click Save to save the data source with a relevant name.

Connecting Bold BI to Azure Synapse Analytics Data Source via REST API

Prerequisites

Type while creating the data source needs to be azuresynapseanalytics.

Rest API - v4.0

Parameters for creating Data Source

Parameters	Details
Servername required	`string` Server name or Host name of the connection
Username required	`string` A valid Username.
Password required	`string` A valid Password.
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.
IsEnableSSL optional	`boolean` Enable or disable SSL. By default, it is false.
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",
"Username": "string",
"Password": "string",
"Database": "string",
"Schemaname": "string",
"Tablename": "string",
"AdvancedSettings": "string",
"IsEnableSSL": false,
"CommandTimeout": "string",
"Expressions" : [{
"Name": "Expression1",
"Expression" : "SUM(numeric expression)"
    },
    {
"Name": "Expression2",
"Expression" :  "UPPER(string expression)"
}]
}

For editing connection:

"Connection":
{
"Servername": "string",
"Username": "string",
"Password": "string",
"Database": "string",
"Schemaname": "string",
"Tablename": "string",
"AdvancedSettings": "string",
"IsEnableSSL": false,
"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",
"Username": "string",
"Password": "string",
"Database": "string",
"Query": "string",
"AdvancedSettings": "string",
"IsEnableSSL": "string",
"CommandTimeout": "string",
"Expressions" : [{
"Name": "Expression1",
"Expression" : "SUM(numeric expression)"
    },
    {
"Name": "Expression2",
"Expression" :  "UPPER(string expression)"
}]
}