Discover how a bimodal integration strategy can address the major data management challenges facing your organization today.
Get the Report →Configure a One-Way Send Port for the CData BizTalk Adapter for Zuora
Use the adapter for Zuora with a one-way send port to execute updategrams and data manipulation SQL in BizTalk.
This section provides step-by-step instructions for creating, configuring, and testing a static one-way send port using the CData BizTalk Adapter for Zuora. You can use static one-way send ports to execute updategrams, SQL commands, and stored procedures. Send ports are useful for operations that modify Zuora data but do not have any response data. Typically, this would be DELETE or UPDATE SQL commands or updategrams, and occasionally stored procedure operations.
If you want to trigger actions that will return a response, such as executing SELECT commands or retrieving the Id of a record that you have created, use a solicit-response send port.
Create and Configure the One-Way Send Port
Create a static one-way send port and configure it to use the Zuora adapter as its transport type.
- If you have not already done so, open your BizTalk application in the BizTalk Administration Console.
- In the node for your BizTalk application, right-click Send Ports and select New -> Static One-Way Send Port. The send port properties dialog is displayed.
- In the Name menu, enter a name for the send port.
- In the Type menu, select CData.Zuora.
- In the Send Pipeline menu, select the default option, PassThruTransmit.
Configure the Adapter
Define the command that the adapter will execute in the Transport Properties dialog.
- In the send port properties, click the Configure button. The CData.Zuora Transport Properties dialog is displayed.
- In the CommandType property, select the command type you want.
- If you want to execute an SQL command, enter the command in the SQL Command box.
Configure the Connection to Zuora
Configure credentials and other properties required to connect to Zuora in the Connection String Options dialog.
- In the send port properties dialog, click Configure. The adapter properties dialog is displayed.
- Click the button in the Connection String property.
- Click the box in the Connection String property. The Connection String Options dialog is displayed.
- Enter connection properties. Below is a typical connection string:
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.
- Click Test Connection to verify the values and test connectivity.
After you connect successfully and define the command the adapter will execute, the send port is ready for use. See the following section for an example of using a one-way send port in a simple application. The application reads updategram commands contained in a file and uses a send port to execute the command.
In the example, filters are used to move the messages that contain the updategram from the receive location to the send port. See the following section for more information on filters.
Create Filters to Route BizTalk Messages Through an Application
To associate a send port with the messages you want, create a filter rule in the Filters section of the properties for that send port. Messages matching the criteria will be routed to the send port. See the following example to filter on a receive location.
Example: Execute Updategrams with a One-Way Send Port
This section shows how to use a one-way send port in a simple application. The application reads updategram commands contained in a file and executes the commands:
- A one-way receive location picks up the XML document containing the updategram.
- The receive location creates a BizTalk message containing the results of the command.
- A one-way send port filters on the URI of the receive location. The document is routed to the one-way send port.
- The send port executes the updategram command.
As in the preceding example, the followings steps show how to set up a receive location to read updategrams from a file and use a send port to execute the commands:
- Create and configure a static one-way receive location. Use the File transport type. You can follow the same procedure to create and configure a receive location for the CData BizTalk Adapter for Zuora.
- Create a static one-way send port.
- In the send port properties, click Filters.
- In an empty property, set the following values:
- Property
- Select BTS.InboundTransportLocation from the menu.
- Value
- Enter the URI of the newly created one-way receive location.