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, Credentials, and Entity options to configure your connection settings.
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. |
Credentials
| Field | Description |
|---|---|
| Secrets Wallet | |
| Secrets Wallet | This dropdown list will appear with the Secret Wallets option toggled on. Choose from a list of Zuora secret wallet passes. |
| OAuth 2.0 | |
| Client ID | This field will appear when the OAuth 2.0 option is selected at the Authentication By dials. Enter the client identifier for the Zuora OAuth client. |
| Client Secret | This field will appear when the OAuth 2.0 option is selected at the Authentication By dials. Enter the client secret for the Zuora OAuth client. |
| API Key | |
| Access Key ID | This field will appear when the API Key option is selected at the Authentication By dials. The identifier that is used to sign the requests sent to Zuora. It is displayed when the API User is created in Zuora. |
| Secret Access Key | This field will appear when the API Key option is selected at the Authentication By dials. The key that is used along with the Access Key ID to cryptographically sign the Zuora requests. |
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, refer to https://knowledgecenter.zuora.com/Billing/Tenant_Management/Multi-entity. |
Configuration
Under Configuration, you get the Request, File information, Required fields, Optional fields and Interconnect setting options to set for the Zuora File Usage Forwarder. The configuration fields will be different if you have selected the Use Active Rating checkbox described below.
Request
To send usage data to a Zuora Billing system, deselect the Use Active Rating checkbox. The Active Rating option is only applicable to Zuora customers that have the Active Rating feature activated, and the Use Active Rating checkbox should always be deselected if this is not the case.