Tracker Robot User Manual

Tracker is a very powerful AW robot with heavy MySQL database usage. With the TrackMap utility you can have visual interpretation where your visitors go in your world, you can create movement playbacks for the Crowd  bot.
Tracker is meant to communicate only with its caretakers (with the exception of the Elevator Control) so the average user will not see it in operation.

The robot's primary purpose is to keep track all visitors within a world. It helps GateKeepers to identify visitors, handle an IPWatch list and provides means to get the most out of your world. It has several useful plug-ins to handle separate tasks.

The bot is running in the background, all interaction with it can be done online through chat commands. Base version is running under Linux OS but there is a small Windows wrapper to make it available for those unlucky users who stuck with Windows.
This manual assumes you have a fair understanding of the MySQL database commands/client and the AW technology itself.

The robot currently is available for both the 3.6 AW and the 4.1 AW Universe versions too. TrackerBot is a commercial application, please contact me about pricing.

The bot gets all necessary parameters from its ini file.
New feature: The ini file can contain only the parameters of a MySQL table which contains all the configuration!
If the program finds the SqlConfiguration=1 in the ini file's [IniConfig] section, it will read first all values from the ini file, then overrrides it with the values read from the MySQL table and finally updates the MySQL table with the new values. In case the corresponding table doesn't exists, the program tries to create the table for you.

Fills it's internal tables(Caretaker list, Language tables, Visitors and IPWatch list) from the MySQL database then logs in into the world (the bot can be invisible but in this case you should give CT rights to the owner's citizen number in that world).

Every time starting the bot will try to create the core MySQL tables if they don't exist and adds/modifies the bot owner to the caretaker list with full rights.

It will monitor all visitors coming and going and their movements inworld and record it to the Location database. Movement records can be reduced with the built-in calculation method, which only records the beginning and the end of a straight-line move.

You can assign different caretakers for different rights, so you can have a GateKeeper who deals with IP watching or someone who just receives new visitors entry message:

RightToBotControl         - This caretaker can create/modify caretakers, he has full bot controlling rights.
RightToIPReport           - Those caretakers can edit the IPWatch list and will receive the IPWatch warning messages.
RightToVisitorReport      - They can receive notification of the entering/exiting visitors (their name and preferred language)
RightToReceiveIP          - Those caretakers can receive the IP address of the visitors entering.
RightToBadWord            - Those caretakers can add/modify the bad words table and receive a message if someone used them

Caretakers can customize the appearance of the robot messages with the console command for easy view.

Each visitor entry and exit can be reported to caretakers who have rights to receive them if they sign up for those reports. The bot performs a reverse lookup on the visitor's IP address which can help to locate him/her on the globe and tries to determine the default language the visitor is using based on his top level domain.

Helper    Andras Lang=HU

Those caretakers who have IPWatch rights can manipulate the IPWatch database through commands. They can add new IP address with some meaningful description and username to the table. When using multiple Tracker Bots with a common IPWatch database, consider using the real-time update flag to ensure all bots are in synch or be sure you reload the table when one bot modifies it. Each entry is matched with the IPWatch list and if match found, a warning is issued to all caretakers inworld about the event:

All chat can be logged on demand to a separate log file called tracker.chat.log. Robot messages/errors/etc. is constantly logged to the console (Linux version) or to the tracker.log file together with the memo box (Windows version).

Caretakers can get all current visitors' location by issuing the /vis command.

You should grant the following privileges on the MySQL database for the robot: with a strong password
+-------------------------+--------------------------+-------------------------------------------------------+
| Privilege               | Context                  | Comment                                               |
+-------------------------+--------------------------+-------------------------------------------------------+
| Alter                   | Tables                   | To alter the table                                    |
| Create                  | Databases,Tables,Indexes | To create new databases and tables                    |
| Insert                  | Tables                   | To insert data into tables                            |
| Select                  | Tables                   | To retrieve rows from table                           |
| Update                  | Tables                   | To update existing rows                               |
+-------------------------+--------------------------+-------------------------------------------------------+

