Reporting Framework
External Methods Invocation
1|Page
Table of Contents
Introduction ........................................................................................................................................ 3
Summary ......................................................................................................................................... 3
Architecture ........................................................................................................................................ 4
Functionality.................................................................................................................................... 4
List of parameters ........................................................................................................................... 6
Agent Detail Widget .................................................................................................................... 6
Configuration....................................................................................................................................... 6
Create new method ........................................................................................................................ 7
Edit method ..................................................................................................................................... 9
Delete method ................................................................................................................................ 9
2|Page
Introduction
Summary
The Altitude Reporting Framework (RF) is an accelerator that provides reports on an Altitude uCI
instance.
The RF Real Time component is a web application that monitors Altitude uCI activity in real time. It
receives information from Altitude uCI through several connectors and displays real-time activity
counters through a web browser interface.
The Reporting Framework Real Time functionality can be extended using external DLLs. Methods
defined in these DLLs can be called from the Reporting Framework client browser.
This document describes the architecture and the configuration for invoking external DLLs written
in .NET.
3|Page
Architecture
Functionality
The architecture for extending RF using external DLLs can be seen in the following diagram:
Real Time Server
Method A
Method B
External Dll
Real Time Component
Browser
The DLL is loaded on the first execution of a method.
A DLL method can be invoked clicking with the right mouse button on top of the agent in the
Agent Detail Widget. Some parameters in the widget can be passed to the DLLs method.
The result of the method invocation will be shown in a popup window.
4|Page
This result can be:
o
The output of the method invocation;
An error message when the method fails;
A success message when the method succeeds.
5|Page
List of parameters
The current list of parameters that can be passed to a DLLs method are the following:
Agent Detail Widget
Agent (Agent name);
Agent Extension;
Agent Full Name;
Agent Status - Detail;
Agent Status - Duration;
Agent Telephony Status Detail;
Agent Telephony Status Duration.
Note: when using agent extension and agent full name, you need to check the options in the
Layout Configuration \ Agent Detail.
Configuration
Theres a configuration screen where a DLL and its methods can be associated to Agent Detail
Widget. The parameters to pass from the widget to the DLLs method are also configured on this
screen.
1. Open ARF RealTime page;
2. Login with administrator user;
3. Go to menu File External Method Configuration;
6|Page
Create new method
1. Select the widget to configure from the list;
2. Click in the New button;
3. Fill the:
a. Name;
b. DLL path (including DLL name);
c. Class name (if using namespace namespace.className);
d. Method name.
4. Check if the external method returns a string message;
5. Select the parameters from the list, for sending to the method;
a. Note: You can change the order of the parameters.
6. Click in Validate Method button for analyzing the methods in the DLL. If this analysis is
successful and theres one method with the number of parameters selected, the icon
is shown, if not, the icon
7. Save the configuration.
is shown;
7|Page
8|Page
Edit method
1.
2.
3.
4.
5.
6.
Select the widget to configure from the list;
Select the method for editing;
Click the Edit button;
Do the required changes;
Click the Validate Method button;
Save the configuration.
Delete method
1. Select the widget to configure from the list;
2. Select the method to delete;
3. Click the Delete button.
Document Version 2010-12-13
9|Page
