...
Insert excerpt | ||||||||
---|---|---|---|---|---|---|---|---|
|
When you double-click the meter processor function, the Meter dialog opens. This dialog consists of three different parts;
...
When meter processor is added to a stream a unique Meter key is created and is displayed in the Configuration tab in a Meter key field. This key is unique per meter processor, and is one of the parameters used when creating meters using the APIs, see Managing Meters with the API , and next . Next to the field is a Copy button that you can use to copy the key when creating meters.
Note!
If you import a stream with a meter processor which that is a duplicate of an existing stream, a new Meter key will be generated to ensure they are unique. The meters attached to meter processors are not imported when importing a stream.
...
The meter processor must have at least one guiding rule configured. You can add additional guiding rules by clicking the button at the bottom of the configuration screen. The maximum number of You can configure up to 10 guiding rules is 10. Since guiding rule rules are executed based on the a defined order they are defined, it is possible to re-order guiding rules them by dragging them up and down.
...
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: Each condition is configured with three settings:
For example: Field: download status 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 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, the download type in a streaming service (movie, show, or season), click on the Group by n drop-down. In this drop-down-list Here you can select the field(s) you want to group the usage by. If the desired field is not visible in the drop-down, you can use Add Field field in the drop-down and then click on the + button to add your own. The maximum number of fields you can add for each Group by n section is 5. You can enter several add up to 5 Group by n sections by clicking on the + Add group by button. The maximum number of Group by n sections is 5. For output more details of “group the “Group by” configuration, see Flushing of Metered RecordRecords |
Other operations | |
If you want to send additional information together along with your metered record to downstream system then systems you can click on the Add operation button to . This will display a section for defining the operations that you want to be made:carried out. It is allowed to have maximum 10 other you can add up to 10 operations in a guiding rule. For details of the output of “other operations” configuration, see Flushing of Metered RecordRecords | |
Operation | Select which type of operation you want to perform:
|
Field | Select the field you want to perform the Carry first or Carry last operation on. If the desired field is not visible in the drop-down, you can use the Add Field field in the drop-down and then click on the + button to add your own. |
To view all guiding rule rules together in a table format, click on the View all button on the top right of guiding ‘guiding rules.
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 - This option is used when you want to aggregate over period of time, usually in sync with a billing cycle. If you select this option, the meters will be flushed and reset when the current period of the meter has ended. The period end of the meter is determined by the Reset schedule defined for the respective meter type.
Stream execution - This option is usually commonly used when testing the usage metering solution with integration and when you want to output the metered record from the meter processor immediately. If you select this option, all meters will be flushed and reset at the end of stream execution, see . See Execution of Usage Metering Streams for further information about stream execution considerations. This option is not available for real-time streams.
This setting impacts when the when flush is performed and the calculation of the next metering period. For more information see, Meter Reset in Flushing of Metered RecordRecords and Real-time and batch execution inExecution of Usage Metering Streams.
...
The preview is generated using a fresh state of meters ie, it . It does not matter what is the value of the meter in the system is, it always take takes the meter’s initial state.
Preview functionality works best with a limited set of meters and meter types. A maximum of 200 entries will be shown in the preview. 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 more entries exist the preview will show a random selection of entries. Only the 10 most recently updated meters will be displayed in the output.
The log tab on output data helps with the debugging of issues which that 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 because they are missing mandatory input fields.