VOOZH about

URL: https://www.cdata.com/kb/tech/bitbucket-jdbc-mendix.rst

⇱ Build Apps with Live Bitbucket Data Using the Low-Code Development Platform of Mendix

Build Apps with Live Bitbucket Data Using the Low-Code Development Platform of Mendix

👁 Dibyendu Datta
Dibyendu Datta
Lead Technology Evangelist
Connect Bitbucket data with Mendix to build apps using the CData JDBC Driver for Bitbucket.

Mendix, developed by Siemens, is a low-code platform used to rapidly develop, test, and deploy web and mobile applications, facilitating digital transformation and enhancing business agility. When paired with the CData JDBC Driver for Bitbucket, you can use your Bitbucket data to create various applications using Mendix Studio Pro.

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

This article shows how you can easily create an application that utilizes Bitbucket data in Mendix by combining the JDBC interface provided by Mendix with the CData JDBC Driver for Bitbucket.

Preparing the Mendix environment

In this section, we will explore how to develop an app using Mendix Studio Pro, as previously introduced, with Bitbucket data. Be sure to install Mendix Studio Pro beforehand.

Install the CData JDBC Driver for Bitbucket

First, install the CData JDBC Driver for Bitbucket on the same machine as Mendix. The JDBC Driver will be installed in the following path:

C:\Program Files\CData\CData JDBC Driver for Bitbucket 20xx\lib\cdata.jdbc.bitbucket.jar

Create an application

Now let's start creating the app. First, let's make an app that has the Database Connector available.

  1. Launch Mendix Studio Pro and click 'Create New App.' 👁 Create a new app
  2. Select the 'Blank Web App' option. 👁 Select the Blank Web App option
  3. Click 'Use this starting point' to proceed. 👁 Use this starting point
  4. Create an app with a name of your choice. Also, note down the "Disk location" information, for future reference. 👁 Name the app and note the disk location information
  5. You have now created a brand-new app. 👁 The app is now created

Add the Database Connector to your application

Next, add the Database Connector module to the app you just created.

  1. On the top right, click on the Marketplace button.
  2. Search for Database Connector in the Marketplace search section and select it. 👁 Search for the Database Connector from the marketplace
  3. Click on Download to download the latest Database Connector. 👁 Download the latest Database Connector
  4. In the Import Module window, select the Action as Add as a new module. 👁 Add a new module
    👁 Module is successfully imported
  5. If the Database Connector appears on the app screen, you are good to move on to the next steps. 👁 Database connector is ready to be used

Adding the JDBC Driver to Mendix Studio Pro

To use the CData JDBC driver with this Database Connector, you must add the JDBC Driver JAR file to your project.

  1. In the Mendix project folder you noted earlier, there is a folder named 'userlib.' Place the two files, 'cdata.jdbc.bitbucket.jar' and 'cdata.jdbc.bitbucket.lic,' into that folder. 👁 Place the JAR and LIC files in the userlib folder of Mendix
  2. You can now use the CData JDBC Driver with the Database Connector.

Create a Data Model

Now, let's create an app. We first need to define a data model to load data from the Database Connector and display it on the list screen. Let's create the data model before loading the data.

  1. Add an Entity to the 'Domain model' of MyFirstModule. 👁 Add an entity
  2. Enter the entity name and field definitions. 👁 Add the entity name and field definitions
  3. You can easily configure the data by checking the table definition information through the CData JDBC driver using a tool such as DBeaver. 👁 Check and configure the data using any database administration tool
  4. Define the entities. 👁 Define the entities

Create a constant for the JDBC URL

