Configure Enrichments

Enrichments enhance real-time data streams by adding new attributes before or after aggregation. They are configured in the Administration page.

HCL Detect supports multiple enrichment types to enhance incoming data before or after aggregation. These enrichments are evaluated in the following order:

  1. Transformed Attributes: Adds attributes with constant values or values derived from a Detect Expression Language expression. These attributes can be retained or forwarded in the enriched transaction.

    In the Add Transformed Attribute pane, enter the following details:

    • Attribute Name*
    • Data type*
    • Expression*

  2. Lookup-Based Enrichment
    • Retrieves attributes from the profile store and adds them to the outgoing transaction.
    • In the Add Lookup Attribute pane, select the following:
      • Key Attribute* from the transaction
      • Lookup Table* from the associated database
      • Lookup Table Attributes*

  3. Aggregate-Based Enrichment
    • Adds attributes to the outgoing transaction. Retention of attributes in the output transaction is optional.
    • In the Add Aggregated Attribute pane, enter the following details:
      • Attribute Name*
      • Aggregations*
      • Group By Attributes
      • Period*
      • Window Length Unit*
      • Window Length

  4. Derived Attributes Enrichment
    • Executes an external Python function to compute and append results to transactions. Can be used for scoring functions, expression-based enrichments, or enrichment function-based enrichments.
    • In the Add Derived Attribute pane, configure the following:
      • Attribute Name*
      • Type of Attribute: Select either Enrichment function-based or Expression-based.
      • Enrichment Function
      • Required Attributes and Functional Parameters

Editing Enrichments

The interface for editing enrichments is shown below:

  • The interface allows modification of enrichment settings.
  • Derived attribute enrichments have a separate editing interface.

Configuring Enrichment Order

  • Enrichment operations can occur preAggregation or postAggregation.
  • This affects the values of enriched attributes.
  • To configure post-aggregation enrichment, select the Post-Aggregation Enrichment dropdown during enrichment creation.