Setup Reporting Configuration and Query
Table of Contents
Setup Reporting Configuration and Query
The RIO Education - Reporting Engine allows you to define the configuration and data query for your reporting.
Reporting Configuration
This is to define the report type and variant. To start with the setup:
- Switch to RIO Reporting Engine app.
- Click on the Reporting Configuration tab.
- Create a new configuration.
| Field | Description |
|---|---|
| Name | The identical name for a reporting configuration. |
| Report Type | The target report type. Please see Setup Reporting Picklist Value Set , for more details. |
| Report Variant | The target report variant. Please see Setup Reporting Picklist Value Set , for more details. |
Reporting Query
This is to define the data query of a file type for a report type. To setup a reporting query:
- Switch to RIO Reporting Engine app.
- Click on the Reporting Configuration tab.
- Click on the configuration record.
- On the Reporting Queries related list, click on the "New" button to create a new record.
There are 4 configuration settings:
Query setting
| Field | Description |
|---|---|
| Reporting Configuration | The related reporting configuration. |
| Report File Type |
The target file type. Please see Setup Reporting Picklist Value Set for more details. |
| File Section | The target file section. The value defined will be validated against the Export File Section defined for the Export File Type. |
Summarization setting
The setting for summarization feature.
| Field | Description |
|---|---|
| Data Holder Generation Query | Query that retrieves data to be summarized/generated onto the Reporting Data Holder object. The query format should be: <object name> [WHERE clause] For example: AnyObject__c WHERE AnyField__c = ‘Any Value’ ORDER BY AnyField__c The reporting engine will construct the full query based on the aggregation fields defined in the Export File Config. |
| Data Holder Generation Class Name | Optional. Specify a custom data holder generation class to override the default behavior. |
Denormalization setting
The setting for denormalization feature.
| Field | Description |
|---|---|
| Child Object Queries |
The child object queries to be included for the target object. This is required if you have denormalized child object column defined in the reporting field mapping. Separate each child query with a line break. The query format should be: <child relationship name> [WHERE clause] For example: AnyObjects__r WHERE AnyField__c = ‘Any Value’ ORDER BY AnyField__c For files with the "XML with Section" structure, multi-level sub-queries can be configured, allowing reporting across up to five levels of child relationships. For example the Target Object is Account: Contacts WHERE AnyField__c = ‘Any Value’ Contacts.hed__Program_Enrollments__r WHERE hed__Enrollment_Status__c = 'Full-time' |
Data Export Query setting
The setting for actual data export.
| Field | Description |
|---|---|
| Target Object Name | The target based object of which the data should be exported. This has to be the same as the one specified in reporting mapping. |
| Target Object Reference Field Name | The target based object record id field referenced in the query. The default is Id. |
| Report Export Query | The query that retrieves the data to be exported. |
| Reported Flag Field Name | Optional. The checkbox field that indicates a record has been exported. This helps to ignore a record in the next export. Please note that you will need to undo the checkbox manually if you would like rerun the reporting export. |
Report Export Query
You can define a query with an object that is different from the Target Object Name, as long as the query includes that Target Object Reference Field Name that refers to the same object.
For example:
| Target Object Name | Account |
| Target Object Reference Field Name | AccountId |
| Report Export Query | SELECT AccountId FROM Contact WHERE AnyField__c = 'A' |
Based on the configuration above, the reporting engine will:
- Query the contact records using the Report Export Query.
- Extract the AccountId from the contact records based on Target Object Reference Field Name.
- Query the related Account based on the AccountId extracted and generate the data file.