Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Insert excerpt
License
License
nameLicensing Information The feature described in this documentation is optional and might not be part of the edition covered by your company's license.
nopaneltrue

When you double-click the meter processor function, the Meter dialog opens. This dialog consists of three different parts;

...

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 condition 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 metered:

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 metering on. 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 are expecting for the usage calculation.

For example:

Field: download status
Type: string
Value: 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 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 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

To get the breakdown of the metered usage based on a specific field, for example download 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. 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 Flushing of Metered Record

Other operations

If you want to 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

It is allowed to have maximum 10 other operations in a guiding rule. For output of “other operations” configuration, see Flushing of Metered Record

Operation

Select which type of operation you want to perform:

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

  • Carry last - Will pick the value of the stated field from the last record matches the meter.

Field

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

If the desired field is not visible in drop-down, you can use Add Field field in drop down and click on the + button.

...

This setting impacts the when flush is performed and calculation of next metering period. For more information see, Meter Reset in Flushing of Metered Record and Real-time and batch execution inExecution of Usage Metering Streams.

...