Create Bitbucket-Connected Applications in Appsmith

Appsmith is an open-source internal tool builder that allows teams to quickly and easily build a UI to help improve their business operations. When combined with CData Connect AI, you gain immediate access to Bitbucket data for business applications. This article outlines the process of connecting to Bitbucket using Connect AI and creating a basic application from Bitbucket data within Appsmith.

CData Connect AI offers a pure SQL Server, cloud-to-cloud interface for Bitbucket, enabling the creation of business applications directly from live Bitbucket data within Appsmith, all without the need for data replication to a native database. As you build applications, Appsmith generates SQL queries to gather data. With its inherent optimized data processing capabilities, CData Connect AI efficiently channels all supported SQL operations, including filters and JOINs, directly to Bitbucket. This leverages server-side processing to swiftly deliver the requested Bitbucket data.

Configure Bitbucket Connectivity for Appsmith

Connectivity to Bitbucket from Appsmith is made possible through CData Connect AI. To work with Bitbucket data from Appsmith, we start by creating and configuring a Bitbucket connection.

1. Log into Connect AI, click Sources, and then click Add Connection

2. Select "Bitbucket" from the Add Connection panel

3. Enter the necessary authentication properties to connect to Bitbucket.

   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.
   
4. Click Save & Test
5. Navigate to the Permissions tab in the Add Bitbucket Connection page and update the User-based permissions.

Add a Personal Access Token

When connecting to Connect AI through the REST API, the OData API, or the Virtual SQL Server, a Personal Access Token (PAT) is used to authenticate the connection to Connect AI. It is best practice to create a separate PAT for each service to maintain granularity of access.

1. Click on the Gear icon () at the top right of the Connect AI app to open the settings page.
2. On the Settings page, go to the Access Tokens section and click Create PAT.
3. Give the PAT a name and click Create.
4. The personal access token is only visible at creation, so be sure to copy it and store it securely for future use.

With the connection configured and a PAT generated, we are ready to connect to Bitbucket data from Appsmith.

Create an Appsmith Application from live Bitbucket Data

To establish a connection from Appsmith to the CData Connect AI Virtual SQL Server, follow these steps:

Connect to Bitbucket in Appsmith

1. Log in to your Appsmith instance and create a new application.
2. In the new application, open the Data page and select Bring your data.
3. On this page, you can search for Microsoft SQL Server and select it as your data source.
4. Enter a name for the new data source and then enter the following connection settings:
   • Host address: tds.cdata.com
   • Port: 14333
   • Database name: enter the Connection Name of the CData Connect AI data source you want to connect to (for example, Bitbucket1).
   • Username: enter your CData Connect AI username. This is displayed in the top-right corner of the CData Connect AI interface. For example, [email protected].
   • Password: enter the PAT you previously generated.
   
5. Click Test configuration to confirm a successful connection, then click Save to save the datasource.

Create a new query

With a connection configured to a datasource, we can add a SQL query to actually retrieve data from the data source.

1. On the screen with the new data source, click New Query.
2. This opens the Query Editor to enter a SQL query to select data. To assist with specifying a SQL query, use the Explorer of CData Connect AI to preview the SQL queries and the data you want to retrieve.
3. After creating the SQL query, return to the Query Editor in Appsmith and enter the SQL query, then click Run.
4. Once the query successfully runs, all that remains is to set up the Page to display the data retrieved.

Display Bitbucket data

1. Open the UI tab and click New UI element.
2. Choose a new UI element to grab, then drag and place the element on the page.
3. Click Connect data on the new UI element, then select the query previously created.
4. With the data connected, it is then displayed in the UI element.

Deploy the application

With the Bitbucket data connected to the UI elements in the application, we can deploy the Application. To do this, click Deploy in the top-right corner of Appsmith, then the application is opened in a separate window displaying the Bitbucket data.

Get CData Connect AI

To get live data access to hundreds of SaaS, Big Data, and NoSQL sources directly from your cloud applications, try CData Connect AI today!