Connecting Bold BI to Nutshell data source

The Bold BI dashboard designer supports connecting to the Nutshell web services through the REST API.

Choose Nutshell data source

To configure the Nutshell data source, follow these steps:

Click on the Data Sources button in the configuration panel to add a new data connection.
Click CREATE NEW to launch a new connection from the connection panel.
Select the Nutshell connection in the connection panel.

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

Choose data source from server

Create Nutshell data source

Once you click on the data source, the NEW DATA SOURCE configuration panel will open. Follow these steps to create a Nutshell data source.

Enter a name and description (optional) for the data source.
Choose the Nutshell Method drop-down box and the required endpoint.
Click the Custom Raw Body if you want to enter the Nutshell Method and Params manually. Refer to the Nutshell API documentation for more details.

Example: {"jsonrpc":"2.0","method":"findLeads","params":{<:key>:<:value>},"id":"BoldBI"}
In Max Rows, enter the maximum number of rows to be fetched from the Nutshell data source.
Choose a time interval for the Refresh Settings using the combo box to trigger the Rest API request periodically to keep the data in sync with our dashboard.
Select the JSON data type in the Data Format combo box.
Choose Basic HTTP Authentication in the Authentication Type combo box.
Enter a valid Nutshell Username and API KEY to access the endpoints.

Data source preview

You can also edit the connection information set here using the Edit Connection option.

Additional information

Refresh Settings

The period of time before the next refresh call is triggered. This will automatically trigger a call for the API configured in the data source to keep the data up to date. If you do not want to sync your new data, choose 'Never'.

Setting up the Raw Body

jsonrpc

It specifies the JSON-RPC version. This member is mandatory.

method

Refer to the Nutshell API documentation for details on the methods. This member is mandatory.

params

A Structured value that holds the parameter values to be used during the invocation of the method. This member MAY be omitted.

This membership is mandatory and must contain a String, Number, or NULL value.

Example:

{"jsonrpc":"2.0","method":"findLeads","params":{"query": {}},"id":"BoldBI"}

{"jsonrpc":"2.0","method":"findLeads","params":{"query": {"status": 0}},"id":"BoldBI"}

Sample queries

All Contacts

{"jsonrpc":"2.0","method":"findContacts","params":{},"id":"BoldBI"}

All Accounts

{"jsonrpc":"2.0","method":"findAccounts","params":{},"id":"BoldBI"}

All Leads

{"jsonrpc":"2.0","method":"findLeads","params":{"query": {}},"id":"BoldBI"}

{"jsonrpc":"2.0","method":"findLeads","params":{"query": {"status": 0}},"id":"BoldBI"}

Preview and data import

Click Preview & Connect to connect with the configurations that have been set.
The Choose Schema(s) dialog opens. The schema represents the key fields of JSON data retrieved from the Nutshell Rest API request. This dialog displays a list of schemas in a treeview and their corresponding values in the grid for preview. Select the required schema(s) from the treeview to use in designer and click Connect.
Now, the data design view page with the selected table schema opens. Drag and drop the table.
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 in the data source connection. You can now connect to the data source using custom attributes or dashboard parameters.

Custom Attribute

Custom