Accessing The Interface in Teams

CyReport Analytics licensed for Teams allows users to install and access the CyReport app in Teams. For app installation and licensing instructions refer to article link: Teams App Installation and Licensing - CyTrack Support Articles - Confluence (atlassian.net)

End User Initial Installation from Teams desktop app

1. Log into the Microsoft Teams desktop client as the end-user M365 account.

2. On the left navigation menu select “Apps”.

3. In Search type “cyreport” and click on the app “CyReport”.

4. CyReport app will pop-up, click the “Add” button to install the app and it’ll appear in the left navigation menu ready to be used.

End User Installation Video Demonstration

To navigate to CyReport in Teams, click on CyReport app from the team's vertical App Bar. CyReport can be run within teams or as a pop out app.

CyReport app should auto log in if the user has SSO enabled for this app otherwise the organization admin will have to provide the user with a login credential.

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 application. These options from left to right include: 

• Search Bar - This powerful search functionality works across the saved 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.

• User Guide - The help icon contains a hyper-link that will open this guide online.

• User Profile - The user profile allows users to customize CyReport Analytics Interface and settings. The user profile will be expanded upon later in the guide. 

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 4 on the above screenshot. These options are as follows: 

• Home - This section displays reports that have already been created and are ready to view at any time. These include System Reports , Public Reports and User Reports that will be expanded upon later in the guide. 

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

• Saved Filter - This section allows users to create and save a set of filters that can be linked or imported into an exisitng or new report. Saved filters are also available for use in Dashboard static group stat.

3. Report Tabs

The Report Tabs toggles the page body between System report, Public report and User reports This section also includes the powerful report generator accessed using the Add Report button on the far right.

• System Reports - This section includes pre-designed reports available out of the box. The types of reports available in the section is dependent on the product license and the availability of reportable data (if ‘Show All Columns’ is unchecked in the settings).

• Public Reports - This section includes reports saved by a user as a public report type. The latter makes the user saved report visible to all CyReport users across the system.

• My Reports - This section lists all saved reports by the user logged in. As reports are created and saved by the user, they will appear under this section for easy access later.

• Add 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 or Public Reports section.

4. 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 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. The four main items that can be viewed here will be explained in further detail later in the document.  

1. Settings

In this menu users can update user settings to show all columns and update the number of rows visible in reports.

• Show All Columns - This option updates two parts. Firstly, enabling it shows all system reports available in your license regardless of data being present in the report. Secondly, shows all columns when adding a new report regardless of data present in the column. Selecting this will ensure that columns are all shown when editing a report, rather than having to search for the one that you wish to use within the tabs that are typically provided.

• Default Rows in Table - This is a setting that appears per report that you create and edit, however here allows you to define how many rows are to be displayed within reports by default. The default value is 10, which can be increased or decreased based on the need of the user and the reports you are to create. Larger row counts would be beneficial for high traffic systems, but lower count may be useful when viewing on smaller displays.

2. Download Report Updates

This option downloads predefined reports under the System Reports tab from CyTrack’s online repository. Connectivity to this repository maybe restricted depending on users' network settings. Whilst CyReport Analytics has many predefined report templates available under system reports, the reset will only download reports that are available under the product license. The reset can also be used to restore system reports that may have been deleted from the view.

3. Sign Out

Logs user out of CyReport Analytics and frees up the user license.

4. Webhooks

The incoming webhook connector enables users to link the CyReport app to a teams channel for report sharing. Refer to the following link for more information. https://cytrack.atlassian.net/wiki/spaces/CSD/pages/2016641094/Adaptive+Card+Feature+for+CyReport+in+Teams#Add-and-Link-Adaptive-Card-to-Teams-channel

• View - These buttons allow you to view the report as a static report or as a wallboard refreshing at set intervals. 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 red 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. 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. 

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.  

• Link - Click on the link icon to copy report link to clipboard for sharing.

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

• 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 and Sharing 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. 

• Share On Teams- Teams adaptive card is a type of card that you can use to display rich and interactive content in Teams conversations through a bot or a message extension. Refer to this article for more information. https://cytrack.atlassian.net/wiki/spaces/CSD/pages/2016641094/Adaptive+Card+Feature+for+CyReport+in+Teams#Using-Adaptive-Card-in-CyReport

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

3. 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 Optionsearlier.

• Scheduler - This option allows users to attach a schedule to the created report. This is a window that pops up with options explained under the Other Options earlier.

• Public - This option sets the report as Public and is therefore visible to all users on CyReport.

4. Export and Other Options

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

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

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

1. 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 Add Filter+ button, each individual filter can be edited and even deleted (except the date filter).

• Delete - To delete an entry simply click on the X icon within the filter.

• Edit - 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. 

• Keep open by default - this check box will pin the Applied Filters to the top of the report view at all times.

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

1. Adding New Column

