Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • The Configuration tab, where you configure the processor

  • The Inspect tab where you can see details about the meter types and meters associated with the Meter processor along with their current values, see Inspect Meter Types and MetersInspector

  • A preview Preview section showing which shows what the input and output data looks like and can be used for testing the solution.

...

In the Meter key field above the settings in the Configuration tab, an automatically created Meter key will be displayedWhen meter processor is added to a stream a unique Meter key is created and is displayed in Configuration tab in a Meter key field. This key is unique for each per Meter processor, and is one of the parameters used when creating meters using the APIs, see Managing Meters with the API Reference , and next to the field is a copy.png Copy button that you can use to copy the key when creating meters.

Note!

If you import a stream with a Meter processor which is a duplicate of an existing stream, a new Meter key willl will be generated to ensure they are unique. The meters attached to Meter processors are not imported when importing a stream.

The Configuration tab contains the following settings:

...

The Meter Processor must have at least one guiding rule configured. You can add additional guiding rules by clicking the add-guiding-rule button at the bottom of the configuration screen. The maximum number of guiding rules is 10. Since guiding rule are executed based on the order they are defined, it is possible to re-order guiding rules by dragging them up and down.

Each guiding rule contains the following settings.

Setting

Description

Guiding rule

Name

Enter an intuitive name for the guiding rule in this field.

Condition setting

Select if you want to define customized conditions for the rule or not by selecting either No conditoncondition or Custom condition.

If you select No condition, nothing more is required, but if you select Custom condition, a new section called Condition n will appear that you can expand and enter any conditions you want to be met for the usage to be countedmetered:

condition2.png

Each condition is configured with three settings:

  • Field - In this drop-down-list you select a field in the usage data that you want to base the counting metering on. You can either select an existing field or create a new field by entering a new field in the Add Field field and clicking If the desired field is not visible in drop-down, you can use Add Field field in drop down and click on the + button.

  • Type of field - Select the field type in this drop-down-list; string, number, or boolean

  • Value - Enter the field value that you want to be matched for usage countingare expecting for the usage calculation.

For example:

Field: location download status
Type: string
Value: Bahamas complete

The field matching is case-sensitive. The name of the condition will now be converted to show your configuration which will make it easier to see the configured condition even after collapsing it.

You can configure additional conditions by clicking on the add-condition.png button at the bottom of this section. If you have more than one condition, you can select to have either AND as a separator or OR, but not a combination of the two.

If the usage data record does not match the condition and is filtered out then it will be evaluated against the next guiding rule, if configured.

Category to match

Select which category you want to count aggregate usage for in this drop-down.

The Meter Processor is referring to categories instead of individual Meter Types which provides you with the possibility to add, remove, or update Meter Types whithout without having to update the configuration of the Meter Processor.

All existing categories configured in Meter Types will be displayed, see Creating Meter Types.

If the usage data record does not find the meter available in this category then it will be evaluated against the next guiding rule, if configured.

Group by

Group by n

If you want to group the To get the breakdown of the metered usage based on a specific field, for example regiondownload type in streaming service (movie, show or season), click on the Group by n drop-down.

group-by.png

In this drop-down-list you can select the field(s) you want to group the usage by. You can either select an existing field or create a new field by entering a new field in the Add Field field and clicking If the desired field is not visible in drop-down, you can use Add Field field in drop down and click on the + button. The maximum number of fields you can add for each Group by n section is 5.

You can enter several Group by n sections by clicking on the Add group by button. The maximum number of Group by n sections is 5.

For output of “group by” configuration, see Execution of Usage Metering Streams

Other operations

If you want to perform other operations, send additional information together with your metered record to downstream system then you can click on the Add operation button to display a section for defining operations that you want to be made:

operations.png

For output of “other operations” configuration, see Execution of Usage Metering Streams

Operation

Select which type of operation you want to perform:

  • Carry first - Will pick the value of the stated field from the first record where it occursinput record matches the meter.

  • Carry last - Will pick the value of the stated field from the last record where it occursmatches the meter.

Field

Select the field you want to perform the Carry first or Carry last operation on.

You can either select an existing field or create a new field by entering a new field in the Add Field field and clicking If the desired field is not visible in drop-down, you can use Add Field field in drop down and click on the + button.

Flush By

The Flush by setting determines when flush happens, that is when the aggregated output data records are sent to downstream systems. You have two options;

  • Period end - If you select this option, all the meters will be flushed according to and reset when the current period has ended. The period end is determined by the Reset schedule defined for each meter type, see Creating Meter Types.
    If the meters are flushed by Period end, the periodStart is initially set to the creation time of each meter, and the periodEnd is calculated based on the Reset schedule of the respective meter type.

    To move the meters to their next period when meters are flushed, the periodEnd becomes the new periodStart, and a new periodEnd is calculated based on the meter type Reset schedule.

  • Stream execution - If you select this option, all meters will be flushed and reset at the end of stream execution, see Execution of Usage Metering Streams for further information about stream execution considerations.
    If the meters are flushed by Stream execution, the periodEnd of the flushed meter is set to the time of the flush. The periodStart of the meter in the stream is also set to the time of the flush, and the periodEnd is calculated using the meter type Reset schedule.

Meters that have passed their periodEnd will be flushed at the beginning of the stream execution.

Preview

Click on the preview.png to see a preview of the Input and Output data in the left part of the Meter dialog.

...

  • Input data: Table, tree

  • Output data: Table, tree

The preview is generated using a fresh state of meters ie, it does not matter what is value of the meter in system, preview always uses the fresh state of meters.

Preview functionality works best with limited set of meters and meter types. If there are more than 200 meters or meter types then preview is generated by selecting random 200 meters and meter types and only 10 last updated meters are displayed in the output.

The log tab helps with debugging of issues which may occur due to incorrect fields or guiding rules. The log tab shows the number of records that will be sent to data correction because they have not matched any meter or missing mandatory input fields.