ShopWise Guick Start Guide

A Quick Start Guide to using ShopWise
Post Reply [phpBB Debug] PHP Warning: in file [ROOT]/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1266: count(): Parameter must be an array or an object that implements Countable
Mike
Site Admin
Posts: 6
Joined: Wed Jun 21, 2017 9:26 am
Location: Sydney Australia
[phpBB Debug] PHP Warning: in file [ROOT]/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1266: count(): Parameter must be an array or an object that implements Countable

ShopWise Guick Start Guide

Post by Mike » Sat Jun 24, 2017 1:59 am

This guide is for those who want to dive straight in to using ShopWise and assumes that ShopWise has been installed.

Probably before using this guide you should establish some information:-
  • A list of the Shops that you normally shop at. If this list is according to order that you visit them (the first first in the list...), you can take advantage of ShopWise's suggested Shop order and thus not have to enter the order.
  • A list of the Aisles/locations in the shop again preferably in the order in which you visit them to take advantage of order suggestion.
  • A list of the places in the home (assuming you shop for a home, it could be an organisation though) where the purchased items are placed, again preferably in an order that suits checking what you have, to take advantage of order suggestion. ShopWise uses the term STORAGE for these places.
  • A list of the the items that you purchase along with the shop from which you purchase them and the aisle (location) within the shop, the price and where you store the items at home.
Note! Creating the list above isn't essential, it can just make entering the data easier, as you can take advantage of the automatically generated order field.


The order of the following instructions is a suggested order. You could, for example, start adding Storage before Shops. The following are the rules related to dependencies.
  • Shops and Storage are not dependant.
  • Aisles are dependant upon Shops.
  • Products are dependant upon Storage.
  • Stock is dependant upon Products and Aisles and thus implicitly dependant upon Storage and Shops.
  • The ORDER, CHECKLIST, SHOPPING and RULES options are dependant upon Stock.

    Logic within ShopWise limits the available options (i.e. The Buttons that appear on the Main Display) according to these dependencies.

