Versions Compared

Old Version 1

changes.mady.by.user Lisa Brown

Saved on

compared with

New Version 2

changes.mady.by.user Lisa Brown

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview

The eWallboard tester tool is a comprehensive web-based client application for testing and monitoring real-time KPI (Key Performance Indicator) events from the XTIUM server. This tool simulates subscribing to live data streams and displays real-time updates in a user-friendly interface.

Purpose

This tool allows you to:

  • Test KPI event subscriptions in real-time
  • Monitor live data updates from the XTIUM server
  • Debug wallboard functionality
  • Understand data flow between client and server
  • Copy subscription configurations for external use
  • View KPIs changing in real-time

Getting Started

Step 1: Open the Tool

  1. Open your web browser
  2. Navigate to the wallboard_sa.html located on the public ECS API servers
  3. The page will load with the XTIUM Wallboard Client Tester interface

Step 2: Understand the Interface

The tool has 4 main sections:

Interface Overview

  • Login Section (Top) - Shows current user information and authentication status
  • Handlers Section (Top Panel) - 6 columns for selecting entities to monitor
  • Counters Section (Left Side Panel) - Hierarchical tree of available counters
  • Subscriptions Section (Right Side Panel) - Management and monitoring of active subscriptions

1. Login Section (Top)

  • Shows current user information
  • Displays "Not logged in" until authentication
  • Required for creating subscriptions

2. Handlers Section (Top Panel)

  • 6 columns: Channels, Agents, Business Processes, Campaigns, Callback, Organization
  • Each column shows available entities for that type
  • Checkboxes to select which entities to monitor

3. Counters Section (Left Side Panel)

  • Hierarchical tree structure of available counters
  • Expandable/collapsible counter types
  • Dimensions (sub-categories) for each counter
  • Checkboxes to select specific counters

4. Subscriptions Section (Right Side Panel)

  • Buttons to create/manage subscriptions
  • Table showing active subscriptions and real-time data
  • Copy functionality for external use

Step 3: Login (Required)

IMPORTANT: You must be logged in to create subscriptions and view real-time data.

...

The login information will be provided by the delivery team

Step 4: Explore Available Data

Before creating subscriptions, explore what's available:

A. Handlers Exploration:

  1. Look at the 6 handler columns (Channels, Agents, etc.)
  2. Each column shows available entities for that type
  3. Note the IDs and names of entities you want to monitor
  4. Use the help tooltips (?) for detailed explanations

...

All handlers are part of the organization as it is configured 

B. Counters Exploration:

  1. Look at the left side panel with the counter tree
  2. Click the expand buttons to expand counter types
  3. Some counters have dimensions (sub-categories)
  4. Hover over items to see detailed tooltips with:
    • Counter Type ID
    • Dimension ID (if applicable)
    • Description
    • Other metadata

Step 5: Create Your First Subscription

To see KPIs changing in real-time:

1. Select Handlers:

  1. Check the boxes next to the entities you want to monitor
  2. For example: Select a Channel and an Agent
  3. You can select multiple entities from different types

2. Select Counters:

  1. In the left panel, expand counter types by clicking the expand buttons
  2. Check the boxes next to specific counters you want to track
  3. You can select multiple counters
  4. Some counters have dimensions - select specific dimensions if needed

3. Create Subscription:

  1. Click the "Subscribe" button in the subscriptions section
  2. The tool will create subscriptions for all selected combinations
  3. You will see a success message if everything worked

4. View Real-Time Data:

  1. Look at the "Subscriptions Records" table on the right
  2. Each row shows: Handler Name, Counter Name, Dimension, Current Value
  3. Values will update automatically when the server sends new data
  4. The "Active Subscriptions" counter shows how many subscriptions are active

Step 6: Monitor KPI Changes

Once subscriptions are active:

Real-Time Updates:

  • Values in the table update automatically
  • No need to refresh the page
  • Updates happen when the server sends new KPI events

