preferences: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 revision		 Previous revision
preferences:general [2024/11/07 15:54] – [Label printing section] Gary Willettspreferences:general [2026/01/14 17:18] (current) – [Misc tab] Gary Willetts
Line 32: Line 32:
  
 ==== Synchronisation section ==== ==== Synchronisation section ====
-  * **This datafile is part of a synchronisation system:** If checked it means that the synchronisation system is enabled in this datafile. This means that records to be synchronised will be created at appropriate times. If this is uncheckled it means that the synchonisation system is disabled completely and records to be synchronised will not be created in this datafile. +  * **This datafile is part of a synchronisation system:** If checked it means that the synchronisation system is enabled in this datafile. This means that records to be synchronised will be created at appropriate times. If this is unchecked it means that the synchonisation system is disabled completely and records to be synchronised will not be created in this datafile. 
-  * **Synchronisation is active:** If checked, synchronisation is operating as normal. If it is unchecked, the synchronisation system is paused. Records to be synchronised will still be created but they will not be shared between the cnetral server and remote sites. This is sometimes useful when carrying out maintenance procedures.+  * **Synchronisation is active:** If checked, synchronisation is operating as normal. If it is unchecked, the synchronisation system is paused. Records to be synchronised will still be created but they will not be shared between the central server and remote sites. This is sometimes useful when carrying out maintenance procedures.
  
 ==== Register button ==== ==== Register button ====
Line 121: Line 121:
  
 **Allow users to attach documents after transactions have been finalised** **Allow users to attach documents after transactions have been finalised**
-When this box is checked, mSupply will allow to upload documents on finalised customer invoices, Supplier invoices, Purchase Order and Good receipt. +When this box is checked, users can upload documents to finalised customer invoices, supplier invoices, purchase orders and goods receipts. 
 + 
 +**Allow to sync documents** 
 +If this is checked then documents attached to transactions on remote sites in a sync. system will be synchronised to the central server and will be available there. This is oinly advisable is a remote site has good internet because synchronising a large document will block the rest of the sync. queue until it has finished. If this is not checked then documents attached to transactions will not synchronise with the central server and will only be available at the remote site they were uploaded at.
  
 **Currency formats** This option specifies the format in which currencies will be displayed in mSupply. We provide two preset formats for currencies with 2 decimal places and currencies with none. If you want to enter a custom format you can change the field below the drop-down list. For example you may want to use a different separator than a comma. Note that if you type illogical values into the field the numbers may not display at all, or display erroneous data. Contact Sustianable Solutions if you need more information. **Currency formats** This option specifies the format in which currencies will be displayed in mSupply. We provide two preset formats for currencies with 2 decimal places and currencies with none. If you want to enter a custom format you can change the field below the drop-down list. For example you may want to use a different separator than a comma. Note that if you type illogical values into the field the numbers may not display at all, or display erroneous data. Contact Sustianable Solutions if you need more information.
Line 197: Line 200:
 By default all customers are assigned a price category of "A" By default all customers are assigned a price category of "A"
  
