How do I configure and use SNAPanalytics?

How do I configure and use SNAPanalytics?

Concept

SNAPanalytics is a highly requested feature that allows you to create customized dashboards or wallboards for call center environments.

Definitions

  • Board - a collection of customized cards arranged for viewing.
  • Card - a customizable widget that may contain charted data or content.

Configuring SNAPanalytics

There are various aspects of the SNAPanalytics app that can be configured. This is done by logging into the Admin UI of the Core Module and navigating to System > Settings Advanced > UI Config and adding the parameters listed below. For detailed instructions on how to add UI Configuration Parameters like those below, see How do I Add/Modify UI Configuration Parameters.

Enabling SNAPanalytics

  1. By default, SNAPanalytics is disabled on upgrade/install. To enable this feature add the parameter shown below.
    UI Configuration ParameterDefault ValueValue NeededDescription
    PORTAL_ANALYTICS_FEATURE_ENABLEDnoyes/noEnables the SNAPanalytics app.

Naming the app (If the default is not desired)

  1. To change the name used for SNAPanalytics to something other than the default, add the parameter shown below.
    UI Configuration ParameterDefault ValueValue NeededDescription
    PORTAL_ANALYTICS_FEATURE_NAMESNAPanalyticsText

    Allows for customizing the name of SNAPanalytics in the Call Center Supervisor home view.

Allowing access to Agent Scope users

  1. To allow users with Agent scope to access SNAPanalytics, add the parameter shown below.
    UI Configuration ParameterDefault ValueValue NeededDescription
    ANALYTICS_ENABLE_AGENTS_ACCESSnoyes/no

    Enables access for Call Center Agents to the SNAPanalytics application. Agents have a more limited scope of access.

  1. To allow public links to be generated for boards, add the parameter shown below.
    UI Configuration ParameterDefault ValueValue NeededDescription
    ANALYTICS_PUBLIC_LINK_ENABLEDyesyes/no

    Enables the public link mechanism so SNAPanalytics boards can be viewed without logging in.

  2. To adjust the public link ID length, add the parameter shown below.
    UI Configuration ParameterDefault ValueValue NeededDescription
    ANALYTICS_PUBLIC_LINK_ID_LENGTH8Integer

    Sets the ID length when generating public links.

Enabling custom data sources

  1. To allow custom data sources to be added to certain card types, add the parameter shown below.
    UI Configuration ParameterDefault ValueValue NeededDescription
    ANALYTICS_ENABLE_CUSTOM_DATA_SOURCESnoyes/no

    Enables custom data sources for some card types.

Enabling additional style controls

  1. To show extra style controls for certain card types, add the parameter shown below.
    UI Configuration ParameterDefault ValueValue NeededDescription
    ANALYTICS_EXTRA_STYLE_CONTROLSnoyes/no

    Enables additional style controls for some card type.

Configuring existing parameters

The following parameters are referenced or utilized in SNAPanalytics and may already be configured.

NOTE: These parameters affect SNAPanalytics as well as other apps in SNAPsolution.
UI Configuration ParameterDefault ValueValue NeededDescription
PORTAL_TRACK_ANALYTICSnoyes/no

Enables google analytics in the charts app.

PORTAL_CALL_QUEUE_MANAGER_VIEW_LISTn/ausername of queues, comma separated

A list of call queues to filter autocompletes.

PORTAL_CALL_QUEUE_MANAGER_AGENT_GROUPSn/ausername of departments and/or sites, comma separated 

List of departments and/or sites to filter autocompletes.

 PORTAL_SOCKET_HOSTNAMEvalue of $_SERVER['HTTP_HOST']text/URL

Hostname for the socket connection to the nsnode server.

 

Adding a custom logo for SNAPanalytics

A custom logo can be added to the app for more focused branding. This is done by logging into the Admin UI of the Core Module and navigating to System > Settings Advanced > Images.

  1. Click Add to add a new image.
  2. Fill out the server, reseller, and domain fields.
  3. Select filename analytics_header_logo.png
  4. Choose your image file and upload.

For more detailed instructions about adding images, see How Can I Change Image Branding at the System and FQDN Level?

Using SNAPanalytics

To access SNAPanalytics, log into the Portal with a User Scope that has already been given access to Call Center features and navigate to the Call Center Home. Then click on the SNAPanalytics (or whatever you named the app) button to launch the app. You can also access and log in to the app by directly visiting the URL of your app.

launch.png

Using the main menu

General navigation and viewing boards is accomplished using the Main Menu found in the top left corner of the app:

main_menu.png

Clicking the main menu button will reveal the side navigation:

side_navigation.png
  1. Your logged in user name and extension
  2. Add a new board button
  3. List of boards favorited by you
  4. List of boards owned by you
  5. List of boards shared with you
  6. App version number
  7. Log out button

 

Viewing a board

Here are some of the buttons and actions you can expect to see in the app bar when viewing a board:

sample_board.png

  1. Edit board: Enter board edit mode where you can change the cards and contents of the board.
  2. Copy board: Copy a board and create a duplicate that will appear in your list of boards. Copied boards have all content and settings from the original board.
  3. Delete board: Permanently delete a board so it's not longer viewable.
  4. Board settings: See "Board settings" section.
  5. Favorite board: Favorite the board so it shows up in your list of favorite boards in the side navigation.
  6. Share board: See "Sharing a board" section.
  7. Enter full screen: Toggle between normal and full screen viewing.
  8. More and filters: The more menu provides a shortcut to specific card actions. If the card has filters on its data set, the filters button will also appear next to it.
    • Edit card
    • Copy card
    • Delete card

