cold_chain_equipment:configure_coldchain_app_on_desktop

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
cold_chain_equipment:configure_coldchain_app_on_desktop [2021/04/23 15:16] – Gary Willettscold_chain_equipment:configure_coldchain_app_on_desktop [2023/08/15 03:45] (current) – old revision restored (2022/12/08 06:10) Richard Feryn
Line 1: Line 1:
-====== 19.02. Cold Chain App Notifications ====== +====== 20.03. Cold Chain App Notifications ======
 <WRAP center round important 60%> <WRAP center round important 60%>
-This functionality is only available in v5.1 and above. +This functionality is only available in v5.01 and above. 
 </WRAP> </WRAP>
  
-If you have the mSupply ColdChain app, you can set up mSupply desktop to show notifications from the app, so you can keep an eye on your cold stores while sitting at your desk. mSupply will show a temperature log for each sensor, alert you to any hot or cold breaches, and allow you to change the stock location a sensor is monitoring.+If you have the [[https://docs.msupply.foundation/en:cold_chain:start|mSupply ColdChain app]], you can set up mSupply desktop to show notifications from the app, so you can keep an eye on your cold stores while sitting at your desk. mSupply will show a temperature log for each sensor, alert you to any hot or cold breaches, and allow you to change the stock location a sensor is monitoring. 
  
 ===== Setting up ===== ===== Setting up =====
Line 20: Line 20:
 If you would like this server to start up every time mSupply is started, turn on the preference "Start web server on this computer when mSupply starts”.  If you would like this server to start up every time mSupply is started, turn on the preference "Start web server on this computer when mSupply starts”. 
  
-==== 2. Set up user credentials ====+The default //HTTP Port number// is 8081 and must be different from the prot 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.
  
 +==== 2. Set up store user credentials ====
 +To match an mSupply desktop store to the ColdChain app on a tablet, you need to set up the store's credentials in the store settings. See the [[other_stuff:virtual_stores#store_credentials|25.08. Virtual stores]] page for details on doing that.
  
-To match up a mSupply desktop store with the ColdChain app tablet, we need to set up a store credential.  
-In the Special tab, navigate to Stores, and select the store in which the tablet is used. You must be logged into the store that you want to edit before you can set up credentials.   
- 
-Check "Use store credentials” to start setting up a store, and enter a username and password.  
-The username will be set to the first three letters of the store's code by default.  
-The password must be at least 3 symbols but not more than 30 symbols, and can contain letters and numbers. You can click the “Show password” button (next to password field) will show the password). These credentials will be saved after clicking “OK” in the “Edit store” window. 
- 
-Unchecking the checkbox "Use store credentials" deletes the store credentials. Please be careful before deleting store credentials. 
- 
-{{  :cold_chain_equipment:pasted:20210315-024426.png  }} 
  
 ===== Viewing sensors and assigning locations ===== ===== Viewing sensors and assigning locations =====
 +To see all sensors used in the system, choose //Items > Vaccines > Sensors// from the menus. This window will open, showing you a list of each sensor and whether it is active: 
  
-To see all sensors used in the system, go to Items > Vaccines > Sensors in the menu bar. This will show a list of each sensor and whether it is active in the system. +{{ :cold_chain_equipment:pasted:20210315-030429.png?300 }}
  
-{{  :cold_chain_equipment:pasted:20210315-030429.png?500  }}+Double click the sensor name to view the sensor's details. This window will open:
  
-Double click the sensor name to view sensor details. If the sensor is located in the store you are logged in to, you  can change the active state of the sensor and assign a new location to a sensor. If the sensor is located in a different store, the following details will be read-only.  +{{ :cold_chain_equipment:pasted:20210315-030448.png?300 }}
-  +
-To assign a location to a sensor click “Set Location” button. This will open a new window with a list of available locations that have no sensors assigned. +
  
-{{  :cold_chain_equipment:pasted:20210315-030448.png?500  }}+<WRAP info center round 90%> 
 +If the sensor belongs to the store you are logged in to, you  can change the active state of the sensor and assign a new location to it. If the sensor is located in a different store, all the details will be read-only.  
 +</WRAP>
  
-Please be careful when assigning a location as all the temperature logs for that sensor will be moved to this location. This is non-reversible!+  * **Is active? checkbox:** If checked the sensor's readings are recorded and usable in the system. If unchecked, the sensor is ignored and notifications will not be shown for it (unacknowledged, acknowledged, current or historical). 
 +  * **View location button:** When clicked, will open a window containing the details of the location the sensor is assigned to. 
 +  * **Set location button:** When clicked, will open a new window showing you all the locations in your store that do not have a sensor allocated to them already. Select one by double-clicking on it. This is not reversible so be careful! 
 +    * When a location has been assigned the button's label will change to //Unassign location//. Clicking it then will remove the location from the sensor.
  
  
 ===== Viewing sensor temperature logs ===== ===== Viewing sensor temperature logs =====
-The temperature log window (accessed through the menu bar Item > Vaccines > Temperature logs...)shows all temperature logs for all sensors in the system/ +Choose //Item > Vaccines > Temperature logs...// from the menus and a window showing you the temperature logs for all locations assigned to sensors in the system will open:
  
-Any breaches associated with the temperature logs they will be shown in the last columnm, with the text showing "Hot Consecutive" or "Cold consecutive" depending on the type of breach. For logs where there was no breach, this column will be left empty. +{{ :cold_chain_equipment:pasted:20210315-031041.png?700 }}
  
-You can filter the logs by date in the top right section, and filter by location in the top left.   +The **Temperature breach** column will contain a description of the breach (e.g. //Hot Consecutive// or //Cold consecutive//) if the log represents a breach, otherwise the column will be empty. So an empty column is good news! 
-To change the location you are viewing, follow the usual rules of location input windows - put cursor in the location input window, enter “@” and click “tab”. This will open a window showing all the available locations that have a sensor assigned.+ 
 +Use the filters in the top right to filter the logs by date. 
 + 
 +Use the **Location** field in the top left to filter by location. Type the first few character's of the location's code and press the //Tab// key on the keyboard to select the location to view logs for from the list of all locations that have a sensor assigned and have a code starting with what you typed. Double-click a location to select it and the logs for the sensor attached to that location only will be displayed in the list.
  
-{{:cold_chain_equipment:pasted:20210315-031041.png}} 
  
 ===== Viewing breach notifications ===== ===== Viewing breach notifications =====
-Once the ColdChain app is set up with mSupply desktop, you will start receiving notifications about any **unacknowledged** temperature breaches. This window will open automatically on startup or when mSupply receives data from the tablet, and show up to the right of your mSupply Desktop app. +Once the ColdChain app is set up with mSupply desktop as above, you will start receiving notifications about any **unacknowledged** temperature breaches: 
 + 
 +{{ :cold_chain_equipment:pasted:20210315-031623.png?300 }} 
 + 
 +This window will open automatically on startup or when mSupply receives data from the tablet, and show up to the right of your mSupply Desktop app. 
  
-You can close each notification by clicking the close button to remove each notification individually, or you can close the entire window. This is only a notification, so closing it will not change the breach's state to acknowledged - you can only acknowledge breaches in the ColdChain app itself. +You can remove a single notification by clicking on its close button or you can close the entire window. This does not change any notification's state to acknowledged - you can only acknowledge notifications (breaches) in the ColdChain app itself. 
  
 The notification window will show the sensor's location and name, the date, time, and duration of the breach, and whether it was a cold or hot consecutive breach by displaying the “Lowest” or “Highest” temperature respectively. The notification window will show the sensor's location and name, the date, time, and duration of the breach, and whether it was a cold or hot consecutive breach by displaying the “Lowest” or “Highest” temperature respectively.
  
-{{  :cold_chain_equipment:pasted:20210315-031623.png?400  }} 
  
 \\ \\
 \\ \\
-|  //  Previous:  **[[cold_chain_equipment:configure]]** | | Next: **[[assets:assets_setup]]** //  |+|  //  Previous:  **[[cold_chain_equipment:configure]]** | | Next: **[[assets:]]** //  |
 ---- struct data ---- ---- struct data ----
 pagestatus.status    :  pagestatus.status    : 
 ---- ----
  
  • Last modified: 2021/04/23 15:16
  • by Gary Willetts