Understanding the Data:

  • Handler Name: Which entity the data is for
  • Counter Name: What metric is being tracked
  • Dimension: Sub-category (if applicable)
  • Current Value: The live KPI value

Multiple Subscriptions:

  • You can have multiple subscriptions active simultaneously
  • Each subscription shows data for a specific handler-counter combination
  • Scroll through the table to see all active subscriptions

Advanced Features

Tooltip System

  • Hover over any item in the counter tree to see detailed information
  • Tooltips show: Counter Type ID, Dimension ID, Description
  • Tooltips appear next to your mouse cursor
  • Visual highlighting shows which item you are hovering over

Dimension Selection

  • Some counters have multiple dimensions (e.g., by Agent, by Channel)
  • Expand counter types to see available dimensions
  • Select specific dimensions for more targeted data
  • Dimension groups (marked with data-counter-group) do not show tooltips

Error Handling

  • The tool validates selections before creating subscriptions
  • Error messages appear if no handlers or counters are selected
  • Custom error messages for subscription failures
  • All errors are displayed in the subscriptions section

Copy Functionality

  • Click "Copy to clipboard" to copy subscription details
  • Useful for external applications or documentation
  • Copies the raw subscription data in a structured format

Unsubscribe

  • Click "Unsubscribe" to remove all active subscriptions
  • Clears the subscriptions table
  • Stops receiving real-time updates

User Context Subscriptions

  • Click "Subscribe with User ID" to include your user context
  • Useful for personalized data or user-specific KPIs
  • Same functionality as regular subscribe but includes user information

Troubleshooting

Common Issues and Solutions:

TIP: Always check that you are logged in, ensure you have selected both handlers AND counters, and verify the server is sending data for your selections.

1. "Not logged in" message:

  • Click the Login button and enter credentials
  • Wait for authentication to complete

2. No data appearing in subscriptions table:

  • Ensure you have selected both handlers AND counters
  • Check that subscriptions were created successfully
  • Verify the server is sending data for your selections

3. Values not updating:

  • Check that subscriptions are active (Active Subscriptions > 0)
  • Verify the server is sending real-time events
  • Try unsubscribing and resubscribing

4. Error messages:

  • "No handlers selected": Select at least one handler
  • "No counters selected": Select at least one counter
  • "Fail to subscribe": Check server connection and permissions

Best Practices

Recommended Workflow:

  1. Start Simple: Begin with one handler and one counter
  2. Use Tooltips: Hover over items to understand what they represent
  3. Monitor Active Subscriptions: Keep track of how many subscriptions are active
  4. Explore Dimensions: Some counters have rich dimensional data
  5. Copy for External Use: Use the copy functionality to share subscription details

1. Start Simple:

  • Begin with one handler and one counter
  • Get familiar with the interface before creating complex subscriptions

2. Use Tooltips:

  • Hover over items to understand what they represent
  • Tooltips provide valuable metadata and IDs

3. Monitor Active Subscriptions:

  • Keep track of how many subscriptions are active
  • Unsubscribe when done to free up server resources

4. Explore Dimensions:

  • Some counters have rich dimensional data
  • Select specific dimensions for targeted insights

5. Copy for External Use:

  • Use the copy functionality to share subscription details
  • Useful for integrating with other applications

Technical Notes

  • The tool uses WebSocket connections for real-time data
  • Authentication is required for all operations
  • Data updates are event-driven (no polling)
  • The interface is responsive and updates automatically
  • All subscriptions are managed client-side

Support

If you encounter issues:

  1. Check the browser console for error messages
  2. Verify server connectivity
  3. Ensure proper authentication
  4. Check that the server is sending KPI events for your selections

Summary

This tool provides a comprehensive way to test and monitor real-time KPI data from the XTIUM server, making it easy to understand how wallboard functionality works and to see KPIs changing in real-time.