Differences

This shows you the differences between two versions of the page.

--- web_interface:online_catalogue [2021/10/19 09:04] – Gary Willetts
+++ web_interface:online_catalogue [2021/12/16 05:27] (current) – [1. Tell mSupply which columns to display in the catalogue] Mark Glover
@@ Line 1: / Line 1: @@
 {{indexmenu_n>70}}
 ====== 19.07. Online catalogue ======
-The online catalogue is a searchable list of items you stock, driven by data in mSupply. The information can easily be updated and items added to or removed from the catalogue. By giving users access to the online catalogue you can, for example, replace the expensive printing of hard copy catalogues.
+The online catalogue is a searchable list of items you stock, driven by data in mSupply. The information can easily be updated and items added to or removed from the catalogue. By enabling the online catalogue you can, for example, replace the expensive printing of hard copy catalogues.
 ===== Setup =====
 ==== 1. Tell mSupply which columns to display in the catalogue ====
-This is done in the mSupply preferences. Choose //File > Preferences...// from the menus and go to the //Web catalogue// tab. For the details of the settings and what they do, see the [[preferences:general#web_catalogue_tab|16.01. General preferences]] page for details.
+This is done in the mSupply preferences. Choose //File > Preferences...// from the menus and go to the //Web catalogue// tab. For the details of the settings and what they do, see the [[preferences:general#web_catalogue_tab|16.01. General preferences > Web catalogue tab]] page for details.
 ==== 2. Tell mSupply which store to run the catalogue from ====
-Choose **File > Preferences...** from the menus, and on the **Web server** tab select the store in the //Default store for web interface// drop down list. If the mSupply web server isn't already running you'll also need to click on the //Start web server// button. More information about these options can be found [[preferences:general#web_server|here]].
+Choose //File > Preferences...// from the menus, and on the //Web server// tab select the store in the //Default store for web interface// drop down list. If the mSupply web server isn't already running you'll also need to click on the **Start web server** button. More information about these options can be found on the [[preferences:general#web_server|16.01. General preferences]] page.
 ==== 3. Tell mSupply which items are to be included in the catalogue ====
