Add Zuora Data to Informatica Enterprise Data Catalog

Informatica provides a powerful, elegant means of transporting and transforming your data. By utilizing the CData JDBC driver for Zuora, you are gaining access to a driver based on industry-proven standards that integrates seamlessly with Informatica's Enterprise Data Catalog. This tutorial shows how to classify and organize Zuora data across any environment.

Load the JDBC Driver

To load the JDBC Driver:

1. Install the JDBC Driver on the host running Informatica. For this article, it is assumed that the driver was installed into cdata.jdbc.zuora.ZuoraDriver.

$ java -jar setup.jar

2. Navigate to the JDBC install directory and create a zip file called genericJDBC.zip containing the driver and its license file.

$ cd ~/cdata-jdbc-driver-for-zuora/lib
$ zip genericJDBC.zip cdata.jdbc.zuora.jar cdata.jdbc.zuora.lic

3. Move the genericJDBC.zip file into the Catalog Service directory within Informatica. For this article, it is assumed that Informatica is installed into /opt/informatica. Working in this folder will probably require root permissions, so make sure to su or sudo to root before continuing.

# mv genericJDBC.zip /opt/informatica/services/CatalogService/ScannerBinaries

4. Edit the custom deployment configuration to unpack the zip file.

# cd /opt/informatica/services/CatalogService/ScannerBinaries/CustomDeployer/
# nano scannerDeployer.xml

After unpacking the existing ExecutionContextProperty nodes, add a new ExecutionContextProperty node with this content.

<ExecutionContextProperty
 isLocationProperty="true"
 dependencyToUnpack="genericJDBC.zip">
<PropertyName>JDBCScanner_DriverLocation</PropertyName>
<PropertyValue>scanner_miti/genericJDBC/Drivers</PropertyValue>
</ExecutionContextProperty>

5. Refresh the Catalog Service from the Admin console.
👁 Refresh the Catalog Service from the Admin console.

Configure the JDBC Resource

To configure the JDBC resource:

1. Open the Catalog administrator and add a new JDBC resource with the following properties:
• Driver Class: cdata.jdbc.zuora.ZuoraDriver
• URL: jdbc.zuora:OAuthClientID=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;Tenant=USProduction;ZuoraService=DataQuery;InitiateOAuth=GETANDREFRESH;

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.

Built-In Connection String Designer

For assistance in constructing the JDBC URL, use the connection string designer built into the Zuora JDBC Driver. Either double-click the .jar file or execute the .jar file from the command-line.

java -jar cdata.jdbc.zuora.jar

Fill in the connection properties and copy the connection string to the clipboard.

👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)


When you configure the JDBC URL, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.

Typical additional connection string properties follow:

JDBC;MSTR_JDBC_JAR_FOLDER=PATH\TO\JAR\;DRIVER=cdata.jdbc.zuora.ZuoraDriver;URL={jdbc:zuora:OAuthClientID=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;Tenant=USProduction;ZuoraService=DataQuery;InitiateOAuth=GETANDREFRESH;};

2. Username: user
3. Password: password

Note that the Username and Password properties are required, even if the driver you are using does not require them. In those cases, you can enter a placeholder value instead.

👁 Add a new JDBC resource (Couchbase is shown).

4. Configure the metadata options to perform at least one source metadata scan. This scan uses the driver to determine what tables, views, and stored procedures are available through the service.
• Source Metadata: Enable this option.
• Catalog: Set this to the appropriate catalog for multi-catalog data sources. Otherwise, set this to CData.
• Schema: Set this to the appropriate schema for multi-schema data sources. Otherwise, set this to the name of the service (for example, Couchbase).
• Case-sensitivity: Generally this option should be disabled. Enable it only for data sources which are case-sensitive.
• Import stored procedures: Enable this if you want to import stored procedure definitions in addition to tables and views.
👁 Configure the source metadata settings (Couchbase is shown).


Other metadata scanners may be enabled as desired.

5. Complete the driver configuration, optionally configuring custom attributes and a scanner schedule.
6. Perform the metadata scan by navigating to the Monitoring tab and clicking Run. Depending upon the data source, this may takes a few minutes.

When the scan is complete, a summary of all of the metadata objects is displayed along with the status of the Metadata Load job. If any errors occur, you can open the Log Location link for the job to see the errors reported by Informatica or the driver.

Validate the Discovered Metadata

Open the Catalog Service browser to view the metadata extracted from the data source. Depending upon the options you selected when configuring the metadata scanner, you may see any combination of tables, views, and stored procedures for the resource you defined.