This will require Data Admin privileges to setup and Builder for implementation.
iDashboards is able to connect to most Representational State Transfer (REST) API by using a JDBC driver to access and connect to virtually any REST data source. A JDBC driver is a software component enabling a Java application to interact with a database. To connect with individual databases, JDBC (Java Database Connectivity API) requires specific drivers for each database. The JDBC driver gives out the connection to the database and implements the protocol for transferring the query and result between the client and the database. iDashboards implements native protocols and does not require additional software installed on the driver host. In other words, iDashboards provides driver connectivity with the JDBC Data Source via the specified driver. This document explains a step-by-step procedure to create the Data Source with a Premium Data Connector. If you do not have access to the Premium Data
Connectors please contact your Client Success Manager.
CDATA Sync { }REST Integration
CDATA { } REST API
CData JDBC Driver for { }REST Integrations is where we get the documentation on making this connection, however, the Premium Data Connectors are not a straight forward process which is why we make articles like this to help you make the connections more easily. This one requires a few steps, with a few different links to get very specific pieces of information to make this connection within iDashboards. The REST API is part of the Premium Data Connectors if you do not have these please contact your Client Success Manager. REST Integrations are often found in the following formats: HTML, XML, JSON.
CDATA Sync { }REST Integration
JDBC REST Integration
Go to either Data Hub or iDashboards Admin and log in with your iDashboards credentials.
- Click Data Sources
- Then click on New
- You will then fill out the highlighted fields, what has worked for us is shown below:
Data Source Name: CDATA-REST (Internet URL)
Database URL: jdbc:rest:URI="https://YourDataUrlHere.com";
Driver Class: cdata.jdbc.rest.RESTDriver
Optional Driver Properties: Format="XML";DataSource="clinical_study";GenerateSchemaFiles="OnStart";
Schema: REST
Select: Quotation Marks, Quote Table and Column Names, Allow Custom Queries
Data Source Name: CDATA-REST (Local File)
Database URL: jdbc:rest:URI="C:\Users\UserName\Desktop\YourDataFile.xml";
Driver Class: cdata.jdbc.rest.RESTDriver
Optional Driver Properties: Format="XML";XPath="C:\Users\UserName\AppData\Roaming\CData\REST Data Provider\clinical_study";DataSource="clinical_study";GenerateSchemaFiles="OnStart";
Schema: REST
Select: Quotation Marks, Quote Table and Column Names, Allow Custom Queries
**Replace UserName with the local computer UserName and clinical_study with your Data Source name.** - Then Click Save
- Create a New Data Set (if using iDashboards, create a new chart in Builder)
- Select Table/View
- Now Create Your Charts!
If you have any issues with #3 above use the following ON the SERVER:
- Open Command Prompt as Administrator
- Type in: cd C:\Program Files\iDashboardsSRV\ivizgroup\drivers
- Hit Enter
- Type in: java -jar cdata.jdbc.rest.jar
- Hit Enter
- The following window will appear:
- Type in your connection information.
If you need further assistance please look at the following in the CDATA documentation before contacting iDashboards Support.
- Building the JDBC URL
- Connecting REST Data Sources
- System Tables - sys_connections_props
- XPath Information
- Advanced Settings
CDATA Sync { }REST Integration
The sync utility allows for multiple database options for syncing. The below instructions are informational steps not an exact step by step process.
- CDATA Sync for { }REST
- Data Platform (CRM, ERP,
- SQL Database (MS SQL Server, Oracle, MySQL)
- Login to your database server
- You will need a System Administrator Account to perform all of the steps below
- Create a database called REST Integration (or whatever data platform you use)
- We will be using the database name of REST Integration in the rest of the document
- If you choose a different name the remaining instructions will not be accurate
- We will be using the database name of REST Integration in the rest of the document
- Create a Username for the Sync application to use
- This account will be used for the Sync utility to input data into the Database
- Mapping the Username to the database
- Make sure that the Username has permission to login and configure the database
- User permissions
- Grant the db_owner permission for this user to the REST Integration database
- If a lesser permission is granted not all features of the application will be able to be used
Your Data Platform
- Login to your Data Platform
- Document the required information:
- Security Token:
- Username:
- Password:
Configuring the CDATA Sync Utility
- Setting up the Connection Tab
- Authentication Section
- Place your Password in the Password line
- Place your Security Token in the Security Token line
- Place your Username in the User line
- Click Test Connection
- Close the Connected to the server successfully window
- Authentication Section
- Setting up the Database Tab
- Select Database
- Please configure your database information
- The information that will be needed:
- Server Hostname
- Port
- User
- Password
- Database of your SQL server
- Click Test Connection
- Close the Connected to the server successfully window
- Run the synchronization process!
- The information that will be needed:
- Please configure your database information
- Create a New Data Set (if using iDashboards, create a new chart in Builder)
-
- Select Table/View
- Now Create Your Charts!
-
- Select Database
For More Information:
- Creating a Database URL (Connection String)
- iDashboards Admin Manual 10. Managing Data Sources
Disclaimer: iDashboards Technical Support Engineers are not proficient in the Management and Integration of every API that exists as new APIs are being created everyday with each company that wants to provide seamless integration with other software. However, we do our best to help you make these connections because we want to assist you in your success. If you do not see an article for a connection you would like to make please contact iDashboards Support and know that it will take a bit of time to figure out what is necessary for this integration.
If the above is unable to resolve the issue, then please contact iDashboards Support for further assistance.
Comments
0 comments
Please sign in to leave a comment.