Build Linear-Connected Web Apps in Servoy

Servoy is a rapid application development and deployment platform. When paired with the CData JDBC Driver for Linear, users can build Linear-connected apps that work with live Linear data. This article describes how to connect to Linear from Servoy and build a simple web app to display and search Linear data.

With built-in optimized data processing, the CData JDBC Driver offers unmatched performance for interacting with live Linear data. When you issue complex SQL queries to Linear, the driver pushes supported SQL operations, like filters and aggregations, directly to Linear and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations). Its built-in dynamic metadata querying lets you work with Linear data using native data types.

Connect to Linear in Servoy Developer

To build Linear-connected apps, you need to first create a data provider in Servoy Developer using the CData JDBC Driver for Linear.

1. Install the JDBC Driver.
2. Copy the JDBC Driver JAR file. (cdata.jdbc.linear.jar) to the /application_server/drivers/ directory in the installation directory for Servoy.
3. Open Servoy Developer.
4. In the Solution Explorer, right-click Database Server (under Resources) and choose "Connect to existing database" -> "empty."
   1. Name the server.
   2. Click to show the advanced server settings.

      • Set the URL, for example: jdbc:linear:AuthScheme=APIKey;APIKey=myAPIKey;

        Built-In Connection String Designer

        For assistance in constructing the JDBC URL, use the connection string designer built into the Linear JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

        
        				java -jar cdata.jdbc.linear.jar
        				

        Fill in the connection properties and copy the connection string to the clipboard.

        You can authenticate to Linear with a personal API key or with OAuth 2.0. The API key is the simplest option for connecting with your own Linear account.

        Authenticating with an API Key

        Set the following connection properties:

        • AuthScheme: Set this to APIKey.
        • APIKey: A Linear personal API key.

        To create a personal API key, log in to Linear, open Settings > Security & access > Personal API keys, select New API key, and create it. Copy the key immediately, because Linear shows it only once.

        Authenticating with OAuth

        OAuth requires a custom OAuth application registered in Linear (Settings > API > OAuth applications), which provides the OAuthClientId and OAuthClientSecret. Two flows are supported:

        • Authorization code: Set AuthScheme to OAuth, InitiateOAuth to GETANDREFRESH, and provide OAuthClientId, OAuthClientSecret, and the CallbackURL defined in your application (e.g., http://localhost:33333). The driver opens Linear in your browser so you can grant access.
        • Client credentials: Set AuthScheme to OAuthClient and provide OAuthClientId and OAuthClientSecret. This authenticates the application itself, with no browser interaction, and suits machine-to-machine integrations.

        By default, the driver requests the read,write scopes. The driver refreshes the access token automatically when it expires.

        
      • Select the Driver class you just copied, for example, cdata.jdbc.linear.LinearDriver
   

Build a Linear-Connected Web App

Once you have configured the connection to Linear in the Servoy Developer resources, you are ready to build apps with access to live Linear data.

Create a New Solution

1. In the Server Explorer, right-click "All solutions" and select "Create new solution."
2. Name the solution.
3. Select the checkbox to include the "search" module.
4. Click "Finish."

Create a New Form

Right-click "Forms" and select "Create new form."

1. Name the form.
2. Select a Datasource.
3. Set the type (e.g., Simple) and click "Finish."

Add a Data Grid to the Form

1. Drag a Data Grid component (from Servoy NG-Grids) onto the form.

2. Drag a column component onto the Data Grid and set the "dataprovider" property for each column component to a column from the Linear "table" (e.g., id from the Team table).

   Continue adding columns as desired.

Add Searching to the App

Note that the "svySearch" extension is required to add search functionality (included by default when you create a new solution). If you did not add the extension when you created the solution or you are modifying an existing solution, you can add the search module by right-clicking Modules (in the solution) and selecting "Add Module." Select "svySearch" and click "OK."

1. Drag a Text Field component onto the Form.
2. Right-click the Form and select "Open in Script Editor."
3. Create a new variable (JavaScript) to hold the search value:

   var searchText = '';
   

4. Back on the Form, in the Text Field properties:
   1. Set the "dataprovider" property to the Form variable you just created.
   2. Double-click to add a method for the onAction event.
   3. Click to create the method in "Form," name the method (e.g., onEnter), and click "Create private."
   4. Click "OK & Show."
5. Add the following JavaScript to the JavaScript file to use the Servoy framework to implement searching bound data based on the text in the Text Field:

   var search = scopes.svySearch.createSimpleSearch(foundset).setSearchText(searchText);
   search.setSearchAllColumns();
   search.loadRecords(foundset);
   

Save and Launch the App

Save the form and JavaScript file, then click Run -> Launch NGClient to start the web app.

Download a free, 30-day trial of the CData JDBC Driver for Linear and start building Linear-connected apps with Servoy. Reach out to our Support Team if you have any questions.