The Portal Control allows having Customers for detailed statistics. Each customer can own Booths, signs, URLs, etc inworld. The bot keep track of visitors in the customer's locations, number of URL/Object clicked, time spent within a booth. Once you set up the Customer database, you can assign any objects to the customer, specify its category (booth, sign, URL, etc.)  by the portal control commands. Customers can have advertising, which changes to another one when a visitor clicks on it, or just change them periodically with the given time frame. They can have links pointing to their web pages and the bot can push those to the visitor's 3D window or to the web window together with the URL whispered to them. You can rent those booths to the customer and charge by the visit frequency/time spent in their location, etc. The bot's commands and responses give you full control during the development phase of the Portal and during its operation.
Current implementation is based on a 13 story, 4 towers building but it can be changed by explicit order. For making the floor references simpler, the bot uses a floor cross-reference table.
There are two major object concept within the implementation:

When you prebuild the world (preferably with a single ground object), you can build the rooms/suites within the given environment. Each room/booth/suite should have an entry in the BoothLocation database, which describes it location and size. Those values provide the basis of the "Visiting" status of a booth. Furnishing objects can be inside the booth or somewhere else and they are assigned to a customer to keep track of the density the given customer should be charged and to provide the basis of calculating clicks(hits) or submitting advertisements. The later ones are residing in a separate table with their display duration and click actions.
The Customer table should be filled by some sign-in web page where the customer is able to retrieve the statistics of the visits too. This exercise is left to you, I don't have a working example.

There are several commands helps you build the area and assign them to customers. Almost all action is based on simply selecting an object (right click) but not changing it. You can preset which customer should own the object then with right clicking (or multiple selection) the bot will assign those objects to the preselected customer. Few commands operate on the "last selected" object.

With the Elevator Control, you can have multi-story buildings with elevators and your visitors can go there by telling the bot their desired destination. E.g. Floor 3 will bring them to the nearest 3rd floor elevator door. Floor 7 n  will teleport the visitor to the North Tower 7th floor.

The Elevator control has a multi-language communication database where you can have the messages/commands stored in several languages. The first entrance based on his Top Level Domain automatically determines the visitor’s language. Each visitor can change his language to his preferred one by issuing the LANG command to the bot. Current implementation uses 5 different languages: English, Dutch, German, French and Hungarian.

