Build Google Cloud Storage-Connected Web Apps in Servoy

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

With built-in optimized data processing, the CData JDBC Driver offers unmatched performance for interacting with live Google Cloud Storage data. When you issue complex SQL queries to Google Cloud Storage, the driver pushes supported SQL operations, like filters and aggregations, directly to Google Cloud Storage 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 Google Cloud Storage data using native data types.

Connect to Google Cloud Storage in Servoy Developer

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

1. Install the JDBC Driver.
2. Copy the JDBC Driver JAR file. (cdata.jdbc.googlecloudstorage.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:googlecloudstorage:ProjectId='project1';InitiateOAuth=GETANDREFRESH

        Built-In Connection String Designer

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

        java -jar cdata.jdbc.googlecloudstorage.jar

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

        Authenticate with a User Account

        You can connect without setting any connection properties for your user credentials. After setting InitiateOAuth to GETANDREFRESH, you are ready to connect.

        When you connect, the Google Cloud Storage OAuth endpoint opens in your default browser. Log in and grant permissions, then the OAuth process completes

        Authenticate with a Service Account

        Service accounts have silent authentication, without user authentication in the browser. You can also use a service account to delegate enterprise-wide access scopes.

        You need to create an OAuth application in this flow. See the Help documentation for more information. After setting the following connection properties, you are ready to connect:

        • InitiateOAuth: Set this to GETANDREFRESH.
        • OAuthJWTCertType: Set this to "PFXFILE".
        • OAuthJWTCert: Set this to the path to the .p12 file you generated.
        • OAuthJWTCertPassword: Set this to the password of the .p12 file.
        • OAuthJWTCertSubject: Set this to "*" to pick the first certificate in the certificate store.
        • OAuthJWTIssuer: In the service accounts section, click Manage Service Accounts and set this field to the email address displayed in the service account Id field.
        • OAuthJWTSubject: Set this to your enterprise Id if your subject type is set to "enterprise" or your app user Id if your subject type is set to "user".
        • ProjectId: Set this to the Id of the project you want to connect to.

        The OAuth flow for a service account then completes.

      • Select the Driver class you just copied, for example, cdata.jdbc.googlecloudstorage.GoogleCloudStorageDriver

Build a Google Cloud Storage-Connected Web App

Once you have configured the connection to Google Cloud Storage in the Servoy Developer resources, you are ready to build apps with access to live Google Cloud Storage 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 Google Cloud Storage "table" (e.g., Name from the Buckets 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 Google Cloud Storage and start building Google Cloud Storage-connected apps with Servoy. Reach out to our Support Team if you have any questions.