Platform SDK Java 8.5 API Reference

Package com.genesyslab.platform.reporting.protocol.statserver.requests

This package contains the Request objects that your applications can use to open, look at, and close statistics.

See:
          Description

Class Summary
RequestCloseStatistic Requests that Stat Server stop sending information about a particular statistic.
RequestGetStatistic Requests one-time notification about a particular predefined statistic.
Note, this request is not applicable to the CurrentTargetState category.
RequestGetStatisticEx Requests one-time notification about a statistic that is defined in this request.
RequestGetStatisticProfile Requests information on the currently available statistical types, time profiles, time ranges, or filters.
RequestOpenStatistic Requests that Stat Server start sending information about a predefined statistics.
RequestOpenStatisticEx Requests that Stat Server start sending information about a statistics that is defined in this request.
RequestPeekStatistic Requests immediate recalculation and transmission of the value of a previously opened statistic.
RequestResumeNotification Asks Stat Server to resume sending notifications to the client: because this request is asynchronous, you should use the send method, not the request method.
RequestSuspendNotification Asks Stat Server to temporarily stop sending notifications to the client: because this request is asynchronous, you should use the send method, not the request method.
 

Package com.genesyslab.platform.reporting.protocol.statserver.requests Description

This package contains the Request objects that your applications can use to open, look at, and close statistics. There are also requests to inquire about statistics profile information such as statistical types, time profiles, time ranges, or filters. You can also suspend and resume notification from the server.

The Platform SDK allows you to work with statistics that have already been defined in the Configuration Layer using RequestOpenStatistic, RequestPeekStatistic, and RequestGetStatistic. You can also create your own statistics dynamically using RequestOpenStatisticEx or RequestGetStatisticEx.

Note: RequestPeekStatistic, RequestSuspendNotification, and RequestResumeNotification are asynchronous. You should use the send method with these requests and not the request method.

For general information on the structure and usage of the Platform SDKs, or an introduction to using the Statistics Platform SDK, please refer to the Platform SDK Developer's Guide.

A sample is provided below showing how you can open a statistic using Platform SDK. For more details on the code involved, see the Using the Statistics Platform SDK article in the Platform SDK Developer's Guide.

[Java]

RequestOpenStatistic req = RequestOpenStatistic.create();

StatisticObject object = StatisticObject.create();
object.setObjectId("Analyst001");
object.setObjectType(StatisticObjectType.Agent);
object.setTenantName("Resources");
object.setTenantPassword("");

StatisticMetric metric = StatisticMetric.create();
metric.setStatisticType("TotalLoginTime");

Notification notification = Notification.create();
notification.setMode(NotificationMode.Periodical);
notification.setFrequency(15);

req.setStatisticObject(object);
req.setStatisticMetric(metric);
req.setNotification(notification);

req.setReferenceId(2);

System.out.println("Sending:\n" + req);
statServerProtocol.send(req);

For more information on Genesys statistics and reporting, refer to the sections on "Metrics and Statistics for Solution Reporting" and "The Statistical Model" in the latest version of the Genesys Reporting Technical Reference Guide.

For general information on the structure and usage of the Platform SDKs, please refer to the Platform SDK Developer's Guide.


Platform SDK Java 8.5 API Reference

Send comments on this topicTechpubs.webadmin@genesys.com.
Document version: 8.5.302.00
Copyright © 2006–2017 Genesys Telecommunications Laboratories, Inc. All rights reserved.