queryCriteria and subscriptionQueryCriteria Fields in Data Extraction

Knowledge Center > Zuora RevPro > queryCriteria and subscriptionQueryCriteria Fields in Data Extraction

queryCriteria and subscriptionQueryCriteria Fields in Data Extraction

In order to facilitate filtering a specific set of data, Zuora RevPro Integration introduces two fields, queryCriteria and subscriptionQueryCriteria, in the Create a data extraction job operation. You have the flexibility to use them together or individually in an API request to get the desired result. 

The length of both fields should not exceed 200 characters.

Fields Comparison

The following table describes the differences between the two fields from different perspectives and gives examples of how to use them:

Field Business Purpose Usage Syntax and Example Supported  Transaction Type Supported Objects
queryCriteria

This field is used to filter a specific Orders or Invoice Item data set through API.

For the Orders data, the filter is applied after the data is queried. This might cause performance issues if you are extracting a large data set.

For the Invoice Item data, this filter is applied upfront.

Use this field to filter only the Invoice Item data for better performance

ZOQL query that begins with:
AND [DataSourceObject].[Field] = [Value]

For example:

AND (InvoiceItem.Quantity = 100 OR Product.Name = 'SampleProduct')

Sales Order

 

  • Account
  • Amendment
  • Product
  • ProductRatePlan
  • ProductRatePlanCharge
  • RatePlan
  • RatePlanCharge
  • Subscription
Invoice Item 
  • Account
  • Amendment
  • Invoice
  • InvoiceItem
  • Product
  • RatePlan
  • RatePlanCharge
  • ProductRatePlan
  • ProductRatePlanCharge
  • RatePlanCharge
  • Subscription
subscriptionQueryCriteria

This field is used to selectively extract the Orders data based on the custom field value set at the related Subscription object.

The filter is applied upfront while querying the Orders Metrics data through Revenue Run.

Use this field to filter the Orders data for better performance

ZOQL query that begins with:
AND Subscription.[Subscription_CustomField] = [Value]

For example:

AND Subscription.CustomProductName__c = 'CustomName'
Sales Order Subscription

Fields Validation

When submitting a request, Zuora RevPro Integration does the validation for both fields. The validation has two phases:

  1. Syntax Validation: If the query contains AQuA syntax errors, the job will fail at job submission.
  2. Performance Validation: If the query passes the syntax validation but it takes an excessive amount of time (10 minutes by default) to execute the assembled AQuA query, the extraction job will be ABORTED. You must check and modify the query you entered before resubmitting the job.

Zuora strongly recommends you to use Indexed Custom Fields to get the best performance. See Manage Custom Fields for more information.

 

Last modified

Tags

Classifications

(not set)