Exporting Report and Status Monitoring
Table of Contents
Exporting Report and Status Monitoring
The RIO Education - Reporting Engine uses both Reporting Export and Reporting Export Job to track the status of an export.
Initiate an export
To start initiate an export:
- Switch to RIO Reporting Engine app.
- Click on the Reporting Export tab.
- Select a reporting export record.
- Update the Status to Queue.
Calculate the expected files
When an export is requested, the Reporting Export's Total Expected Data Holder Generation and Total Expected Export are recalculated based on the Reporting Query defined.
| Field | Description |
|---|---|
| Total Expected Data Holder Generation | The count of reporting query with Data Holder Generation Query by the report file type and file section. |
| Total Expected Export | The count of all reporting query by the report file type and file section. |
Reset of export history
Please bear in mind upon the initialization of an export, the history of the reporting export will be reset. This includes:
- The Reporting Export's Level and Log Message.
- The attachment/files.
- The related Reporting Data Holder records.
- The related Reporting Export Job records.
If you would like to keep the history, please clone the reporting export record and initiate the export from the newly cloned record.
Stages of export
The reporting export has three stages.
| Sequence | Stage | Description |
|---|---|---|
| 1 | Data Holder Generation |
The reporting engine will query data based on the Reporting Query's Data Holder Generation Query and perform the summarization onto the Reporting Data Holder object. The completed jobs are tracked on the Total Data Holder Generated field. When the total matches the expected data holder generation, it will proceed to the Data Compilation stage. |
| 2 | Data Compilation | The reporting engine will query the data based on the Reporting Query's Report Export Query and compile a list of record ids to be exported in Data File Export stage. |
| 3 | Data File Export |
The reporting engine will start generating the reporting file based on the records found on Data Compilation stage. The completed jobs are tracked o the Total Exported field. When the total matches the expected export, the status of the Reporting Export will be set to Completed if there is no error. |
Status monitoring
The export is executed in asynchronous mode. Therefore, the status of the asynchronous jobs are tracked on the Reporting Export Jobs.
| Fields | Description |
|---|---|
| Name | The identical name for an asynchronous job. |
| Reporting Export | The related reporting export. |
| Apex Job Id | The Id for an asynchronous Apex job execution. |
| Job Type |
The type of execution. The supported options are:
|
| Start Time | The start datetime for an asynchronous Apex job. |
| End Time | The end datetime for an asynchronous Apex job. |
| Status |
The status for an asynchronous Apex job. The supported options are:
|
| Log Message | The logging details when an asynchronous Apex job failed. |