Entry Control gives you the ability to expand the "Entry Rights" list within the world options to unlimited number of visitors. The list can be defined in two separate method (selectable by the ini file's EntryListRanges parameter).

The EntryRange mode uses the visitor's citizen number or the privilege number to determine if this visitor is allowed to enter the world. The bot uses the EntryDatabase's Entryrights table to retrieve the right for the visitor. If the visitor has no right to enter to this world, the bot tries to determine if it has any world within its rights where the user is allowed to go and will teleport him there. If there is no such world then the visitor is teleported to "Nowhere" world. If the Entryrights table doesn't exist or empty, the bot will create one for you and puts the bot's owner citizen number there to grant entry for the owner.

The Classified method uses a vast database where each citizen number has an assigned classification to determine their entry rights. This later feature can be used for creating closed party or invitation only visits. Entry rights should be inserted into the Citizen table.

The teleportation puts the visitor in to a slight random location around the desired address, so they won't end up on top of each other.

In both method you can add/delete citizen numbers/ranges to the database.

With Weather Control, you can have a Weather Pattern played back in your world anytime. The pattern contains all environment related variables (water level, fog, light direction, color, etc) and optionally you can even issue Immigration Officer messages during the playback. With the /recordweather command you can create your own record pattern while inworld. Just start the weather recording with a unique pattern name and change the world options settings. The bot will put another entry to the WeatherSequence table and will record all changes together with the time duration into the WeatherAction table. Issuing another record command stops the recording and the new pattern is ready to play back. If you want to manually/programmatically edit/create a pattern: those fields you leave NULL in the database will not be changed during playback. You can specify a single weather pattern to be played back regularly in the ini file. The weather patterns can be interrupted/restarted by commands too.

Exhibit Control gives you an excellent tool to create an exhibit where you can use prebuilt booths for placing them into a predefined spot. The prebuilt booth has special designators for those models that can be changed/assigned by the exhibitor. Your exhibitor, who can have all booths visible on a web page, can do the booth selections and he can fill in all the signs, pictures, URLs for his exhibit. The bot (and the corresponding web pages) simplifies the booth building and helps you creating an outstanding exhibition.
If you use together with the Portal Control feature, you can keep track of the individual exhibitor's hits.

Your customers (exhibitors) will use a web driven interface where they can select a booth location, pick which booth they want there and they can fill out the signs/textures/URL etc fields of the pre built booth. This web interface will create the necessary property data in the MySQL database. When you decide your customer finalized his request, you can command the bot to build those exhibit spots automatically for you.

First you have to create the exhibit world and place the booth designator object on those spots you want to have the bot to build booths. When you are satisfied with the layout, create a map of it with the MapView utility.

Next phase is you create the booth templates for the exhibition. Build the booth template on a clear area in your world. Assign special action commands to those objects, which are customizable by the customers (logo textures, URLs, streaming media, etc.). When you are happy with a template, command the bot to query and save that template to the database.

Class control can be used to hold presentation, keep your visitors off the stage, etc. You have to build your auditorium for the class: a stage where the speaker and his invited listener can go and chairs where the visitors can sit.

When a visitor clicks on a chair, the chair turns into invisible (so others can't click on the same chair), the visitor is teleported to that chair, his/her avatar is changed to a predefined new avatar (e.g. a sitting avatar) and  he can be summoned to the stage by the speaker. The visitor can leave his chair if shift is enabled in your world but there is another control option within the bot that pushes the visitor back if he is not allowed to leave the chair. This feature can be changed while the bot is running. The visitor can leave his seat by clicking to a predefined Gesture button in his browser. In case the visitor leaves his chair, his original avatar is assigned back to him and he is teleported back to the location he came from. Only those visitors will be seated, whose avatar number is in the ini file list.

The Teacher/Speaker can summon a sitting avatar to the stage by clicking on the sitting avatar. The bot will teleport the avatar to the stage. The speaker can send him back to his seat by clicking on the avatar on the stage again.

• dbprefix_badwords - which holds the regular expression of the bad chat, the severity of this offense and a description to explain why this expression is bad.
  
• dbprefix_quarantine - which holds the severity threshold, the quarantine duration, the world name and the quarantine coordinates.
  

Lists your active status. E.g.: IPWatch langdef visitor IP Included (this CT will get IPWatch warnings, User language preference, User entry/exit with IP)

Sets the console message color,bold,italic,leading string values.
E.g.: /console 192 0 0 1 0 Helper  will produce all messages like: Helper    Andras ( giant.andras.net ) 194.152.129.209 Lang=EN

- toggles visitors report

- toggles visitor exit report

- toggles 'new visitors only' report (does not report those who were inworld recently)

- lists current visitors. E.g.:
[Alice] (236)        2.00N 2.00W 0.10a 342
Andras (236)        0.76N 1.30W 0.00a 272

- toggles visitors IP address report

- toggles IPWatch report

- sets IP to watch. E.g.:  /setip 192.168.0.1 Username dirty language

- delete IP to watch

- List IP watches. E.g.: 80.57.46.201 name=misc Msg=Must be banned! Using a craked "tourist bot" to fill the visitor list

- Starts a full world query

- adds caretaker with rights:

• full - the user has full bot control rights
• bot - the user can use bot controlling commands like /suspend.
• upd - the user has rights to create portal objects
• query - the user can issue MySQL commands to the portal database
• ip - the user can receive IPWatch warnings
  
• visitor - the user can receive visitors entry/exit notification
• report - the user can use all reporting features of the Portal plug-in
• address - the user can receive the visitor's IP address
• teacher - the user can act as a teacher/moderator in the ClassControl pug-in.
  

- deletes caretaker
Those two commands can be executed by a CT who has full rights. If you accidentally change your own full right, you have to modify the CareTaker table entry in the MySQL database.:

+--------+------------------+------+-----+------------+-------+
| Field  | Type             | Null | Key | Default    | Extra |
+--------+------------------+------+-----+------------+-------+
| citnum | int(11)          |      | PRI | 0          |       |
| rights | int(10) unsigned |      |     | 2147483647 |       |
+--------+------------------+------+-----+------------+-------+

- list caretakers. e.g.:
324 ip visitor
193 ip visitor address

-  reloads the bot's database from the MySQL database

-  reloads the bot's database and the object database from the MySQL database

-  tells you your current location and the potential Customer who owns the Location

-  suspends all bot activity except chat logging

-  resumes bot activity (issue a reload too!)

- toggles all move recording versus no straight line check

- toggles all enter recording versus only if session changed

- exits the bot! Don't use it if you can't access the computer where the bot is running.

- Enables URL listing when clicked

- toggles density, ownership report when selecting an object.

- Disables URL listing when clicked

-  all consecutive object selection will assign the object to the Customer and sets the type to Furnishing type and inserts the object to the Furnishing database if it is not there. e.g.:  objselect 0 LgSign   will remove the current ownership if it is there and add the object to the Large Signs Furnishing issuing another objselect command will turn the feature off

-  all consecutive object selection will assign the object a push URL Updates (and delete the previous one if exists)

- disables the URL assigning

- assign URL to the last selected furnishing

- assign customer to the last selected object (like objselect)

- assign customer to the Furnishing

-  all consecutive object selection will assign the object a Teleport Updates with your current coordinate

- disables the Teleport assigning

- clears the last selected furnishing Teleport assignment

-  toggles the bot relay MySQL command state. Each command should start with the letter 'q' and that letter is stripped from the command

-  start/stop recording all world options to the database with the given name. This recorded "weather" sequence can be played back later by the next command. The robot checks for the pattern name uniqueness!

-  start/stop playing back a weather pattern

-  triggers timed weather pattern playing where frequency is given in minutes

- undocumented automatic water movement generator. This command generates water movement only.

  - Add enter right to the citizen(s) within this world. While in classified mode, it will create "General" type citizen entry right list into the Citizen table. EntryList mode will add the range to the Entryrights list;

  - Revoke enter right to the citizen(s) within this world. The bot properly handles overlapping ranges.

  - Reloads enter rights for this world from the database. No need to issue if you use RealTimeEntryDatabase flag.

- toggles class control feature (literally disables/enables all class control related activities)

- toggles sticky chair feature: Is the user can leave its seat by moving or only with a given gesture

- sets the height offset of the stage - only use if the stage object center position is different then its top.

- Query radius meter around your avatar and save this template as "name" in the database. Make sure there is no other pieces with the radius which doesn't belong to your template. The center of the templace will be your avatar position and its orientation is your facing angle.

- Query around the center address a rectangle which size is determined by thenssize and wssize parameters (in meter!). Designate the orientation angle of the template with the orientationangle parameter (in degrees). Example: /queryat  1.1s 3.44e 180 5 10 newname

- registers build requests on lotname

- starts all registered build requests

- toggles visitors bad word usage reporting

- list the bad words regular expressions (could be a LARGE list!) 

- reloads the bad words list from the database (in case someone modified it with a different bot ot in a different world)

- deletes an item from the bad words list identified by ID

- deletes all bad words from the list which description has a match with the given regular expression

- adds a new bad word with the given severity value to the table. Description must be terminated by a semicolon followed by the regular expression

- if called without any parameter, it displays if the quarantine is enabled and what is its parameters (severity,duration,location)
- if severity threshold=0 then it deletes the current world's quarantine entry from the table and disables the quarantine feature
- if threshold and duration is given, the bot inserts the new entry to the quarantine table and enables the quarantine feature.