Location: PHPKode > projects > eCanteen > ecanteen/documentation/ecanteen_user_guide.txt
eCanteen User Guide:

Setup:

Register by clicking the "Sign-Up!" link on the login screen.
Enter Username.
Enter Password.
Enter Email address.
Click Join.
Click the "log in" link to return to the login screen.

Login with the username and password entered above.
Click "My Details" link to edit personal details.
Enter First name, Last name and mobile number - click post to save.
Click "Return to main menu" to go to main screen.

Click "Manage Minors" to set up minor accounts.
Click "Add record" to enter data entry screen.
Enter First name, Last name and class ID. Click "Active" checkbox to activate account.
Click "Post" to create account.
Repeat for all required accounts.
Note - user-level activation determines if the account can be activated by users.

Make payment to admin to gain pre-paid credit on system - admin will update your account's credit.


Daily Usage:

Login into eCanteen.

1. Making an order.

Click "Minor Account Orders" to list Minor accounts.
Click on required account.
Order Calendar opens.
Click on the Break Link on the date required - the Break Menu screen for date opens.

Note: you cannot place orders for past dates or for breaks whose order close-off time is past. Some dates are inactive canteen days and do not have Break Order Links.
Note: Use the "<<" to go to the previous month or ">>" to go to the next month. Or use the date selector at the bottom to go to a specific date.


Select Items from Menu and click -->> to add item to order list.
Use <<-- to remove item from order list.
Optional - use Control-click and/or Shift/Click to select multiple items from the list to add or remove from order list.
To order multiples of an item, select the item and click the -->> the required number of times. The item will appear in the Order List multiple times. These will be collated in the Order placement process.

The "Credit" field in the upper right keeps track of your available credit as you order.
The "Order Total" field underneath the "Credit" field is the running total of the current order.

Note: if an item causes your credit to be exceeded, then an info box will display and the item will not be moved to the order list.

When required items have been ordered, use the order buttons to place the order.

You can:

a. Clicking the "Place Order" button will create the order and subtract the order total from your credit. You will be returned to the Order Calendar once the process has completed.

Or

b. Clicking the "Repeat Order Weekly" button will create the order and subtract the order total from your credit. It will then prompt you to repeat the order for the same day next week. If you click "Ok" and the textbox has "Y", the order will be repeated the same day for a series of weeks until you click "Cancel" on the prompt. If you click "Ok" and the textbox has "N", that date will be skipped and the next date will be prompted. Clicking "Cancel" stops the repeat order process immediately and returns you to the Menu screen. Click  the "Return to Calendar" to return to the Order Calendar.

Note: Be careful not to repeat orders on non-active dates.

Or  

c. Clicking the "Repeat Order Daily" button will create the order and subtract the order total from your credit. It will then prompt you to repeat the order for the next day. If you click "Ok" and the textbox has "Y", the order will be repeated the next day for a series of days until you click "Cancel" on the prompt. If you click "Ok" and the textbox has "N", that day will be skipped and the next day will be prompted. Clicking "Cancel" stops the repeat order process immediately and returns you to the Menu screen. Click  the "Return to Calendar" to return to the Order Calendar.

Note: Be careful not to repeat orders on non-active dates, including weekends. Existing Orders on dates you attempt to repeat an order on will not be overwritten - a messagebox will alert you to the attempted duplication. Click "OK" and continue. 
An alert will also trigger if you run out of credit during the repeat order process.

Repeat order process as required.

2. Order Maintenance.

Orders that have been placed replace the Break Link in the Order Calendar with a listbox of the ordered items - abbreviations and quantity on each line.
The Break short name and the Transaction number appear above the listbox.
The delete and re-order buttons are next to the Transaction number.

To delete an order, click the associated delete button next to the Transaction number. It has the Break short name and a "-" as the button label, eg "R-".
A prompt will appear to confirm the action. Clicking "Ok" will remove the order and refund the order amount to your credit. A Break Order link will replace the Order Details group.

To re-order an order, click the associated re-order button next to the delete button. It has the Break short name and a "*" as the button label, eg "R*".
A prompt will appear to confirm the action. Clicking "Ok" will remove the order and open the Break Menu for the date. The originally ordered items are preloaded into the Order List and the Order Total subtracted from your credit. You can now amend the order as required and place the order or click the "Return to Calendar" button to cancel the order.

Only Orders in the future can be accessed or for breaks whose order close-off time is past.

3. Transactions.

A history of your transactions can be accessed by the "My Transactions" option. 
This opens the "My Transactions" page. 

The fields are:

TransactionID: A unique Identifier for the transaction.
TransactionNumber: A 0 or 1 indicating if the transaction is a deposit (payment to your credit) or withdrawal (payment for an order).
TransactionDate: The date the transaction occurred.
TargetDate: The date the order if the transaction is for an order - otherwise blank.
TransactionDescription: If the transaction is an order, the abbreviated list of items. If a credit payment, the cheque or receipt number.
AdminID: The Admin account entering the credit payment.
MajorAccountID: Your customerid.
MinorAccountID: The id of the minor account if the transaction is an order.
BreakID: The Break for the order.
WithdrawalAmount: The payment for the order.
DepositAmount: Payment to your eCanteen Credit.
PrintDate: The date the order was printed by eCanteen admin.










Return current item: eCanteen