integration:dhis2_integration

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
integration:dhis2_integration [2024/08/14 08:36] – [mSupply preferences] Gary Willettsintegration:dhis2_integration [2024/08/15 14:32] (current) – [mSupply preferences] Gary Willetts
Line 14: Line 14:
  
  
-===== Common types of data ===== +Common types of data that you can send to DHIS2 from mSupply for an item: 
-  - Stock on hand +  - Current stock on hand 
-  - Stock expiring+  - Current months of stock on hand 
 +  - The amount of stock in adjustments 
 +  - The amount of stock received 
 +  - The amount of stock issued 
 +  - The amount of stock expiring within 90 days 
 +  - The amount of stock expired
   - Value of stock on hand   - Value of stock on hand
   - Average monthly consumption   - Average monthly consumption
   - Days out of stock   - Days out of stock
-  - Stock beginning of the month +  - Stock at the beginning of the month 
-  - Stock end of the month+  - Stock at the end of the month 
 +  - Whether the item is currently stocked out
  
  
Line 51: Line 57:
   * **Username:** The username mSupply will use to access the DHIS2 database.   * **Username:** The username mSupply will use to access the DHIS2 database.
   * **Password:** The password mSupply will use to access the DHI2 database.   * **Password:** The password mSupply will use to access the DHI2 database.
-  * **Client:** The client name mSupply must use to access the database. +  * **Client:** Only visible and used if **Basic authentication** is checked. The client name mSupply must use to access the database. 
-  * **Secret:** The secret that is used for mSupply to access the DHIS2 database. No need to enter this if none was provided. +  * **Secret:** Only visible and used if **Basic authentication** is checked. The secret that is used for mSupply to access the DHIS2 database. No need to enter this if none was provided. 
-  * **Setup:** Choose depends on your DHIS2 configuration +  * **Setup:** Here you choose how to identify the elements of data that you send to DHIS2 must be identified. Your choice depends on how DHIS2 is configured. 
-    * **Using category option combo:** If you are using attribute option combos where there is one category combo assigned per data for an entire data set. +    * **Using category option combo:** Choose this if DHIS2 is using attribute option combos where there is one category option combo assigned per data element (AMC, stock on hand etc.) for an entire data set. For this option, you need to tell mSupply what the DHIS2 category option combo ID is for each data element you want to push (i.e. //Active// column is checked) in the //Data elements to push// table. 
-    * **Different data elements per item:**  If there is an assigned data element per item per data. +    * **Different data elements per item:**  Choose this if there is a different identifier for each data element for each item. These identifiers need to be entered for each item in item user fields or item custom fields - you enter the name of the field the value is stored in into the //Data elements to push// table in the //Custom field name// column. 
-    * **Push only 1 data element:** If you only have 1 data element.+    * **Push only 1 data element:** Choose this if you are only pushing a single data element (e.g. AMC, stock on hand etc.) for each item to DHIS2. In the //Data elements to push// table you must check only a single box in the //Active// column and no values need to be entered in the //Category option ID// or //Custom field name// columns.
   * **Data elements to push** In this table, select the data elements that you want to push for each mSupply item.   * **Data elements to push** In this table, select the data elements that you want to push for each mSupply item.
     * **Active column:** Check the checkbox for each data element you want to send for an item. Click on the checkbox to toggle it on and off.     * **Active column:** Check the checkbox for each data element you want to send for an item. Click on the checkbox to toggle it on and off.
-    * **Category option ID column:** Required if **Using category option combo** is selected in the //Setup// section. This is the DHIS2 category option ID per data element. +    * **Category option ID column:** Required if **Using category option combo** is selected in the //Setup// section. This is the DHIS2 category option ID for the data element. 
     * **Custom field name column:** Required if **Different data elements per item** is selected in the //Setup// section. Enter the corresponding item custom field name used to identify the item corresponding DHIS2 data element code.     * **Custom field name column:** Required if **Different data elements per item** is selected in the //Setup// section. Enter the corresponding item custom field name used to identify the item corresponding DHIS2 data element code.
     * **Interval column:** Select the interval between successive sends of the data element. Select one of //monthly//, //weekly//, //daily//, //first day of the month// and //last day of the month// by clicking on the down arrow in the cell and selecting the appropriate option.     * **Interval column:** Select the interval between successive sends of the data element. Select one of //monthly//, //weekly//, //daily//, //first day of the month// and //last day of the month// by clicking on the down arrow in the cell and selecting the appropriate option.
  • Last modified: 2024/08/14 08:36
  • by Gary Willetts