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 12:17] – [mSupply preferences] Gary Willettsintegration:dhis2_integration [2024/09/12 15:57] (current) – [mSupply preferences] Gary Willetts
Line 14: Line 14:
  
  
-Common types of data that you can send to DHIS2 from mSupply for an item:+The types of data that you can send to DHIS2 from mSupply for an item:
   - Current stock on hand   - Current stock on hand
   - Current months of stock on hand   - Current months of stock on hand
Line 22: Line 22:
   - The amount of stock expiring within 90 days   - The amount of stock expiring within 90 days
   - The amount of stock expired   - The amount of stock expired
-  - Value of stock on hand 
   - Average monthly consumption   - Average monthly consumption
   - Days out of stock   - Days out of stock
Line 57: Line 56:
   * **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:** 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.   * **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:** 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.+    * **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:**  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.     * **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:** 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.     * **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.
Line 74: Line 73:
   * **Data element ID scheme:** This tells mSupply what kind of DHIS2 item identifiers are stored in mSupply (in the place defined by the **Item field reference** section above), item codes or UIDs.   * **Data element ID scheme:** This tells mSupply what kind of DHIS2 item identifiers are stored in mSupply (in the place defined by the **Item field reference** section above), item codes or UIDs.
   * **Round off checkbox:** If checked then mSupply will round numerical data values to the nearest whole number as some DHIS2 setup only accept integers.   * **Round off checkbox:** If checked then mSupply will round numerical data values to the nearest whole number as some DHIS2 setup only accept integers.
 +  * **No. of items per payload:** Enter the number of pieces of information to send in a particular call to the DHIS2 server. If there are more than this number of pieces to send then they will be split up into separate calls with this number of pieces of information in them. Helpful if there is a lot of information to send but the DHIS2 server can't handle the volume of information (which usually results in internal errors being returned).
   * **Test connection button:** Click this to test the connection to the DHIS2 server. You will be shown a message that tells you whether mSupply was able to connect to the DHIS2 server with the credentials you have provided.   * **Test connection button:** Click this to test the connection to the DHIS2 server. You will be shown a message that tells you whether mSupply was able to connect to the DHIS2 server with the credentials you have provided.
   * **Manual push data button:** Click this button to immediately attempt to push the data as setup in this window to DHIS2. The data will, of course, be pushed on a //current day// basis. View the log (see the [[admin:the_log|]] section for details) to see the results of the attempt.   * **Manual push data button:** Click this button to immediately attempt to push the data as setup in this window to DHIS2. The data will, of course, be pushed on a //current day// basis. View the log (see the [[admin:the_log|]] section for details) to see the results of the attempt.
  • Last modified: 2024/08/14 12:17
  • by Gary Willetts