Reports
Mint Service Desk 3.4.2 user manual.
Basics
Agents can create, download and email reports about Tickets, Assets, Users and Contracts, or run SQL queries against the database. Reports can be shared with other users, except administrators.
IMPORTANT!
Saved reports take into account the permissions (context) of the user who created them. If an Agent shares a report with a person who does not have access to specific queues or ticket types, when generating the report, that person will see all tickets visible to the report author in the list. The author’s permissions are checked each time a new report is generated.
Creating and managing a report involves the following steps:
1) Report configuration: define the filters, data range, users with access and file formats (CSV, XLSX). You can also set email recipients. Click Save to store the configuration.
2) Report generation: generate the report from its saved configuration. The system records its status and generation date in the history.
3) View, download and send: after successful generation, view the report in the system, download it in the selected format or email it to the configured recipients.
4) Setting the report schedule: choose dates or intervals for recurring generation, such as daily, weekly or monthly. You can also email generated reports to selected recipients automatically.
The general description of the tabs can be found in the Tab Description section, while detailed information on creating a report is available in the Creating Report section. To learn more about creating schedules, visit the Creating Schedule section.
Tab Description
The main report screen is divided into three tabs:
- Reports (default screen): saved and shared reports.
- Report generation history: all generation attempts and their success or error status.
- Report schedule: schedules for generating selected reports and emailing them to recipients.
REPORTS
The main screen displays a list of created reports. By default, the table displays columns such as Name, Type, Creation date, Last generated. There are also columns with action buttons: Send, Generate, Download (in CSV or XLSX format) and Actions (Edit and Delete).
The buttons have these functions:
- Send - allows you to send the last generated report to the recipients defined in the report in the Recipients section (button is hidden if no email recipients are defined in the report configuration)
- Generate - used to generate a report based on the data contained in the configuration. Each click generates a new report and saves it in the history in the preview window.
- CSV/XLSX - buttons for downloading the report in the appropriate format (visibility of these buttons depends on the options selected in the Exports section of the report configuration)
- Edit - allows you to access the saved report configuration and make changes
- Delete - allows to delete the report configuration including all its history
Use “Search” to find reports in the fields selected under ‘Search by’ in ‘Set column properties’.
Click to choose which columns to display.
In ‘Set column properties’, select or clear the columns you want to show. Changes are saved automatically and remain in place when you leave the view.
Click ‘Creation Date’ to sort reports by their creation date. The icon shows ascending or descending order.
REPORT GENERATION HISTORY
This tab records report generation attempts. Tasks enter a queue. When several reports are generated at once, some may have ‘Waiting’ status until earlier tasks finish.
The table contains the following columns
-
Name - the name of the generated report
-
Messages - the column that indicates the contents of the error if the report generation failed
-
Creation Date - the date and time when a particular report was added to the generation queue
-
Generate started at - the date and time the report generation started
-
Status - the current status
- Waiting - generation waiting in queue (when multiple reports are generated at the same time)
- Success - generation was successful
- Progress - generation is still in progress
- Cancelled - the report was in the process of being generated, but the user aborted the action with the Cancel button
- Error - an error occurred and the report could not be generated
-
Action - the column that displays the Cancel button when the report is being generated. Clicking it will cancel the task
This tab does not refresh automatically. Use the refresh button in the top left corner of the table.
The “Search” field works as described for the Reports tab. Search toolbar
REPORT SCHEDULE
This section allows you to create a schedule for the automatic generation of saved report configurations. You can also configure the system to send the report as an attachment to specified email addresses after it is generated, with a corresponding title and message body. The history of each email delivery is saved in each schedule. You can download historical reports or resend them manually.
The main view is a table with the following columns:
- Name - The name given to the schedule.
- Is active? - Indicates whether the schedule is currently active. You can change this setting in the schedule’s edit view.
- Author - The creator of the schedule.
- Creation date - The date when the schedule was created.
- Last modification - The date of the last change to the schedule.
- Modification by - The author of the last modification.
- Last run - The date when the report was last generated.
- Last message - The last error message related to sending or generating the report (if an error occurred).
- Action - Buttons to edit and delete the schedule.
Creating Report
Click the button shown below to create a report.
The ‘Create report’ view opens.
Report data and access
Choose the data to include in the report:
- Tickets
- Assets
- Users
- Contracts
- SQL
The selected report type determines which fields and filters are available. Some fields, such as those in a ticket report, are selected by default. You can change this set.
The next section is “Can view”
Select the roles that may view this report.
The Filters section is below.
You can keep the default filters or change them. Each filter requires its corresponding field.
Removing the ‘Ticket type’ field also removes its filter. You can add a field without adding a filter. To add a filter, click Add filter.
Filters
In the drop-down list, after the basic fields, there is a section with custom fields.
Hover over a custom field to see its Ticket Type and Group.
The same information is available after you select a custom field.
In Export, choose the file format in ‘Export type’ and the language in ‘Default language’ to enable report downloads.
The Report groups section below Export groups tickets or assets by your chosen criteria. You can add up to five items.
Example of a report using Report groups:
In Report recipients, select who should receive the report by email.
You can click on button and select from the list of saved recipients:
Alternatively, click to add an email address.
Example: a ticket report
After filling in all the fields, click the button. The report configuration is now ready for generating a new report.
The following example creates a report for all tickets:
- assigned to ‘Mint Agent’
- created within the current week,
- having ‘In progress’ status,
- owned (created) by ‘MINT Customer’ user.
Select the report type in ‘Please select the type of report you want’.
Enter a ‘Name’, such as “Urgent Tickets”, in the lower part of the view. In ‘Fields’, choose the columns to include or keep the defaults.
Click ‘X’ next to a field to remove it. In this example, remove ‘Ticket type’.
The ‘Ticket type’ filter is also removed. Add a field and filter for the condition “owned (created) by ‘MINT Customer’ user”.
To add a new field click on the field located below.
Select ‘Company user’ from the list of available fields. You can add further fields while unselected items remain in the list.
The selected field appears in ‘Fields’.
To add a company user filter, click below the selected filters.
From the newly created ‘Filter fields’ list select ‘Company user’.
Click to add the filter, or to cancel.
The filter appears in the list.
Set the filters to find tickets:
- assigned to ‘Mint Agent’
- created within the current week,
- having ‘In progress’ status,
- owned (created) by ‘MINT Customer’ user.
Select the filter values shown below.
To remove a selected value, click ‘X’ next to its name. The ‘X’ on the right of a filter clears all its selected values.
The first method is used for deleting single position, while the second one will delete all of the selected options for the filter.
The report cannot yet be saved with ‘Save’: unused filters are outlined in red.
Delete those filters you don’t want to use by clicking button next to each of them.
Click button to create the report. Once you do that you will see a new position on the list in the ‘Report definitions’ view.
To change a saved report, click to open ‘Edit report’.
To delete the report, click and confirm with ‘Yes’.
SQL Reports
SQL Reports lets you query the Reports module database directly. Mint Service Desk displays the available records from the selected table. You can also email the generated report to a selected address.
Report Details
Click a report’s name to open its preview. The following example uses a ticket report.
After clicking, a new page opens.
The top bar contains the following buttons.
On the left side, you will find:
- Refresh: updates the view, for example after generating a report with Generate.
- Generate: starts a new report. When generation finishes, the report appears in Report History and Preview.
On the right side, you will find:
- Hide/Show Preview: shows or hides Preview.
- Hide History: shows or hides Report History.
- Download: opens the menu for downloading the latest report as CSV or XLSX, depending on the configured format. It is unavailable if no export format is configured.
The next section is Preview (initially open).
Preview shows the report selected in Report History, with the columns chosen in its configuration. The final Action column contains View, which opens the corresponding incident. The generation date appears in the top right corner. Use the search bar to find values.
The number of rows displayed is dependent on the settings in Admin → Settings → General → Reports under the Maximum number of rows in report preview field.
At the bottom, there is the Report History section.
Report History lists generated reports. By default, it shows only successful runs. Select Show full history to include statuses such as Cancelled or Error. Click Preview to inspect a historical report, or download it as CSV or XLSX, depending on the configured export format. Download buttons are unavailable if no format is configured.
Creating Schedule
The Report Schedule tab lists saved schedules for sending selected reports. You can also add schedules here.
Click the button shown below to add a schedule.
The ‘Create report schedule’ view opens.
To create a schedule for a selected report, you need to fill in the following fields:
- Name: the schedule name in the system.
- Checkbox “Active”: enables or disables the schedule.
- Report definition: select a prepared, shared report from the “Report definition” tab. Each schedule uses one report.
- Report format: choose .CSV or .XLSX.
In Time trigger, choose how often to send reports to the recipients.
In Report recipients, choose registered Mint Service Desk users with “Add recipient” or enter email addresses with “Add custom recipient”. You can add one or more recipients.
In Schedule email details, enter the subject and body of the email sent with the report.
After filling in the required fields, click in the bottom right corner to save the schedule.
Schedule Details
Click a schedule’s name to open its details.
The top left section contains basic information, such as the report name, last generation date, and size.
The top right section displays the report filters.
If no filters were used in the report, the Filters field is hidden.
The main part of the schedule details is a table containing the generated reports. These can be reports that are only generated and saved, as well as reports that are additionally sent to the email addresses specified in the configuration. The top left corner of the table contains button, which allows you to manually generate or send the report, regardless of the date set in the configuration. The top right corner contains the Search by section with buttons similar to those in the previously described tables.
The table contains the following columns:
- Creation date - the date when the report was generated by the schedule.
- Name - the name of the report (the name may change depending on the report configuration currently attached to the schedule).
- Email subject - the subject of the sent email message.
- Status - the status of the report.
- Recipients - the email recipients specified in the schedule configuration.
- Sent at - the date when the email was sent.
- Message - the error message, if the report generation was unsuccessful.
- Action - this section contains the Resend button to resend the email (if sending is enabled in the schedule configuration), and the XLSX or CSV button to download the report (available depending on the format selected in the schedule configuration).