Versions Compared

Old Version 15

changes.mady.by.user Kevin Wu

Saved on

compared with

New Version Current

changes.mady.by.user Casey Han

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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.

Image Removed.

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/
US DC2 Production: https://rest.zuora.com/
US DC1 API Sandbox: https://rest.sandbox.na.zuora.com/
US DC2 API Sandbox: https://rest.apisandbox.zuora.com/
US Central Sandbox: https://rest.test.zuora.com/

EU Production: https://rest.eu.zuora.com/
EU Sandbox: https://rest.sandbox.eu.zuora.com/
EU Central Sandbox: https://rest.test.eu.zuora.com/

Custom

- Use

: Use this option to access your own custom tenant environment. Specify the URL for your endpoint.

...

Authentication

Secrets WalletThis dropdown list will appear with the Secret Wallets option toggled on.

Field

Description

Secrets Wallet

Select from secrets wallet

Choose from a list of Zuora secret wallet passes

.OAuth 2.0Client 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 SecretThis 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 KeyAccess 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 

see https://knowledgecenter.zuora.com/Billing/Tenant_Management/Multi-entity

.

Configuration

...

.

Request

To send usage data to a Zuora Billing system, deselect the Use Active Rating checkbox check box. The Active Rating option is only applicable to Zuora customers that have the Active Rating feature activated, and the Use Active Rating checkbox check box should always be deselected if this is not the case.

Rw ui tabs macro
Rw tab
titleNon-Active Rating

Image Removed

Configuration for Non Active Rating with Interconnect enabled

File information

Field

Description

File name

Enter the file name of the Zuora usage file.

Note
title

Note!

  • The name of a usage file must not be longer than 42 characters.

  • If the total usage data is equal to or below 4MB, a single file will be sent to Zuora Billing with the specified file name.

  • If the total usage data exceeds 4MB, multiple files will be sent to Zuora Billing. The specified file name will include numbering to indicate the split files.
    For example: filename_1, filename_2 and etc.

  • The file will be saved in .csv format and

compressed before being

  • compressed before it is sent to Zuora Billing.

  • The File name field supports Variable Insertion.  

  • If File name is not specified, the filename from the collector function will be used. If no file is collected from the collector function, UsageData will be used as the filename.

File name non active rating.pngImage Added

Required fields

In 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.

Required field non active rating.pngImage Added

Optional fields

In 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. 

Interconnect setting

Optional field non active rating.pngImage Added

Response handling

Toggling the

Interconnect setting

Response handling on will allow you to Select Interconnect

Receiver

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.

Response handling non active rating.pngImage Added
Rw tab
title
Active RatingImage Removed
Configuration for
Active Rating
with Interconnect disabled.

File information

Field

Description

File name

Enter the file name of the Zuora usage file.

Note
title

Note!

  • The name of a usage file must not be longer than 42 characters.

  • If the total usage data is equal to or below 18MB, a single file will be sent to Zuora Billing with the specified file name.

  • If the total usage data exceeds 18MB, multiple files will be sent to Zuora Billing. The specified file name will include numbering to indicate the split files.
    For example: filename_1, filename_2 and etc.

  • The file will be compiled and sent in .csv format to Zuora Billing.

  • The File name field supports Variable Insertion.  

  • If File name is not specified, the filename from the collector function will be used. If no file is collected from the collector function, UsageData will be used as the filename.

Description

Enter a description for the Zuora usage file.

File information active rating.pngImage Added

Required fields

In 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. 

Required field active rating.pngImage Added

Optional fields

In Optional fields, you add the remaining optional fields or you may add additional custom fields to compile the usage file by clicking on Add Field mapping. To add an optional field, click the Add field mapping button. There are three Optional fields and those are Description, UniqueKey, and GroupIDGroupId. 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  You do not need to include this prefix in the field name. 

Interconnect setting

Optional field active rating.pngImage Added

Response handling

Toggling the

Interconnect setting

Response handling on will allow you to Select Interconnect

Receiver

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

File Forwarder will not send anything through the Interconnect Sender.

Response handling active rating.pngImage Added