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 [2023/01/16 13:03] – [DHIS2 tab] Gary Willettspreferences:general [2024/02/01 07:07] (current) – [Misc tab] Rachana Kunwar
Line 1: Line 1:
 {{indexmenu_n>10}} {{indexmenu_n>10}}
 ====== 16.01. General preferences  ====== ====== 16.01. General preferences  ======
-<WRAP center round important 70%> +<WRAP center round important 90%> 
-  * The preferences described here (accessed through **File > Preferences...**) apply to all stores in an mSupply datafile. +  * The preferences described here (accessed through **File > Preferences...**) apply to all stores on an mSupply server. 
-  * In a [[other_stuff:remote_sync|synced system]] there will be multiple 'sync satellites' and these settings can be different on each sync satellite (because they are not synchronised from the primary server)). +  * In a [[synchronisation:introduction|synced system]] there will be multiple 'sync satellites' and these settings can be different on each sync satellite. 
-  * There are some settings that are 'per store' i.e. they affect only a single store in a datafile. Please see the [[https://docs.msupply.org.nz/other_stuff:virtual_stores#the_preferences_tab|Store preferences]] section for details on those.+  * There are some settings that are 'per store' - refer [[other_stuff:virtual_stores#the_preferences_tab|Store preferences]], and store preferences can be different for each store on an mSupply server.
 </WRAP> </WRAP>
  
Line 10: Line 10:
  
 ===== General tab ===== ===== General tab =====
-{{ :preferences:preferences-preferences_1.png?600 |}}+{{ :preferences:pasted:20230122-211456.png?600 }}
 ==== Organisation name ==== ==== Organisation name ====
 What is filled in here is quite important.  Not only will it print on the top of invoices and various reports, but it is also tied to your registration code. Please think carefully about what it should be before entering it.  If you need to change your organisation name, please do so and then re-contact info@msupply.org.nz for a new registration code. What is filled in here is quite important.  Not only will it print on the top of invoices and various reports, but it is also tied to your registration code. Please think carefully about what it should be before entering it.  If you need to change your organisation name, please do so and then re-contact info@msupply.org.nz for a new registration code.
Line 19: Line 19:
  
 ==== Close mSupply if user is inactive for ''#'' minutes ==== ==== Close mSupply if user is inactive for ''#'' minutes ====
 +This preference is only available in a multi-user system on an mSupply client. It will not be visible in any single user copies of mSupply.
  
-This determines how long a user can be inactive on mSupply before mSupply window closes. Entering any value bigger than 9 will close mSupply if the user has been inactive for that many minutes (note: entering any value smaller than 10 will currently not do anything!).  This timer is re-set when:+This determines how long a user can be inactive on mSupply before mSupply window closes. Entering any value bigger than 9 will close mSupply if the user has been inactive for that many minutes (**note:** entering any value smaller than 10 will currently not do anything! The inactive user logout is disabled if you set a time less than 10 minutes).  This timer is re-set when:
   * a user clicks on a:    * a user clicks on a: 
      * supplier invoice       * supplier invoice 
Line 27: Line 28:
      * stocktake       * stocktake 
   * anytime the software checks a user's permission (normally when creating a new transaction)   * anytime the software checks a user's permission (normally when creating a new transaction)
-  * anytime the software updates some (but not all) progress bars +  * anytime the software updates some (but not all) progress bars 
 + 
 + 
 +==== 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. 
 +  * **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. 
 ==== Register button ==== ==== Register button ====
 This button is used for registering mSupply. (It will be dimmed if you have already registered). If you have not registered, clicking this button will display the registration details window: This button is used for registering mSupply. (It will be dimmed if you have already registered). If you have not registered, clicking this button will display the registration details window:
Line 44: Line 51:
   * The code is entered by clicking the **Enter code** button in the window shown above. You will then be shown another window where you can enter the registration details you have been supplied: {{ :preferences:registration2.png?450 |}} Your registration instructions supplied with the registration code will describe what information to put in each field.   * The code is entered by clicking the **Enter code** button in the window shown above. You will then be shown another window where you can enter the registration details you have been supplied: {{ :preferences:registration2.png?450 |}} Your registration instructions supplied with the registration code will describe what information to put in each field.
  
-<WRAP center round info 90%>+<WRAP center round important 90%>
   * mSupply registration codes are specific to the Hardware ID, organisation name, Number of users and Expiry date of your licence (if it is time-limited - nearly all mSupply licenses are NOT time limited).   * mSupply registration codes are specific to the Hardware ID, organisation name, Number of users and Expiry date of your licence (if it is time-limited - nearly all mSupply licenses are NOT time limited).
   * If you change either your organisation name or the computer on which you are running mSupply, you will need to contact Sustainable Solutions for a new code.    * If you change either your organisation name or the computer on which you are running mSupply, you will need to contact Sustainable Solutions for a new code. 
-  * From version 3.85, the registration code depends on the machine UUID which is unique to every single computer and consists of 36. If your machine UUID is blank, please make sure that windows program CMD is allowed to run (it may be blocked by anti-virus or anti-malware software). Please make sure you keep mSupply as a trusted application and unblocked by any anti-virus or anti-malware software you are using. +  * The registration code depends on the machine UUID which is unique to every single computer and consists of 36 characters. If your machine UUID is blank, please make sure that windows program CMD is allowed to run (it may be blocked by anti-virus or anti-malware software). Please make sure you keep mSupply as a trusted application and unblocked by any anti-virus or anti-malware software you are using. 
-  * For versions before 385, the registration code is dependent on the MAC address of the computer. If you have a 3G USB dongle (modem) plugged into the computer at the time you click on the registration button, Hardware ID will likely be based on the MAC address of the 3G USB dongle rather than that of the computer's Ethernet card. This can cause problems because if the 3G USB dongle is removed or changed at a later date, mSupply can become unregistered.  To avoid this, make sure mSupply uses the MAC address of its inbuilt Ethernet card rather than the 3G USB dongle: +  * If the Hardware ID field is empty, mSupply or the Windows CMD programme is being blocked by anti-virus or anti-malware software. If you need help, please consult Sustainable Solutions.  
-    * Disconnect any 3G USB dongles from the computer and restart mSupply. +  * If you move your data file to a new computer you will need to obtain a new registration code from us and enter it within 3 months to prevent mSupply from not working.
-    * Proceed with retrieving the registration details as described above and send them to us to create the unlocking code for you. +
-  * If the Hardware ID field is empty, for pre-3.85 versions this indicates that you do not have an Ethernet card or 3G USB dongle installed on your computer and for version 3.85 and above that mSupply or the Windows CMD programme is being blocked by anti-virus or anti-malware software. If you need help, please consult Sustainable Solutions.  +
-  * If you move your data file to a new computer you will need to obtain a new registration code from us and enter it within 3 months to prevent mSupply not working.+
 </WRAP> </WRAP>
  
-After entering your registration details and clicking on the OK button in the screenshot above, if the datafile is set to use [[other_stuff:remote_sync|synchronisation]] then the following window will appear:+After entering your registration details and clicking on the **OK** button in the screenshot above, if the datafile is set to use synchronisatino (see the [[synchronisation:introduction]] page for details) then the following window will appear:
  
 {{ :preferences:stop_sync_or_keep_working.png?400 |}} {{ :preferences:stop_sync_or_keep_working.png?400 |}}
Line 61: Line 65:
 This is a very important window and you must be careful to make the right choice! When a datafile is unregistered, synchronisation is prevented from running for data security reasons. Your datafile is just about to be registered so you are being asked whether you want synchronisation to continue working or whether it should be stopped. This is a very important window and you must be careful to make the right choice! When a datafile is unregistered, synchronisation is prevented from running for data security reasons. Your datafile is just about to be registered so you are being asked whether you want synchronisation to continue working or whether it should be stopped.
  
-If you select "Stop Synchronisation", then the synchronisation settings will be cleared and synchronisaiton will not work. You would select this option if you were using a copy of live data for training, for example.+If you select "Stop Synchronisation", then the synchronisation settings will be cleared and synchronisation will not work. You would select this option if you were using a copy of live data for training, for example.
  
 If you select "Keep Synchronisation working", then synchronisation will keep working (surprise!). You would use this option if you were using this datafile in a live synchronisation system, either for the first time or if you've moved it to a new computer. If you select "Keep Synchronisation working", then synchronisation will keep working (surprise!). You would use this option if you were using this datafile in a live synchronisation system, either for the first time or if you've moved it to a new computer.
Line 100: Line 104:
  
 ===== Misc tab ===== ===== Misc tab =====
-{{ :preferences:misc.png?600 |}}+ 
 +{{:preferences:pref-misc.png?600| Misc Tab}}
  
 **Own code for electronic invoices** The code that customers must have for your organisation in their copy of mSupply. This code is added to invoices you export, and allows customers to import the invoice into their system automatically. **Own code for electronic invoices** The code that customers must have for your organisation in their copy of mSupply. This code is added to invoices you export, and allows customers to import the invoice into their system automatically.
Line 114: Line 119:
 An example of where turning on this option might be useful is when you store your mSupply data on a file server, and allow multiple single-user copies of mSupply to access the same data file. In such a situation to have 2 users attempt to access the data simultaneously would be disastrous. An example of where turning on this option might be useful is when you store your mSupply data on a file server, and allow multiple single-user copies of mSupply to access the same data file. In such a situation to have 2 users attempt to access the data simultaneously would be disastrous.
  
-**Item codes must be unique** When this box is checked, mSupply will ensure that each new item entered has a unique code.<WRAP center round important 60%> +**Allow users to attach documents after transactions have been finalised** 
-It was likely never a good idea to allow two items to have the same code.  As of v5 (or earlier) this preference has been removed and mSupply should not allow two items to have the same code. +When this box is checked, mSupply will allow to upload documents on finalised customer invoices, Supplier invoices, Purchase Order and Good receipt. 
-</WRAP> +
- +
-**Include catalogue code for item search** When checked, a report can be produced where the item's catalogue code is one of the search parameters.+
  
 **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 234: Line 236:
 === Tender letter section === === Tender letter section ===
   * **Title**: The title for the printed tender letter. If nothing is entered in here mSupply will use 'Invitation to tender'.   * **Title**: The title for the printed tender letter. If nothing is entered in here mSupply will use 'Invitation to tender'.
-  * **Tender reference**: The reference for the tender so that, when you communicate with others you both know which tender you are referring to. If nothing is entered in here mSupply will use 'Tender reference'.+  * **Tender reference**: The reference for the tender so that, when you communicate with others, you both know which tender you are referring to. If nothing is entered in here mSupply will use 'Tender reference'.
  
-=== User details for Tender module section === +=== Health Supply Hub section === 
-== We run a remote tender module == +Note: From version 7.04 of mSupply, the Health Supply Hub has replaced the remote tender module, which is now obsolete and will be removed.
-Click this to indicate that you operate an mSupply remote tender service where suppliers and you will log into a common web page to submit and download tender information. You will need to contact Sustainable Solutions for the account information required below before using this option. If this box is unticked you will need to enter bids manually. If it is ticked, you will see an extra //Synchronise// tab when you view the details of any tender.+
  
-**Client ID** This is the ID that you use to login to the remote tender web page and is unique to you. This will be supplied to you by Sustainable Solutions. +This section of preferences is for the connection to the [[https://docs.msupply.foundation/health-supply-hub/introduction/|Health Supply Hub]], the replacement for the remote tender module where you can upload yourt tenders for suppliers to enter their quotes and many other things.
- +
-**Password** This is the password you use to login to the remote tender web page. Like the ID, this will be supplied to you by Sustainable Solutions. +
- +
-**Tender Module Address** The internet address of the remote tender web page in the format //IP address:port number//. Once again, this will be supplied to you by the indefatigable Sustainable Solutions. +
- +
-<WRAP center round tip 60%> +
-Currently the Remote tender Module URL is :  https://tenders.msupply.org.nz +
-On the Tender Module Address, you are expected to enter "tenders.msupply.org.nz" without the quotes +
- +
-</WRAP>+
  
 +  * **Use Health Supply Hub integration checkbox:** If checked, this tells mSupply that the you are using the Health Supply Hub and certain small changes (extra buttons) will appear in the tenders module. All the other fields in this section are disabled until this is ticked.
 +  * **Integration username:** enter the username provided by mSupply for you to login to the Health Supply Hub.
 +  * **Password:** enter ther password provided for you to login to the Health Supply Hub.
 +  * **Use custom server checkbox:** If checked, tells mSupply to use the server defined by the preferences below it rather than the default, mSupply Foundation server.
 +    * **Health Supply Hub URL:** The URL of the server.
 +    * **GraphQL port:** The port used by the Health Supply Hub database.
 +    * **Front end port:** The port used by the Health Supply Hub interface.
 +  * **Test connection button:** When this is clicked, mSupply will attemnpt to use the settings you have entered to connect to the Health Supply Hub. You will be told whether the connection is successful.
  
 ===== Reminders tab ===== ===== Reminders tab =====
Line 519: Line 518:
  
 ===== Synchronise tab ===== ===== Synchronise tab =====
-For an explanation of this section please go to [[preferences:synchronisation|Synchronisation]].+For an explanation of this section please see the [[preferences:synchronisation]] section.
  
 ===== Customisation options ===== ===== Customisation options =====
Line 705: Line 704:
  
 To allow users to search by a column, check the checkbox in the //Search by// list. Any columns that have this checked will be added to the filters available in the catalogue. To allow users to search by a column, check the checkbox in the //Search by// list. Any columns that have this checked will be added to the filters available in the catalogue.
 +
 +
 +===== HL7 Integration tab =====
 +See the [[integration:hl7_integration]] page for details on this tab.
 \\ \\
 \\ \\
  • Last modified: 2023/01/16 13:03
  • by Gary Willetts