Reports represent instances that have data exported from the CloudBlue Connect platform. Reports can be especially useful to extract required data and import it to external systems for further processing, such as billing and reconciliation operations.
Reports can be created via the Directory tab of Reports module. By using the provided report templates, the system generates a System report object. Such reports contain predefined report parameters that are selected via the aforementioned templates and that include corresponding export data.
Additionally, it is possible to export any data from the platform via Connect Reports SDK. Therefore, by following the provided instructions, Connect users can provide their custom templates and generate a Custom report. Custom reports may contain any of your specified report parameters and consequently can provide any information and your specified combination of data for the export operations.
Once a report instance is created, the system starts to process your report file. In case the report processing is successful, the system provides a report file in your specified format (JSON, CSV, or XLSX) and displays Ready in the report status. Thereafter, the system allows you to successfully download the report file.
The CloudBlue Connect platform also allows creating report schedule objects and customize schedule triggers. Therefore, the system will systematically generate report files based on your selected template and trigger configurations. Reports can be automatically created daily, weekly, or monthly.
The system enables Connect users to edit provided trigger configuration as well as report parameters after the schedule object is created. In addition, users can manually trigger their report schedule and generate required report files immediately.
Note that the system also enables you to disable or enable your created report schedules.
The following introduces, illustrates and describes all available report statuses on the Connect platform.
Pending: This state indicates that an export request is successfully submitted. Furthermore, this status indicates that the system starts generating a new report.
Deploying: This status indicates that a new report is being deployed on the Connect platform. From this particular state, the system decides if a report file is generated successfully. Thereafter, in case the report creation is successful, the system assigns the Ready status to this report. Otherwise, the report creation is failed and the system assigns the corresponding status to it.
Ready: This status is displayed in case the report creation process was successfully completed. Therefore, your report file is ready and it is available to download.
Failed: This state is displayed in case the report creation process is failed due to an error. Therefore, this report will not be available for download. Note that Failed status represents a terminal state, meaning no further actions with this report are required or available.
Access the following articles to learn more about the graphical user interface, available operations and API of the Reports module on the Connect platform: