Ready to get started?

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

Free Trial

Create Zuora-Connected Enterprise Applications in OutSystems



Use CData Connect Cloud to connect to Zuora from OutSystems and build custom enterprise apps using live Zuora 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 Zuora data for business applications. This article shows how to create a virtual database for Zuora in Connect Cloud and build a simple app from Zuora data in OutSystems.

The CData Connect Cloud provides a pure cloud-to-cloud interface for Zuora, allowing you to build reports from live Zuora 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 Zuora, leveraging server-side processing to quickly return the requested Zuora data.

Configure Zuora Connectivity for OutSystems

Connectivity to Zuora from OutSystems is made possible through CData Connect Cloud. To work with Zuora data from OutSystems, we start by creating and configuring a Zuora connection.

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

    Zuora uses the OAuth standard to authenticate users. See the online Help documentation for a full OAuth authentication guide.

    Configuring Tenant property

    In order to create a valid connection with the provider you need to choose one of the Tenant values (USProduction by default) which matches your account configuration. The following is a list with the available options:

    • USProduction: Requests sent to https://rest.zuora.com.
    • USAPISandbox: Requests sent to https://rest.apisandbox.zuora.com"
    • USPerformanceTest: Requests sent to https://rest.pt1.zuora.com"
    • EUProduction: Requests sent to https://rest.eu.zuora.com"
    • EUSandbox: Requests sent to https://rest.sandbox.eu.zuora.com"

    Selecting a Zuora Service

    Two Zuora services are available: Data Query and AQuA API. By default ZuoraService is set to AQuADataExport.

    DataQuery

    The Data Query feature enables you to export data from your Zuora tenant by performing asynchronous, read-only SQL queries. We recommend to use this service for quick lightweight SQL queries.

    Limitations
    • The maximum number of input records per table after filters have been applied: 1,000,000
    • The maximum number of output records: 100,000
    • The maximum number of simultaneous queries submitted for execution per tenant: 5
    • The maximum number of queued queries submitted for execution after reaching the limitation of simultaneous queries per tenant: 10
    • The maximum processing time for each query in hours: 1
    • The maximum size of memory allocated to each query in GB: 2
    • The maximum number of indices when using Index Join, in other words, the maximum number of records being returned by the left table based on the unique value used in the WHERE clause when using Index Join: 20,000

    AQuADataExport

    AQuA API export is designed to export all the records for all the objects ( tables ). AQuA query jobs have the following limitations:

    Limitations
    • If a query in an AQuA job is executed longer than 8 hours, this job will be killed automatically.
    • The killed AQuA job can be retried three times before returned as failed.
  4. Click Create & Test
  5. Navigate to the Permissions tab in the Add Zuora 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 Zuora data from OutSystems.

Connect to Zuora from OutSystems

The steps below outline connecting to CData Connect Cloud from OutSystems to create a new Zuora 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 Zuora)
    • 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 Zuora connection (e.g. Zuora1)
  6. Click "Test Connection"
  7. Click "Create"

Map Zuora Tables or Views to Entities in an Extension Module

Once you create the database connection for Zuora, 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. zuora_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 Zuora data just like you would with the standard OutSystems entities.

More Information & Free Trial

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