ASD Web Tools Help

ASD TIPPING SERVER - Version 1.2   

CAUTION: Only have up to 50 maximum tipping devices listening on 1 server channel. All must be within same sim as server object. List of compatible devices  

DO NOT USE THE SAME CHANNEL FOR MORE THAN 1 SERVER. If you have more than 1 Servers connected to the same channel only the most recently rezzed object will work correctly. Within a short time the older servers will shut themselves down.

IMPORTANT: Touch your Tipping items before setup and select the "Updates" button to be sure you have the most recent version.

These Instructions are separated into 7 sections:
  1. The License Box (Do this First)
  2. Server Setup Instructions
  3. Touch Menu Features
  4. Web Tools Info
  5. Using as Access List
  6. Plugins Info
  7. FAQ and Help

Related Help Topics:
  Changelog 
 ● Biggest Tipper Plugin 
 ● Most Tipped Plugin

 

********************************************

   THE LICENSE BOX - DO THIS FIRST

Before using a Tipping Server you will first need to get a Channel setup.

Rez your included "License Box" Object. (Make sure you are not set Busy.)

It will automatically create your database and issue you a Channel Number.

After finished it will Die and poof. You only get one channel per License Box. (Purchase more Tipping Server sets to get more channels.)

If there is a problem creating the database the License Box will display information in floating text and issue a warning message. Follow whatever instructions it says.

********************************************

   SERVER SET-UP INSTRUCTIONS

  1. Rez Tipping Server and select channel to use from dialog Menu. (Reset Scripts if no menu.)

  2. Touch the Tipping Server for settings menus.

  3. Select "Web Tools" button from touch menu to manage your Tipping Server on the Internet. (If you are not signed up on our site yet this button will help you get registered too. Select the button again from menu once signed up to verify account.)

  4. Create your Categories and Staff Lists on Web Tools site. (See below for more information.)

  5. Copy the channel number into the Tipping Items' Configuration notecards in your sim that you wish to connect with this server. (Tipping items can be owned by yourself or by anyone, see below for more information.) You may also specify a one word Category for each tip jar in it's Configuration notecard. Later you can choose which avatars can use tip jars set to a specific category.

  6. Select "Refresh Tip Jar List" from Web Tools or in-world server Touch Menu under "Manage" section when finished.

 

********************************************

   TOUCH MENU FEATURES

Features can be used by Managers and Owner unless noted otherwise.
Most features can also be accessed using Web Tools, (more info below.)

____________________________________________
MANAGE

Here owners and managers can: "Log Out All" listening tip items or "Refresh List" to see How Many are listening and reconnect. Use Web Tools for more commands, (more info below.)

____________________________________________
SETTINGS

