16.0 Environment Groups Configuration¶

16.1 Overview¶

In order to restrict certain areas in an environment or the ability to invoke particular triggers content developers utilize the concept of user groups. Once the environment is deployed to a web.alive server, an administrator can use the User Administration panel (as seen in the figure below) in the server's Admin Panel to add users to the particular groups supported by the given environment. In order for the environment's groups to show up accurately in the Admin Panel the content developer must accurately describe the environment's groups in its associated "group.xml" file.

16.2 Group.xml¶

The "group.xml" file can be found under the "LevelAssets" directory in any web.alive Editor project. It describes the groups that are used within that project's environment. An xml editor is highly recommended when editing this file, but any text editor will do. An example of a typical "group.xml" file can be seen below.

<?xml version="1.0" encoding="utf-8"?>
<configurableWindowsGroups xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <item fullName="ServerAdmin" shortName="Administrator" groupType="General" pixelSize="90" description="The Server Administrator has the ability to kick/ban, mute/un-mute users as well as modify sign data" toolTipDescription="The Server Administrator has the ability to kick/ban, mute/un-mute users as well as modify sign data"></item>
  <item fullName="Moderator" shortName="Moderator" groupType="General" pixelSize="70" description="The Moderator has the ability to kick/ban, mute/un-mute users, but cannot modify sign data" toolTipDescription="The Moderator has the ability to kick/ban, mute/un-mute users, but cannot modify sign data"></item>
  <item fullName="MeetingRoomPresenter" shortName="Meeting Room Speaker" groupType="General" pixelSize="100" description="The Meeting Room Presenter has the ability to present slides and use a laser pointer inside certain meeting rooms." toolTipDescription="The Meeting Room Presenter has the ability to present slides and use a laser pointer inside certain meeting rooms."></item>
  <item fullName="AuditoriumPresenter" shortName="Auditorium Speaker" groupType="General" pixelSize="100" description="The Auditorium Presenter has the ability to present slides and use a laser pointer inside the main auditorium." toolTipDescription="The Auditorium Presenter has the ability to present slides and use a laser pointer inside the main auditorium."></item>
 </configurableWindowsGroups>

In the above example, four groups are defined as being used within the associated environment. Looking at the first entry:

  <item fullName="ServerAdmin" shortName="Administrator" groupType="General" pixelSize="90" description="The Server Administrator has the ability to kick/ban, mute/un-mute users as well as modify sign data" toolTipDescription="The Server Administrator has the ability to kick/ban, mute/un-mute users as well as modify sign data"></item>

The following attributes must be provided for each group in your environment:

fullName is the full group name as it is used with the environment

shortName is the short name as it will appear in the User Administration panel

groupType is the group type for possible future use. It should be set to "General".

pixelSize is the number of pixels to reserve in the User Administration panel to display the ShortName value.

description is description of the group

toolTipDescription is a description used for any tool tip associated with the group

The group.xml from your web.alive Editor project is included in any exported WAE file and will be used by the Admin Panel once the WAE file has been deployed to a web.alive server.