Versions Compared

Key

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

...

Under Parameters, you get the Environment, CredentialsAuthentication, and Entity options to configure your connection settings.

...

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 this option to access your own custom tenant environment. Specify the URL for your endpoint.

...

Authentication

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 .

...

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.

Rw ui tabs macro
Rw tab
titleNon-Active Rating

...

Non Active Rating.pngImage Added

File information

Field

Description

File name

Enter the file name of the Zuora usage file.

Note

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

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.

Optional fields

In Optional fields, you add the remaining optional fields or you may add additional fields to compile the usage file. 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

Toggling the Interconnect setting 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.

Rw tab
titleActive Rating

...

Configuration for Active Rating with Interconnect disabled.

Active Rating.pngImage Added

File information

Field

Description

File name

Enter the file name of the Zuora usage file.

Note

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.

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. 

Optional fields

In Optional fields, you add the remaining optional fields or you may add additional fields to compile the usage file by clicking on Add Field mapping. 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. 

Interconnect setting

Toggling the Interconnect setting 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.