Search results

Connecting Bold BI to Snowflake data source

The Bold BI dashboard designer supports connecting to Snowflake database through SQL Live query.

Supported Server Editions: Standard, Enterprise and Business Critical

Choose Snowflake data source

To configure the Snowflake data source, follow these steps:

  1. Click on the Data Sources button 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 Snowflake connection in the connection panel.

    Choose data source

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

Choose data source from server

Connect to Snowflake

Create Snowflake data source

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

  1. Enter a name and description (optional) for the data source.
  2. Enter a valid Snowflake server or host name in the Server Name text box.

For example, https://dum421.west-europe.azure.snowflakecomputing.com 3. Enter a valid Snowflake user name in the User Name text box. 4. Enter a valid Snowflake password in the Password text box. 5. Enter a valid Snowflake database name in the Database text box.

Snowflake Connection

There are two connection types in a data source:

  • Live mode
  • Extract mode

Live mode connection

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

Snowflake Live Connection

Data Preview

  1. Click Connect to establish a connection with the Snowflake server using the configured details.

The schema represents the collection of lists retrieved from the Snowflake server. This dialog displays a treeview list of schemas 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

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

Snowflake Connection

NOTE: Initially, data will be extracted based on the maximum number of rows selected in order to proceed with data model creation. The remaining records (with no limit) will be extracted during the next refresh.

Max rows option

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 date, and end date 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’s Time Zone and shown on the right side for users’ convenience. After selecting, click Schedule.

    Save Schedule

Preview and data import

  1. Click Connect to establish a connection with the Snowflake server using the 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, 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. Incremental Update can be performed in both tables and views. The option is available for configuring incremental refresh column for the selected items in the right-side panel. * The table must have a primary key column and date column to configure the incremental refresh option. * Views must have a date column to configure the incremental refresh option, and unique column(s) are optional but can be used to update the modified records.

If you configured it, then the data source will work on Incremental update, otherwise works on Full load concept. And finally click Connect.

Preview

  1. 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

  2. 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.

Connect using custom attribute and dashboard parameter

We have added support for custom attributes and dashboard parameters in the data source connection. You can now 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 Snowflake Data Source via REST API

Prerequisites

Supported Server Editions: Standard, Enterprise and Business Critical

Type while creating the data source needs to be snowflake.

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

NOTE: The ability to provide join support is only available 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
Port

required
string

Port number used to connect to snowflake

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
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.
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
Port

required
string

Port number used to connect to snowflake

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
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.
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 provide the parameter that needs to be changed.

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

For editing connection:

"Connection":
{
"Servername": "string",
"Port": "string",
"Username": "string",
"Password": "string",
"Database": "string",
"Schemaname": "string",
"Tablename": "string",
"AdvancedSettings": "string",
"CommandTimeout": "300",
"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 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",
"Username": "string",
"Password": "string",
"Database": "string",
"Query": "string",
"AdvancedSettings": "string",
"CommandTimeout": "300",
"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": "string",
       "Database": "string",
       "UserName": "string",
       "Password": "string",
       "AdvancedSettings": "string",
       "CommandTimeout": "string",
       "Schema": "string"
  } 

How to filter active warehouse through connection parameters for Snowflake data source

The Bold BI application allows you to filter the warehouse through connection parameters in the Snowflake data source by following these steps.

Steps to connect the snowflake with the active warehouse

  1. Refer to the Connecting Bold BI to Snowflake data source for successfully connecting to it.

  2. For connecting the Snowflake with warehouse connection, you need to add the connection string Warehouse=WarehouseName in the Additional connection parameters textbox along with the existing server details and click Connect.

    Additional COnnection Parameters

In this way, you can filter the warehouse connection by passing parameters in the connection string.

  1. Drag and drop the table from the table schema in the data design view page.

    Table schema

  2. Click Save to save the data source with a relevant name in order to proceed with designing a dashboard.

    Save option

Data Transformation

Editing a Data Connection

Dashboard Designer Walkthrough

Snowflake Integration