This requires Admin or Data Admin privileges for implementation.
Please Note: If you do not have the correct privileges to access Data Hub you will receive the following upon your login attempt. If you get this message and think it is an error please see your organization's iDashboards Administrator for assistance as Support is unable to give you access.
This document outlines 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.
Connecting the Data Hub API
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 Satellite Installation. Begin by logging into the Local iDashboards Data Hub and select API Accounts 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. Click Add Account
Now select iDashboards Data Hub and click Log in
It will then bring up the Add Account window
Open a separate Internet browser window and connect to the Satellite Data Hub
Select Connected Apps from the System drop down menu
Then click on Add a Connected App
On the Add Connected App window, specify an App Name, paste the Redirect URI from the local Data Hub and click Add
From the Tokens tab copy the Client ID and Client Secret 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 Satellite Data Hub. If you would like to use a self-signed or untrusted certificate, enable that option by selecting Advanced
Click Log In, then it will bring up another windows asking to Allow Access from iDashboards Administrator
Click Allow, then it will ask you to log in to iDashboards.
You will now see the newly created Data Hub option available in the API Accounts
Creating a Data Set
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 Satellie 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 New Data Set
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.
Click Save, in the new window, you can confirm your data.
Click Save then name and save it to an available Data Sets folder. Click Save again.
Your new Data Set will now be available in the Data Hub and you can access it under Edit Data Sets.
Creating an ETL job
Select New ETL job to add the data from the data Set into a database table. Drag an Extract (E) task from the left onto the canvas. Hover over the Extract Data task and click on the gear icon, alternatively you can double click on it. Select your Data Set and click Open.
You will then see the Extract Data window, click Save.
Add a Load (L) task and link the Extract to the Load. Then configure the Load save the data to a table in your database. Click Create a Target Table from Input. Select a Data Store, then a Schema.
Name the table and click Create.
Verify your details in the next window and click Save.
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.
Creating a Chart
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.
choose a chart type
Edit/Insert Chart Properties and click Save. You will now see your new chart filled with data from your Data Hub API connection in your new chart.
For More Information:
- iDashboards Data Hub Manual 8. Extract, Transform and Load
If the above is unable to resolve the issue, then please contact iDashboards Support for further assistance.