Here you are able to turn various settings On or Off. You can also change these settings using Web Tools.

  USE CATEGORIES - When enabled Tip Jars will only let staff members in the same Category as the Tip Jar use them. (Use Web Tools to create Categories and set Tip Jar's Category in its Config note.)

  ALLOW OTHERS - If True server will communicate with Tip Jars owned by any avatar, as long as on correct channel. If False only server object owner's tip jars will communicate.

  OWNER IM - If enabled the server object owner will receive an Instant Message at midnight each day with the prior day's total amount tipped.

____________________________________________
ADD STAFF

Owners and Managers can add new staff members in-world to the Staff List using this feature. The staff member must be present and will need to Touch the server object when prompted to be added.

After staff member is successfully added the owner or manager will have an opportunity to set the user's role and category using Web Tools, (more info below.)

Staff members can also be added using Web Tools alone.

____________________________________________
SCHEDULE

When enabled the server will Log Out all listening tip jars at a set time every day.

This is in 24 hour time format. Midnight is 00:00:00 and 11PM is 23:00:00. You are only allowed to select the time in hourly increments.

____________________________________________
CHANNEL

Select "Channel" from Menu to learn the channel in use. Do not share your channel with anyone except your managers.

____________________________________________
STATISTICS

Select "Statistics" from Menu to see how much total has been tipped so far today, and since last reset. (Day ends at 12AM Pacific time.)

____________________________________________
SERVER ON/OFF ( Object Owner Only )

This will turn on/off all server features. Server will stop listening for tipping items and web commands while off.

____________________________________________
RESET ( Object Owner Only )

Good for if server acting strange or to load a different channel. This is the same as re-rezzing. All settings will be retained and loaded from web database. They will not need to be set again after reset.

____________________________________________
UPDATES ( Object Owner Only )

Checks to see if a new Server version is available and how to get it if so.

 

********************************************

   WEB TOOLS INFORMATION

You and your managers can use Web Tools to manage your Tipping Server, track transactions, view statistics, setup email reports, and more.

In the Touch Menu select 'Web Tools.'

If you have not already registered you will be taken to the signup page. After you're registered the "Web Tools" button in server menu will take you to the Control Panel online, (you may need to login first.)

NOTE: You must register with your site username exactly the same as your avatar name in Second Life, first and last. You will not be able to use Web Tools if your name does not match exactly. For more help registering on Web Tools please visit: http://www.asdwebtools.com/help.php


   ABOUT THE WEB TOOLS SETTINGS AND FEATURES


------ OVERVIEW -----------------

The main page for the Tipping Server Web Tools. Here you can access all sections.

Some features can only be accessed from this page including Emails, Password, and Channels. Only the owner can set these settings.

  Manage Emails: Up to 3 email addresses can be added. You can receive daily, weekly, or both email reports. Reports contain all Transaction data for a period as well as totals.

  Password: The Password is used to keep others from depositing false information into your records. Can be any word with letters and numbers only, no spaces or special characters allowed.

  Manage Channels: This is where you can set a Nickname for your server channel. Nicknames are handy for telling apart multiple server channels if you have access to more than one.


------ MY EARNINGS -----------------

Here you can view summaries of your total earnings, or any staff member's total earnings, for any particular day, the last 7 days, any month, or year.

To view earnings summaries for your staff you must add them to Staff List on Web Tools, info below.


------ TRANSACTIONS -----------------

This will show you all transactions from all devices connected to your Tipping Server.

You can view transaction logs from any day, the last 7 days, and any month. You can export the lists to CSV for saving to your computer or opening in programs like Excel.

You can also search all transactions here. Search by tipper name, staff, or more options.


------ STATISTICS -----------------

This will show you graphs for your tipping Categories in addition to lists of your Biggest Tippers, and Most Tipped staff.

You can view this data by Day, Last 7 Days, Month, or Year.

Set your Categories on Web Tools and put category name in each of the Tip Jars to see which of your jars makes the most money with these graphs!


------ SESSIONS -----------------

Sessions start when user logs into tip jar and end on log out. It shows how long a user was logged into a jar, how many tips were made during that time, and how long the sessions was.

You can sort sessions by time, tips, amount, and more. You can view sessions for a particular Day, Week, or Month.

You can export session lists to CSV for saving to your computer or opening in programs like Excel.

Click on Session Details icon to view stats and all Transactions during that session.

TIP: Use Auto-Logout feature in your Tip Jars to make sure all sessions get closed when user is done working each time.


------ STAFF LIST -----------------

Add all of your staff members to the server to keep track of their stats as well as allow them access to certain tip jars or even use Web Tools to manage your server online!

You can add staff either in-world using the Tipping Server's touch menu or on Web Tools from this section. You must be sure the avatar name and avatar key match SL exactly or it will not work. Always use Legacy Names for staff members: http://www.aliciastella.com/modules/AMS/article.php?storyid=46

Once your staff members have been added to Web Tools you can set whether they're normal staff or "Managers" by clicking on EDIT for a user. Managers can log into all tip jars and can use Web Tools to manage tip jars online. (See next section "USING THE TIPPING SERVER AS AN ACCESS LIST" for more info on adding staff for access to jars.)

It is possible to set individual percentages for each staff member on Web Tools. See next section "USING THE TIPPING SERVER AS AN ACCESS LIST" for more info on adding staff for access to jars.

You can also view the Staff Rankings from this section. Staff Rankings will sort the staff by who is making the most money for the last 90 days, any particular day, week, or month. Ranks are refreshed nightly automatically or you can click on "Refresh Ranks" link from top of page to do it manually any time and see the updated rankings list.

TIP: If a staff member is not showing any tips even though there are transactions in history make sure their name and avatar key match exactly in the staff list as they do in Transactions.


------ DEVICE LIST -----------------

This shows a list of all connected tipping devices. From here you can Log Out, Refresh, & Edit device settings.

You can log out individual jars or all jars at once.

You can Edit individual jar's settings, all jars in a Category, or all jars at once. (Be careful because jars will revert to notecard settings if reset inworld.)


------ CATEGORIES -----------------

Here you can view and create Categories for your Tip Jars.

Categories should be simple, one word, with no special characters. Put the category name in your tip jar's Configuration notecards. Category names are CaSe SeNsItIvE so make sure they match the web exactly when adding them to jars.

Categories serve three primary functions:

  For tracking which groupings of jars are making the most money. For example I may have a Category named "DOWNSTAIRS" and another named "UPSTAIRS", each is used in my donation boxes at my club for the ones downstairs and upstairs. I can view the Statistics pages and see at a glance which groups of donation boxes are pulling in the most money.

  To allow certain staff members to only log into certain tip jars. You can set your staff members to one category each on the staff edit page. Then they will be restricted to only logging into jars set to that category. More info on that can be found in the next section: "USING THE TIPPING SERVER AS AN ACCESS LIST".

  Categories can also be used for mass editing settings using Web Tools, allowing you to change settings for all jars set to a specific Category, rather than just one or all of them at the same time.


------ SETTINGS -----------------

You can also change these settings in-world from the Server's touch menu.

  USE CATEGORIES - When enabled Tip Jars will only let staff members in the same Category as the Tip Jar use them. See next section for more details.

  ALLOW OTHERS - If True server will communicate with Tip Jars owned by any avatar, as long as on correct channel. If False only server object owner's tip jars will communicate.

  OWNER IM - If enabled the server object owner will receive an Instant Message at midnight each day with the prior day's total amount tipped.

  SCHEDULE - When enabled the server will Log Out all listening tip jars at a set time every day. You are only allowed to select the time in hourly increments.


------ PLUGINS -----------------

Tipping Server Plugins add additional functions, but are sold separately. Here you can manage any plugins you have purchased and edit settings specifically for them. See the Plugins section below for more info.

 

********************************************

   USING THE TIPPING SERVER AS AN ACCESS LIST

  1. Create Categories using Web Tools (see more above). Categories should be one word with no special characters. Examples are "DANCERS" or "HOSTS." Category names are CaSe SeNsItIvE.

  2. Add all the Staff Members to the Staff List either inworld using server menu or online using Web Tools.

  3. Using Web Tools assign each employee a category in the "Staff List." (Employees set as Managers will have access to all tip jars regardless of their category.)

  4. In the Configuration notecards for each Tip Jars you need to set the Category you wish to allow access. The Category name must match exactly.

  5. You can turn the Tip Jars' built in Access List option and Group-use options off in Configuration if you like.*

  6. Be sure to have "Use Categories" setting set to TRUE in Settings page on Web Tools or in touch menu for server.

*NOTE: When an avatar touches a tip jar while Groupuse is on the user's group tag will be checked first by the script. If they are same group they will be allowed to log in. If not, the built-in access list will be checked next, if enabled. If not enabled, or if not in list, the user will be checked by the Tipping Server last. Turn off Groupuse and Access List if you only want to use the server to check for authorization.

 

********************************************

   TIPPING SERVER PLUGINS INFO

Tipping Server Plugins add additional functions but require a Tipping Server to work. Plugins are sold separately. Currently the "Biggest Tippers Boards" and "Most Tipped Staff Boards" sets are the only plugins available.

Once purchased a plugin may be applied to one server channel only. Multiple copies of a plugin would need to be purchased if you own more than one channel and wish to use the plugin's features for each.

Plugins available at ASD Main Store and online here.

Plugins Full Instructions: Big Tipper | Most Tipped

 

********************************************

 FREQUENTLY ASKED QUESTIONS / HELP

  Q: Why can a channel only be used in 1 sim at a time?

    A: Most server data is stored in a web database and the last unit to store data will be the only working unit running if more than one on same channel, even if in different sims.

 - You can only have 1 server running on a channel. -

 

  Q: Is it alright if I use a channel in one sim for awhile but then move it to another sim?

    A: Yes, as long as it's never 2 sims at same time.

 

  Q: Is there a limit to how many CHANNELS an avatar can purchase?

    A: If you own 21 or less Channels it will be okay. If you do happen to own 22 or more you will need to IM Alicia Stella for a new version of the Tipping Server object. The current version can only handle up to 21 Channels but can easily be updated for you, just ask.

   

  Q: Why is it sometimes when I am clicking on the Server Object it doesn't respond?

    A: When using the Server in world I suggest always zooming your screen close enough to clearly make out the little Green and Red lights, (on the bottom-right corner.) Sometimes while the red light is on the server may be busy. (Red light also on while server Off.)

 

  Q: Why did my Tipping Server just suddenly Shut Down?

    A: If you rez another Server Object and set it to the same channel already in use the older object will Shut Down and IM the owner. (This will happen between 3 and 6 hours when the server tries to check into the web database.) In rare occasions it could be caused by web connection issues. Touch and select Reset from menu if it happens.

 

  Q: It says my Web Tools account is not "Verified." What's that all about?

    A: You just need to select the "Web Tools" button from the in-world server object's Touch Menu. Your account should then be verified and your option to manage servers will appear on the site. (If even after this it still says unverified or does not show you as owning a server on the site please contact Alicia Stella for assistance.)

   

  Q: Why can't I get Web Tools to work? I can login but not access my servers.

    A: Did you create your Web Tools' Username *exactly* as your name in Second Life? It must be your First and Last name with a space in between. Example: "Alicia Stella" If you need to change your username contact Alicia Stella. Do not create a new account.

 

  Q: I'm trying to change settings from the web and it keeps saying: "Sorry, connection not successful. Please try again." What can I do?

    A: You should select "Reset" from in-world Touch Menu. This will force a new communication key to be formed. The problem may sometimes occur after a sim restart and usually corrects itself within a few hours. A reset will force it faster is all.

 

ADVANCED SCRIPTING OPTION:  Also included in the original box is a "Custom Script." You can drop that into your Tipping Server object and edit it to do something when a Tip is Paid to any of the listening Tip Jars. See the inside of the script for more information.

CAUTION: Only have up to 50 maximum tipping devices listening on 1 server channel. All must be within same sim as server object.

All times are Pacific Standard/Daylight Time US (SL Time.)

 



 // CHANGELOG //

VER 1.2 - January 2015: Update

  Fixed major bug that could crash Tipping Server if Second Life is having trouble connecting to web server.

  Individual staff member percentages added, set through Web Tools. Requires Tipping Server and version 6.0 (or greater) of all your tip jars. (Not available for dance furniture.) You can set each staff member to a specific percentage, or set a percentage for an entire Category for them to use, or continue to use the percentage set in the tip jars' Configuration notecards. Each staff member can have a different setting.

  Other bug-fixes added to help system run more smoothly.

  Instructions notecard updated with more details on web tools use and settings.


VER 1.1 - August 2010: Security Update

VER 1.0 - November 2009: Product Original Release