items:adding_a_new_item

Differences

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

Link to this comparison view

Both sides previous revision Previous revision
Next revision		 Previous revision
items:adding_a_new_item [2021/12/14 10:48] – updated cross reference item img arpitaitems:adding_a_new_item [2023/05/09 15:24] (current) – [Cross reference item tab] Gary Willetts
Line 14: Line 14:
  
 ===== Normal items ===== ===== Normal items =====
-{{ :items:add-item-general.png?550 |}}+{{ :items:add-item-general.png?450 |}}
  
 **Type:** Select the type of item you want to add here. The field always defaults to //normal//. **Type:** Select the type of item you want to add here. The field always defaults to //normal//.
  
-**Item code:** This field is mandatory and is a short way of referring to and finding the item throughout mSupply. 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 (''_'').  <WRAP center round important 60%> +**Item code:** This field is mandatory and is a short way of referring to and finding the item throughout mSupply. Any non-printable characters entered before or after the code (including spaces) will be removed. Any entered in the code (except spaces - spaces are allowed in item codes) will be replaced with an underscore (''_''). Item codes should be unique; mSupply will warn you if you try to enter an item code already in use by another item.
-As of v5 (or earlier) it should not be possible to create an item with the same code as another item. +
-</WRAP> +
  
 **Item name:** This field is also mandatory and is the name that the item will be known by throughout mSupply. It will appear in reports and displays, wherever the item is referred to. Any non-printable characters entered before or after the name will be removed. Any entered in the name will be replaced with an underscore (''_''). **Item name:** This field is also mandatory and is the name that the item will be known by throughout mSupply. It will appear in reports and displays, wherever the item is referred to. Any non-printable characters entered before or after the name will be removed. Any entered in the name will be replaced with an underscore (''_'').
Line 55: Line 52:
 **Default weight:** The weight of the preferred pack size in kg. **Default weight:** The weight of the preferred pack size in kg.
  
