Create Bitbucket-Connected Nintex Workflows
Nintex Workflow Cloud is a cloud-based platform where you can design workflows to automate simple or complex processes using drag-and-drop interactions — without writing any code. When paired with CData Connect AI, you get instant, cloud-to-cloud access to Bitbucket data for business applications. This article shows how to create a virtual database for Bitbucket in Connect AI and build a simple workflow from Bitbucket data in Nintex.
CData Connect AI provides a pure, cloud-to-cloud interface for Bitbucket, allowing you to build workflows from live Bitbucket data in Nintex Workflow Cloud — without replicating the data to a natively supported database. Nintex allows you to access data directly using SQL queries. Using optimized data processing out of the box, CData Connect AI pushes all supported SQL operations (filters, JOINs, etc.) directly to Bitbucket, leveraging server-side processing to quickly return the requested Bitbucket data.
Configure Bitbucket Connectivity for Nintex
Connectivity to Bitbucket from Nintex is made possible through CData Connect AI. To work with Bitbucket data from Nintex, we start by creating and configuring a Bitbucket connection.
- Log into Connect AI, click Sources, and then click Add Connection
- Select "Bitbucket" from the Add Connection panel
-
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:
- Go to Settings (the gear icon) and select Workspace Settings.
- In the Apps and Features section, select OAuth Consumers.
- Click Add Consumer.
- Enter a name and description for your custom application.
- 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.
- 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.
- Select which permissions to give your OAuth application. These determine what data you can read and write with it.
- To save the new custom application, click Save.
- 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.
- Click Save & Test
-
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.
- Click on the Gear icon () at the top right of the Connect AI app to open the settings page.
- On the Settings page, go to the Access Tokens section and click Create PAT.
-
Give the PAT a name and click Create.
- 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, you are ready to connect to Bitbucket data from Nintex Workflow Cloud.
Connect to Bitbucket from Nintex
The steps below outline creating a new connection to Bitbucket data from Nintex (via Connect AI).
- Log into Nintex Workflow Cloud
- In the Connections tab, click "Add new"
- Select "Microsoft SQL Server" as the connector and click "Connect"
- In the SQL Server connection wizard, set the following properties:
- Connection Name: Connect AI
- Username: a Connect AI username (e.g. [email protected])
- Password: the Connect AI user's PAT
- Database Host: tds.cdata.com:14333
- Database Name: the Bitbucket connection (a.g., Bitbucket1)
- Click "Connect"
- Configure the connection permissions and click "Save permissions"
Create a Simple Bitbucket Workflow
With the connection to CData Connect AI configured, we are ready to build a simple workflow to access Bitbucket data. Start by clicking the "Create workflow" button.
Configure the Start Event Action
- Click the start event task and select the "Form" event
- Click "Design form"
- Drag a "Text - Long" element onto the Form and click the element to configure it
- Set "Title" to "Enter SQL query"
- Set "Required" to true
- Drag a "Text - Short" element onto the Form and click the element to configure it
- Set "Title" to "Enter desired result column"
- Set "Required" to true
Configure an "Execute a Query" Action
- Add an "Execute a query" action after the "Start event: Form" action and click to configure the action
- Set "SQL Script" to the "Enter SQL Query" variable from the "Start event" action
- Set "Column to retrieve" to the "Enter desired result column" variable from the "Start event" action
- Set "Retrieved column" to a new variable (a.g., "values")
Configure a "Send an Email" Action
- Add a "Send an email" action after the "Execute a query" action and click to configure the action
- Set the "Recipient email address"
- Set the "Subject"
- Set the "Message body" to the variable created for the retrieved column
Once you configure the actions, click "Save," name the Workflow, and click "Save" again. You now have a simple workflow that will query Bitbucket using SQL and sand an email with the results.
To learn more about live data access to hundreds of SaaS, Big Data, and NoSQL sources directly from your cloud applications, check out the CData Connect AI page. Sign up for a free trial and reach out to our Support Team if you have any questions.