Skip to content

ACCUMULATE DATABLOCK METADATA

Description

The ACCUMULATE DATABLOCK METADATA processor is designed to aggregate metadata from individual data points within a data block to the metadata of the data block itself. This processor is particularly useful for scenarios where metadata from individual data points needs to be consolidated for reporting, analysis, or further processing purposes.

Config Location

To configure the ACCUMULATE DATABLOCK METADATA processor, you need to define it within the consDPProcessors section of your data item configuration. This involves specifying the processor name and entity.

Supported Data Types

  • int
  • byte
  • short
  • long
  • float
  • double
  • boolean
  • char

These are the eight primitive data types defined in Java, representing raw values stored directly on the stack.

Config Requirements

Config ({}) options are required for the ACCUMULATE DATABLOCK METADATA processor. If no configuration is provided or if the configuration is improperly set up, a block violation will be thrown. For more information on Apiro violations and their appearance in the Apiro UI or logs, refer to the violations section.

Example Config

Below is an example of how to configure the ACCUMULATE DATABLOCK METADATA processor in XML format:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
<dataPoint name="QUANTITY" dataType="INTEGER">
    <consDPProcessors>
        <consDPProcessor name="ACCUMULATE" entity="ACCUMULATE_DATABLOCK_METADATA">
            <config>
                <![CDATA[
                    {
                        "metaDataField":"quantity"
                    }
                ]]>
            </config>
        </consDPProcessor>
    </consDPProcessors>
</dataPoint>

Example Result

Upon successful configuration and execution, the ACCUMULATE DATABLOCK METADATA processor will aggregate the metadata from individual data points within the QUANTITY data item to the metadata of the data block. The specific metadata field to be aggregated is specified as "quantity".

Config Parameters

name acceptable values comment
metaDataField A string representing the name of the metadata field to be aggregated from individual data points to the data block metadata

Common Mistakes

  • Ensure that the processor name and entity are correctly defined in the configuration to ensure that the processor is correctly identified and applied during the data processing pipeline.
  • Verify that the metaDataField name matches an existing metadata field within the data points of the data item.
  • Remember that the configuration for the ACCUMULATE DATABLOCK METADATA processor is required. If no configuration, or improper configuration is provided then a block violation will be thrown.