Kentico CMS 6.0 Developer's Guide

On-line users web part

On-line users web part

Previous topic Next topic Mail us feedback on this topic!  

On-line users web part

Previous topic Next topic JavaScript is required for the print function Mail us feedback on this topic!  

The module comes with the On-line users web part. In the web part selection dialog, you can find the web part in the Membership -> Users category. The image below displays the output of the web part enclosed in the Orange box web part container.

 

devguide_clip0690

 

The web part displays a summary defined by the Additional info text property, followed by a list of users that are currently on-line. Users are displayed based on the transformation specified in the Transformation name property.

 

The web part has the following related properties:

 

Transformation name

Sets the transformation used to display the on‑line users.

 

You can use the default CMS.Root.OnLineUsers transformation, which displays user names separated by spaces.

Path

If you enter an alias path here, only users that are accessing pages found under the specified path will be displayed.

Select top N

Sets the maximum number of users that can be selected and displayed.

Additional info text

Sets the text which will be displayed above the list of on-line users.

 

You can use the following formatting macros that will be resolved into the appropriate number:

 

{0} - number of all connected users

{2} - number of connected registered users

{1} - number of connected anonymous users

No users on-line text

Sets the text that will be displayed if no users are currently on-line.

Columns

Lists which columns should be loaded from the CMS_User or CMS_UserSettings tables along with user records. Column names need to be separated by commas ( , ). Specifying a list without unnecessary columns may significantly improve performance.

 

These columns may be used in the code of the specified transformation to display data related to the on‑line users.