Ready to get started?

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

Free Trial

Connect to Zuora Data in RunMyProcess through Connect Cloud



Use CData Connect Cloud to create on OData API for Zuora and connect to Zuora data in Akorbi Digital RunMyProcess.

Akorbi Digital RunMyProcess makes it easy to create applications for complex business applications, such as budget application and contract management. CData Connect Cloud creates a live connection to Zuora and can be used to generate an OData API (natively supported in RunMyProcess) for Zuora. By pairing RunMyProcess with CData Connect Cloud, you get true cloud-to-cloud connectivity to all your SaaS and cloud-based Big Data and NoSQL sources - no need to migrate your data or write your own integrations. Simply connect to Connect Cloud from RunMyProcess as you would any other REST service and get instant, live access to your Zuora data.

In this article, we walk through connecting to Zuora from CData Connect Cloud and accessing Zuora data through an OData feed in RunMyProcess.

Connect to Zuora from RunMyProcess

To work with live Zuora data in RunMyProcess, we need to connect to Zuora from Connect Cloud, provide user access to the connection, and create OData endpoints for the Zuora data.

(Optional) Add a New Connect Cloud User

As needed, create Users to connect to Zuora through Connect Cloud.

  1. Navigate to the Users page and click Invite Users
  2. Enter the new user's email address and click Send to invite the user
  3. You can review and edit users from the Users page

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.

Connect to Zuora from 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 "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 Zuora OData Endpoints in Connect Cloud

After connecting to Zuora, create OData Endpoints for the desired table(s).

  1. Navigate to the OData page and click Add to create new OData endpoints
  2. Select the Zuora connection (e.g. Zuora1) and click Next
  3. Select the table(s) you wish to work with and click Confirm

Sample URLs for OData Feeds

Once you have configured a connection to Zuora, created a user, and created OData endpoints in Connect Cloud, you can access OData feeds for Zuora data. Below, you will see the URLs to access tables and the list of tables. For information on accessing the tables, you can navigate to the OData page for Connect Cloud. For the URLs, you will need the URL of Connect Cloud: https://cloud.cdata.com/api/odata/service.

Table         URL
Entity (table) List https://cloud.cdata.com/api/odata/service/
Metadata https://cloud.cdata.com/api/odata/service/$metadata
Invoices https://cloud.cdata.com/api/odata/service/Invoices

As with standard OData feeds, if you wish to limit the fields returned, you can add a $select parameter to the query, along with other standard OData URL parameters, such as $filter, $orderby, $skip, and $top. See the help documentation for more information on supported OData queries.

With the connection and OData endpoints configured, you are ready to connect to Zuora data from RunMyProcess.

Retrieve Zuora Data from RunMyProcess DigitalSuite Studio

With the connection to Zuora and OData endpoints created, we are ready to add Zuora data to RunMyProcess for Retrieval.

Create a Provider

  1. Log into RunMyProcess and open DigitalSuite Studio.
  2. Click Resources to bring up the Resources page, then select then the CONNECTORS tab.
  3. Click the + (New Provider) button to create a new provider, choose the account to use, then click Confirm.
  4. In the provider settings page, configure the following properties.
    • URL: Set the OData endpoint in the Connect Cloud OData page: https://cloud.cdata.com/api/odata/service.
    • Authentication Schema: Select Login/Password.
    • Login: Specify a CData Connect Cloud username (e.g. user@mydomain.com).
    • Password: Specify the PAT of the Connect Cloud user.
  5. Fill in the same properties in the ACCEPTANCE and TEST tabs. Note: You can copy the configured settings by clicking 'Copy this configuration button,' then pasting the content in the new tab by clicking 'Paste previously copied configuration.'
  6. Click Save to save the properties.

Retrieve Zuora Data by Creating a Connector

  1. In the CONNECTORS tab, click the button with three dots to create the provider, then select Add connector from the menu.
  2. In the following page, set Connector URL to the OData endpoint configured in Connect Cloud (e.g. https://cloud.cdata.com/api/odata/service)
  3. Click Save then Launch to test the connector execution. Click Launch test to execute. The process is successful if you get the JSON response of your configured table information.

More Information & Free Trial

Now, you have created a provider and connector to retrieve Zuora data. For more information on creating OData feeds from Zuora (and more than 100 other data sources), visit the Connect Cloud page. Sign up for a free trial and start working with live Zuora data in RunMyProcess.