Salesforce

ClientSessionStatisticsGet (Magic xpa 4.x)

« Go Back

Information

 
Created BySalesforce Service User
Approval Process StatusPublished
Objective
Description

ClientSessionStatisticsGet (Magic xpa 4.x)

This client-side function returns information about the current session.

Syntax:

ClientSessionStatisticsGet()

Parameters:

None

Returns:

The function will return:

  • Requests Count

  • External Time: time, in ms, which the client was waiting for requests to complete. The External Time is the combination of network time + Middleware Time + Server Time.

  • Middleware Time: time, in ms, which requests were waiting to be selected by available servers.

  • Server Time: time, in ms, which the server was processing requests.

  • Session Time: overall time, in ms, since the client was started until it ended.

  • Upload (in kb)

  • Download (in kb)

  • Upload ratio (%)

  • Download ratio (%)

(Upload ratio, Download ratio – Since version: 1.9)

Usages:

A typical usage of this function is to take several snapshots and compare the difference in the amount of requests or/and External time.

Example:

ClientSessionStatisticsGet()

Note:

This is a client-side function that is only available for Rich Client tasks.

This function sends a request to the broker, which increases the number of requests.

When the program is executed from the Studio, there is no compression, so the download and upload ratio will be 0%.

Exceptions:

This function is not supported in Web Client tasks.

See also:

[MAGIC_RIA] section in the Magic.ini file

How Do I Fine Tune My Rich Client Application?

The Rich Client Samples project (program RRC10)

Since version: 1.8

Reference
Attachment 
Attachment