Clicking the Column link allows the user to add 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 through the tabs to select the desired column. Each tab includes items that meet certain criteria to help the user quickly identify which ones to use. Each item has a description of what it does and the kind of data it will display. Or you can search, where typing in the desired column name will update the list in real time.

2. Detail Item

Columns can be added or edited to become Detail Items. This is the terminology used when an item, instead of being a column on the report that is visible at all times, is instead added as a row and attached to each record displayed. To avoid clutter on the report itself, these new row items are added as a tree view to each record. Hidden by default but can be expanded and viewed if needed.

When adding a new column and the user wishes for it to become a Detail Item, select the down arrow located on the Add button and select Add in details. Alternatively, when editing an existing column, a checkbox Show in details is present which when ticked will change the column to a detail item instead.

Regardless of how the item is created, the end result is pictured below. In the example the Date/Time column had been switched to a Detail Item. Each record gains a plus icon indicating a tree view. Clicking on the icon will expand and show all detail items associated to the record, in this instance it is just the Date/Time value.

3. Column Filters

In addition to filtering at the report level, Filters can also be applied at a column level. There are two main advantages to why applying these per column can assist in creating the right report. One option is that certain data can be filtered out and hidden from the end results, allowing the user to quickly identify the information that matters most. An additional option is applying filters over multiple columns, to allow you to manipulate the display of data in one column based on the results within another column. Both methods are explained below.

If a report is rather broad with it’s search results, including multiple call types or events, we can use filters on columns to display relevant information specifically Each column allows for a filter to be applied against it, this includes the columns that are in the default view and any that the user may choose to add. When editing a table and wishing to change a column, click the Edit icon of that specific column and access the Filter tab from the window that appears.

4. Column Summary

Within the Edit Column screen there is also a tab for Summary. This can enable the user to create and maintain summary values on a per column basis, working only on those specific values and data held within that column. This can be used to only show the information needed, and can be used in combination with other column attributes such as Filter to allow you to manipulate the data further. Hiding or organising the data as you see fit.

2. Adding New Summary Item

Adding a summary item within the creating/editing stage is done so in the same process as adding a column. At the top right of the table, you wish to summarise, click on the Summary link. This will bring up an additional popup window, which will allow you to pick and tailor the values you wish for the summary to work on. Such as choosing the average value to display, or total.

3. Group Level?

Group levels act as a hierarchy, these levels help instruct the report to identify what should be sorted first. This comes in use when more than one group is defined. For example, perhaps you wish for calls to be grouped by extension first, and then within those groups you would like them grouped further by call type. This is all done through assigning groups with a number when editing them, with 1 being the top value within the hierarchy.

2. Adding New Summary Item

Adding a summary item within the creating/editing stage is done so in the same process as adding a column. At the top right of the table, you wish to summarise, click on the Summary link. This will bring up an additional popup window, which will allow you to pick and tailor the values you wish for the summary to work on. Such as choosing the average value to display, or total.

3. Enabling Show only Summary

The Show only Summary option is contingent to the report columns already containing summary values for example count, sum, average or maximum. This option hides the itemized records and only displays summary for each column at group and/or Report level.

 

1. 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 the reports will be automatically sent to.

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

• 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 seperated by column. 

• Mode - The mode used in this particular schedule. How often or frequency 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. 

• Report Format - The file format that 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.

  • Type - Page orientation of the report to be attached to the email. This can be portrait or landscape.

  • One Component Per Page - Prints each Table and Chart on a new page of the report.

  • Show Date Range - Shows the date range applied to the data set.

  • Show Filters - Prints the filters applied to the report.

  • Show Footer - Includes a footer in the exported report containing report description.

  • Only Send if Data Present - With this option turned on, the schedular will not send report if no data is present for that period.

  • Only new Data - This option will not show data already included when the scheduler ran the last time.

2. Configure

The Configure option displays different settings depending on the report mode selected.

• Weekly Mode- The weekly mode prompts for a day of the week and time values the schedule will be run.

• Monthly Mode- When monthly mode is selected, the configure option prompts for Day of the Month and Time settings:

• Daily Mode- Similarly, the daily mode only prompts for the time the report will be sent.

• Periodic Mode- And lastly, the periodic mode allows users to configure report schedule in intervals of set time (in minutes).

 

3. 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. Multiple reports can be selected under the same schedule.

 

4. Done

No action is required in this section and the result indicates the success of the setup.

 

1. Title

The title is the name of the saved filter which will be available within a report or in the dashboard custom statistics.

• Title - This is the title given to that specific filter. Used to identify at a glance, this can be used to describe and indicate what the filter accomplishes, such as whether you create it to filter specific time period or certain type of call.

2. Filter

The Filter option displays different parameters available in CyReport Analytics. By default this includes activities made today and this parameter cannot be deleted but can be modified to another time period.

• Add Filter+ - Opens the filter options with a drop down list of several parameters to choose from. The options that follow vary based on the filter type selected.