Entity Group

EntityGroup [Schema]

The entity reporting group. Represents a logical output element within the report. Used to select and iterate over entities during the report generation process.

Name Type Required Description
Condition Query element of type:
no The exclusion conditions. Allows for the specification of exclusion condition checks.
Filter Query element of type:
no The filter rules. Allows for the specification of entity filter expressions.
Output Query element of type:
no The output expressions. Allows for the specification of report output expressions.
Order Query element of type:
no The order expressions. Allows for sorting matched entities.
Group Query element of type:
no The sub entity groups. Allows for generation of hierarchical report elements.
GroupName xsd:string
Pattern: [A-Za-z0-9:]*
no The group name. Used to name the containing report element generated for the entity group. If omitted, no containing element is created and all sub elements will be appended to the containing parent node.
ItemName xsd:string
Pattern: [A-Za-z0-9:]*
no The item name. Used to name any matched entity report elements. If omitted, no entity level element is created and all outputs will be appended to the containing parent node.
Selector xsd:string
Pattern: [a-zA-Z0-9-\/\[\]-]+$
no The entity selection URL. Used match entities for the owning group. Follows the URL pattern used across the API. For Example: /Employer/ER001/Employees will match all employees under the employer with a unique key of ER001.
UniqueKeyVariable xsd:string
Pattern: \[[A-Za-z0-9]+\]
no The variable name to store the matched entity unique key during the report iteration. If specified, the unique key value will be applied to the named variable as the report executes any sub groups.
LoopExpression xsd:string no The loop expression. Enables options for looping over the matched entities.