Best practices for Revenue configuration deployment
This topic describes the best practices to plan, validate, and deploy Revenue metadata safely and consistently across environments.
-
Labels are the primary parent object for many Revenue components. Deploy Labels before deploying other Revenue components that reference them. A missing Label can prevent pre-validation or cause a dependent component to fail during deployment. Labels are available as a configuration under Application.
-
Product recommends deploying Revenue Layout and Revenue Reports as standalone component. For best results, do not pair them with other components.
-
When deploying Revenue Reports, the user has the option of overriding reports or not under Deployment Preferences. The Don't Override option is selected by default. To override the reports from the source tenant to the target tenant, select Override Revenue Reports.
-
The dependency sequence must be maintained with the current Revenue component matrix. If Zuora publishes an updated sequence, use the updated sequence instead.
-
Run pre-validation before deploying. Review every missing dependency, incompatible configuration, and unique-key warning. Resolve each issue in the source or target tenant before you submit the deployment.
-
Use a source tenant that represents the desired baseline. Compare the target tenant before deployment, and deploy parent objects before child objects to reduce configuration drift and partial deployments.
-
Use the tenant-type filter to limit the Select screen to components that apply to the current environment. This helps OTR and Revenue-only customers avoid selecting components that are not available for their tenant configuration.
-
Use Configuration templates to save and reuse a known-good Revenue deployment configuration across environments or customers. Review the template after adding new Revenue objects or changing dependency rules
-
For Revenue-only deployments, verify the OneID environment before authenticating the source tenant. For OTR deployments, verify that the source tenant uses Billing client credentials and that the user has access to both the Billing Deployment Manager permission and the Revenue components.
-
Validate Revenue metadata deployment in a stable sandbox or other approved test environment before promoting changes to production. Include test cases for OTR and Revenue-only authentication, tenant-type filtering, dependency ordering, partial deployment, rollback, and environment-specific OneID endpoints.