Introduction

Imagine effortlessly transforming raw data into insightful reports, whether they are straightforward summaries or intricate analyses.
SGBox empowers users with a vast array of predefined templates, streamlining the report generation process and saving valuable time.

VERSATILE OUTPUT
One of the standout features of the SGBox report system is its output capabilities: reports are generated in HTML format, enhancing user engagement through interactivity.
One of the system’s features is the ability to automatically adapt reports to different page sizes and orientations, perfectly supporting A4, A3, and full-screen formats.
Moreover, they are readily printable, ensuring accessibility even offline.

To provide a glimpse into its functionality, let’s explore the workflow of the SGBox report system, illustrated in the image below.

Main Concept

Let’s delve further into the different panels of the module and enhance their descriptions to provide a clearer understanding of their functionalities:

Configuration

The configuration allows to set or customize the system behavior for several elements like Logs Retention, Notification Recipients, Tenant Management type and more.

Catalog

The catalog panel is the heart of the SGBox report system, empowering you to effortlessly generate, schedule, and distribute reports. It functions as a central hub for all your reporting needs.

Archive

The archive panel serves as a centralized repository for all the reports generated by the system.
It provides you with a well-organized and easily searchable collection of your past reports.

With the report archive, you can conveniently access, review, and manage your historical data. This streamlined approach saves you time and effort when retrieving or deleting specific reports from the archive.

Schedule

The schedule panel offers you an efficient way to manage and control your report schedules directly from the application.
It allows you to oversee and modify existing schedules effortlessly. Thanks to this feature, you can ensure that your reports are automatically generated at the intervals you’ve set, ensuring the seamless and timely delivery of vital information.

The schedule feature not only optimizes your workflow but also minimizes the need for manual intervention, putting you in control of your time and resources.

Schedule Manager (master tenant)

The schedule manager panel serves as your centralized control center for managing all report schedules.
It provides a view of your scheduling activities, consolidating information from multiple tenants into master tenant.

With the schedule manager, you gain a comprehensive perspective on your report schedules, enabling you to efficiently monitor, adjust, and coordinate all scheduling activities.
This centralized approach simplifies the management process and enhances your overall control over report generation.

SUMMARY

This SGBox module offers the following panels to optimize your report management:

• The Configuration lets you to define the Report System behavior.
• The Catalog enables seamless report generation and scheduling.
• The Archive acts as a well-organized repository for storing and accessing historical reports.
• The Schedule streamlines automated report generation, ensuring timely and accurate delivery.
• The Schedule Manager provides a centralized platform for managing and overseeing all report schedules.

First access

To access any panel of the RS module, you’ll have to click on the printer symbols in the SGBox side menu, as shown below.

To access a specific panel, simply click on the corresponding entry in the submenu.

RS Configuration

The configuration section can only be accessed by a SGBox Administrator.

This panel allows to configure how the Report System behavior. Divided in two sections, in the first it will be possible to specify general options, that is, those options that impact the whole SGBox Instance. The second section will look different depending on the instance environment (i.e. Manager, Single Tenant, etc.) ad allows to specify Tenants specific configuration.

Let’s see the sections in detail

Configuration options

In this panel you can configure:

• Logs history retention period – This option determine how long the scheduling Logs will be kept. The default value is 30 days.
• Archived reports retention period – This option determine how long the generated reports will be kept, in the Report Archive, before being cleaned up. The default value is 180 days.
• Notification email subject – This option allows to specify a custom Notification Email subject. The default subject is Report System Notification – <your_report_name>. The subject of the email can be customized with any text of your choice, as well as integrated with one or more of the following placeholders:
  • [date] – to insert the execution Date
  • [time] – to insert the execution Time
  • [tenant] – to insert the Tenant Name
  • [title] – to insert the Report Title

NOTE: Usually notification emails will be sent each time a report is generated, but It is possible to choose, individually for each report or report schedule, if you want to be notified on the report generation.

Tenant(s) management

This section shows the current management state and the configured notifications recipients for each Tenant and allows to change Tenants specific options.

Management option

When a Tenant is Centrally managed means that reports schedulation is in charge to an Admin on the Manager Instance.
When the schedulations takes place, the reports will be automatically dispatched to the proper Tenant and will be avalable in the Report Archive panel.

On the other hand, when a Tenant is set as Locally managed means that reports schedulation is totally in charge to the Tenant owner.

There is a third option to delegate the management of one or more reports to the customers, the Share Mode (see the Share Mode chapter below).

This section looks different when shown in a Manager instance, in a Tenant instance or in a Single Tenant.
Let’s see the how appears on a Master Instance first.

