- Property Manager name: Aggregated Reporting
- Behavior version: The
v2023-01-05rule format supports theaggregated_reportingbehavior v1.2. - Rule format status: GA, stable
- Access: Read/Write
- Allowed in includes: No (temporarily)
Configure attributes for your custom aggregated reports. You can configure up to four attributes.
| Option | Type | Description | Requires | |
|---|---|---|---|---|
enabled | boolean | Enables aggregated reporting. | {"displayType":"boolean","tag":"input","type":"checkbox"} | |
report_name | string | The unique name of the aggregated report within the property. If you reconfigure any attributes or variables in the aggregated reporting behavior, update this field to a unique value to enable logging data in a new instance of the report. | {"displayType":"string","tag":"input","type":"text"}{"if":{"attribute":"enabled","op":"eq","value":true}} | |
attributes_count | number (1-4) | Select the number of attributes by which your report is grouped. You can add up to four attributes. | {"displayType":"number","max":[4],"min":[1],"tag":"input","type":"range"}{"if":{"attribute":"enabled","op":"eq","value":true}} | |
attribute1 | string (allows variables) | Select a previously user-defined variable to be an attribute for the report. The values extracted for all attributes range from 0 to 20 characters. | {"displayType":"string","tag":"input","type":"text"}{"if":{"attribute":"enabled","op":"eq","value":true}} | |
attribute2 | string (allows variables) | Select a previously user-defined variable to be an attribute for the report. The values extracted for all attributes range from 0 to 20 characters. | attributes_count ≥ 2 | {"displayType":"string","tag":"input","type":"text"}{"if":{"op":"and","params":[{"attribute":"enabled","op":"eq","value":true},{"attribute":"attributesCount","op":"gte","value":2}]}} |
attribute3 | string (allows variables) | Select a previously user-defined variable to be an attribute for the report. The values extracted for all attributes range from 0 to 20 characters. | attributes_count ≥ 3 | {"displayType":"string","tag":"input","type":"text"}{"if":{"op":"and","params":[{"attribute":"enabled","op":"eq","value":true},{"attribute":"attributesCount","op":"gte","value":3}]}} |
attribute4 | string (allows variables) | Select a previously user-defined variable to be an attribute for the report. The values extracted for all attributes range from 0 to 20 characters. | attributes_count is 4 | {"displayType":"string","tag":"input","type":"text"}{"if":{"op":"and","params":[{"attribute":"enabled","op":"eq","value":true},{"attribute":"attributesCount","op":"eq","value":4}]}} |