-To do this, from the menus choose **Item > Show items...**, click on the Find button and double click on an item you want to appear in the catalogue. This will open up the Item's details window. Click on the **Misc** tab on the left hand side and the screen will look like this:
-{{ :web_interface:catalogue_setup_2.png?800 |}}
+The items that will appear on the web catalogue are all those that have their 'On Price List' flag set in the Default store for web interface.
-In the Price list section:
+To set an item's 'On Price List' flag, you will need to do this from the //Item// > //Misc// tab - refer to [[items:item_basics:tab_misc#price_list|4.01.03. Items - Misc(ellaneous) tab]] page.
-  * Check the //On price list// checkbox (any item with this checked will appear in the catalogue)
-  * Enter the pack size of this item that is going to appear in the catalogue in the //Catalogue pack size// textbox
-  * Enter the price for this pack size in the //Catalogue price// textbox. This is optional and can be left at 0 if you don't want the price included in your catalogue.
-Repeat these steps for each item you want to appear in your catalogue. As with many repetitive tasks in mSupply, the //OK & Next// and //OK & Previous// buttons are your friends here.
+You need to set these values for all the items you want to appear in the catalogue. As with many repetitive tasks in mSupply, the **OK & Next** and **OK & Previous** buttons at the bottom of the item details window are your friends here.  If you are going to need to work with hundreds, or even thousands of items, then the Update [[items:item_basics:tab_misc#update_on_price_list_in_bulk|On Price List in bulk]] feature is your even greater friend.
-And that's it. Setup is complete and you are now ready for users to view your catalogue.
 ===== Operation =====
-Once the mSupply web server is running users access the catalogue using a browser. The address to visit is <code>https://example.com/catalogue/</code> where example.com is the domain of your web server.
+Once the mSupply web server is running, users access the catalogue using a web browser (Firefox, Chrome etc.). The address to visit is <code>https://example.com/catalogue/</code> where //example.com// is the domain of your web server.
 This is what the user will see:
-{{ :web_interface:catalogue.png?700 |}}
+{{ :web_interface:catalogue.png?800 |}}
-The catalogue can be searched by either item name (the top section) or the categories that items belong to (bottom section).
+The catalogue can be searched by either item name (or other property that you have set to be searchable) or the categories that items belong to.
-==== Searching by item name ====
+==== Searching by item name/property ====
-To search by item name enter something in the top textbox and select the comparator in the drop down list next to it. These are the options you can choose from:
+Searching by item name is the default search when the online catalogue first loads in the browser, shown in the screenshot above.
-{{ :web_interface:catalogue_item_name_options.png?250 |}}
+To search by item name, type something in the //Search// field, select the appropriate comparator in the drop down list (set to //Starts with// by default, as shown in the screenshot above) and click on the **Search** button.
+If you leave the //Search// field empty, all items in the catalogue will be returned by the search.
+If you have set other item properties to be searchable in the [[web_interface:online_catalogue#tell_msupply_which_columns_to_display_in_the_catalogue|1. Tell mSupply which columns to display in the catalogue]] setup step (above) then you can click on the //Item name// drop down list and select another searchable property, as shown here:
+{{ :web_interface:screenshot_2021-10-19_at_12.09.20.png?200 |}}
+As you do that, the options in the search comparator drop down list (Showing //Starts with// in the **Operation** section screenshot above) will change to match the type of property you have chosen.
-Then click on the top //Search// button and mSupply will search for items with names matching the options you have entered. When the search is complete the item detail screen (shown below) will be displayed and you can browse the items found.
 ==== Searching by category ====
-The category used to search for items in the catalogue is item category 1. This category is hierarchical and has 3 levels. For more details about this category, including setting it up and assigning it to items, see [[items:item_categories#category_1_categories|here]]. Note that in the catalogue, Top level corresponds to level 1 of category 1, Mid level to level 2 and Bottom level to level 3.
+The category used to search for items in the catalogue is item category 1. This category is hierarchical and has 3 levels. For more details about this category, including setting it up and assigning it to items, see [[items:item_categories#category_1_categories|here]]. Note that in the catalogue, //Top level// corresponds to level 1 of category 1, //Mid level// to level 2 and //Bottom level// to level 3.
+We say that Mid level categories are children of the Top level categories and Bottom level categories are children of Mid level categories.
+To search by category, click on the **By category** slider in the top right hand corner:
+{{ :web_interface:screenshot_2021-10-19_at_12.31.56.png?800 |}}
+The window will change to show the category search options:
+{{ :web_interface:screenshot_2021-10-19_at_12.37.35.png?800 |}}
+By default the search filters are set to search for all items that have a category. If you click on the **Search all Categories** button, all items that have a category will be returned (and if no items have a category set then no items will be returned!)
+If you want to find all items that have no category set you can change the **Bottom level category** drop down list to //None// (this is the only category filter that has a //None// option). The **Search all categories** button will change to **Search bottom category** with a //for items with no category// subtitle to make it clear what will happen:
+{{ :web_interface:screenshot_2021-10-19_at_12.46.53.png?800 |}}
+If you change the drop down list of one of the category levels away from //All//, the child level drop down list will change to contain only categories that are children of the one you selected. Using this, you can refine your category search as much or as little as you wish.
+So, if you select a category in the //Top level category// drop down list and click on the **Search top level category** button (the **Search all categories** that is automatically renamed) then all the items that have a category that is a child of that top level category will be returned.
+Before you click on the **Search top category** button, if you look at the options in the **Mid level category** drop down list, you will notice that it now contains only categories that are children of the selected top level category. If you select one of those, the **Search top category** button will become **Search mid category** and, if you click on it, all items that have a category that is a child of the selected mid level category will be returned.
+Similarly, if, before clicking on the **Search mid category** button, you selected one of the //Bottom level// categories then the **Search mid category** button will become **Search bottom category** and, if you click on it, all items that have the selected bottom level category will be returned.
-To search by category, click on one of the 3 //Search// buttons in the lower section of the search screen. When you do that, mSupply will search for items belonging to the category of the level of category 1 you selected in the corresponding drop down list. If the //All// option is selected then mSupply will search for items belonging to all the corresponding categories at that level of category 1.
+==== The results ====
+Whatever search filter you choose, the search results are shown after you click on the **Search button** like this:
-When you select an option other than //All// in the Top level category drop down list, the options in the Mid level drop down list are changed to be all the children of the top level category you selected. And when you select a Mid level category, the options in the Bottom level drop down list change to be the children of that mid level category.
+{{ :web_interface:screenshot_2021-10-19_at_12.28.20.png?800 |}}
-The Bottom level category drop down list has an additional "None" option. Using this option will search for all items which are not assigned to a category 1 category.
+Note that the filter is still available at the top of the window so that you can change the search if you wish. If you click on the **Expand results** button is removed to give the resultds as much screen space as possible. Click the button again and the search filter will be displayed again.
-==== Item detail screen ====
+The columns shown in the search results table are those you selected in the [[web_interface:online_catalogue#tell_msupply_which_columns_to_display_in_the_catalogue|1. Tell mSupply which columns to display in the catalogue]] setup step above. They are also displayed with the display names you sent for them.
-The screen looks like this:
-{{ :web_interface:catalogue_2.png?700 |}}
- When you've finished browsing the items displayed you can click on the //Search// button on the top left hand side to return to the search screen, where you can perform another search if required.
 \\
 \\