Manager instance

When running on a Manager Instance an Administrator can configure both the management type and the recipients that will receive email notifications for that Tenant.

Multiple criteria configuration

There are two methods to set Tenants Criteria, which one to choose depends on the number of impacted Tenants.
If you need to update several tenants setting the same management type or adding (or replacing) Tenant’s recipients with a new recipient set, you can use the Multiple Criteria configurationOperating the Multiple Criteria configuration toggle switch [ 1 ] will show up a hidden section that allows to specify the common criteria that will be applied to all the selected Tenants.

• To set the Reports Management type, just click on the desired option on the desired tenant row. Select one or more recipients from the
• To change the Notification Recipients, select one or more recipients from the dropdown box and set the Override Recipients switch to determines if the specified recipients will override currently defined recipients or if they will be added to the currently defined ones.

Once the common Criteria has been configured, they can be applied to the Tenants in the following ways:

• Operating the Select all toggle switch (2), this will select all listed Tenants.
• Using the Search box (3) to automatically select all the Tenants matching the search.
• Manually select the tenants to apply the Criteria to, by clicking on the Tenant name (that will turn green).

NOTE: The Notifications Recipients that can be configured in the Multiple criteria configuration dropdown box, belongs to the manager instance users (usually Administrators or Service Providers).
This can be useful for an administrator to get feedback on what is happening with the Reporting System schedules.

Tenant by Tenant

If you want to be more selective, you can change the options of one or more Tenants by manually setting the desired criteria, and save all changes at once.
This can be useful for an administrator to get feedback on what is happening with the reporting system schedules.

Tenant or single tenant instances

The Tenant management for individual Tenants of a multi-Tenant or of a Single Tenant instance is much more simplier.
We have to configure only the Recipient that will be notified.

Manage Tenant’s recipients

Regardless of the environments (Manager, Tenant or Single Tenant) the way to manage a Tenant Notification Recipents list is always the same: click the edit icon under the Action column for the desired Tenant.
By clicking the icon, a new sub-section will be displayed to show the Current Recipients and the Available Recipients for the selected Tenant.

1. Add recipient: select one or more recipients from the Available Recipients table, and click the list add icon
2. Remove recipient: select the recipients you want to remove from the Current Recipients table and click the list remove icon

NOTE: If the manager  text is present on the right of a recipient means that the User/Recipient does not belong to the Tenant but is from the manager instance (i.e. a supervisor).
This kind of recipients can be removed as well as any other recipient.

RS Catalog

Upon selecting the “Report Catalog” entry from the menu, the modules of the reports will be displayed in an organized and user-friendly format, like the one below.

Click on the desired module entry and the reports will be displayed in table format.
This table presents a structured overview of the reports available within the selected module, providing essential information such as report names, description and other relevant data.

The Catalog’s table view allows users to quickly locate and access the desired reports, making it easy to retrieve specific information or analyze data from different perspectives.
Users can sort, filter, or search within the table to narrow down their search and find the exact report they need.

1. Actions symbol – clicking on it allows you to choose which action to perform on the report (generation or scheduling)
2. Share mode symbol (master tenant) – clicking on it allows you to choose a different share mode for the report

NOTE: You will not be able to see the Incident Management (IM) report’s entry if the latter is not active on your tenant.
If the IM entry appears but there is no report inside it, it’s possible that the problem is linked either to the Share Mode or to the fact that the current user is not present in any IM group.

Generate report

The following section explains how to generate a report from the RS Catalog panel.

Click on the printer symbol over the report you want to generate, a window like the one below should appear, it serves as a form where you can provide and select the necessary data or parameters for generating the report

1. Generated report name – Enter a name to identify the report in the Archive once it’s generated (default is the report’s original name)
2. Report options – By hovering the information icon, a window similar to the one shown in the image below should appear, explaining what each option does
3. Reference date – Enter a valid date in order to select report’s data from this date backwards (default is today’s date at midnight)
4. (Master Tenant) – Running Tenant(s) – Choose the Tenant(s) where the report will be executed and eventually archived
5. Category data – Select at least one category item on which the report will be run
6. Call to actions – Click on the button to initiate the report generation process

Report Options

Once the generation is completed, the window above should close and a green banner is going to slide if the generation didn’t encounter any errors, otherwise the banner’s color will be red.

SUMMARY

• Choose a report from the catalog
• Click on its printer symbol
• Enter your report requirements
• Click GENERATE

Schedule report

As for the generation process, here are listed the steps used to schedule a report.

Click on the printer symbol over the report you want to schedule, a window like the one below should appear, it serves as a form where you can provide and select the necessary data or parameters for scheduling the report.

