Create Azure Synapse-Connected Enterprise Applications in OutSystems

Ready to get started?

Learn more about CData Connect Cloud or sign up for free trial access:

  Free Trial


Use CData Connect Cloud to connect to Azure Synapse from OutSystems and build custom enterprise apps using live Azure Synapse data.

OutSystems is a low-code platform which provides the tools for companies to developer, deploy, and manage omnichannel enterprise applications. When paired with CData Connect Cloud, you get instant, cloud-to-cloud access to Azure Synapse data for business applications. This article shows how to create a virtual database for Azure Synapse in Connect Cloud and build a simple app from Azure Synapse data in OutSystems.

The CData Connect Cloud provides a pure cloud-to-cloud interface for Azure Synapse, allowing you to build reports from live Azure Synapse data in OutSystems — without replicating the data to a natively supported database. As you create applications to work with data, OutSystems generates SQL queries to gather data. Using optimized data processing out of the box, CData Connect Cloud pushes all supported SQL operations (filters, JOINs, etc.) directly to Azure Synapse, leveraging server-side processing to quickly return the requested Azure Synapse data.

Connect to Azure Synapse in Connect Cloud

CData Connect Cloud uses a straightforward, point-and-click interface to connect to data sources.

  1. Log into Connect Cloud, click Connections and click Add Connection
  2. Select "Azure Synapse" from the Add Connection panel
  3. Enter the necessary authentication properties to connect to Azure Synapse.

    Connecting to Azure Synapse

    In addition to providing authentication (see below), set the following properties to connect to a Azure Synapse database:

    • Server: The server running Azure. You can find this by logging into the Azure portal and navigating to Azure Synapse Analytics -> Select your database -> Overview -> Server name.
    • Database: The name of the database, as seen in the Azure portal on the Azure Synapse Analytics page.

    Authenticating to Azure Synapse

    Connect to Azure Synapse using the following properties:

    • User: The username provided for authentication with Azure.
    • Password: The password associated with the authenticating user.
  4. Click Create & Test
  5. Navigate to the Permissions tab in the Add Azure Synapse Connection page and update the User-based permissions.

Add a Personal Access Token

If you are connecting from a service, application, platform, or framework that does not support OAuth authentication, you can create a Personal Access Token (PAT) to use for authentication. Best practices would dictate that you create a separate PAT for each service, to maintain granularity of access.

  1. Click on your username at the top right of the Connect Cloud app and click User Profile.
  2. On the User Profile page, scroll down to the Personal Access Tokens section and click Create PAT.
  3. Give your 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, you are ready to connect to Azure Synapse data from OutSystems.

Connect to Azure Synapse in OutSystems

The steps below outline connecting to CData Connect Cloud from OutSystems to create a new Azure Synapse database connection.

  1. Open OutSystems Service Studio
  2. Click the gear icon to open Environment Management in the Service Center
  3. Click Administration and select "Database Connections"
  4. Click "New Database Connection"
  5. Configure the database connection:
    • Name: name the connection (e.g. CData Connect Cloud Azure Synapse)
    • DBMS: SQL Server / Azure SQL
    • Username: a Connect Cloud user (e.g. user@mydomain.com)
    • Password: the PAT for the Connect Cloud user
    • Server: tds.cdata.com,14333
    • Schema: the name of your Azure Synapse connection (e.g. AzureSynapse1)
  6. Click "Test Connection"
  7. Click "Create"

Map Azure Synapse Tables or Views to Entities in an Extension Module

Once you create the database connection for Azure Synapse, you can create an extension that maps the tables or views to OutSystems entities. If you have not already done so, create an Application in Service Studio.

  1. Open the Service Studio and open the existing Application
  2. Click "Add Module," set the "Module Name" (e.g. azuresynapse_db_extension), set "Module Type" to "Extension," and click "Create Module"
  3. In Integration Studio, connect to your environment
  4. Right-click "Entities" in the extension tree and select "Connect to External Table or View..."
  5. Follow the steps in the wizard, selecting the tables and views you wish to work with
  6. In the Integration Studio, click "1-Click Publish"
  7. In the "1-Click Publish" wizard, click "Configure" when the process completes
    • In the Service Center, associate the logical database name of the extension to the database connection that the extension will use and click "Apply"
  8. In your application, click "Manage Dependencies..."
  9. Add a dependency to the Extension and select the Entities that you will use in your application

At this point, you can access and work with Azure Synapse data just like you would with the standard OutSystems entities.

More Information & Free Trial

With Connect Cloud and OutSystems, you can easily build Azure Synapse-connected applications. Request a free trial of Connect Cloud and start working with Azure Synapse data in OutSystems today.