Adding Shops (no predecessors, required before Aisles can be added)
  • 1 - From the Main Display, click SHOPS, current shops will be listed (none if starting from scratch), then click ADD.
  • 2 - For each Shop, enter the Shop's Name in the Shop Name field and the Shop's location in the City field, change the order if necessary, lower numbers appear first in the Shopping List. When done click on SAVE, the Shop should appear in the list.
  • 3 - Repeat 2 until all Shops have been added.
  • 4 - Click on DONE and then on DONE ( the first takes you back from the Shops - Add display, to the Shops Display, the second takes you back to the Main Display

    Note! you can edit a Shop by clicking the Shop in the list shown in the Shops display, you can delete a Shop by long clicking the respective Shop in the list shown in the Shops Display. When Aisles and Products exist you can also select to Stock (assign a product to a Shop/Aisle) according to Shop by clicking the respective Shop in the list shown in the Shops Display.

    Note! when you click or long click a Shop in the list shown in the Shops Display, a dialog appears allowing you to select options, which also displays the impact (what else will be deleted).

    Note! the list of Shops shown in the Shops - Add Display (or Shops - Edit Display, when editing a Shop) are not clickable/long clickable (this is to avoid the confusion of recursion).

    Note! The AISLES option will now be available from the Main Display.

Adding Storage (no predecessors, required before Products can be added)

Storage facilitates ShopWise's CHECKLIST feature allowing an ordered check of what you currently have).
  • 1 - From the Main Display, click STORAGE, current storage will be listed (none if starting from scratch), then click ADD.
  • 2 - For each Storage, enter the name in the Storage field, change the order if necessary, lower numbers appear first in the CheckList. When done click on SAVE, the Storage should appear in the list.
  • 3 - Repeat 2 until all Storage has been added.
  • 4 - Click on DONE and then on DONE ( the first takes you back from the Storage - Add display, to the Storage Display, the second takes you back to the Main Display

    Note! you can edit a Storage by clicking the Storage in the list shown in the Storage display, you can delete a Storage by long clicking the respective Storage in the list shown in the Storage Display.

    Note! you cannot delete a Storage if the Storage has Products assigned to it, a message will be displayed indicating that the Storage is not empty.

    Note! when you click or long click a Storage in the list shown in the Storage Display, a dialog appears allowing you to select options.

    Note! the list of Storage shown in the Storage - Add Display (or Storage - Edit Display, when editing a Storage) are not clickable/long clickable (this is to avoid the confusion of recursion).

    Note! The PRODUCTS option will now be available from the Main Display.

Adding Aisles (at least one Shop is required before Aisles can be added, STOCK requires Aisles to exist)
Aisles are locations within a Shop, they needn't be actual Aisles.
  • 1 - From the Main Display, click AISLES, current Aisles will be listed (none if starting from scratch) for the currently selected Shop (clicking the Shop will present a Drop Down list of the current Shops, clicking a Shop from the list will change the Shop), then click ADD.
  • 2 - Select the Shop, if not already selected, that is to have the Aisle. You select the shop by clicking the current Shop and then clicking the Shop you require from the list that is presented.
    Enter the name of the Aisle in the Aisle Name field, change the order if necessary, lower numbers appear first in the Shopping List. When done click on SAVE, the Aisle should appear in the list.
  • 3 - Repeat 2 until all Aisles have been added.
  • 4 - Click on DONE and then on DONE ( the first takes you back from the Aisles - Add display, to the Aisles Display, the second click takes you back to the Main Display

    Note! you can edit an Aisle by clicking the Aisle in the list shown in the Aisle display, you can delete an Aisle by long clicking the respective Aisle in the list shown in the Aisle Display.

    Note! when you click or long click an Aisle in the list shown in the Aisles Display, a dialog appears allowing you to select options, which also displays the impact (what else will be deleted).

    Note! the list of Aisles shown in the Aisles - Add Display (or Aisles - Edit Display, when editing an Aisle) are not clickable/long clickable (this is to avoid the confusion of recursion).

    Note! If Products have also been added then the STOCK option will now be available from the Main Display.

Adding Products (at least one Storage is required before Products can be added, STOCK requires products to exist, as well as Aisles)
Products are the items that you purchase, noting that Stock is a Product assigned to an Aisle within a Shop. e.g. Baked beans is a product, but Baked Beans at ShopX in Aisle 1 is Stock. Baked Beans could also be Stock at ShopY in Aisle 10.
  • 1 - From the Main Display, click PRODUCTS, current Products will be listed (none if starting from scratch) then click ADD.
  • 2 - Enter the name of the Product in the Product field, change the order if necessary, lower numbers appear first in the Shopping List. When done click on SAVE, the Product should appear in the list.
    Note! The Product field also acts as a filter for the list of Products displayed progressively reducing the list, thus making it easy to see if you have already added the product.
  • 3 - Select the Storage, if not already selected, where the Product will be stored. You select the Storage by clicking the current Storage and then clicking the Storage you require from the list that is presented.
  • 4 - Repeat 2 and 3 until all Products have been added.
  • 5 - Click on DONE and then on DONE ( the first takes you back from the Aisles - Add display, to the Aisles Display, the second click takes you back to the Main Display

    Note! you can edit a Product by clicking the Product in the list shown in the Product display, you can delete a Product by long clicking the respective Product in the list shown in the Product Display.

    Note! when you click or long click a Product in the list shown in the Products Display, a dialog appears allowing you to select options, which also displays the impact (what else will be deleted).

    Note! the list of Produtcs shown in the Products - Add Display (or Products - Edit Display, when editing a Product) are not clickable/long clickable (this is to avoid the confusion of recursion).

    Note! If Aisles have also been added then the STOCK option will now be available from the Main Display.
Note! The Products Display includes an input field named Filter, as you enter data in the field the listed products shown will only be those that contain the entered data. This facilitates a rapid progressive means of reducing the listed items.


Adding Stock (at least one Aisle and thus Shop and at least one Product and thus Storage is required before Stock can be added, ORDER, CHECKLIST, SHOPPING and RULES all require Stock to exist)
Stock is ShopWise's term for Products assigned to Aisles within Shops, that is what you can/will actually purchase.
  • 1 - From the Main Display, click STOCK, current Stock will be listed (none if starting from scratch) then click ADD.
  • 2 - Select the Shop, if not already selected, where the Stock will be located. You select the Shop by clicking the current Shop and then clicking the Shop you require from the list that is presented.
  • 3 - Select the Aisle, if not already selected, where the Stock will be located. You select the Aisle by clicking the current Aisle and then clicking the Aisle you require from the list that is presented.
    Note! only the Aisles defined to the selected Shop are displayed.
  • 4 - Select the Product, if not already selected, for the Stock. You select the Product by clicking the current Product and then clicking the Product you require from the list that is presented.
    Note! Filter complements the Product selection by filtering the products displayed according to the data entered. That is only Products that contain the data entered are displayed in the Drop Down Selector.
  • 5 - Enter the Price of the Stock.
    Note! a price of 0.00, the default, will have no impact on the costs displayed in the shopping list and could be used for TO DO's.
  • 6 - Enter the Order in the Order field, if desired.
    Note! Order determines the order within the Aisle, within the Shop. Unlike other orders this defaults to 1000, as ordering at this level could be considered as not really necessary.
  • 7 - Tick the Checklist box if you want this Stock to appear in the CheckList, otherwise leave unchecked.
  • 8 - If CheckList was ticked then enter Level to indicate how many should be in storage, otherwise leave it as the default as it will not be used.
  • 9 - Click on SAVE to save the Stock.[/size]\
  • 10 - Repeat 2 - 9 for each Product that you wish to Assign to a Shop Aisle as Stock (this would rarely not be all products as a product by itself has little if any use).
  • 11 - Click on DONE to return to the Stock Display and then on DONE again to return to the Main Display

    Note! you can edit Stock by clicking the Stock in the list shown in the Stock display, you can delete a Stock by long clicking the respective Stock in the list shown in the Stock Display.

    Note! The Product Drop Down list excludes Products already assigned to the Selected Shop/Aisle. That is, duplication of Stock, is prevented.

    Note! when you click or long click a Stock in the list shown in the Stock Display, a dialog appears allowing you to select options, if long clicking the dialog also displays the impact (what else will be deleted) of the deletion.

    Note! the list of Stock shown in the Stock- Add Display are clickable/long clickable. This differs from the norm as editing Stock uses a static display and thus negates potential confusion due to recursion.

    Note! Adding Stock will enable the ORDER, CHECKLIST, SHOPPING and RULES options.

    Note! The Stock Display includes an input field named Filter, as you enter data in the field the listed Stock shown will only be those that contain the entered data in the Products name. This facilitates a rapid progressive means of reducing the listed items.

    Note! the Stock Add option is also available from the Shops Display, the Aisles Display and the Products Display by clicking a listed item, in which case the respective items will be selected in the Stock Add Display. That is if clicking Stock on a Shop (only if the Shop has at least one Aisle) in the Shops Display the Shop will be selected, if clicking Stock on an Aisle in the Aisles Display the Shop and Aisle will be selected and if clicking on a Product in the Products Display the product will be selected.

The Instructions above are all related to adding the core data. The following Instructions are related to Preparing for and Doing the Shopping.
ORDER (at least one Aisle and thus Shop and at least one Product and thus Storage is required before ORDER is enabled).
Order is used to add items in an ad-hoc way to the Shopping List. You would typically know what specific Stock you are adding. For example, you may have just used a can of Baked Beans and wish to add them to the Shopping List.
  • 1 - Click ORDER from the Main Display, locate the Stock to be added, using the filter can make it easier and then click on ADD. If you have too many (#in List displays how many) you can click on LESS to remove 1 from the Shopping List.

CHECKLIST (at least one Aisle and thus Shop and at least one Product and thus Storage is required before CHECKLIST is enabled).

Checklist is used to do an orderly check of what you have against the level (as set when adding/editing Stock) you should have. It is similar to using ORDER other than there is a Check-off button that you click to indicate that you have checked the respective item.

There is no filter as the idea behind the checklist is that it is followed in order. Again # in List, displays the number currently in the Shopping List. Additionally the CheckList is not sortable.

Additionally there is a RESET button, this resets the Checklist so nothing is checked off, it does not affect the number in the Shopping List.
  • Note! If no Stock items have been set to appear in the CheckList, then the CheckList will be empty.

SHOPPING (at least one Aisle and thus Shop and at least one Product and thus Storage is required before CHECKLIST is enabled).

This is the Shopping List that is used as the guide to doing the shopping.

When you get to an item you place it in your basket/trolley and then click the BOUGHT button, repeating this if the number to get is more than 1.

You can use the ADJUST button to; change the item's Name (the underlying Product name will be changed so it would affect other Stock based upon that Product), alter the Price of the item (only the specific Stock will be altered) you can change the quantity required or the number purchased (the number you see in the Shopping List is the number remaining to be purchased i.e. quantity required - quantity purchased).

The DELETE button will remove the Item from the Shopping List as if the Item had never been added. However, if purchases had been made and the BOUGHT button clicked, then the record of this transaction will not be removed.

The TIDY button will remove checked-off items (i.e. items where the required quantity has been purchased). It also adjusts each Item's required quantity to be the number remaining to be purchased, also setting the number purchased to 0. It's intended use is to mark the shopping expedition as complete.
  • Note! If no items have been added to the Shopping List, via ORDER, CHECKLIST or RULES then the Shopping List will be empty.

RULES (at least one Aisle and thus Shop and at least one Product and thus Storage is required before RULES is enabled).

Rules facilitate automated addition to the Shopping List on a regular basis.

To ADD a Rule click RULES from the Main Display and then click ADD, then :-
  • 1 - Select the required Shop from the Shop selector (i.e. click on the selected Shop and then click on the required Shop).
  • 2 - Select the required Aisle from the Aisle selector (i.e. click on the selected Aisle and then click on the required Aisle).
    Note! if the Selected Shop has no Aisles then the Aisle selector doesn't appear.
  • 3 - Select the required Product from the Product selector (i.e. click on the selected Product and then click on the required Product.
    Note! the Products listed are limited to the Stock assigned to the selected Aisle, if none then the Product selector doesn't appear, a message Unable to Create Rule will also be displayed.
  • 4 - Enter a name for the Rule into the Rule field.
  • 5 - Enter the quantity that is to be added to the Shopping List in the Get field.
  • 6 - If you want a prompt to appear before the addition to the Shopping List then tick the checkbox.
  • 7 - If required, change the Date that the Rule is first applied. The date can be selected from a Date Picker by clicking the displayed date or by entering a date in the format dd/mm/yyyy (e.g. 31/03/2017 for 31st March 2017) into the input field immediately to the right of the displayed date.
  • 8 - Select the appropriate period from the drop down list of available periods (Days, Weeks, Fortnights, Months, Quarters or Years) and then input the appropriate multiplier.
  • 9 - Click on SAVE to save the Rule.
    Note! The multiplier is used in conjunction with the period e.g. A period of Weeks along with a multiplier of 3 will result in the rule being applied every 3 Weeks). The first application of the rule will be on the Starts date and then every 3 weeks after.

    Note! The SAVE button will not appear if there is a detected issue, such as the Aisle not having any Stock.

    Note! If there are other Rules associated with the Shop/Aisle selection then these are displayed (click or longclick are not available).

    Note! Rules are actually applied when the Shopping List is displayed (i.e. by clicking on SHOPPING from the Main Display), rather than on the actual date. Any outstanding Rules are applied which may be the application of a rule a number of times on a catch-up basis. e.g. If a Rule existed to add on a daily basis and the Shopping List were not displayed for a week, then the Rule would be applied 7 times.

    Note! Prompted Rules, if any, are listed before the Shopping List is displayed, as this may be a rare event a dialog appears as a reminder before the list of prompted rules is displayed. The list or Prompted Rules has two options per entry ADD or SKIP. Clicking ADD will apply the Rule and thus add to the Shopping List according to the Rule. Clicking on SKIP will skip adding to the Shopping List. In both situations the next date will then be determined and applied to the Rule. If the Rule's new date is before or on the current date, then that specific next occurrence of the Rule will then added to the Prompted Rules List. That is Rule catch-up happens and thus it may appear that ADD or SKIP is not working (checking the date will show that they are different occurrences, another reason why the dialog is displayed before the Prompted List is displayed).

More to come......
Regards, Mike.

Post Reply [phpBB Debug] PHP Warning: in file [ROOT]/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1266: count(): Parameter must be an array or an object that implements Countable
[phpBB Debug] PHP Warning: in file [ROOT]/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1266: count(): Parameter must be an array or an object that implements Countable
[phpBB Debug] PHP Warning: in file [ROOT]/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1266: count(): Parameter must be an array or an object that implements Countable

Who is online

Users browsing this forum: No registered users and 1 guest