Differences
This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
web_interface:online_catalogue [2020/03/16 10:26] – 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> | {{indexmenu_n> | ||
- | ====== | + | ====== |
- | 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 |
===== Setup ===== | ===== Setup ===== | ||
- | ==== 1. Tell mSupply which store to run the catalogue | + | ==== 1. Tell mSupply which columns |
- | Choose | + | This is done in the mSupply preferences. |
- | ==== 2. Tell mSupply which items are to be included in the catalogue ==== | + | ==== 2. Tell mSupply which store to run the catalogue |
- | To do this, from the menus choose **Item | + | Choose // |
- | {{ : | + | ==== 3. Tell mSupply which items are to be included in the catalogue ==== |
- | In the Price list section: | + | The items that will appear |
- | * Check the //On price list// checkbox (any item with this checked | + | |
- | * Enter the pack size of this item that is going to appear | + | |
- | * 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, | + | To set an item's 'On Price List' flag, you will need to do this from the //Item// > //Misc// tab - refer to [[items: |
- | And that's it. Setup is complete | + | 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** |
===== Operation ===== | ===== Operation ===== | ||
- | Once the mSupply web server is running users access the catalogue using a browser. The address to visit is < | + | Once the mSupply web server is running, users access the catalogue using a web browser |
This is what the user will see: | This is what the user will see: | ||
- | {{ : | + | {{ : |
- | 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/ |
- | 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 | + | Searching by item name is the default search when the online catalogue first loads in the browser, shown in the screenshot above. |
- | {{ : | + | |
+ | To search by item name, type something in the //Search// field, | ||
+ | |||
+ | 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: | ||
+ | |||
+ | {{ : | ||
+ | |||
+ | 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 ==== | ==== 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: | + | 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: |
+ | |||
+ | 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: | ||
+ | |||
+ | {{ : | ||
+ | |||
+ | The window will change to show the category search options: | ||
+ | |||
+ | {{ : | ||
+ | |||
+ | 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: | ||
+ | |||
+ | {{ : | ||
+ | |||
+ | 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 | + | ==== The results ==== |
+ | Whatever | ||
- | 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. | + | {{ : |
- | The Bottom level category drop down list has an additional " | + | Note that the filter is still available at the top of the window so that you can change the search |
- | ==== Item detail screen ==== | + | The columns shown in the search results table are those you selected in the [[web_interface: |
- | The screen looks like this: | + | |
- | {{ :web_interface: | + | |
- | When you've finished browsing | + | |
\\ | \\ | ||
\\ | \\ | ||
- | | // Previous: | + | | // Previous: |
---- struct data ---- | ---- struct data ---- | ||
+ | pagestatus.status | ||
---- | ---- | ||