CONTENTS
2. PURPOSE AND PRE-REQUISITES.. 3
2.1. Purpose of the Application.. 3
4.1. User roles in the module. 5
4.3.1. Create a preset analytics screen.. 8
4.3.2. Create a new analytics dashboard from scratch.. 18
4.3.3. Create a new analytics dashboard by copying an existing one. 21
4.3.4. Export an analytics dashboard. 22
4.3.5. Edit Analytics Dashboard. 24
4.3.6. Delete analytics screen.. 25
4.4.1. Generate a preset report 27
4.4.2. Create a new report (from scratch) 31
4.4.3. Create a new report by copying an existing report 34
1. INTRODUCTION
1.1. Terms and definitions
| Analytics Panel | Tool for displaying reporting indicators in real time. |
| Back Office | A set of modules for managing System parameters and commonly used directories. |
| Dashboard | Analytics Panel |
| Export |
Output all or part of the data from the current file/document/database to an external source.
|
| Report |
Information compiled in a certain form, data on the activities of the System participants for a certain past period, intended for printing or sending to external consumers.
|
| Sorting | Order a set of similar data in ascending or descending order. |
| System | The service payment system supplied by Kontron America Inc. |
| System Module |
A functionally completed structural part of the System that performs similar user tasks.
|
| System Operator | A legal entity that ensures the functioning of the System. |
1.2. Application domain
Automation of actions related to the generation of reports for users of the System.
1.3. User training level
The user should know this guide and be able to use the main features of the current manufacturer-supported versions of Microsoft edge, Mozilla Firefox, Google Chrome, Apple Safari.
2. PURPOSE AND PRE-REQUISITES
2.1. Purpose of the Application
The application is designed to access the reporting functions for users of the System.
The application provides reporting in the form of:
- analytical screens,
- reports.
2.2. Conditions of use
The pre-requisites to use the Application are:
- access to the Internet with a bandwidth of at least 128 kbit/s, 512 kbit/s is recommended,
- a current manufacturer-supported version of the browsers Microsoft Edge, Mozilla Firefox, Google Chrome, Apple Safari.
3. GETTING STARTED
After turning on the computer and waiting for the operating system to boot:
- Start your internet browser and in the address bar type [web address https://bo.itsbreezemobile.com].
The System portal window will open (Figure 1).
Users with the roles "FIN_REP", "VOL_REP", "COAC_REP", "REP_ADM" have rights to work with reports.
- Enter the login and password received from the System Operator.
|
Note: when you first enter the Back Office, you need to change your password. |
The Back Office modules will be displayed on the screen (the set of modules displayed depends on the user's access rights) (Figure 2).
- Select the "Reports" module.
The "Reports" module will open on the screen, consisting of the sections "Reports", "Report Editor", "Analytical Panels", "Dashboard Editor" and "Load Data"
The visibility of data in the module is determined by the user's organization.
4. APP FEATURES
4.1. User roles in the module
Roles:
VOL_REP: access to analytical screens (dashboards) and reports that do not contain financial data.
FIN_REP: access to analytical screens (dashboards) and reports containing financial data.
REP_ADM: ability to create and edit reports and their display structure (folders), as well as enter data.
COAC_REP: right to inspect dashboards and reports on corporate clients ("B2B program rides", etc.).
The report/dashboard availability option for each user role is set when the report/dashboard is created.
4.2. Working with folders
The module provides the ability to create a hierarchical tree of folders to facilitate the search for reports/dashboards. REP_ADM creates a folder structure for a user in the "Report Editor" and "Dashboard Editor" sections.
A report/dashboard can be located in several folders at the same time. The "All" folder displays all reports/dashboards.
In order to add a folder:
- Click on the "Add Folder" button.
- In the window that opens, enter the name of the folder.
- Click the "Add" button.
Figure 3 Adding a folder
Adding a lower-level folder is initiated by clicking on the "" button to the right of the root folder name.
The folder name can be changed in the "Name" field by pressing .
The settings for displaying a report/dashboard in a folder are set when it is created (see para. 4.3.2). A report can be displayed in multiple folders at the same time.
In order to move a report from one folder to another, click on a page of the report, add the folder to where the report is to be moved, and remove from the original folder.
The number of reports in a folder is displayed to the right of its name (Figure 4, note 1). You can expand the list of folder contents by clicking on (Figure 4, note 2).
Figure 4 Displaying the contents of a folder
To delete a folder, click on to the right of its name and confirm the deletion in the pop-up window.
4.3. Analytical screens
Analytical screens (dashboards) display data about the work effectiveness of System participants in real time (see Figure 5).
Figure 5 Analytical screens section
4.3.1. Create a preset analytics screen
Preset analytical screens are part of the "Reports" module (see Table 1).
Table 1 Preset analytical panels (dashboards)
| № | Name | Financial (yes/no) | Content |
|
|
Sales | Yes | Dashboard shows:
|
|
|
Usage | No | Dashboard shows:
|
|
|
Audit log | No |
The dashboard displays a log of user audit activity (with details). The list of operations is displayed in a table with columns:
For a selected row, the parameters which were used to select the data, and the results are displayed. |
|
|
Rider flows (Rail) | No |
Report for fixed installation sites with fixed output. For each pair of stations, i.e., the Boarding station and the Destination station, the number of media usages on the respective "route" between the two stations (i.e., the "entry transaction at the departure station" pair and the subsequent "destination station exit transaction" are calculated for one carrier over one operating day, taking into account the shift of the operating day). |
|
|
Average travel time | No |
Report for fixed installation sites with fixed output. For all pairs of stations, i.e. the Boarding station and the Destination station, the average travel time is calculated depending on the start time. |
|
|
Unsuccessful attempts | No | The dashboard displays unsuccessful attempts to pass during the specified period of date / time (by default - from the beginning of the previous day to the beginning of the next) with the possibility of filtering by station and the cause of failure. |
|
|
Dashboard template | No | Template for creating new dashboards from aggregated data |
The sequence of steps for working with an analytical screen (dashboard) is:
- Use the "Loading Data" tab to enter the data for the required period of time (Figure 6).
Figure 6 Entering data for the dashboard
- Go to the "Analytical Screens" tab to find the desired dashboard and open it by clicking on the link (Figure 5). The dashboard opens in a new tab.
- Click on and configure the settings in the Dashboard Parameters window (example in Figure 7; parameters may differ from one dashboard to another).
- Note the "Send null" setting means that the specified parameter will not be used.
- The reporting period for the dashboard is set by the date interval.
- Click on the "Submit" button.
- The Information is displayed as in Figures 8 and 9. It is possible to sort the data by any parameter of the table (press "" in the column header). Tooltips are displayed when you hover over the columns of the chart (Figure 9).
Figure 8 Viewing dashboard data
- If necessary, an additional dashboard module can be opened (Figure 10-Figure 11).
Figure 10 Export and Expand tools
Figure 11 Additional dashboard module
The reports feature information displays with nesting e.g. "Usage" (see para. 4.3.1.1).
- Export dashboard data to PDF, PNG, JPG, XLSX, XLS formats (Figures 12 to 15).
Figure 12 Selecting the data export option
Figure 13 Configuring PDF Export Settings
Figure 14 Configuring Image Export Settings
Figure 15 Configuring Export Settings in Excel
Return to the dashboards list by clicking on "Cancel" button.
4.3.1.1. Displayed information features on the analytical screen for the use of services ("Usage")
The dashboard format follows the general algorithm for the formation of preset analytical screens (see para. 4.3.1).
The data presented on the "Usage" analytic screen is nested:
- At the first level of nesting (Figure 16), the table display statistics on the use of services by date.
Figure 16 Dashboard "Usage". The first level of table nesting
- At the second level of nesting (Figure 17), the table displays statistics on the use of services by lines / routes. Open the second level by clicking on a date in the list.
Figure 17 Dashboard "Usage". Second level of table nesting
- At the third level of nesting (Figure 18), the table displays statistics on the use of services by stations and as part of selected lines / routes. Open the third level by clicking on the name of a line / route.
Figure 18 Dashboard "Usage". Third level of table nesting
Return to the previous level by clicking in the upper right corner of the block (Figure 18, note "A").
4.3.2. Create a new analytics dashboard from scratch
Only a user with the "REP_ADM" role can create a new analytics dashboard. Reports are created using DevExpress components (DevExpress Web Report Designer). User documentation can be viewed at https://docs.devexpress.com/Dashboard/17383/end-user-documentation.
Steps to create a dashboard:
- Download data for the required period on the "Load Data" tab (Figure 19).
- On the "Dashboard Editor" screen (Figure 20), click the "Create" button.
Figure 20 "Dashboard Editor" screen
- Fill in the form fields(Figure 21):
- the name of the dashboard;
- The folder in which it will be displayed.
- the roles of users who will be allowed access to the dashboard.
Figure 21 Form to create a new analytics screen
- Click the "Add" button. The new entry appears in the list of dashboards in the Dashboards tab.
- Return to the list of dashboards, find the created record, click on ("Edit") to the right of it. The report designer will open (Figure 22).
- Create an analytics dashboard in accordance with the guidelines on the https://docs.devexpress.com/Dashboard/17383/end-user-documentation website.
4.3.3. Create a new analytics dashboard by copying an existing one
Only a user with the role "REP_ADM" can create a new analytics screen. If the new analytics screen is slightly different from an existing one, and existing dashboard can be copied and modified.
Copy dashboard:
- On the tab "Dashboard Editor" find the dashboard to be copied.
- Click on ("Copy") to the right of the name of the this dashboard (Figure 23).
- In the window that opens, enter the name of the new dashboard (Figure 24).
Figure 24 Entering the name of the dashboard when copying
- Click on the "Copy" button. The new dashboard will appear in the list.
- Make the necessary changes to the copied dashboard following the procedures set out in paragraph 4.3.5.
4.3.4. Export an analytics dashboard
A dashboard can be exported by clicking in the upper right corner of the workspace (Figure 25).
Figure 25 Exporting the dashboard
Any of the dashboard blocks can also be exported by clicking on in the upper right corner of the working area of the block (Figure 26).
Figure 26 Exporting a single block of dashboard
Dashboard blocks can be exported in the following formats: *. pdf, *. png, *. gif, *. jpg, *. xls, *. xlsx.
4.3.5. Edit Analytics Dashboard
Only a user with the role "REP_ADM" has the right to edit an analytical screen.
The steps to change an analytical screen are:
- In the "Dashboard Editor" section, find the dashboard to be changed.
- Click on to the right of the dashboard name (Figure 27). The report designer will open.
- Make the necessary changes (see the official documentation on the website https://docs.devexpress.com/Dashboard/17383/end-user-documentation).
- Call up a drop down menu by clicking and save the changes by clicking "Save" (Figure 28).
Figure 28 Saving changes to a dashboard
4.3.6. Delete analytics screen
Only a user with the REP_ADM role has the right to delete an analytics screen.
In order to delete an analytical screen:
- On the "Edit Analytics screen" click ("Delete") on the right of the name of the dashboard (Figure 29).
Figure 29 Removing a dashboard
Figure 30 Confirmation of dashboard deletion
4.4. Reports
The System generates reports in the "Reports" module (Figure 31).
4.4.1. Generate a preset report
The "Reports" module presents preset reports (Table 2).
| № | Name | Financial (yes/no) | Content |
|
|
Registration Date by Customer | No | Displays detailed information registered clients for the selected period |
|
|
Sales Details (by Customer) | Yes | Displays detailed sales information for the selected period grouped by client |
|
|
Usage per Account by Exact Last Name | No | Shows detailed data on entrances and exits for the selected period for the specified client (grouped by Clients with the same surname). |
|
|
Sales Per Payment Method | Yes | Displays a summary of sales data for the selected period by payment method and payment service |
|
|
Sales Overview Per Product | Yes | Displays a summary of sales data for the selected period by product (tariff) |
|
|
Report template | No | Template for creating reports on aggregated data |
|
|
Usage Overview | No | Shows the number of entrances and exits for the selected period by day. Without detail. |
|
|
Station Load | No | Station activity report. Activity parameters are the number of transactions of a given type for a given station in a given hour: entrances, exits and total (the sum of entrances and exits). |
The sequence of steps to generate a reports is:
- Enter the "Reports" section.
- On the "Load Data" tab, enter the data for the required period of time (Figure 32).
Figure 32 Entering data for a report
- On the "Reports" tab, find and open the required report by clicking on the link to its name (Figure 31). The report opens in a new tab.
- Set the reporting period in the filter in the upper right corner of the screen (Figure 33).
Figure 33 Filter for customizing the reporting period of the report
- Click on the "SUBMIT" button. A report of the specified form for the selected reporting period will be displayed on the screen. (Figure 34).
- Configure the export parameters for the report data (Figure 35) and save (Figure 36).
- Print the report (Figure 36).
Figure 36 Printing (1) and exporting (2) the report
Return to the list of reports by clicking on "Cancel".
4.4.2. Create a new report (from scratch)
Only a user with the REP_ADM role can create a new report.
The report designer uses components of the DevExpress web report designer (DevExpress Web Report Designer). User documentation can be viewed at https://docs.devexpress.com/Dashboard/17383/end-user-documentation.
The steps to create a report are:
- Enter data for the required period on the "Load Data" tab (Figure 37).
- On the "Report Editor" tab (Figure 38), click the "Create" button.
- Fill in the fields in the form that opens (Figure 39).
- Name of the report
- The folder in which it will be displayed.
- The role of the users who will be allowed access to the report.
Figure 39 Create New Report Form
- Click the "Add" button. The new entry appears in the list of reports on the Report Editor tab.
- Return to the list of reports, find the created record, click ("Edit") button to the right of it. The report designer opens (Figure 40).
- Create a report using the guidelines at https://docs.devexpress.com/Dashboard/17383/end-user-documentation
4.4.3. Create a new report by copying an existing report
Only a user with the REP_ADM role can create a new report. Create a new report by copying and making changes to an existing report form in the "Report Editor" section using the procedure described in paragraph 4.3.3.
4.4.4. Edit Report
Only a user with the REP_ADM role has the right to edit a report. The steps to change a report are:
- In the "Report Editor" section, find the report to be modified.
- Click on the the right of the report title (Figure 41). The report designer will open.
- Make the necessary changes (see the official documentation on the website https://docs.devexpress.com/Dashboard/17383/end-user-documentation).
- Call up a drop down menu by clicking and save the changes by clicking "Save" (Figure 42).
Figure 42 Save Changes to Report
4.4.5. Delete a report
Only a user with the REP_ADM role has the right to delete a report.
In order to delete a report:
- On the "Report Editor" tab click ("Delete") on the right of the name of the report (Figure 43).
- Confirm deletion by clicking the "Confirm" button in the pop-up window (Figure 44).
Figure 44 Confirmation of report deletion