Formula - Count
Tip
An example of real-life usage, use the Count function to get an alert if an order has less (or more) then X order rows
The count( )
Formula function is a pretty straight-forward and self-explanatory function. It is used to return the number of unique values extracted from the Content part.
Quick example
Let's get you started with the following example: For other and more advanced examples, scroll down on this page to the Examples section.
Input | Expression | Result |
---|---|---|
|
|
2 |
Text Data | count expression | Unique values |
Features
The count( )
function can be used on any content, as long as data is returned from the Content
part. It doesn't matter if the content parameter a plain text or any valid Formula Plugin function. Please notice that the number returned represents the unique count of the extracted values; more on this later below.
- Return the count of extracted values from the Content.
- It returns the count of the unique values from Content.
- It can be applied on the Content part that returns data; Like jsonpath, xpath functions or even a plain-text, review the Formula user guide for the complete list of functions.
Important
This plugin loads the entire message into RAM, so make sure to apply this function only on small messages..
How to use
The Content part should contain data to use the count function, (otherwise, it will fail, and you will end up with nothing as the result). But first and foremost, you must configure the Formula plugin:
- Select Formula as the expression type plugin.
- Write down the expression to use in the 'Expression' text area.
- Input Content as a parameter to the function.
Syntax
Use the count function with any of the following parameters:
From Message Body:
count(body)
From Message Context:
count(context('MessageContextKey'))
Result from previous Formula operation
count(SomeOtherNestedFormulaFunction(Content))
Examples
Below, you will find different common examples of how to use the count function.
Body as Content
"Nodinite" is the message body text; By using the provided expression, the result is 1
.
e.g. count(body)
Message Body
Nodinite
Expression
count(body)
Context as Content
"Nodinite" is the value for the corresponding key "id", by using the provided expression, the result is 1
.
e.g. count(context('id'))
Message Context Value
Nodinite
Expression
count(context('id'))
Formula Function as Content
The message body is a JSON structure, and by using the provided expression, the result is 3
.
e.g. count(jsonpath('a[*].b', body))
Message Body
{a:[{b:'This'},{b:'is'},{b:'Formula Plugin'}]}
Expression
count(jsonpath('a[*].b', body))
Next Step
How to Add or manage Search Fields
How to Add or manage Log Views
Related
Expression Type Plugins are used in Search Fields
What are Search Fields?
What are Search Field Expressions?
What are Message Types?
What are Log Views?