preferences:custom_fields

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
preferences:custom_fields [2019/10/24 16:16] – [13.11. Custom fields] Emily Porrellopreferences:custom_fields [2023/09/02 01:00] (current) Mark Glover
Line 1: Line 1:
-======  13.11. Custom fields ====== 
 {{indexmenu_n>110}} {{indexmenu_n>110}}
 +====== 16.11. Custom fields ======
 +<WRAP center round important 90%>
 +In a [[synchronisation:introduction|synced system]], Custom fields must be added on the **central server** and will then sync to other sites where they will apply to all stores on each site.
 +</WRAP>
 +
 +<WRAP center round alert 50%>
 +**Only edit custom fields if you are confident with the information in this page and fully understand the content.** Otherwise you could cause some things to stop working in your copy of mSupply! This is true for all settings, but please be especially careful with custom fields.
 +</WRAP>
  
 You can create custom fields that appear in different areas in mSupply. These allow you to record additional information and customise mSupply for your needs.  You can create custom fields that appear in different areas in mSupply. These allow you to record additional information and customise mSupply for your needs. 
Line 8: Line 15:
   * Supplier invoice   * Supplier invoice
   * Store     * Store  
-  * Requisition 
   * Item   * Item
   * Item category    * Item category 
Line 14: Line 20:
   * Name (of customers, suppliers, prescribers etc.)   * Name (of customers, suppliers, prescribers etc.)
   * User   * User
 +  * Purchase orders
 +  * Transaction categories
 +  * Item Category Level 1 
 +  * Transaction lines
 +
  
-<WRAP center round important 50%> 
-**Only edit custom fields if you are confident with the information in this page and fully understand the content.** Otherwise you could cause some things to stop working in your copy of mSupply! This is true for all settings, but please be especially careful with custom fields. 
-</WRAP> 
 ===== Creating custom fields ===== ===== Creating custom fields =====
  
 1. Navigate to the **Admin** tab and click the **Preferences** button. 1. Navigate to the **Admin** tab and click the **Preferences** button.
  
-{{ :preferences:options_admin_pref.png?400 |}}+{{ :preferences:options_admin_pref.png?600 |}}
  
 2. Select **Custom Fields** from the list on the left. 2. Select **Custom Fields** from the list on the left.
  
-3. Select the screen requiring custom fields from the dropdown list.+3. Select the area requiring custom fields from the **Table to set custom data fields for** dropdown list. 
 + 
 +{{ :preferences:customfields_type.png?600 |}}
  
 4. Click the **New Field** button. 4. Click the **New Field** button.
  
-5. Click on the new line to change the name of the custom field. +5. Click on the new line in the **Field Label** column to change the name of the custom field. 
  
-6. Click the small arrow in the **Field Type** column and choose from the drop-down list. The options are:+6. Click the small arrow in the **Field Type** column and choose from the drop-down list. The options for your new field are:
   * **Text:** User can type free text.   * **Text:** User can type free text.
   * **Number:** User can only type a number.   * **Number:** User can only type a number.
Line 39: Line 49:
   * **List:** User can only select an option from a list.   * **List:** User can only select an option from a list.
  
-6. If you chose a **List** field type, highlight the line and click **Add Item** to enter the options that will appear in the list. To delete an option, select the item from the list and click **Delete Item(s)**.+{{ :preferences:customfields_new.png?600 |}}
  
-7Click **OK**.+6If you choose a **List** field type, highlight the line and click **Add Item** to enter the options that will appear in the list. To delete an option, select it in the list and click **Delete Item(s)**.
  
-If you want to delete a custom field, highlight the line and click **Delete field(s)**.+{{ :preferences:customfields_list.png?600 |}}
  
 +7. Click **OK**.
  
 +If you want to delete a custom field, highlight the line and click **Delete field(s)**.
 ===== Using custom fields ===== ===== Using custom fields =====
-This section shows where custom fields appear in each area after they are created. +This section shows how custom fields appear after they are created.
- +
-====Customer invoice==== +
-**When creating a customer invoice:**+
  
-Click the **Custom Data** tab. In this example, we added a # custom field.+====Customer invoices==== 
 +**When creating a [[issuing_goods:issuing_goods_customer_invoice|customer invoice]]:**
  
-====Supplier invoice==== +Click the **Custom Data** tab. 
-**When creating a supplier invoice:**+
  
-Click the **Custom Data** tab. In this example, we added a # custom field.+In this example, we added two custom fields: a **Date** and a **List** field type.
  
-====Store==== +{{ :preferences:customfield_customer_invoice.png?600 |}} 
-**When creating a store:**+====Supplier invoices==== 
 +**When creating a [[receiving_goods:supplier_invoices|supplier invoice]]:**
  
-Click the **Custom Fields** tab. In this example, we added a # custom field.+Click the **Custom Data** tab. 
  
-====Requisition==== +In this example, we added two custom fields: a **Boolean** and a **Text** field type.
-**When creating requisition:**+
  
-====Item==== +{{ :preferences:customfield_supplier_invoice.png?600 |}} 
-**When creating a new item:**+====Stores==== 
 +**When creating a [[other_stuff:virtual_stores|store]]:**
  
-====Item category==== +Click the **Custom Fields** tab. 
-**When creating a new item category:**+
  
-====Quote line==== +In this example, we added one custom field: a **Number** field type.
-**When creating a quote line:**+
  
-====Name==== +{{ :preferences:customfield_store.png?600 |}}
-**When creating a new name (e.g. customer, supplier, prescriber etc.):**+
  
-====User==== +\\ 
-**When creating a new user:**+\\ 
 +|  //  Previous:  **[[preferences:options]]** | | Next: **[[import_and_export:]]** //  |
 ---- struct data ---- ---- struct data ----
 +pagestatus.status    : 
 ---- ----
  
  • Last modified: 2019/10/24 16:16
  • by Emily Porrello