Reports

The Reports feature in CPAM provides tools to generate, manage, and analyze system data through a variety of customizable report types.

Reports are helpful for tracking system performance, user activity, and service usage, enabling informed decision-making and proactive issue resolution.

Dashboard

The Dashboard section provides a quick overview of your active and scheduled reports, offering easy access to view, create, and manage dashboard reports.

  1. Click Reports: When you click Reports in the navigation menu, the Dashboard section opens.

  2. Active Dashboard Reports: If there are active reports, they are listed on the Dashboard page.

  3. No Active Reports: If no dashboard reports are currently active, a message is displayed: "No active dashboard reports."

If you already have active dashboard reports, you can take action on them directly from the Dashboard page. The following actions are available:

Viewing a Report

Click on View to see the details of the active report.

Editing a Report

Click on Edit to modify the report's schedule or settings. Once you click it, a pop-up opens, allowing you to edit the following details:

  • Name: Modify the name of the report.

  • Interval: Change the frequency of the report (Daily, Weekly, Monthly).

  • Activate: Optionally, you can activate or deactivate the report without deleting it. When deactivated, the report no longer runs or appears in the active list.

Additionally, if you click Edit Report on the pop-up, you are able to modify the following settings:

  • Report Type: Choose a different report type from the available options.

  • Report Filters: Adjust the filters applied to the report.

Once you have made the necessary changes, click Save to apply them.

Deleting a Report

When you click on Delete to remove the report a confirmation pop-up appears:

"Are you sure you want to delete the report: NAME OF THE REPORT?"

From here, you have the following options:

Confirm: Click to permanently delete the report.

Cancel: Click to cancel the deletion and return to the previous screen.

To create a new dashboard report:

  1. Click Add Dashboard Report.

  2. Three content forms appear, allowing you to configure the new report:

    Dashboard Options

    In here you can define the basic settings for your report:

    • Name: Provide a name for the dashboard report.

    • Limit: Set a limit for the data that should be included in the report (defaults to 0).

    • Interval: Daily, Weekly or Monthly.

    Select Report

    Allows you to choose the type of report to generate.

    Select Report Filters

    Enables you to refine the data in your report by applying specific filters. After selecting a filter, an input field appears beneath it for entering or selecting the value for that filter.

    You can choose more than one filter at a time.

  3. After filling in the necessary fields in the containers, two options appear below:

    • Add: Click to create the new dashboard report based on your selections.

    • Preview: Click to generate a preview of the report before finalizing it.

If you want to activate a previously created or scheduled dashboard report:

  1. From Dashboard, locate the list of Scheduled Reports.

  2. Click on the report name to activate or view its data.

Scheduled Reports

The Scheduled Reports section in CPAM allows users to schedule reports to be generated automatically at specified intervals. This ensures that reports are consistently delivered without the need for manual intervention.

In this section, users can view existing scheduled reports, create new ones, and export the reports in your preferred format (CSV or XML).

To access the Scheduled Reports:

  1. Click on the Scheduled Reports button in the navigation menu.

  2. A table appears displaying the Scheduled Report List.

To create a new scheduled report, click New Report. This opens the same configuration options as Add Dashboard Report, but without the Dashboard Options forms.

After completing the report configuration, three options are available:

  • Preview: Click to preview the report before finalizing it.

  • Schedule: Click to schedule the report with the specified options.

  • Export: Click to export the report.

Scheduling a Report

When you click Schedule a pop-up opens with the following configuration options:

  • Name: Enter the name for the scheduled report.

  • Select Format: Choose the format for the exported report (CSV or XLS).

  • Frequency: Select the frequency at which the report should be generated (Daily, Weekly, Monthly).

  • Start Date: Set the start date for the scheduled report.

  • Report Distribution List: Define a list of recipients for the scheduled report.

Once the configuration is complete, you can either:

  • Cancel: Close the pop-up without scheduling the report.

  • Schedule Report: Finalize the scheduling and generate the report based on the defined options.

Exporting a Report

When you click Export a pop-up opens with the following options:

  • Name: Enter the name of the report to be exported.

  • Limit: Set a limit for the data included in the exported report (starts from 0).

  • Select Format: Choose the format for the exported report (CSV or XLS).

  • Start Date: Set the start date for the export.

  • End Date: Set the end date for the export.

Once the configuration is complete, you can either:

  • Cancel: Close the pop-up without exporting the report.

  • Export Report: Finalize the export and generate the report in the selected format.

The Scheduled Report List provides a table of all active and upcoming scheduled reports. The columns in the table are as follows:

  • Name: The name of the scheduled report.

  • Interval: The frequency at which the report is scheduled (Daily, Weekly, Monthly).

  • Next Execution: The date and time of the next scheduled execution of the report.

  • Active: Whether the report is active or inactive.

  • Type: The type of report scheduled.

  • Actions: Options for managing the report, such as viewing, editing, or deleting it.

If you already have scheduled reports, you can take action on them directly from the Scheduled Report List.

The following actions are available:

View

Click View to see the details of the scheduled report. This allows you to quickly view the content of the scheduled report without making any changes.

Edit

Click Edit to open a pop-up with the following options:

  1. Schedule Options: In this section, you can modify the following details:

    Name: Change the name of the report.

    Interval: Modify the frequency of the scheduled report (Daily, Weekly, Monthly).

    Activate: Optionally activate or deactivate the report, stopping its execution while keeping it available in the system.

    Report Distribution List: Define or modify the list of recipients for the scheduled report.

  2. Edit Report: After updating the schedule options, click Edit Report to modify the following:

    Report Type: Change the report type.

    Report Filters: Modify the applied filters for the report.

Once all changes are made, click Save to apply them.

Delete

To delete the scheduled report, click Delete. A confirmation pop-up appears with the message:

"Are you sure you want to delete the report: NAME OF THE REPORT?"

You can either:

Confirm: Click to permanently delete the report.

Cancel: Click to cancel the deletion and return to the previous screen.