-To assign a different category to a customer, choose Customers > Show customers... and find the customer entry. Then set the price category field to a different value+To assign a different category to a customer, choose Customers > Show customers... and find the customer entry. Then set the price category field to a different value (see the [[https://docs.msupply.org.nz/names:adding_and_editing#price_category|5.01. Names: using, adding and editing]] page for details on where this field is).
  
 Here in the Preferences, you specify what percentage change to the default price will be made for each category. Here in the Preferences, you specify what percentage change to the default price will be made for each category.
Line 348: Line 351:
  
 **Print Expiry date of Item on label** When checked, the stock line's expiry date will be printed on the label. **Print Expiry date of Item on label** When checked, the stock line's expiry date will be printed on the label.
 +
 +**Rotate label 180 degrees** When checked, labels will be printed out rotated by 180 degrees. Perfect for turning labels the right way up if they come out upside down. Can be an issue if pre-printed labels are used and they are the opposite way round to what you expected.
  
 **Allow users to select ward on prescriptions** If checked, **Patient type** and **Ward** drop down lists are displayed on prescriptions. If //Inpatient// is selected as the patient type then the Ward drop down list is enabled and the patient's ward can be selected. **Allow users to select ward on prescriptions** If checked, **Patient type** and **Ward** drop down lists are displayed on prescriptions. If //Inpatient// is selected as the patient type then the Ward drop down list is enabled and the patient's ward can be selected.
Line 459: Line 464:
 mSupply allows you to make up to 3 secondary backups to separate locations if you would like to. You can use 1, 2 or all 3 if you would like to. At least one is recommended for security purposes. mSupply allows you to make up to 3 secondary backups to separate locations if you would like to. You can use 1, 2 or all 3 if you would like to. At least one is recommended for security purposes.
  
-===== E-mail tab =====+===== Email tab =====
 You can choose to send orders, reports, invoices and notifications to recipients using e-mail in mSupply. However, before mSupply can send anything by e-mail you must tell mSupply about the server you wish to use and details of the e-mail described below:  You can choose to send orders, reports, invoices and notifications to recipients using e-mail in mSupply. However, before mSupply can send anything by e-mail you must tell mSupply about the server you wish to use and details of the e-mail described below: 
  
Line 506: Line 511:
 {{ :preferences:pref_web_srvr.png?600 |}} {{ :preferences:pref_web_srvr.png?600 |}}
  
-These settings are all for mSupply's built-in webserver, which is used for things such as the [[web_interface:dashboard_using|Dashboard]], [[mobile:user_guide|mSupply mobile]], [[web_interface:online_catalogue|online catalogue]] and the [[web_interface:msupply_customer_setup|Customer interface]]. Note: To use this feature an additional license is required. Please contact Sustainable Solutions for further information.+These settings are all for mSupply's built-in webserver, which is used for things such as the [[web_interface:dashboard_using|Dashboard]], [[https://docs.msupply.foundation/mobile/introduction/introduction/|mSupply mobile]], [[web_interface:online_catalogue|online catalogue]] and the [[web_interface:msupply_customer_setup|Customer interface]]. Note: To use this feature an additional license is required. Please contact The mSupply Foundation for further information.
  
-== Starting the web server == +== Start web server on the server when mSupply server starts == 
-The web server can be set to start automatically when mSupply starts by checking the box, or manually, as and when you use the service, by clicking the **Start Web server** button.+The web server can be started automatically when mSupply starts by checking the box (it will only start on the central server!), or manually when you want to use it by clicking the **Start Web server** button.
  
-== Run Webserver on port ==+== Run the web server on port ==
 The default port is 8080. This is the port used for non-secure http connections. The default port is 8080. This is the port used for non-secure http connections.
  
 == Use the following port for SSL == == Use the following port for SSL ==
 The default port is 2048. This is the port used for secure https connections. The default port is 2048. This is the port used for secure https connections.
 +
 +== Web URL ==
 +The URL of the web server to connect to. If this does not begin with "https:%%//%%" you are shown an alert. You most likely do want to use https if you're making these settings in a live envoronment. And if you're setting up [[synchronisation:introduction|synchronisation]] then you won't get any connection if you don't use https.
 +
 +== Enable Support DB Integration ==
 +If this checkbox is checked (only possible on the central server) this copy of mSupply will send support information to The mSupply Foundation's support database once a day during a time of low activity on the server at night: this is information about all the remote sites, their names, the type and version of mSupply they are running, whether they are registered, the time they last synchronised with the central server, when their latest transaction was entered and when their first stocktake was created.
 +  * **Username:** The username to use when connecting to the support database.
 +  * **Password:** The password to use when connecting to the support database.
 +  * **URL:** The URL of the support database.
 +  * **Test connection** button: Click this to validate your settings and check the connection to the support database. An alert message will tell you whether the test was successful or not.
 +  * **Push now** button: Click on this button to send the support information immediately rather than waiting for the automatically scheduled time. You will be shown the progress of the data send and told whether it is successful or not.
 == Disable the customer order web module and display the following message: == == Disable the customer order web module and display the following message: ==
 Check this if you want to take the [[web_interface:msupply_customer_howto|customer ordering module]] off line and enter the message you want to display to customers who access the module. Check this if you want to take the [[web_interface:msupply_customer_howto|customer ordering module]] off line and enter the message you want to display to customers who access the module.
Line 669: Line 685:
 {{ :preferences:stock_field_preferences.png?650 |}} {{ :preferences:stock_field_preferences.png?650 |}}
  
-Each of the fields you tick the "Show" checkbox for will appear on the bottom of the [[receiving_goods:supplier_invoices#adding_new_lines_to_a_supplier_invoice|supplier invoice line detail form]] when receiving stock. They will appear with the label you give them in the "Display name" column (click once in the column to make the cell editable then type the name).+Each of the fields you tick the "Show" checkbox for will appear on the bottom of the [[receiving_goods:supplier_invoices#adding_new_lines_to_a_supplier_invoice|supplier invoice line detail form]] when receiving stock. The first 4 fields will also appear in a goods received note and several other places throughout mSupply where stock lines are shown. They will appear with the label you give them in the "Display name" column (click once in the column to make the cell editable then type the name).
  
 The values you enter in these fields (or select for the fields if it's one of fields 5-8) will be attached to the stock and follow it through the system. See the [[receiving_goods:custom_stock_fields]] section of this user guide for details. The values you enter in these fields (or select for the fields if it's one of fields 5-8) will be attached to the stock and follow it through the system. See the [[receiving_goods:custom_stock_fields]] section of this user guide for details.
Line 686: Line 702:
  
 ===== Alternate server tab ===== ===== Alternate server tab =====
-The alternate server is used for sending cold chain notifications. For more detail please see the [[cold_chain_equipment:configure_coldchain_app_on_desktop#setting_up|Setting up Cold Chain App Notifications]] page.+The alternate server is used for a few functionalities in mSupply e.g. sending cold chain notifications ([[cold_chain_equipment:configure_coldchain_app_on_desktop]] and barcode scanning ([[barcode_scanning:handheld_computer]]). 
 + 
 +To turn on the alternate server, choose //File > Preferences// from the menus and click on the //Alternate Server// tab: 
 +  
 +{{ :cold_chain_equipment:pref_alernate_server.png?600 |}} 
 + 
 +  * **Start alternate web server** button: Click to start the alternate webserver with the settings in the table. The button label Will change to //Stop alternate web server// and clicking it will stop the alternate web server. When the web server is running you cannot edit the settings in the table. To edit them, stop the web server first. 
 +  * **Reset preferences to default** button: Clicking this when the alternate web server is **not** running will reset the settings in the table to their defaults (shown in the screenshot above). 
 + 
 +If you would like this server to start up every time mSupply is started, check the **Start web server on this computer when mSupply starts** checkbox. This is a good idea if you're using cold chain notifications or barcode scanning so that, if the mSupply server is restarted for any reason, the alternate server automatically restarts with it and barcode scanning and cold chain notification functionality can continue without further interruption for users. 
 + 
 +The settings in the table: 
 + 
 +^ Server parameter ^ Description ^  
 +| HTTP port number | The port number the alternate web server will use for the HTTP protocol. | 
 +| HTTPS port number | The port number the alternate web server will use for the HTTPS protocol. | 
 +| Maximum size (in bytes) of incoming HTTP requests | Requests over this size (in bytes) will be ignored by the alternate web server. | 
 +| Parse header timeout (milliseconds) | The maximum time it can take to parse incoming request headers. Requests with headers that take longer than this to process will be rejected. | 
 +| Parse body timeout (milliseconds) | The maximum time it can take to parse incoming request bodies. Requests with bodies that take longer than this to process will be rejected. | 
 +| Worker threadpool count | The maximum number of staff you can have in a swimming pool at any one time. Just kidding! This is the maximum of threads the server will use to process an incoming request. | 
 +|Log level | 0: No logging, 1: Log only 500 responses, 2: Log all responses, 3: Log all responses and requests.|  
 +| REST API enabled | Check this if the alternate web server REST API is to be enabled. Functionalities like cold chain notifications and barcode scanning require this REST API so turn it on if you're using one of them. |  
 + 
 +The default //HTTP Port number// is 8081 and must be different from the port number used by the mSupply server set on the //Server// tab (see the [[preferences:general#server_tab|16.01. General preferences]] page for details). If you inadvertantly try to set both servers to the same port, mSupply will warn you and prevent you from saving your settings. 
 + 
 +Please note that setting either the HTTP or HTTPS port to 0 will turn off the alternate server for that protocol.
  
 ===== Assets tab ===== ===== Assets tab =====
  • Last modified: 2024/11/07 15:54
  • by Gary Willetts