My favorites | Sign in
Project Logo
                
Search
for
Updated Aug 19, 2008 by russ.phillips.nospam
Labels: svn
AdminManual  
Administrator manual (svn)

Bitsand Administrator's Manual

This is a manual for Bitsand administrators.

General Notes

An administrator can edit any player's OOC or IC details, at any time. Players cannot modify their own details once they have been confirmed, but an admin can still edit the details for them. There is an extra box visible to administrators when editing a player's OOC details - this is labelled "Admin Notes (only visible to admins)". As it says, anything entered here will only be visible to other administrators - the player will not be able to view anything entered here. This can be used to record sensitive or confidential information (eg "Don't bunk with J. Random - they hate each other").

(LT Only): Administrators can select illegal combinations of skills when entering IC information via the admin pages. If an illegal combination is entered, a warning will be displayed and a note will be appended to the IC Notes box.

There is a page (linked from the main admin page) which displays all users with admin notes or (in the LT version) illegal skill combinations.

Administrators can also add users, using the "Add a new user" page. This can be useful if some players prefer to send in paper booking forms instead of booking online. Note that it is possible to add players in this way, and confirm their booking, even if there are no more spaces left.

Disabled Accounts

If a user enters an incorrect password too many times, their account is disabled. If this happens, e-mails will be sent to the user and to the technical contact (defined by TECH_CONTACT_MAIL in the configuration file).

The account can be re-enabled by simply setting a new password. This can be done by the user themselves, using the "Lost Password" page, or by an administrator, using the "Password Reset" page. In either case, an e-mail will be sent to the user with their new password.

Payments & Bookings Status

NOTE that as of Bitsand version 3.0, you must have a Business or Premier account to use the PayPal features of Bitsand. This is because version 3.0 uses Instant Payment Notification, which is only available on Business and Premier accounts.

Payments can be made through PayPal (if it is enabled in the configuration file), or by other methods. If PayPal is enabled, PayPal payment buttons will be displayed. If a user pays using PayPal, they will be automatically marked as paid. If they pay using any other method, they will have to be marked as paid by an administrator. This can be done via the "Payments Received" page. If any booking types are free, then users will see a "Finalise booking" link. Users clicking on that link will be automatically marked as paid.

The "Bookings Status" page shows players that have confirmed either IC or OOC details. It shows which sets of details have been confirmed, and whether or not the player is marked as paid.

Players that book using methods other than PayPal can be marked as paid via the "Mark payments received" page. If a player is going to pay on the gate, this can be marked here.

You can track the amount of money paid by a player, and the amount you expect them to pay. Any Paypal bookings will have these values filled in automatically. When you "Mark payments received" you can also set the amount paid and expected. Sensible default values will be selected.

Bunks

Players can request a bunk when booking. Bunks are assigned by an admin, using the "Assign bunks" page. This page shows enough detail to identify the player, along with dates that the player confirmed details and was marked paid. The dates are given so that bunks can, if desired, be allocated on a first-come, first-served basis. Medical information is also shown, so that medical cases can be given priority.

Booking CSV Export

Booking data can be downloaded as a CSV file using the "Save bookings to csv" link. This file can be opened in any spreadsheet or database program, and can be used as the source for a mail merge.

Telephone numbers will be prefixed with ". " and suffixed with " ." - this is to ensure that your spreadsheet/database program treats it as text, and not a number, thus preventing it from stripping any leading 0s. (As an example, a phone number of "0123456789" will be exported as ". 0123456789 ." - the extra characters should be unobtrusive enough that a human can ignore them, but they ensure that a spreadsheet or database will display it exactly as exported.

Where skills & OSPs have long names, a shortened version will be exported. In the case of skills, the full name will be displayed in the header row, but the short version will be used in all other rows. This is done to facilitate using the spreadsheet as the source for character card data, since the full names of many skills simply won't fit on a character card.

Setting up for an Event

Assuming Bitsand is already configured and set up, the following steps need to be taken in order to be able to take bookings:

  • Remove any existing bookings (this can only be done by the root user, using the "Remove all bookings" page)
  • Edit inc_event.php (in the inc directory) and event.php (in the top-level directory) with the event details
  • Copy a printable booking form to the img directory (a PDF file is recommended. PDF Creator is a good, free tool that can create PDFs from any Windows application)
  • Edit the settings for PLAYER_SPACES, MONSTER_SPACES, STAFF_SPACES, TOTAL_SPACES, BOOKING_FORM_FILE_NAME & EVENT_NAME in the configuration file. Update prices in the configuration file, if required.

FAQ

The FAQ items are stored in the database, and can be edited using the "Add/edit/delete FAQ items" link from the main admin page. This page lists the current FAQ items, in editable text boxes.

Note the following, which are true when editing existing FAQ items and when adding new ones:

Groups, Locations and Ancestors

The list of groups, locations and ancestors are stored in the database, and can be edited using the "Add/edit/delete groups" and "Add/edit/delete locations" links from the main admin page. Each page lists the current groups or locations (as applicable), in editable text boxes.


Sign in to add a comment
Hosted by Google Code