The Telerik Platform product is retired.Learn more

Getting Started with Relational Data Connectors

Getting Started with Relational Data Connectors

Using the Telerik Platform Data Connectors feature you can expose a subset of the data in an existing relational database and then consume it in a mobile or desktop application without needing to build your own web service or storing data in the cloud.

This article explains how to connect to any of the supported SQL database servers.

Steps at a glance:


Before you continue with the steps in this guide, ensure that you have the following:

The Data Link Server is a Java Spring application that builds a RESTful service layer over your database. It enables you to access your data through a Backend Services RESTful API. You need to install it on a machine within your own infrastructure in a way that allows it to access your SQL database.

  1. Log in to the Telerik Platform portal.
  2. Click your app.
  3. Navigate to Data > Data Connectors.
  4. Under the Setup a Data Connector... label click the type of the database server that you would like to connect to.
  5. Enter a name for the Data Connector. For example, MyDatabaseServer.
  6. Click the Download Data Link Server button to download the Data Link Server Installation Package.
  7. Log in to the machine that will host the Data Link Server and install the Data Link Server package.

    The full installation procedure for Linux machines is explained in Setting Up Data Link Server on a Linux Machine.

    The full installation procedure for Microsoft Windows machines is explained in Setting Up Data Link Server on a Microsoft Windows Machine.

  8. After you complete the installation of the Data Link Server, return to the Telerik Platform portal in your web browser.

  9. Click Download Authentication key to download a plain text file named after the App ID of your Telerik Platform app.
  10. Copy the file to the keys folder in the folder where the Data Link Server application is located.
  11. Test your installation. Open a web browser and type the the following address—http(s)://datalinkserver:9090 where datalinkserver is the fully qualified domain name (FQDN) or the IP address of the machine where you installed the Data Link Server.

    Receiving an OK response means that the Data Link Server is properly set.

Set Up the Data Connector

  1. After installing the authentication key for the Data Link Server, go back to the Telerik Platform portal.
  2. Fill in the required information in the Connect your Data Link Server to Telerik Backend Services section. You can find detailed descriptions of the fields in Creating an SQL Data Connector Using the Portal.
  3. When you are ready, click the Test button to give your connection a try. You will see a notification with the status of the connection.
  4. If you get a connection error, verify the following on your side:
    • that the FQDN or IP address and the port number of the Data Link Server are accessible outside of your network (for example your firewall is not blocking them) so that the Telerik Platform server can access it
    • that the connection data you entered is correct
  5. Click the Save button to save the Data Connector.

    Configure a data connector image

Create a Content Type from a Data Connector

After you successfully set up a Data Connector you can start connecting data from your SQL database to your application.

You create a RESTful endpoint on top of a database table or view which you can access using an HTTP request or the Backend Services client SDKs. A content type created from a database table supports full CRUD operations. One that you create from a view, however, is read-only.

  1. Log in to the Telerik Platform portal.
  2. Click your app.
  3. Navigate to Data > Types.
  4. Click the Create Type from a Data Connector button.
  5. On the screen that appears, select the table and columns from your database that you would like to connect to the cloud. You can also create content types from database views. More details are available in Creating an SQL Data Connectors Content Type Using the Portal.
  6. When you are ready, click Save. You will see a data browser screen populated with the data from the SQL table you selected. You can use this screen to add, edit, or delete database records.

    Create a Content Type screen

You are now ready to connect the data to your client application using the various Backend Services client SDKs.

Test the RESTful Endpoint

With your Telerik Platform App ID and the content type name at hand, you have a unique endpoint at your disposal that exposes all CRUD operations with the content type. You can access it using this URL:

Replace Products with the name that you gave to the content type.

Test it in your browser or using your favorite tool for making HTTP requests.

Next Steps

See Also

Contact us: +1-888-365-2779
Copyright © 2016-2018, Progress Software Corporation and/or its subsidiaries or affiliates. All rights reserved.