The Zuora Import Usage Function imports usage data files from Usage Engine to Zuora Billing. It handles data using the Zuora Import Usage API as documented by the service. By implementing this service in a stream the users can build custom logic to handle responses or errors from Zuora.
...
| Note | ||
|---|---|---|
| ||
|
Configuration
To configure the Zuora Import Usage Function:
In Environment, to access the Zuora tenant environment, specify:
Field Description Tenant The name of the Zuora environment. URL The base URL for the REST endpoint. If the Custom tenant is selected, specify the appropriate endpoint. If the Zuora tenant is available, you can access the Zuora REST API using the following endpoints:
Tenant Base URL for REST Endpoints US Production https://rest.zuora.com US API Sandbox https://rest.apisandbox.zuora.com US Performance Test https://rest.pt1.zuora.com EU Production https://rest.eu.zuora.com EU Sandbox https://rest.sandbox.eu.zuora.com Custom You can also access your own custom tenant environment. Specify the URL for your endpoint. Note title Note! The Zuora endpoint that we are using for the Zuora Import Usage Function is POST to /usage-imports. In Credentials, you can choose to authenticate using two methods. In Authenticate by specifying:
Authentication Type Field Description OAuth
Client ID The client ID that is displayed when the OAuth client is created in Zuora. Client Secret The client secret ID that is displayed when the OAuth client is created in Zuora. API Key Access Key ID 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 The key that is used along with the Access Key ID to cryptographically sign the Zuora requests. Note title Note! You can also use the Secrets Wallet toggle button to select a predefined Zuora secret from your Secrets Wallet.
In File Information, specify the name of the usage file that is sent to Zuora in Filename and provide a Description.
Note title Note! - Filename field supports Variable Insertion.
If Filename is not specified, the filename from the collector function will be used. If no file is collected from the collector function, UsageData.csv will be used as the filename.
- In 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.
In Field Mapping, you must specify the Source Field based on the input from the previous function for the appropriate Target Field. There are five Target Fields that must be mapped to the Source Fields: AccountNumber, Tag, UnitOfMeasure, StartDateTime and Quantity. The target fields are defined according to the template of the usage file. To add a custom field mapping, click + Add custom field mapping. You can also add multiple custom field mappings.
Note title Note! The format of the custom Target Field must follow Zuora's naming guidelines. When adding a Target Field in a custom field mapping, you must always begin with CustomFields. as the prefix. For example, CustomFields.<key_value>.
After configuring the Zuora Import Usage Function, click Preview to preview your data before running the stream.
Note title Note! When you preview the Zuora Import Usage Function, it always represents the request.fileContent data in the Buffer/binary format to improve performance of the engine.