Adding and editing a board

After adding a new board or editing an existing board, the app bar changes color indicating you're in edit mode and some new options are available to you.

edit_board.png

  1. Edit board name: Change the board's name.
  2. Save or cancel changes: After making changes made to a board, save and cancel buttons will appear. You can save or revert any changes made.
  3. Add card: See "Adding a card" section.
  4. Add header: Add a simple text header to help create card groupings or sections. You can adjust header width and font size.
  5. Drag and drop cards: Click and hold on any card, then drag to the desired position.
  6. Drag to resize cards: Click and hold on the corner handle, then drag to resize.
  7. Card hover options: Hover over a card to show some quick actions.
    • Edit card
    • Copy card
    • Filters (if applied)
    • Delete card
  8. BackExit edit mode by clicking the back button.

Adding a card

  1. Click the Add card button
  2. Choose one the following card types:
    card_types.png
    • Line Graph: One or more lines from a data set plotted over time.
    • Gauge: A stat value with a gauge that fills to a specified limit.
    • Single Stat: A single stat's value.
    • Table: Data with multiple stats or descriptive information available in columns.
    • Grid: Simple table arranged in a grid format to maximize number of items. (Data set limited to agents for v40 release.)
    • Note: Customizable text content.
    • Iframe: Display external web sites or resources.
  3. Add data: One or more data sets can be added to cards depending on the selected card type.
    • Select from a list of data sets that are compatible with the chosen card type.
      • Note and iframe card types only take manual text input.
      • If you've enabled the custom data sources parameter ANALYTICS_ENABLE_CUSTOM_DATA_SOURCES, the option will appear at the bottom of the data set list.
    • Breakdown: Data sets on line graphs can be broken down into separate lines. The breakdown options are: aggregate, per queue, and per agent. Specific breakdown options may be limited depending on the data set.

      breakdown_and_filters.png
    • Filters: Filters for call queue, departments, sites, and agents can be applied to data sets. (Default filters can be applied to new cards. See "Board settings" section.)
  4. Add alerts: Alerts allow you to trigger color changes or browser notifications when a monitored data set crosses a threshold.

    alerts.png
    • Select which data set you want to monitor and set the alert to trigger when it's either above or below the specified threshold.
      NOTE: Multiple thresholds must have the same threshold trigger direction. If your first alert triggers when it's above a threshold, the rest of your alerts must also be above their specified threshold.
    • Select the color of your alert.
  5. Style: Adjust some of the visual settings to fine tune your card.
    • Style settings change depending on the card type.
    • Additional style settings can be enabled for some cards using the ANALYTICS_EXTRA_STYLE_CONTROLS parameter. (See "Enabling additional style controls" section.)
  6. Move and resize: Move and resize your card to the desired position.

Board settings

Within board settings you can adjust card layout margins, toggle browser notifications for the board, and set default filters that new cards will inherit for their data sets.

board_settings.png

  1. Card Margin: Adjust the margin space between cards to better fit display resolutions. You can select: auto, 16px, or 24px. The auto option will adjust depending on the view width.
  2. Browser Notifications: Enable or disable browser notifications for a board. This allows you to turn off notifications on a board.
  3. Default FiltersSet filters that will automatically apply to data sets in all new cards within the board. Updating and saving filters here will also give you the option to update all existing cards with the new filters.

Sharing a board

Board sharing options are available in SNAPanalytics and allow you to share your board with specific individuals or broad groups. Boards shared with others will appear in their list of "Boards shared with me" in the side navigation.

share_board.png

  1. Share board with... : By default, boards are set to be shared only with specific groups or people. You can change this so the board is shared with everyone in the organization and toggle whether everyone can edit.
  2. Share with specific groups or people: Sharing with specific groups or people requires you to add a list of scopes, sites, departments, or people in order to share with them.
    • Enter a specific scope, department, site, or person.
      share_select.png
    • Configure individual settings to set who can view or edit the board.
  3. Share a view-only public link: If you have the ANALYTICS_PUBLIC_LINK_ENABLED parameter set to "yes", the public link will be enabled. Sharing a public link with others allows them to view a specific board without logging in.
    • Old links can be expired or invalidated by generating a new link.

    • Related Articles

    • Wallboard Call Center Statistics Explained

      There are many call types when using a VoIP platform. For example our Call History reports are very exhaustive and are designed mainly to provide call data for troubleshooting. This means that the platform registers and reports all Call Attempts ...
    • [GUIDE] Advanced Contact Center - Users Config

      We’ve added a new feature for our Advanced Contact Center Reporting Wallboard. All these features are designed to control permissions and user access. Call Center Reporting Only for oxygen users We’ve added a new access type for oxygen users. If you ...
    • How to configure the audio input and output for OFFICELINE

      How to configure the audio input and output for  (PC version only).   Once logged in on the upper right-hand corner where the username appears.   Click on the arrow  Once you click on the arrow, as shown above, you will see the settings, click on it ...
    • Channel Partner Agent Commission

      A quick reference guide to create and manage agent’s commissions inside the Channel Partners Portal. [DOWNLOAD HERE] 
    • How to use nexogyTeams application running on a mobile device?

      nexogy teams let you experience collaboration by taking your office’s phone line wherever you go. Here's a quick tutorial on how to use it on a mobile device.