Welcome to Zuora Product Documentation

Explore our rich library of product information

Product catalog best practices, terminologies, and facts

This reference topic provides an overview of the recommended best practices and deployment considerations for product catalog deployment.

Product catalog deployment best practices

The Product catalog contains a large amount of data and many interconnected parameters. Follow these guidelines to ensure a smooth deployment.

  • Configure and baseline the following components before deploying the product catalog to minimize failed deployments.
    • Tax Codes
    • Accounting Codes
      • Configure and baseline the following components before deploying the product catalog to minimize failed deployments.
        • Tax Codes
        • Accounting Codes
        • Revenue Recognition Codes
        • Units of Measure
        • Chart of Accounts
      • Deploy custom fields before deploying the product catalog.
      • Baseline the following support-enabled features before deploying the product catalog in source and target.
        • Prepaid with Drawdown, Minimum Commitment, Prepaid Cash with Drawdown, and Dynamic Usage Charges
        • Zuora Revenue
        • Billing-Revenue Integration
        • Z-Finance
    • Revenue Recognition Codes
    • Units of Measure
    • Chart of Accounts
  • Deploy custom fields before deploying the product catalog.

  • Baseline the following support-enabled features before deploying the product catalog in source and target.
    • Prepaid with Drawdown, Minimum Commitment, Prepaid Cash with Drawdown, and Dynamic Usage Charges
    • Zuora Revenue
    • Billing - Revenue Integration
    • Z-Finance

Product Catalog terminologies in List view interface

StatusDescription
SubmittedThe compare job is initiated and is in queue.
Compare in ProgressThe system is retrieving and validating data in the backend.
Compare DoneThe comparison between source and target tenant is complete.
Compare FailedThe comparison job has failed due to a breakage in the backend integration logic.
CanceledThe comparison job is canceled if the job runs for more than 15 minutes and is considered a failure. The user can initiate a new job with the same tenants.
View DetailsThe comparison results are available for validation and deployment on the compare screen.
Auto-Generate SKUThe deployment manager will generate a new SKU based on the last SKU present in the target tenant while creating a new product.
Clone Source Tenant SKUThe deployment manager will clone the product, including the SKU, from the source to the target tenant.
On the source list view interface, the new source tenant's record appears as read-only. You can delete the source tenant ID after authentication.

Deployment facts for Product, Rate Plans, and Rate Plan Charges

  • If you select to validate and deploy a product name as the primary key for comparison, then the system behaves as follows based on the selection:

    • Product Name - If multiple products have the same name in the source tenant, Deployment Manager does not support comparison and deployments of these products.

    • SKU and Product Number - If the user selects SKU as the primary comparison key, the products with no validation will be displayed for validation and deployment.

  • Deployment Manager does not support comparing and deploying Rate Plans and Rate Plan Charges with the same name. The primary key for comparing the Rate Plans and Rate Plan Charges is the name; hence multiple rate plans with the same name are not compared and displayed by the compare screen.

  • Product catalog deployments deal with a large volume of data, and the deployment manager does not compare and display the products configured only in the target.