CyReport Interface
Introduction
The CyReport interface is a powerful and intuitive tool that allows you to make the most of your data. Creating reports, monitoring statistics, and managing automated tasks. This can all be handled through the interface that can be easily accessed through your browser.
This documentation will introduce the interface and explain the basics of its operation. Touching upon the features that are available that can be tailored to meet any requirement.
Accessing The Interface
As mentioned, the interface can be accessed from your web browser. This means that it can accessed directly on the system the software is installed on, or remotely on another system if there is a connection between them, and the systems can see each other.
To navigate to the portal, simply type the URL as you would for any other webpage into the address bar. The address will typically be in the following format, where HOSTNAME would be replaced by the hostname of the CyTrack system.
https://HOSTNAME/cyReportWebApp/
Upon navigating to this address the main login splash screen will appear, asking for two fields of data. Your username and password. Additional user accounts can be created for the purposes of accessing this interface, with the ability to impose restrictions of what each account can access and perform. The default account is Administrator, and the password field is left blank.
Main Interface
Upon logging in you are greeted with the main portion of the interface. It is on this page that all operations take place when utilizing this interface, with the page constantly changing to meet the demands of the user. The page has been annotated to explore the 3 main areas; these are explained below:
1.Toolbar
The first item pictured at the top right of the interface is the user toolbar. This contains options that assist the user in the overall operation of the interface and likewise these options do not necessary fall into the 2 other areas on the page. These options from left to right are:
Search Bar
This powerful search functionality works across the user reports and can be used to easily access the reports you need the most by just typing in their name.
Language Selection
This gives the user the ability to change the language of the entire interface to match their preferences. Select a language from the drop-down menu and the text will change to the desired language instantly without need to reload the page.
Notifications
This section will light up and alert you if there are unread notifications.
User Profile
Clicking this icon will provide you with a drop-down menu. It is from here that you can log out from the interface.
2. Navigation Bar
The navigation bar is what controls the main portion of the page and what is displayed for the user. Clicking on one of these options will change what is seen within the area marked as with a 3 on the above screenshot. These options are as follows:
My Reports
This section displays reports that have already been created and are ready to view at any time. These include both System Reports and User Reports that will be expanded upon later in the document.
New Report
This section is a robust tool to allow for complete creation and customization of reports, this includes selecting search parameters along with how data is displayed and grouped. Reports created here can then be saved for view and access later within the User Reports section.
Scheduler
This section allows for reports to be automated and delivered to users via email. New schedules can be created that instruct the system as to when automated reports should be run and delivered. Existing schedules can also be maintained, edited, manually run, and even deleted from here.
3. Page Body
Page body is the largest section on the interface. This section is where the main work is carried out and data is displayed, all depending on the selection made from the navigation bar.
When an option on the navigation bar is selected, this section will display a loading symbol as it loads in the relevant content, all without the need to reload the entire page and risk losing any progress. The 3 main items that can be viewed here will be explained in further detail later in the document.
My Reports
Tree View
When you first log in to the interface, the first thing displayed is the My Reports section. And within this there are two options that operate on a tree view system. These are System Reports and User Reports. By default, System Reports is expanded.
Expanding either the System Reports or the User Reports display the same information. A list of all the reports listed within that section.
System Reports
These are prebuilt reports on pre-determined search parameters. These can be used out of the box and present the user the ability to jump straight into examining their data. Reports found here cannot be altered by users, if a user wishes to modify a System Report, they will need to copy them so that a copy of the report appears in the User Report section.
User Reports
User Reports are a list of reports that have been created and saved by the users from within the New Report section. So, these will typically be tailored made to meet the demands of the users and apply more accurately to their specific data and needs.
Report List Layout
Whether you expand System Reports or User Reports, both will reveal the same layout that is pictured below. This is the list view where you can select your reports to view, you also can adjust the reports, through copying them to deletion. Each of these heading can be sorted by clicking on them. These are explained below:
View
These buttons allow you to view the report. Clicking on one will reload this section of the page to display the selected report.
Title
This is the title of the report. Highlighting the information icon will reveal the author and columns in use.
Modified On
This is the date that the report was created or last modified.
Category
This is the category this report has been grouped into. It can be used to help sort and organize your reports and list by assigning categories for certain report types, for example a group of reports looking at a specific number.
SubCategory
Similar to the Category section, this gives an additional level of control and organization when assigning categories. Allowing for more intricate subgroups.
Copy
Clicking these icons allows the user to copy a report. This may be to make minor adjustments to the copy without losing the original.
Delete
Clicking the Bin icon will delete a report. There is a browser confirmation window to ask whether you are sure you wish to delete. Once confirmed it will be removed from the list.
Filter
Clicking on the Filter icon will expand a window that allows you to tailor which fields you wish to filter by. This includes Title, Columns, Category and Sub-Category. Any input in these fields will adjust what reports are displayed in the main list, depending on what you filter by. Clicking the Reset button will remove text from the fields and go back to the default view. Clicking the X button will minimize the Filter window.
Report View
Viewing any report on the list will reload the main section of the page, changing to display the desired report to the user. Apart from the main navigation at the top of the screen, all other content changes to reflect the report that has been selected. In this example we are looking at a report titled Test Queue.
1. Heading
Report Title
This is the name of the report and what is seen on the previous list. This is entered when first creating a report.
Author
The username of the author of the report, enabling you to keep track of what reports people are interested in and are creating.
2. Report Content
Table Title
This is the name of the table within the report. This used when there are multiple tables of graphs within a report, allowing the user to better organize and present the data.
Filter
The filter is where search parameters are entered and defined when viewing reports. For pre-established reports, these filters are already filled in following the rules that were set when the report was created.
These can be amended and even added to when viewing a report. Making a change here will update the table in real time. Filters are expanded upon in the Report Filter section of this document on page 12.
Table
This is where the search results are presented and can be viewed. For pre-established reports, this section cannot be edited or changed from this view. The columns listed here is completely dependent on how the report is constructed and the data available. Hovering the cursor over the information icon reveals a tooltip that will explain what the column is and shows.
Pagination
The controls at the bottom right of the report are the navigation buttons for exploring your reports. Allowing you to view pages or skipping to the end. Increasing or decreasing the value in the Rows Per Page field updates the table in real time.
3. Export Options
Export
The export button allows you to create a file on your local system, this file will be your report in your desired file format. Clicking on this opens a window that allows you to tailor your exported file, this includes displaying the filters used, whether it is portrait of landscape, etc. You can allow define the following file types:
PDF
Excel
CSV
Print
This allows you to send the report to a print queue. This operates similar to the Export option, clicking the button opens an additional window that allows you to tailor your print job before printing.
Send Via email
Another option that is similar to Export, opening a window and allowing you to tailor the export. It will be a file as per the Export button, however instead of saving the file to your local system it allows the user to enter a recipient email address. The resultant email that is received will include the report as a file attachment.
Send Link
Clicking the Send Link button will create a new blank email in the desired email client. Within the body of the created email will be a link to the report, allowing the user to then send this to any desired recipient to view when they like.
4. Other Options
Scheduler
Scheduler is the button that facilitates automated reporting. You can click this to amend existing schedules for this report or add it to a new one.
Upon opening the scheduler window there are two tabs, the first is Existing Schedule and it lists the available schedules that have been created on the system, these all have checkboxes that allows the user to select one or multiple schedules for the report to be a part of.
The Add new schedule tab allows you to create further schedules, to add to this or other reports.
Edit Design
The Edit Design button reloads the page as if you were clicking on the New Report button from before. However, the screen will be pre-populated with the currently viewed report with the options to add, amend and delete items from it. This will be covered in greater detail in the New Report section.
Save As
Save As allows you to specify an additional or new report title, this is so you may create copies of reports to not overwrites previous versions.
Save
The Save option allows for additional options when saving, giving the user the ability to define categories and subcategories for the saved report. Along with a description field. There is also the option to have the report saved as a template for future report types.
Report Filter
Applied Filters
When viewing a report in the previous section, there is a hyperlink called Filter. Clicking this will expand a window from the left, pushing the report across the screen so it is still viewable as you observe the filters of the selected report.
Along with adding new filters through the top button, each individual filter can be edited and even deleted. To delete an entry simply click on the X icon within the filter. To edit, click on the corresponding pencil icon located beside the filter. This will open a following window similar to when adding a new filter.
Add Filter
Clicking on the Add Filter + button opens an additional window that takes focus on the screen. This window allows you to fully tailor a filter to add to your report, allowing you to view the data you are specifically interested in.
This window is responsive and will resize to accommodate your selections. To begin adding a filter, expand the drop-down menu. Here you have a complete list of all the possible filters and a search bar to quickly get to the one you wish to use. Typing in this search bar updates the search results in real time.
Selecting one of the options on the bar will populate the window with controls to tailor your filter for the report. For example, selecting the Extension filter will expand the window to allow you to select the following:
Mode
The mode that the filter is operating. With Extension, you can define whether you wish to look at ranges or extract extensions. The mode allows you to define this.
Lower Value
The first field that allows you to define extensions. For range-based modes this will be the lowest value in the range. For modes such as Equal To this is the only field necessary to populate.
Upper Value
The opposite of the previous field, this is for the upper end of a range. For modes such as Equal To, this is not necessary to enter data into.
When you are satisfied that your new filter is complete, click Done to add it to the applied filters list and get back to your report. And you are always able to come back and edit the filter later if needed.
New Report
The New Report section is where you can come to create a brand-new report from scratch. This would be if the reports in the previous section do not meet your requirements, or you have some specific you are looking for.
Most things are achievable with the pre-defined reports and only require changes to the associated filters. This would be if you require changes to how that information is displayed and presented. Allowing you to customize how much or how little you wish to see from your reports.
The page is laid out similar to the Report View explained previously, to allow you to get an idea of how the report will look as you create it. However, there are slight differences that will assist in the creation process. The main table can be edited by clicking on it. As pictured, each column has an Edit icon, clicking this will allow you to edit, change or even delete an existing column.
1.Table Options
Add Group
This option allows you to create groups within a report. By default, you have 1 group when first creating a report. This can be used to group separate extensions together within search results or call types.
Column
This adds additional columns to the selected table. This can allow you to add additional information that is presented from the chosen filter. Selecting this button opens an additional window that allows you to pick exactly what kind of new column you wish to add. Such as whether you want a column that displays the call type.
Within this opened window, you may go down the list and select the desired column. Or you can search, where typing in the desired column name will update the list in real time.
Delete
This option deletes the table in question. Pressing this will immediately delete the table.
2. Report Options
Add Chart
This button will open a window that allows you to tailor and create a chart for your report. Please note, that this chart is not attached to a table and can act upon its own unique filters that can be selected during this process and edited at any time.
Options include selecting what time of chart is used and displayed, and which data is used to be displayed and used within the axis. Colours can also be tailored and amended for your own presentation purposes or to highlight specific data.
Add Table
This button will add an additional table to your report that will be created with the default setting. This includes looking at data for today, with the columns Site Name, Duration and Date/Time. This can be edited separately with its own buttons that are explained earlier within the Table Options section on page 15.
Scheduler
This option allows you to attach a schedule to the created report. This is a window that pops up in a similar manner to what was explained within the Other Options section earlier in this document on page 11.
4. Export and Other Options
Import
This allows you to import files, saved versions of the reports. You can use this option in conjunction with the Export button if you wish to make a lot of copies of a certain table or layout without having to define it each time.
Export
As mentioned in the previous Import section, this particular Export option can create a saved version of the layout and report you have created. Saving it as a file that can be imported later when creating future new reports.
Undo
This option is your undo key on this interface. Pressing this will undo the last action carried out on the page.
Save
Once your report is complete, this option will save it to the My Reports list. Please note that this can only be selected once the basic options have been met, such as defining a report name and title. These will be reminded to the user if they are not previously met. A report can always be revisited and edited at a later date once saved.Page Break
Scheduler
The final main section. This is where you can view and manage existing schedules that have been created. As well as defining new schedules that can then be applied over all the reports available on the interface. This includes existing and new reports.
Title
This is the title given to that specific schedule. Used to identify at a glance, this can be used to describe and indicate what the schedule accomplishes, such as whether you create it to run on a specific day or create it for a specific report.
Mode
The mode used in this particular schedule. How often or regular it runs that you can read at a glance, typically a schedule may be set to run daily, or periodically may mean it runs on a certain day of the week or month.
Recipient
The email address that the report will go to once the schedule is run. This is typically one user but can be expanded to include groups or multiple users.
Actions
This section includes 4 interactive buttons that can be used to amend and work with the existing schedules. These include the following:
Execute
Execute the selected schedule at the time of pressing the button. This may be if you wish to see a copy of the report now, or whether it is to test its functionality.
Edit
An existing schedule can be edited with this button. Clicking it will carry out the same behaviour as if you were defining a new schedule, by opening a window that will contain all the editable fields. This will be further explained on page 17 in the New Schedule section.
Delete
This bin icon will delete the selected schedule immediately upon being pressed. Use with caution if you are sure you wish to delete this schedule, all reports that use this schedule will need to be reconfigured to use a new schedule.
Enable/Disable
If you wish to stop a schedule from running, but not delete it completely. You can toggle this option to enable or disable a schedule. This will affect every report that uses this schedule.
New Schedule
When creating a new schedule, or editing an existing one, you are presented with the same window that is divided into 3 main steps and the completion stage. These are explained below, and each must be completed before proceeding to the next step.
Details
The details that are displayed on the main Scheduler section. These are defined here, such as the title of the schedule and the recipients that it should be emailed to. The additional field here is selecting which file format is used when the report is attached to the email. Only one format can be defined per schedule.
Advanced Options
Advanced Options is a section on the first step that is minimized but can be expanded and worked on. These are additional options that are not required to proceed to the next step but can help tailor the presented report and schedule. These include such options as picking the report orientation, whether a header and footer are displayed, and so fourth.
Subscribe
The final step that needs to be actioned before saving, you are presented with a list of all available reports, and you can pick which is to be used for this schedule. Please note only one can be selected at this step, but additional reports can use the schedule when you edit the report itself as explained on page 11 within the Other Options section.