VOOZH about

URL: https://www.cdata.com/kb/tech/zuora-cloud-filemaker-pro.rst

⇱ Connect to Zuora Data from Filemaker Pro (Mac)

Connect to Zuora Data from Filemaker Pro (Mac)

👁 Mohsin Turki
Mohsin Turki
Technical Marketing Engineer
Use CData Connect AI to connect to and query live Zuora data from Filemaker Pro on Mac.

FileMaker Pro is a cross-platform relational database application that allows users to visually modify a database. When paired with CData Connect AI, FileMaker Pro gets access to live Zuora data. This article demonstrates how to connect to Zuora using Connect AI and query Zuora data in FileMaker Pro.

CData Connect AI provides a pure SQL Server interface for Zuora, allowing you to query data from Zuora without replicating the data to a natively supported database. Using optimized data processing out of the box, CData Connect AI pushes all supported SQL operations (filters, JOINs, etc.) directly to Zuora, leveraging server-side processing to return the requested Zuora data quickly.

Configure Zuora Connectivity for FileMaker Pro

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

  1. Log into Connect AI, click Sources, and then click Add Connection
    2. 👁 Adding a Connection
  2. Select "Zuora" from the Add Connection panel
    3. 👁 Selecting a data source
  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.
    👁 Configuring a connection (Salesforce is shown)
  4. Click Save & Test
  5. Navigate to the Permissions tab in the Add Zuora Connection page and update the User-based permissions. 👁 Updating 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. 👁 Creating a new PAT
  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, you are ready to connect to Zuora data from Filemaker Pro.

Connect to Zuora from FileMaker Pro using Connect AI

To establish a connection from FileMaker Pro to the CData Connect AI Virtual SQL Server API, follow these steps.

Configure the ODBC Connection to CData Connect AI

  1. Download and install the Actual ODBC Driver for SQL Server (actualtech.com)
  2. Configure a DSN for the Actual ODBC driver by setting the following properties:
    • URL: tds.cdata.com
    • Port: Change the port from 1433 to 14333
    • Username: Your Connect AI email address
    • Password: the PAT you created earlier

Query Zuora from FileMaker Pro

  1. In the SQL Query Builder "SELECT" tab, select the columns to include as part of the query. 👁 Configuring the query by selecting columns.
  2. Open the "WHERE" tab of the SQL Query Builder and select "Show only selected columns."
  3. In "Table.Column,"" select a table and a column name.
  4. Set the "Operator" to =.
  5. Select "Column," and then select the same table and column name as "Table.Column."
  6. Click "Insert into SQL Query." 👁 Configuring the query by setting the WHERE clause.
  7. If no other modifications to the SQL query are required, click "Execute."

Get CData Connect AI

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