Next, create a JDBC URL constant to use with the Database Connector.

  1. Add 'Constant' to MyFirstModule. 👁 Add a constant
  2. Add a name to the Constant in the Add Constant window. 👁 Add a name to the constant

  3. Generate a JDBC URL for connecting to Bitbucket, beginning with jdbc:bitbucket: followed by a series of semicolon-separated connection string properties.

    For most queries, you must set the Workspace. The only exception to this is the Workspaces table, which does not require this property to be set, as querying it provides a list of workspace slugs that can be used to set Workspace. To query this table, you must set Schema to 'Information' and execute the query SELECT * FROM Workspaces>.

    Setting Schema to 'Information' displays general information. To connect to Bitbucket, set these parameters:

    • Schema: To show general information about a workspace, such as its users, repositories, and projects, set this to Information. Otherwise, set this to the schema of the repository or project you are querying. To get a full set of available schemas, query the sys_schemas table.
    • Workspace: Required if you are not querying the Workspaces table. This property is not required for querying the Workspaces table, as that query only returns a list of workspace slugs that can be used to set Workspace.

    Authenticating to Bitbucket

    Bitbucket supports OAuth authentication only. To enable this authentication from all OAuth flows, you must create a custom OAuth application, and set AuthScheme to OAuth.

    Be sure to review the Help documentation for the required connection properties for you specific authentication needs (desktop applications, web applications, and headless machines).

    Creating a custom OAuth application

    From your Bitbucket account:

    1. Go to Settings (the gear icon) and select Workspace Settings.
    2. In the Apps and Features section, select OAuth Consumers.
    3. Click Add Consumer.
    4. Enter a name and description for your custom application.
    5. Set the callback URL:
      • For desktop applications and headless machines, use http://localhost:33333 or another port number of your choice. The URI you set here becomes the CallbackURL property.
      • For web applications, set the callback URL to a trusted redirect URL. This URL is the web location the user returns to with the token that verifies that your application has been granted access.
    6. If you plan to use client credentials to authenticate, you must select This is a private consumer. In the driver, you must set AuthScheme to client.
    7. Select which permissions to give your OAuth application. These determine what data you can read and write with it.
    8. To save the new custom application, click Save.
    9. After the application has been saved, you can select it to view its settings. The application's Key and Secret are displayed. Record these for future use. You will use the Key to set the OAuthClientId and the Secret to set the OAuthClientSecret.

    Built-in Connection String Designer

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

    java -jar cdata.jdbc.bitbucket.jar

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

    👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)

    A typical JDBC URL is below:

    jdbc:bitbucket:Workspace=myworkspaceslug;Schema=Information;InitiateOAuth=GETANDREFRESH;
  4. Specify the connection string copied from the previous step in the Default value section and click on OK. 👁 Provide the connection string

Create a microflow to retrieve Bitbucket data

Let's create a microflow that retrieves data from the Database Connector based on the entity we created.

  1. Click 'Add microflow' from MyFirstModule. 👁 Click on Add microflow
  2. Create a microflow with any name. 👁 Create a microflow
  3. First, create an object for the entity you defined earlier. Then, add the 'Create Object' action to the microflow. 👁 Create an object
  4. Click on the 'Select' button for Entity in the Create Object window. 👁 Click on Select in create object window
  5. Select a previously defined Entity. 👁 Select the defined entity
  6. Enter an arbitrary Object name and click OK. 👁 Enter an object name
  7. Next, add an Execute Query action to the microflow to retrieve data from the Database Connector. 👁 Add an execute query action
  8. Define each input in the Execute Query window. 👁 Define each inputs for execute query
  9. In "jdbc url", specify the constant you defined beforehand. 👁 Specify the constant defined before
  10. In SQL, write a query to retrieve data from Bitbucket. 👁 Write a query to retrieve the data
  11. You don't need a Username or Password this time, so set them to 'empty' and assign the object created in the previous flow as the Result object. Then, simply specify any name you prefer for the List in the List Name section. 👁 Add any name to the list
  12. Finally, define the output of the microflow. 👁 Define the output of the microflow
  13. Double-click the End Event to open it, select 'List' from the Type dropdown, and link it to the Entity you defined earlier. Then, set the output result of Execute Query as the Return value. 👁 Link list to the entity
  14. This completes the microflow that retrieves data from Bitbucket. 👁 Microflow creation is complete

Create a list screen and link it to a microflow

Finally, let's create a screen that displays the results obtained from the microflow.

  1. Double-click 'Home_web' inside the Toolbox menu to open it. 👁 Open Home_web from toolbox menu
  2. Drag and drop a Data grid template from the Data containers section into the list screen. 👁 Drag and drop data grid template into the list screen
  3. Once you have placed the Data grid, double-click on it to display the Edit Data Grid settings screen. 👁 Open edit data grid to configure it
  4. Navigate to the Data source tab and link the data source type with the Microflow.
  5. Select the microflow you just created. 👁 Select the microflow
  6. Now click OK. 👁 Approve the microflow configuration
  7. When you click OK, you'll be prompted to auto-detect columns. Simply click 'Yes' to proceed. 👁 Click Yes for auto-detect columns
  8. Next, you'll be prompted to generate controllers for various Data grids. Since we won't be configuring the logic for each one this time, click 'No.' 👁 Click No to controllers for data grids
  9. This will create a simple data grid screen as shown below. 👁 Data grid screen is now created and ready to be used

Try it out

Now let's check if it works properly.

  1. Click the 'Publish' button to prepare the app you created. Once that's done, click 'View App' to open the app. 👁 Publish the app created
  2. If you see a list of Bitbucket data like the one below, you're all set! You've successfully created a Bitbucket-linked app with low code, without needing to worry about Bitbucket's API. 👁 See the list of Bitbucket data on the Mendix app screen

Get Started Today

Download a free 30-day trial of the CData JDBC Driver for Bitbucket with Mendix, and effortlessly create an app that connects to Bitbucket data.

Reach out to our Support Team if you have any questions.