This document goes over the process required to create an API connection to Data Hub. This process will flow from initializing the API connection to creating a job in the ETL tool that transfers that API data into a database table/data source, to adding a chart connecting to that data source.
Table of Contents
There are two machines that need to be configured to share data between Data Hubs. The machine that you want to share data with will be referred to as the Local installation. The machine you want to share data from will be the Remote Installation.
Begin by logging into the Local iDashboards Data Hub and select the API Accounts option from the System Drop Down menu.
You will now see a new screen that shows you the API Accounts options as well as any existing API connections you might have already configured. Click the Add Account button.
Now select the iDashboards Data Hub option and click Log in.
It will then bring up the Add Account window.
Open a separate Internet browser window and connect to the Remote Data Hub.
Select the Connected Apps option from the System Drop Down menu, click on Add a Connected App.
On the Add Connected App window, specify an App Name, paste the Redirect URL from the local Data Hub and click Add.
Copy the Client ID and Client Secret from the next window’s Tokens tab and paste them into the Client ID and Client Secret boxes in the Add Account window on the Local Data Hub and click Next.
It will then ask you to Enter the URL of the Remote Data Hub. If you would like to use a self-signed or untrusted certificate, enable that option under the Advanced button.
Once you click Log In, it will bring up another windows asking to Allow Access from iDashboards Administrator.
After clicking Allow, it will ask you to log in to iDashboards.
You will now see the newly created Data Hub option avialable in the API Account window window.
You have completed adding your Data Hub API connection. From here you are now ready to proceed to creating a new data set. First, on the Remote Data Hub, create a new Data Set, and when saving it, enable the “Share this data set” checkbox.
On the local Data Hub installation, click on the New Data Set option.
Select Cloud API and choose the iDashboards Data Hub option.
The next window will show you the available Data Sets, and the columns when you select it.
Then, click Save. In the new window, you can confirm your data.
Click Save and give the new data set a name and save it to an available Data Sets folder. Click Save again.
Creating a new ETL job
Select New ETL job to add the data from the data Set into a database table. Drag an “E” task from the left onto the canvas. Hover over the “Extract Data” task and click on the gear icon. Select your Data Set and click Open.
You will then see the Extract Data window, click save.
Add a Load operation and link the Extract to the Load. Then configure the Load operation to save the data to a table in your database.
Click Create a Target Table from Input. Select a Data Store, then a Schema:
Give the Table a name and click Create:
Verify your details in the next window and click Save.
Click Save or Save As.
Once the job has been run to create the table and it has added the data to the data store target table you selected, you now have an available data source that contains your Data Hub data and you are ready to build a chart from this data in the User application.
Log into the User application and right click on any dashboard and select New Chart, then find the data hub data source you added the table to and select it from the list. Now pick the correct data set table you created in the ETL tool and click Next.
Now, select the columns you want to use in your chart and click Next.
Finally, choose a chart type and click Finish.
You will now see your new chart filled with data from your iDashboards Data Hub API connection in your new chart.