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.

System Administrators have inherent permissions to manage reports. Internal Users require the additional MANAGE_REPORTS permission. System Admins and permitted users can use the Reports menu to do the following:

Navigate to Reports to view a list of all reports or the dashboard.

Report List

The Report List contains all available reports in a table format containing:

  • Report: The name of the report

  • Type: The category or type of report

  • Status: Enabled or Disabled status

  • Created: The creation date of the report

  • Last Execution: The date the report was last run

  • Actions: Options to manage the report

Click on a report's name to access the Report View page that contains:

  • Details Tab: Report information, configuration, and metadata

  • History Tab: Execution history showing all past runs

  • Report Preview: Sample data from the most recent execution

Dashboard

Alternatively, reports with the Dashboard Display selection appear in the Reports > Dashboard page in a card-based layout. Each card shows:

  • Report name

  • Report period information

  • Most recent data

  • View Report button to access full details

  • Refresh button to re-run the report with current data

Download a Report

To download a completed report:

  1. Navigate to the report’s view page.

  2. Locate the execution you wish to download.

  3. Click Download next to the execution.

  4. The report file downloads in the selected format (CSV or XLS).

To create a report:

  1. Navigate to Reports > Report List.

  2. Click Create New Report.

  3. Select a report from the list.
    The Report Configuration opens.

  4. Complete the Report Configuration.

  5. Click Create Report.

Use the following table to understand the Report Configuration fields:

Field Description
Name

Provide a unique name to the report.
Report Period (if applicable)

Provide a time frame for the report using one of the following:

  • Last N Days: Reports data from the previous N days.

  • Previous Month: Reports data from the previous calendar month.

  • Previous Year: Reports data from the previous calendar year.

  • Current Month: Reports data from the current calendar month.

  • Current Year: Reports data from the current calendar year.

  • Custom Range: Allows you to specify custom start and end dates.
File Type

Choose the export format for the report:

  • CSV: Comma-separated values format

  • XLS: Microsoft Excel format
Distribution List Select or create an email distribution list to automatically deliver completed reports .
Schedule Report

Select the report's cadence:

  • Daily: Runs every day

  • Weekly: Runs once per week

  • Monthly: Runs once per month
Dashboard Display

Select if the report should appear in Reports > Dashboard or not.
Preview Button Click the Preview button to review your report before saving.

To modify an existing report:

  1. Navigate to Reports > Report List > Report you want to edit > Report View page.

  2. Click Edit on the Report Information section to modify the following:

    • Report name

    • File type

    • Distribution List

    • Display on dashboard

  3. Click Save to apply the changes.

To modify when and how often a report runs:

  1. Navigate to Reports > Report List > Report you want to edit > Report View page.

  2. Click Edit on Schedule to modify the following:

    • If the report is scheduled or only on demand.

    • Recurrence between daily, weekly, or monthly.

    • Schedule.

  3. Click Save to apply the changes.

To remove a report permanently:

  1. Navigate to Reports > Report List > Report you want to delete > Report View page.

  2. Click Edit on the Report Information.

  3. Click Delete Report.

NOTE:

Deleting a report cannot be undone. All report instances and execution history associated with the deleted report are removed from the system.

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

Accessing the Dashboard

  1. Click Reports in the Legacy UI: 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."

Managing 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.

Creating a New Dashboard Report

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.

Activating an Existing Dashboard Report

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.

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.

Creating a New Scheduled Report

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.

When 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.

When 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.

Scheduled Report List

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.

Managing Scheduled Reports

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.

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

Delete

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

  • Confirm: Click to permanently delete the report.

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