...
The Zuora Usage File Forwarder is used to send usage data in file format to Zuora Billing using the Zuora Post Usage API or with the Active Rating Post Usage API. You map fields from a source to specific target fields. Zuora Usage File Forwarder then compiles the fields into a comma-separated value (.csv) file or files to be sent downstream.
The options are available under the Parameters and Configuration tabs. The Parameters tab allows you to set the values for how the Zuora Usage File Forwarder would behave when communicating with the Zuora Billing system. The Configuration tab allows you to configure options to send the usage data as file(s) and allows you to enable the use of Active Rating on the Zuora Usage FIle Forwarder.
Parameters
Under Parameters, you get the Environment, Authentication, and Entity options to configure your connection settings.
...
You can configure this function in the following settings.
Environmentto select the Zuora environment.
Authentication to select a Zuora credential from Secrets Wallet.
Entitytospecify the name of the entity if you have the Zuora Multi-entity feature enabled.
Requestto enable Active Rating. The configuration fields will be different if you have selected the Use Active Rating check box described below.
File information
Required fields to field map the mandatory fields for the usage file.
Optional fields to add the remaining or additional optional fields to compile the usage file.
Response handling to determine the response details sent to a selected Interconnect receiver.
Environment
Field | Description |
|---|---|
Tenant | The name of the Zuora environment. The following endpoints are available for selection: US DC1 Production: https://rest.na.zuora.com/ EU Production: https://rest.eu.zuora.com/ Custom |
...
: Use this option to access your own custom tenant environment. Specify the URL for your endpoint. |
Authentication
...
Field | Description |
|---|
...
Secrets Wallet
Select from secrets wallet | Choose from a list of Zuora secret wallet passes. |
Entity
Field | Description |
|---|---|
Multi-Entity | If you have the Zuora Multi-entity feature enabled, you can specify the name of the entity you want access to. Zuora Multi-entity provides the capability to create and manage multiple entities within a single Zuora tenant. For more information on Zuora Multi-entity, see https://knowledgecenter.zuora.com/Billing/Tenant_Management/Multi-entity . |
Configuration
...
Request
...
Request
To send usage data to a Zuora Billing system, deselect the Use Active Rating check box. The Active Rating option is only applicable to Zuora customers that have the Active Rating feature activated, and the Use Active Rating check box should always be deselected if this is not the case.
| Rw ui tabs macro | ||||
|---|---|---|---|---|
|
...
File information
Required fieldsIn Required fields, the field mapping is done for the mandatory fields for the usage file. You must specify the Source Field based on the input from the previous function for the appropriate Required fields. There are four Required fields that must be mapped to the source fields: ACCOUNT_ID, UOM, QTY, and STARTDATE.  Optional fieldsIn Optional fields, you add the remaining optional fields or you may add additional custom fields to compile the usage file. To add an optional field, click the Add field mapping button. There are five Optional fields and those are ENDDATE, SUBSCRIPTION_ID, CHARGE_ID, DESCRIPTION, and UNIQUE_KEY. To add a custom field mapping, type the custom field name into Add field. |
...
 Response handlingToggling the |
...
Response handling on will allow you to Select Interconnect |
...
receiver. The Zuora Usage File Forwarder has a built-in Interconnect Sender which will forward the status ID and file details received from Zuora after it has received the files. A second stream can use the Interconnect Receiver to accept the status ID and file details forwarded by the Zuora Usage File Forwarder to track the status of the file in Zuora. If the stream fails for any reason, Zuora Usage FIle Forwarder will not send anything through the Interconnect Sender. 
|
...
File information
 Required fieldsIn Required fields, the field mapping is done for the mandatory fields for the usage file. You must specify the Source Field based on the input from the previous function for the appropriate Required fields. There are five Required fields that must be mapped to the source fields: AccountNumber, Tag, UnitOfMeasure, StartDateTime, and Quantity. |
...
 Optional fieldsIn Optional fields, you add the remaining optional fields or you may add additional custom fields to compile the usage file |
...
. To add an optional field, click the Add field mapping button. There are three Optional fields and those are Description, UniqueKey, and |
...
GroupId. To add a custom field mapping, type the custom field name into Add field. Added custom fields will automatically be appended with the prefix CustomFields. |
...
. You do not need to include this prefix in the field name. |
...
 Response handlingToggling the |
...
Response handling on will allow you to Select Interconnect |
...
receiver. The Zuora Usage File Forwarder has a built-in Interconnect Sender which will forward the status ID and file details received from Zuora after it has received the files. A second stream can use the Interconnect Receiver to accept the status ID and file details forwarded by the Zuora Usage File Forwarder to track the status of the file in Zuora. If the stream fails for any reason, Zuora Usage File Forwarder will not send anything through the Interconnect Sender.  |