Documentation

Search results

Connecting Bold BI to Azure Synapse Analytics data source

The Bold BI Dashboard Designer supports connecting to an 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 on Data Sources in the configuration panel to add a new data connection.
Click on 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 on the Data Sources menu from the left menu panel and selecting 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 from the listed databases associated with the Azure Synapse Analytics server in the database combo box.

NOTE: Azure Synapse Analytics supports live mode connection only.

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.

Data Preview

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

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

Treeview schema

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

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

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

Custom

Dashboard Parameter

Dashboard Parameter

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

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

NOTE: The ability to provide join support is available only during the creation of a new data source. Join in edit connection mode is not supported.

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
JoinType Required For Join Info	`string` Enter a valid JoinType For Example (Inner,Outer)
LeftTable Required For Join Info	`string` Enter a valid Left Table name
RightTable Required For Join Info	`string` Enter a valid Right Table name
LeftField Required For Join Info	`string` Enter a valid Left Table Column Name
RightField Required For Join Info	`string` Enter a valid Right Table Column Name
Condition Required For Join Info	`string` Enter a valid Condition For Example (AND,OR)
LeftField Required For Join Info	`string` Enter a valid Left Table Column Name
Operator Required For Join Info	`string` Enter a Valid Operator For Example (=,>=)
Value Optional For only Join Info	`string` Specifically choose the column values.
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 edit the connection while upload the dashboard via API

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
Schema required for table mode	`string` Enter a valid Schemaname
AdvancedSettings optional	`string` Additional optional connection parameters can be provided. By default, it is empty.
IntegratedSecurity optional	`string` This is used to specify Authentication mechanism. Needed to provide true for Windows Authentication, false for Basic Authentication. default value is false
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

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: To edit the 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

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

"Connection":
{
"Servername": "string",
"Port": "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",
"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 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",
"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)"
}]
}

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

"Connection":  { 
 "DataSource": "string",
 "InitialCatalog": "string",
 "UserName": "string",
 "Password": "string",
 "IntegratedSecurity": "string",
 "AdvancedSettings": "string",
 "CommandTimeout": "string",
 "Schema": "string"
 }