Click on the “SCHEDULE REPORT” tab

Follow the same steps listed in the “Generate report” section

1. Scheduled report name – Enter a name to identify the report in the Archive once it’s generated (default is the report’s original name)
2. Report options – By hovering the information icon, a window similar to the one shown in the image below should appear, explaining what each option does
3. Schedule date – Enter a valid schedule date when the report will start its generation
4. Execution interval – Enter a valid generation interval (daily, weekly, monthly, …) along with the schedule status (active/suspended)
5. (Master Tenant) – Running Tenant(s) – Choose the Tenant(s) where the report will be executed and archived
6. Category data: Select at least one category item on which the report will be run; in this case, the “select all” switch in the top-left corner of the table, when checked, will retrieve ALL the category data at the report’s generation time.
   This means, for example, if I plan a report and then add a new class, when the generation starts it will also take this last class into consideration
7. Call to actions: click on the button to initiate the report scheduling process

Report options

Once the scheduling is completed, the window above should close and a green banner is going to slide if the scheduling process didn’t encounter any errors, otherwise the banner’s color will be red.

SUMMARY

• Choose a report from the catalog
• Click on its printer symbol
• Go to the “SCHEDULE REPORT” tab
• Enter your schedule requirements
• Click SCHEDULE

Custom Report

The custom reports are available on the Tenant’s catalog, under its namesake module.

There are only two available reports to choose from

• Executive: contains the default charts or the charts for the categorized parameters
• Detailed: contains the executive version and the detailed events table (limited)

Upon selecting one of those two, the last thing to do is to choose the custom report to generate / schedule and its specific options (if detailed).
It follows the same behavior of the previous sections.

1. Custom Report – Choose which template the report should be generated, the recommended choice is to select one template at the time
2. (Detailed) – CR Options – By hovering the information icon, a window similar to the one shown in the image below should appear, explaining what each option does

Custom options

As for the normal reports, once the process is completed, the window above should close and a green banner is going to slide if the process didn’t encounter any errors, otherwise the banner’s color will be red.

SUMMARY

• Choose a report from the catalog
• Click on its printer symbol
• Enter your report requirements
• Click GENERATE / SCHEDULE

Share Mode

Available only for an admin on the Master Tenant

Report sharing mode is a very useful way to distribute reports to managed Tenants, allowing them to access only certain reports.
The different sharing methods with their descriptions are listed below

• SOC_ONLY – reports visible exclusively on the Master Tenant [uneditable]
• SOC – the generation/scheduling process will be accessible exclusively on the Master Tenant.
  Other Tenants will only view the report’s from the archive
• PUBLIC – reports visible to all users and tenants within the application

Two more sharing methods can be found on the system, but only if a client request a report directly to the SGBox team

• CUSTOMER – works like the SOC mode [uneditable]
• CUSTOM – works like the PUBLIC mode [uneditable]

To update a share mode, you have to be an admin on the Master Tenant

Click on the share symbol over the report you want to update, a window like the following should open

1. Change the share mode
2. Save

If the report has been scheduled on a by a Tenant user, then a window like the following will open

As evident from the image above, altering the sharing mode of an already scheduled report will result in the permanent deletion of the schedule on the Tenant

RS Schedule Manager

Available only on the Master Tenant

The schedule manager panel will look like this once you schedule some reports from the Master Tenant

1. Running Tenant(s) – Clicking on the symbol, a window with the list of tenant in which the report runs and eventually get stored will open
2. Schedule Actions
   – Edit – change the schedule data
   – Delete – delete selected schedule (confirm required)

RS Schedule

As for the Schedule Manager, this panel is used by the Tenant(s) user to manage their own schedules

The panel looks like the following

The actions are the same as the Schedule Manager one

RS Archive

1. Click on the module and the report’s original name entry
2. Search the report you’re interested in, every panel has a sorting system of it’s own
3. Archive Actions
   – Preview – open the report in a new SGBox tab
   – Delete – delete the report (confirmation required)

Report preview

The page that will open should look like this

1. Page format – click on any entry to change the report’s page format
2. Print report – prints the report in PDF format

For a correct document printing is recommended to use Google Chrome browser for compatibility reasons with the technology used to render the report

Print dialog

if you want to print a PDF document, then you will need to adjust the browser settings in order to print the report in a correct way

1. Layout – adjust the report page to the desired format
2. Margins – adjust the margins in order to remove unnecessary space to the page

Other adjustments:

• Scale: eventually adjust the scale
• Headers and Footers: eventually remove those items

Click save and your report will be downloaded on your system