You are viewing the documentation for Blueriq 17. Documentation for other versions is available in our documentation directory.

What is it for?

AQ_Aggregate_Count is used to count an Aggregate based on its metadata or custom metadata. It resembles AQ_Aggregate_Search that returns the actual aggregates instead of only the count

What does it do?

AQ_Aggregate_Count retrieves the number of found aggregates and stores this in an attribute.

Parameters

Parameter
Direction
Value
Description
Required
Aggregate typeInputModule element AggregateSelect the aggregate type to count.Yes
Target entityOutputEntity

Select an entity in which you want to store the aggregate count.

If this entity is a multiton, an instance is created for each time this service is invoked.

If this entity is a singleton, the aggregate count is overwritten each time this service is invoked.

Yes
Target attribute for aggregate countOutputAttribute of target entitySelect an attribute of the target entity on which attribute you want to store the aggregate count. This attribute must be singlevalued.Yes
Only count for latest versionsInputCheckbox, checked by defaultCheck when only latest versions of versioned aggregates are counted.No
Search criteriaInputStandard and custom metadata fieldsSpecify the search criteria, based on standard and custom metadata fields.Yes

Search criteria

The search criteria are all triples that adhere to the pattern <metadata><operator><value>. The value can be single or multi, depending on the operator. See the list below.

Operator
Used with metadata of type
Value can be
EqualsAll single-valued datatypesSingle value
Not equalsAll single-valued datatypesSingle value
Less thanAll single-valued datatypesSingle value
Less than or equalsAll single-valued datatypesSingle value
Greater thanAll single-valued datatypesSingle value
Greater than or equalsAll single-valued datatypesSingle value
LikeStringSingle value
Not likeStringSingle value
InAll multivalued datatypesMultivalued
Not inAll multivalued datatypesMultivalued

Events

This service uses one event for an exception:

  • Unauthorized: This exit is triggered when the user does not have one of the roles that is set on the aggregate definition.

Tracing

Counting aggregates is not traced, just like reading aggregates (using Service call type: AQ_Aggregate_Read).

Visual overview of aggregate concepts

Aggregate