Connecting Bold BI to Origami data source

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

Note: Origami data source is available in On-Premises Deployment, but not in the Syncfusion Managed Cloud Server.

Choose Origami data source

To configure the Origami 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 Origami 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

Create Origami data source

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

Enter a name and description (optional) for the data source.
Enter a valid Origami REST API endpoint in the URL textbox. Refer to the Origami API documentation for more details.

Example: https://<:Account_Name>.origami.ms/entities/api/instance_data/format/json?
Select POST method for the REST API in the Method combo box.
Choose a valid Username ,Password and Entity_data_name in parameters.
In Max Rows, enter the maximum number of rows to be fetched from the Origami data source. This value is used to fetch the data from the Origami data source via pagination.
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 JSON data type in the Data Format combo box.
Choose None under the Authentication Type as authentication is done through the header.

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

How do I get Entity_data_name for connecting Origami Data source?

Login to the Origami account.
Go to Settings -> Developers -> Entity test.

Additional information

Max Rows	Most REST APIs return only a limited amount of data on a single API request. To retrieve the necessary amount of data, you can set a value in this field. Pagination is handled internally and will fetch the required data.
Refresh Settings	The period of time before the next refresh call is triggered. This will automatically trigger a call to 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 URL

Login to the Origami account. Once you log in to the account, an ACCOUNT NAME will be created on the URL.
Replace the account name in the <:ACCOUNT NAME> on the URL.

Sample queries

Fetch instance structure

https://zync.origami.ms/entities/api/entity_structure/format/json?

Create instance with regular groups

https://zync.origami.ms/entities/api/create_instance/format/json?

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 Origami Rest API request. This dialog displays a list of schemas in a treeview and its corresponding values in a grid for preview. Select required schema(s) from a 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