Welcome to Zuora Product Documentation

Explore our rich library of product information

Configure an Enrichment processor (Product or Account data)

Learn how to configure an Enrichment processor to enhance events with product or account data.

You can use this method for enrichment based on standard Zuora metadata such as product catalog, accounts, subscriptions, and charges. To configure an Enrichment processor:

  1. Navigate to Mediation > Meters.
  2. Create a new Custom meter.
  3. Select and drag the Enrichment processor type on to the meter stream page. The enrichment settings page is displayed.
    Enrichment processor settings
  4. On the Enrichment settings page, enter a name for the processor.
  5. Under Enrichment Options, select Enrich events using Product or Account data.
  6. Under Reference Object, select either Account or Product as the source for enrichment.
    The fields from the selected reference object are used to match and fetch additional data into the event.
  7. Specify the Field Mapping.
    Field mappings define the join logic, how event records should be matched to reference data.
    • Event Field: The field from the event stream. Examples: accountNumber, productSKU.
    • Reference Field: The corresponding field from the reference object to be matched.
    This is equivalent to a SQL join ON event.accountNumber = account.accountNumber. You can add multiple field mappings to create composite joins, such as accountNumber and region.
  8. Specify the Fields To Append.
    Defines which fields from the reference data should be appended to the event.
    • Reference Field: The Account or Product field that you want to fetch.
    • Event Field Name: The name of the field in the enriched event.
    Append accountType from Account object as enriched_account_type.
  9. Select an Output Option to specify the events that are returned after enrichment.
    • Include all events: Allows events to pass through even if no match is found in the reference data.
    • Include usage charges only: Filters results to include only usage charges. This is useful when enrichment is intended solely for usage-based billing scenarios.
    • Use event time to match charge segment: Ensures a charge segment is selected based on the event’s timestamp, which is important when rate plan charges have multiple time-based segments. If you leave it unchecked, the system uses the latest timestamp while processing these records.
    Charge Segment
    Start Date End Date Price per Unit
    Jan 01, 2024 Dec 31, 2024 $1
    Jan 01, 2025 ongoing $2
    If the Use event time to match charge segment checkbox is enabled and availableTime is chosen as, say November 2024, the system picks $1. If the checkbox is disabled, the system picks $2.
  10. Click Save.

The Enrichment processor is configured for the custom meter.