items:item_basics:tab_general

Differences

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

Link to this comparison view

Both sides previous revision Previous revision
Next revisionBoth sides next revision
items:item_basics:tab_general [2023/01/19 15:13] – [General] Gary Willettsitems:item_basics:tab_general [2023/03/07 00:23] – Mark Glover
Line 7: Line 7:
 {{ :items:itemdetailswindow.png?750 |}} {{ :items:itemdetailswindow.png?750 |}}
  
-**Item name: ** This is the name by which mSupply will refer to the item.+== Item name == 
 + 
 +This is the name by which mSupply will refer to the item.
  
 <WRAP center round important 60%> <WRAP center round important 60%>
Line 15: Line 17:
 </WRAP> </WRAP>
  
-**Item code:** This is the code assigned to the item.  This should be a unique code, and ideally, should not be a part of another code.  For example, ''1034'' is unique, but is a part of ''1034a'', and so these two codes should ideally not coexist in an mSupply system. Any non-printable characters entered before or after the code will be removed. Any entered in the code (including spaces) will be replaced with an underscore (''_'').+== Item code ==
  
-**Store: **The store which you are using is displayed here.  For mSupply systems that are only using a single store, this field is not relevant. For users managing more than one store, the desired store may be selected from the drop down menu. For users having access to all stores, and wishing to work with the cumulative data from them all, one of the options displayed will be "''Supervisor - All stores''" - refer [[other_stuff:misc_topics#supervisor_-_all_stores|Miscellaneous topics, Supervisor Mode]].+This is the code assigned to the item.  This should be a unique code, and ideally, should not be a part of another code.  For example, ''1034'' is unique, but is a part of ''1034a'', and so these two codes should ideally not coexist in an mSupply system. Any non-printable characters entered before or after the code will be removed. Any entered in the code (including spaces) will be replaced with an underscore (''_''). 
 + 
 +== Store == 
 + 
 +The store which you are using is displayed here.  For mSupply systems that are only using a single store, this field is not relevant. For users managing more than one store, the desired store may be selected from the drop down menu. For users having access to all stores, and wishing to work with the cumulative data from them all, one of the options displayed will be "''Supervisor - All stores''" - refer [[other_stuff:misc_topics#supervisor_-_all_stores|Miscellaneous topics, Supervisor Mode]].
 ---- ----
 === General === === General ===
Line 23: Line 29:
 {{ :items:item_basics:screenshot_2021-04-28_at_12.34.52.png?250 |}} {{ :items:item_basics:screenshot_2021-04-28_at_12.34.52.png?250 |}}
  
-**Units:** Choose the unit you use for this item. It is useful to distinguish items you issue by pack (eg eye drops) from items you issue by volume (eg oral liquids)+== Units ==
  
-**Department:** You can assign each item to a department by choosing from the list of departments here. To set up departments, refer [[items:department_management|Managing Item Access...]].+Choose the unit you use for this item. It is useful to distinguish items you issue by pack (eg eye drops) from items you issue by volume (eg oral liquids)
  
-**Category: **Provided that you have defined item categories, the appropriate category should be selected using the drop down list which displays your defined categories - refer [[items:item_categories|Item categories]].+== Department ==
  
-**Interaction group: **Here you can choose the interaction group for the item - refer [[items:drug_interaction_groups|Manage drug interaction groups]].+You can assign each item to a department by choosing from the list of departments here. To set up departments, refer [[items:department_management|Managing Item Access...]].
  
-**Item Flag: **The item flag field is designed for bulk editing, where you use the list view to update many items at once. You can enter or edit an individual item's flag(s) here, though it can be easier to do so using [[items:item_basics#the_items_list_view|The list view]].+== Category ==
  
-**Universal Code: **mSupply has the ability to look up and store a Universal Code for each item.  Click on the select button {{:items:selectucbutton.jpg?20}} to look up a universal code. This window will open:+Provided that you have defined item categories, the appropriate category should be selected using the drop down list which displays your defined categories - refer [[items:item_categories|Item categories]]. 
 + 
 +== Interaction group == 
 + 
 +Here you can choose the interaction group for the item - refer [[items:drug_interaction_groups|Manage drug interaction groups]]. 
 + 
 +== Item Flag == 
 + 
 +The item flag field is designed for bulk editing, where you use the list view to update many items at once. You can enter or edit an individual item's flag(s) here, though it can be easier to do so using [[items:item_basics#the_items_list_view|The list view]]. 
 + 
 +== Universal Code == 
 + 
 +mSupply has the ability to look up and store a Universal Code for each item.  Click on the select button {{:items:selectucbutton.jpg?20}} to look up a universal code. This window will open:
  
 {{ :items:item_basics:screenshot_2021-05-04_at_12.38.47.png?300 |}} {{ :items:item_basics:screenshot_2021-05-04_at_12.38.47.png?300 |}}
Line 47: Line 65:
 You can also search for universal codes manually from a web browser at https://universalcodes.msupply.org.nz/ (old version) or https://codes.msupply.foundation (new version) You can also search for universal codes manually from a web browser at https://universalcodes.msupply.org.nz/ (old version) or https://codes.msupply.foundation (new version)
  
-**Doses:** Enter the number of doses a single unit of this item provides. Used for vaccines and is only enterable if the **Is a vaccine** checkbox is checked.+== Doses ==
  
-**Is a vaccine:** Check this if this item is a vaccine and you want mSupply to include it in the vaccine functionality (including in mSupply mobile; see the [[https://docs.msupply.foundation/en:mobile:user_guide:vaccine_dispensing|mobile vaccine dispensing]] page for details). When checked, a default value of 1 is entered in the **Doses** field.+Enter the number of doses a single unit of this item provides. Used for vaccines and is only enterable if the **Is a vaccine** checkbox is checked.
  
-**Hold: do not issue: ** If this box is checked, the item will not be available to be issued on invoices. It will still appear in lists, but you will get a warning if you choose it when issuing stock, and will be required to choose a different item.+== Is a vaccine == 
 + 
 +Check this if this item is a vaccine and you want mSupply to include it in the vaccine functionality (including in mSupply mobile; see the [[https://docs.msupply.foundation/en:mobile:user_guide:vaccine_dispensing|mobile vaccine dispensing]] page for details). When checked, a default value of 1 is entered in the **Doses** field. 
 + 
 +== Hold: do not issue == 
 + 
 +If this box is checked, the item will not be available to be issued on invoices. It will still appear in lists, but you will get a warning if you choose it when issuing stock, and will be required to choose a different item.
  
 <WRAP center round important 60%> <WRAP center round important 60%>
Line 57: Line 81:
 </WRAP> </WRAP>
  
-**Issue in builds only: ** Checking this box will mean that the item cannot be issued on customer invoices.  This is useful in situations like where an item which by law can not be sold in an unprocessed state, but is used to 'build' (refer [[items:manufactured_items|Building (Manufacturing) Items]]) another item which is legal for distribution. +== Issue in builds only ==
  
-**Allow pack to one conversion:**  Checking this box allows stock of the item to be repacked to "''1''".+Checking this box will mean that the item cannot be issued on customer invoices.  This is useful in situations like where an item which by law can not be sold in an unprocessed state, but is used to 'build' (refer [[items:manufactured_items|Building (Manufacturing) Items]]) another item which is legal for distribution. 
  
-**Convert pack to one when receiving:** If this box is checked, when you receive items the pack size will automatically be converted to "''1''".  This is primarily for use in dispensary mode, but may be useful in other+== Allow pack to one conversion == 
 + 
 +Checking this box allows stock of the item to be repacked to "''1''". 
 + 
 +== Convert pack to one when receiving == 
 + 
 +If this box is checked, when you receive items the pack size will automatically be converted to "''1''".  This is primarily for use in dispensary mode, but may be useful in other
 situations too. situations too.
  
Line 68: Line 98:
 </WRAP> </WRAP>
  
-**Include in DHIS2 data push:** If checked then data from this item will be included in information pushed to DHIS2 via the DHIS2 interface.+== Include in DHIS2 data push == 
 + 
 +If checked then data from this item will be included in information pushed to DHIS2 via the DHIS2 interface.
 ---- ----
  
 === Pricing === === Pricing ===
 {{:items:item_basics:pasted:20200113-093256.png}}\\ {{:items:item_basics:pasted:20200113-093256.png}}\\
-**Default margin:**  This is the margin that will be applied to this item on supplier invoices to calculate the selling price. It can be set to a different value in different stores if required (which also means that you must set it to a value in every store you want it to have a value in - setting it in one will not set it in any others). Note that if a supplier margin is also set, there is a setting in the **Preferences > Invoices 1** that determines which margin will be used. Note also that if a default selling price is set, this price will take priority and be used rather than the margin.+== Default margin == 
 + 
 +This is the margin that will be applied to this item on supplier invoices to calculate the selling price. It can be set to a different value in different stores if required (which also means that you must set it to a value in every store you want it to have a value in - setting it in one will not set it in any others). Note that if a supplier margin is also set, there is a setting in the **Preferences > Invoices 1** that determines which margin will be used. Note also that if a default selling price is set, this price will take priority and be used rather than the margin. 
 + 
 +== Default sell price of preferred pack size == 
 + 
 +Only enter a price here if you want a fixed selling price for this item. Enter the price for one preferred pack. A price entered here will override any margins you have specified for either the supplier or the item.
  
-**Default sell price of preferred pack size:** Only enter a price here if you want a fixed selling price for this item. Enter the price for one unit (eg 1 capsule or 1 gm). A price entered here will override any margins you have specified for either the supplier or the item.+== Price editable when issuing ==
  
-**Price editable when issuing:** If the **Allow editing selling price on customer invoice lines** store preference is turned on (see [[other_stuff:virtual_stores#preferences_tab|Virtual store preferences]]) and this checkbox is checked, when adding a line of this item to a customer invoice, an additional **Sell price** field will be available for the user to enter the sell price for that line of the customer invoice (see [[issuing_goods:issuing_goods_customer_invoice#issuing_from_a_single_line|Issuing goods (customer invoices)]] for details). +If the **Allow editing selling price on customer invoice lines** store preference is turned on (see [[other_stuff:virtual_stores#preferences_tab|Virtual store preferences]]) and this checkbox is checked, when adding a line of this item to a customer invoice, an additional **Sell price** field will be available for the user to enter the sell price for that line of the customer invoice (see [[issuing_goods:issuing_goods_customer_invoice#issuing_from_a_single_line|Issuing goods (customer invoices)]] for details). 
 ---- ----
 === Full description === === Full description ===
Line 98: Line 136:
   * In the past, there was a greater tendency towards **N** = **Necessary**.  Therefore, mSupply 'hard wired' **N** = **Necessary**.   * In the past, there was a greater tendency towards **N** = **Necessary**.  Therefore, mSupply 'hard wired' **N** = **Necessary**.
   * There is an increasing trend towards **N** = **Not essential**.   * There is an increasing trend towards **N** = **Not essential**.
-  * As of mSupply v5.04, you can choose which is used in your data in the preferences (see the [[preferences:general#title_for_n_classification_for_ven_items|General preferences - Title for "N" classification]]).+  * As of mSupply v5.04, you can choose which is used in your data in the preferences - see [[preferences:general#title_for_n_classification_for_ven_items|General preferences - Title for "N" classification]].
     * For all pre-existing installations, **N** = **Necessary** unless you change it.      * For all pre-existing installations, **N** = **Necessary** unless you change it. 
     * For all new implementations after v5.04, **N** = **Not essential**.       * For all new implementations after v5.04, **N** = **Not essential**.  
  • Last modified: 2023/04/05 14:25
  • by Gary Willetts