Consuming the Dataset from external applications

<< Click to Display Table of Contents >>

Navigation:  Cloud applications > Bizagi Datasets >

Consuming the Dataset from external applications

Overview

When having defined a Dataset for a specific purpose, you may easily look up its service endpoints and access keys to consume its data from an external application, such as a reporting tool.

Bizagi Datasets supports being consumed as an OData feed (through an OData RESTful service) using Basic authentication.

For introductory information on Datasets, refer to Bizagi datasets.

 

Cloud_Datasets_reports

 

This section describes how to use information stored in a Dataset from outside of Bizagi applications.

 

Before you continue

Note that these steps part from the fact that you would already have created a Dataset, already populated with information (either real information or just for testing purposes).

For more information about this step, refer to Creating a dataset.

 

What you need to do

In order to have your external application integrate a Bizagi Dataset as a source of data, these steps need to be carried out:

 

1.Obtain the service endpoint and its access keys to use the connector.

2.Configure the connection in your external application.

 

Example

For this example, we have created a Dataset with the columns definition as given by a csv sample downloadable at http://samplecsvs.s3.amazonaws.com/SalesJan2009.csv (from this Insurance service company's site: https://support.spatialkey.com/spatialkey-sample-csv-data/).

This Dataset contains as well populated data as available in that same csv file.

 

Cloud_BizagiDataset7

 

You may for instance check out that this sample .csv file has the following information:

 

Cloud_BizagiDataset10

 

And we will be using Power BI to create a report based on this data:

 

Cloud_Dataset_extt_tease

 

Procedure

Once you have the Dataset ready, follow these steps:

 

1. Obtain the service endpoint and its access keys to use the connector.

Go into the Dataset's given environment (for instance, Development), and into the Security & Connectivity tab.

 

Cloud_Datasets10alt

 

 

In order to prepare yourself for next steps regarding configuration at your external tool, ensure you copy the service endpoint and access keys.

You may rely on the Copy Key button to have at hand:

ODATA URL (the service endpoint that exposes data to be consumed by external applications):

 

Cloud_Datasets_ODataURL

 

Access key 1 (username) and Access key 2 (password):

 

Cloud_Datasets_keys

 

note_pin

DO NOT use the Generate New Keys option unless you are completely certain of wanting to generate new access keys and eliminating previous ones.

Note that once you eliminate previous ones, you will not be able to look them up,nor use them again, which entails that any connector's configuration or application already using the previous pair of keys would no longer be able to connect to the service endpoint.

 

2. Configure the connection in your external application.

Open the application of your choice and configure connection to an OData source.

While using Power BI, locate the Get data option and select OData feed:

 

Cloud_Dataset_ext3

 

Notice that for the URL field, you are supposed to paste the previously copied OData URL from the Dataset's connectivity information.

Click Ok and in the next screen, enter the username and password (for Basic authentication), as also previously copied at the connectivity information (Access key 1 and Access key 2 respectively).

 

You may leave the default root for the service endpoint and click Connect:

 

Cloud_Dataset_ext4

 

In the next screen you may preview the values that will be imported as data.

Ensure you tick the values checkbox and click Load:

 

Cloud_Dataset_ext5

 

Once data finishes up loading (may take up a minute or two depending on the volume of information), you may start using Power BI's features to build your chart and reports:

 

Cloud_Dataset_ext0

 

And that's it.

At this point, you have configured an external application such as Power BI, to generate graphic reports on data incoming from the Dataset.

Similarly, you may carry out the same procedure for other Microsoft applications such as Excel:

 

Cloud_Dataset_ext1

 

Notice with Excel you may view and filter data or include charts:

 

Cloud_Dataset_ext2