-**Price list:** If this box is checked, this item will be included when you produce price lists. If checked the item will also be included in the online catalogue.+**Price list:** If this box is checked, this item will be included when you produce price lists. If checked the item will also be included in the online catalogue.  Refer [[items:item_basics:tab_misc#price_list|Price list]].
  
 **Non stock item:** If the item is something you do not normally keep in stock, but is passed straight to a customer, this box should be checked. **Non stock item:** If the item is something you do not normally keep in stock, but is passed straight to a customer, this box should be checked.
Line 72: Line 69:
 **Is a vaccine:** Check this if this item is a vaccine and you want mSupply to include it in the vaccine functionality (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. **Is a vaccine:** Check this if this item is a vaccine and you want mSupply to include it in the vaccine functionality (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.
  
-**Restricted to:** The location type that this item must be restricted to. You can from a list of all active Location types. When something is selected here, all stock of this item that is received must be put in a location which is of the same location type. For example, all cool store locations could have been given a type of "cool" and then if the item you are editing should be kept in a cool store, choose that type here, and you will only be able to receive that item into a cool store location.+**Restricted to:** The location type that this item must be restricted to. You can pick from a list of all active Location types. When something is selected here, all stock of this item that is received must be put in a location which is of the same location type. For example, all cool store locations could have been given a type of "cool" and then if the item you are editing should be kept in a cool store, choose that type here, and you will only be able to receive that item into a cool store location.
  
 When you have added all the details for your new item, click on the **OK** button or, if you want to add another new item, the **OK & Next button**. When you have added all the details for your new item, click on the **OK** button or, if you want to add another new item, the **OK & Next button**.
Line 79: Line 76:
  
 ==== Stores tab ==== ==== Stores tab ====
-On this tab, you select which stores the item will be visible in.+On this tab, you select which stores the item will be visible in:
  
-{{ :items:stores_censored.jpg?550 |}}+{{ :items:stores_censored.png?450 |}}
  
 Simply check the //Visible in store// checkbox against each store in the list you wish the item to be visible in (if an item is visible in a store then it can be used in that store). You can use the //All/None// checkbox to toggle selection of all stores or no stores. Simply check the //Visible in store// checkbox against each store in the list you wish the item to be visible in (if an item is visible in a store then it can be used in that store). You can use the //All/None// checkbox to toggle selection of all stores or no stores.
Line 89: Line 86:
  
 ==== Master lists tab ==== ==== Master lists tab ====
-On this tab, you select which master lists the item should be added to.+On this tab, you select which master lists the item should be added to:
  
-{{ :items:masterlist_censored.jpg?550 |}}+{{ :items:masterlist_censored.png?450 |}}
  
 Master lists can be used for many things in mSupply (e.g. controlling visibility of items in stores or determining which items appear on requisitions). See [[items:master_lists|Item master lists]] for details of how to set them up and use them. Master lists can be used for many things in mSupply (e.g. controlling visibility of items in stores or determining which items appear on requisitions). See [[items:master_lists|Item master lists]] for details of how to set them up and use them.
Line 99: Line 96:
  
 ==== Barcodes tab ==== ==== Barcodes tab ====
-On this tab, you can add barcodes of the item that contain manufacturer and pack size information and therefore become useful for managing pharmaceuticals. See [[barcode_scanning:adding_barcodes_to_items| Adding barcodes]] for details on setting them up.+On this tab, you can add barcodes of the item that contain manufacturer and pack size information: 
 + 
 +{{ :items:barcode-item.png?450 |}} 
 + 
 +This information is used when using barcode scanners to help manage your pharmaceuticals. See [[barcode_scanning:adding_barcodes_to_items| Adding barcodes]] for details on setting them up.
  
-{{ :items:barcode-item.png?550 |}} 
  
  
 ===== Cross reference items ===== ===== Cross reference items =====
 +Cross reference items point to another item, they do not have stock themselves. Whenever the cross reference item is entered, it will be immediately replaced with the normal item it points to. This is useful for handling branded items or items with a common name that is more recognisable than its generic name. An example would be Aspirin for Acetysalycilic acid or Panadol for Paracetamol.
 +
 To create a cross reference item select //cross reference// in the **Type** drop down list. The window changes slightly: To create a cross reference item select //cross reference// in the **Type** drop down list. The window changes slightly:
  
-{{ :items:cross_reference.png }}+{{ :items:cross_reference.png?450 | }}
  
 The **Item code** and **Item name** fields are the same as for a normal item (described [[items:adding_a_new_item#adding_a_new_item|above]]) but remember you're entering the details of the brand or familiar name in here! The **Item code** and **Item name** fields are the same as for a normal item (described [[items:adding_a_new_item#adding_a_new_item|above]]) but remember you're entering the details of the brand or familiar name in here!
  
 ==== Cross reference item tab ==== ==== Cross reference item tab ====
-**When this item is chosen in a list, use:** Type the first few characters of the normal item you always want to replace the brand/familiar name with in this field. Then press the //Tab// key on the keyboard and select the item you want.+**When this item is chosen in a list, use:** Type the first few characters of the normal item you always want to replace the brand/familiar name with in this field. Then press the //Tab// key on the keyboard and select the item you want. When you've selected the matching item then it's code will be appear in the read only **Item code** field.
  
 That's it, all done. After clicking the **OK** or **OK & Next** buttons, every time a user chooses the item you entered in the **Item name** / **Item code** fields it will be replaced with the item you entered in the **When this item is chosen in a list, use** field. That's it, all done. After clicking the **OK** or **OK & Next** buttons, every time a user chooses the item you entered in the **Item name** / **Item code** fields it will be replaced with the item you entered in the **When this item is chosen in a list, use** field.
  
-==== Stores tab ==== +**Note:** Item custom field 5 is also settable, as shown in the screenshot. It is a number field. This is the user_field_5 for the **cross reference item** (brand/familiar name), not the normal item. The //user_field_5// label shown in the screenshot will be replaced with the name assigned to the field in the preferences (see the [[preferences:general#misc_tab|16.01. General preferences]] page for details) if it has been set. Making this field settable here might seem strange but it is used in some customisations!
-You select the stores the cross reference item will be visible in on this tab. It operates exactly the same as the Stores tab described [[items:adding_a_new_item#stores_tab|above]] for normal items.+
  
-Note: cross reference items cannot be added to master lists so there is no Master lists tab. Their visibility cannot therefore be controlled by master lists but only by directly selecting the stores they are visible in on this stores tab.+The visibility of cross reference items in different stores matches the visibility of the normal item it is linked to. So there is no functionality for manually setting the visibility of cross reference items.
  
 ===== Service items ===== ===== Service items =====
 +Service items are those which have a price but no stock. You can use them to represent service or other charges that need to be handled.
 +
 To create a service item select //service// in the **Type** drop down list. **PLEASE NOTE:** the service option will not be available in this drop down list if the preference to allow service items has not been set. Please see [[preferences:general#misc_preferences|General preferences]] for details. To create a service item select //service// in the **Type** drop down list. **PLEASE NOTE:** the service option will not be available in this drop down list if the preference to allow service items has not been set. Please see [[preferences:general#misc_preferences|General preferences]] for details.
  
 The window changes slightly: The window changes slightly:
  
-{{ :items:item_service_add.png |}}+{{ :items:add_service_item.png?450 |}}
  
-The **Item code**, **Item name** and **Barcode** fields are the same as for a normal item (described [[items:adding_a_new_item#adding_a_new_item|above]]).+The **Item code** and **Item name** fields are the same as for a normal item (described [[items:adding_a_new_item#adding_a_new_item|above]]).
  
 ==== Service item tab ==== ==== Service item tab ====
  • Last modified: 2021/12/14 10:48
  • by arpita