• Examples (iOS)
• Examples (Android)
• Examples (C++)
Server API Documentation

 

» Zone Configurator module

The AdminTool's Zone Configurator allows configuring Zones and static Rooms that will be generated automatically each time SmartFoxServer 2X is started. Administrators can create new Zones and Rooms, or modify the existing ones.

Please refer to the Zones and Rooms architecture overview for additional information. A video tutorial showing a walkthrough of the main SmartFoxServer configuration settings is also available in our YouTube channel.

Zone Configurator module

» Usage

When the module is accessed, the list of currently configured Zones is requested to the server. The list is automatically updated should another administrator add or remove a Zone (proper system messages are displayed too). A single click on a Zone name populates the list of static Rooms belonging to that Zone.

Gray names in the two lists indicate Zones and Rooms which are not active yet (see the note below too). This can happen if they have been added after the last server restart, or if an error occurred when created during the server's startup process (for example a Room with an invalid name lenght).

Click on the Create/edit/remove Zone or Room buttons buttons in the respective columns to add, edit or remove a Zone or a Room within the selected Zone. Editing can also be initiated by double-clicking the the Zone/Room name. Deleting a Zone also deletes all its Rooms.

When editing is entered, the right area of the module displays the configurations settings, while the Zones and Rooms columns are disabled. Settings can be reloaded at any time by pressing the Reload button located at the bottom of the editing area. Click on the Cancel button to go back to the Zones and Rooms lists.

In order to submit your changes, press the Submit button. In case of concurrent changes made by different administrators, an alert message is displayed.

IMPORTANT
Configuration changes are not applied automatically by SmartFoxServer 2X when submitted. You need to restart the server for the changes to take effect or, in case of a newly created Zone, click on the Activate Zone button Activate button near the Zone name in the Zones list.
A little warning sign in the bottom right corner reminds that a restart is needed on configuration updates.

If enabled (green), the Make Zone backup switch located near the Submit button allows creating a backup copy of the existing Zone settings before saving the new ones. This is highly recommended. A corresponding switch for the Room settings doesn't exist because they are a subset of the parent Zone settings.
The backup files are located in the [sfs2x-install-folder]/SFS2X/zones/_backups folder and are named using the following convention:

In order to restore a backup, rename it to [zone-name].zone.xml (for example SimpleChat.zone.xml) and move it to the [sfs2x-install-folder]/SFS2X/zones folder, overwriting the existing file.

» Configuration settings

The Zone and Room configuration settings are both divided into a number of tabs. Most of the settings are self-explanatory, anyway they are all accompanied by the Help icon Help icon: keeping the mouse pointer over it for a moment shows up a tooltip with basic information. Reading such notes is highly recommended.

The following pages show the screenshots of all the Zone and Room tabs and enter into deeper details about the less straightforward settings.

 

« back to AdminTool