Import and export

- What is import and export? - In a primary health system, the HMIS typically involves a distributed application, where the same application is running in different geographical locations (PHCs,CHCs, hospitals, districts, and state). Most of these physical locations do not have Internet connectivity, and hence they work offline. At some point (normally at the district level), the data needs to be synchronised in order to have a consolidated database for the a particular geographical region. For this, it is important to be able to export data from one location (which is working offline, say at the health facility level) to another one say at the district level where the data would need to be imported. This feature of exporting and importing is thus a crucial function of a HMIS. This feature also helps us overcome the dependency on Internet to some degree, as data updates can be transferred via USB key where there is no connectivity, or through email where there is limited Internet connectivity. DHIS 2 provides robust export-import functionality to fulfil these needs. - -

- Exporting data - In the case on on-line data entry, all data is saved into one database only. In an offline deployment, each deployment will have a separate database in their local system. So the data will be stored in their local database. In an offline deployment, after the data entry is finished, it will need to be manually sent to the next level of where the application is running. In an on-line application, however, that is not required, as all data is stored at a central location using the Internet. - -

- Exporting from DHIS2 - The export option can be made use of by selecting it as follows. -The import or export is available only when the selected organisation (source/destination) has defined datasets. This is because datasets help to define which data is to be or is being exported. Further, which specific data elements get exported is determined by the composition of the dataset being exported. -If there are no datasets defined for an organisation unit, it indicates that no data values are registered for this level of organisation or lower. -To access the main Import-Export module, choose Services->Import-Export - - - - - - - - The exported data values are stored in an ‘xml file’. The file name is defined by the name of the source organisation unit and the period to allow the receiving organisation unit to identify the source and the period of the export file. The XML is placed in your home directory (On Windows this is normally C:\Documents and Settings\ under the sub-directories /dhis / import-export. - -

- Exporting data to other DHIS2 systems - Once the data export screen is displayed, select the Organisation unit, period and dataset for which data export should be selected.Finally click on the export option that will be available on the lower left side of displayed screen. -If there are no datasets defined for an organisation unit, it indicates that no data values are registered for this level of organisation or lower. - - - - - - - - - A pop-up save option will appear on the displayed screen (see picture below) prompting the saving of the exported data. You may save the export folder on your desktop or any other folder by selecting the ‘Save to Disk’ option from the pop-up prompt. - - - - - - - - -

- Exporting metadata to other DHIS2 systems - -

- Metadata export - Metadata is "data about data". In the context of DHIS2, metadata consists of definitions of data elements, indicators, the structure and names contained in the organizational hierarchy, and other options. Click on the "Metadata export" link from the main "Data export" screen in order to access this. Just select the feature that you wish to export and click "Export". This metadata file can then be transmitted just like a data file, except it will contain information on the definitions of the various features, as opposed to the values of the data themselves. - - - - - - - -

- Detailed metadata export - The "Detailed metadata" function will allow you to export specific data element and indicator definitions. Just click "Detailed Metadata Export" and select the data elements and indicators that you wish to export. Click "Export" and save the file to a desired location. This file can then be transmitted via email or USB key to other DHIS2 installations. - - - - - - - -

- IXF data export - DHIS2 support export to the Indicator Exchange Format 2 developed by UNAIDS. The IXF data exchange standard has been implemented ,with various levels of compatibility, between several information management systems including CRIS version 2, DevInfo version 5, KIDS developed by FAO, DHIS 1.4, DHIS2, and HealthMapper version 4 developed by WHO. A more detailed discussion on the use of the IXF data exchange format. - The IXF data export is essentially the same as a standard DHIS 2 DXF export, but results in a file format that is compatible with IXF 2. -

- IXF Metadata export - The IXF detailed metadata export provides the same functionality of the standard DHIS2 detailed metadata export, except that the resulting file is compatible with the IXF data exchange format. -

- DHIS 1.4 Metadata export - The DHIS 1.4 Metadata export functionality provides the same functionality as the standard DHIS2 metadata export, except that the resulting file can be used to transmit metadata information to DHIS 1.4 systems. -

- DHIS 1.4 Detailed Metadata Export - The DHIS 1.4 Metadata export functionality provides the same functionality as the detailed DHIS2 metadata export, except that the resulting file can be used to transmit metadata information to DHIS 1.4 systems. Simply select the data elements and indicators that you want and click "Export" to begin the export process. -

- PDF Metadata Export - Auctor natoque ve vulputate quam. Quam duis posuere risus felis mus class tempor eu sociosqu. Risus duis penatibus turpis, tristique dictum enim est. Quisque mi pulvinar ultrices, fusce diam porttitor mi hendrerit viverra, augue leo vestibulum rutrum. Ridiculus dictumst luctus. Eros. -

- Importing data -

- DXF Import - The Data Exchange Format (DXF) is the default XML schema that is used to transport data between two disconnected DHIS2 systems. Importing data from another DHIS2 system is simple. Just select "Services->Import-Export-Import". Click the "Browse" button, and select the name of the file that you wish to import as shown below. - - Default import screen - - - - - - -

- Importing data - The import option allows different instance of DHIS2 to receive standardised set of data in the absence of a networked system. Typically, a data set is exported from one DHIS instance (e.g. a district level system) to another system (e.g. a provincial level system). DHIS2 is capable of importing data from other systems that either support the DXF of IXF formats. DHIS2 is capable of importing data directly from a DHIS 1.4 Access database. Each of these options will be discussed in the following sections. - DHIS2 is also capable of importing data through the Excel reporting module. The reader is referred to the appropriate chapter for detailed information. -

- Importing data from other DHIS2 systems - Data can be imported into different instances of DHIS2 through the use of the DXF data exchange format. There are two screens that are used to import data, with default and advanced options. - The default data import menu can be accessed by clicking the "Import" from the main Import-Export screen. By clicking the "Browse" button, you can select a file from you local file system. This file may have been received by email, copied from another users system, or received on a CD for example. Simply select the file that you wish to import. - There are three separate options for importing data. - - - Import: This option will import the contents of the import file directly into the database. - - - Preview: This option will enable a preview of the contents of the import file. In the preview one can get an overwiev of the data to be imported, discard unwanted elements and match import elements to existing ones. - - - Analysis: This option will enable an analysis of the contents of the import file. The analysis will search for and examine anomalies in the data, like violations of unique names constraints and invalid indicator formulas. This is useful when importing from external applications where data constraints might be less rigid than in DHIS 2. - - -

+ What is import and export? + In a primary health system, the HMIS typically involves a distributed application, where the same application is running in different geographical locations (PHCs,CHCs, hospitals, districts, and state). Most of these physical locations do not have Internet connectivity, and hence they work offline. At some point (normally at the district level), the data needs to be synchronised in order to have a consolidated database for the a particular geographical region. For this, it is important to be able to export data from one location (which is working offline, say at the health facility level) to another one say at the district level where the data would need to be imported. This feature of exporting and importing is thus a crucial function of a HMIS. This feature also helps us overcome the dependency on Internet to some degree, as data updates can be transferred via USB key where there is no connectivity, or through email where there is limited Internet connectivity. DHIS 2 provides robust export-import functionality to fulfil these needs. + +

+ Exporting data + In the case on on-line data entry, all data is saved into one database only. In an offline deployment, each deployment will have a separate database in their local system. So the data will be stored in their local database. In an offline deployment, after the data entry is finished, it will need to be manually sent to the next level of where the application is running. In an on-line application, however, that is not required, as all data is stored at a central location using the Internet. + +

+ Exporting from DHIS2 + The export option can be made use of by selecting it as follows. +The import or export is available only when the selected organisation (source/destination) has defined datasets. This is because datasets help to define which data is to be or is being exported. Further, which specific data elements get exported is determined by the composition of the dataset being exported. +If there are no datasets defined for an organisation unit, it indicates that no data values are registered for this level of organisation or lower. +To access the main Import-Export module, choose Services->Import-Export + + + + + + + + The exported data values are stored in an ‘xml file’. The file name is defined by the name of the source organisation unit and the period to allow the receiving organisation unit to identify the source and the period of the export file. The XML is placed in your home directory (On Windows this is normally C:\Documents and Settings\ under the sub-directories /dhis / import-export. + +

+ Exporting data to other DHIS2 systems + Once the data export screen is displayed, select the Organisation unit, period and dataset for which data export should be selected.Finally click on the export option that will be available on the lower left side of displayed screen. +If there are no datasets defined for an organisation unit, it indicates that no data values are registered for this level of organisation or lower. + + + + + + + + + A pop-up save option will appear on the displayed screen (see picture below) prompting the saving of the exported data. You may save the export folder on your desktop or any other folder by selecting the ‘Save to Disk’ option from the pop-up prompt. + + + + + + + + +

+ Exporting metadata to other DHIS2 systems + +

+ Metadata export + Metadata is "data about data". In the context of DHIS2, metadata consists of definitions of data elements, indicators, the structure and names contained in the organizational hierarchy, and other options. Click on the "Metadata export" link from the main "Data export" screen in order to access this. Just select the feature that you wish to export and click "Export". This metadata file can then be transmitted just like a data file, except it will contain information on the definitions of the various features, as opposed to the values of the data themselves. + + + + + + + +

+ Detailed metadata export + The "Detailed metadata" function will allow you to export specific data element and indicator definitions. Just click "Detailed Metadata Export" and select the data elements and indicators that you wish to export. Click "Export" and save the file to a desired location. This file can then be transmitted via email or USB key to other DHIS2 installations. + + + + + + + +

+ IXF data export + DHIS2 support export to the Indicator Exchange Format 2 developed by UNAIDS. The IXF data exchange standard has been implemented ,with various levels of compatibility, between several information management systems including CRIS version 2, DevInfo version 5, KIDS developed by FAO, DHIS 1.4, DHIS2, and HealthMapper version 4 developed by WHO. A more detailed discussion on the use of the IXF data exchange format. + The IXF data export is essentially the same as a standard DHIS 2 DXF export, but results in a file format that is compatible with IXF 2. +

+ IXF Metadata export + The IXF detailed metadata export provides the same functionality of the standard DHIS2 detailed metadata export, except that the resulting file is compatible with the IXF data exchange format. +

+ DHIS 1.4 Metadata export + The DHIS 1.4 Metadata export functionality provides the same functionality as the standard DHIS2 metadata export, except that the resulting file can be used to transmit metadata information to DHIS 1.4 systems. +

+ DHIS 1.4 Detailed Metadata Export + The DHIS 1.4 Metadata export functionality provides the same functionality as the detailed DHIS2 metadata export, except that the resulting file can be used to transmit metadata information to DHIS 1.4 systems. Simply select the data elements and indicators that you want and click "Export" to begin the export process. +

+ PDF Metadata Export + Auctor natoque ve vulputate quam. Quam duis posuere risus felis mus class tempor eu sociosqu. Risus duis penatibus turpis, tristique dictum enim est. Quisque mi pulvinar ultrices, fusce diam porttitor mi hendrerit viverra, augue leo vestibulum rutrum. Ridiculus dictumst luctus. Eros. +

+ Importing data +

+ DXF Import + The Data Exchange Format (DXF) is the default XML schema that is used to transport data between two disconnected DHIS2 systems. Importing data from another DHIS2 system is simple. Just select "Services->Import-Export-Import". Click the "Browse" button, and select the name of the file that you wish to import as shown below. + + Default import screen + + + + + + +

+ Importing data + The import option allows different instance of DHIS2 to receive standardised set of data in the absence of a networked system. Typically, a data set is exported from one DHIS instance (e.g. a district level system) to another system (e.g. a provincial level system). DHIS2 is capable of importing data from other systems that either support the DXF of IXF formats. DHIS2 is capable of importing data directly from a DHIS 1.4 Access database. Each of these options will be discussed in the following sections. + DHIS2 is also capable of importing data through the Excel reporting module. The reader is referred to the appropriate chapter for detailed information. +

+ Importing data from other DHIS2 systems + Data can be imported into different instances of DHIS2 through the use of the DXF data exchange format. There are two screens that are used to import data, with default and advanced options. + The default data import menu can be accessed by clicking the "Import" from the main Import-Export screen. By clicking the "Browse" button, you can select a file from you local file system. This file may have been received by email, copied from another users system, or received on a CD for example. Simply select the file that you wish to import. + + There are three separate options for importing data. + + + Import: This option will import the contents of the import file directly into the database. + + + Preview: This option will enable a preview of the contents of the import file. In the preview one can get an overwiev of the data to be imported, discard unwanted elements and match import elements to existing ones. + + + Analysis: This option will enable an analysis of the contents of the import file. The analysis will search for and examine anomalies in the data, like violations of unique names constraints and invalid indicator formulas. This is useful when importing from external applications where data constraints might be less rigid than in DHIS 2. + + + NOTE: We highly recommend always using the Preview option when importing data to make sure you keep control over any changes to your metdata and databases being out of synch on data elements or orgunit names. + + +

+ Preview before importing + Before doing the import into your database it is highly recommended to preview the data to make sure no changes to the metdata (data element and/or orgunit names) have taken place at the source DHIS2 installation. Select Preview in the Type field in the Import window. In the preview window it isIMPORTANT to look for New and Updates in metadata. DO NOT just click the Import all button without carefully reviewing the information in the preview window. Importing new data elements or orgunits without checking properly whether they are really new or just old names can cause a corrupted database with duplicate or incomplete data, so be careful! + + + Procedure for handling New or Updates in the preview: + + + If new: + + If there are new data elements, indicators, or orgunits, first make sure whether they really are new or not. Data elements are rarely new, most of the time they are the old name of something that has been changed in the destination database (e.g. a master db at the national level). If you have changed some data elements names at the national level and these have not yet been updated in the district database, the old names that are in the district export files will appear as new data elements in your import preview. It is very important that you tell the DHIS that these are only just old names of a data element that already exists in your database, if not you will have two data elements meaning the same thing and both with an incomplete set of data. Use the ‘match new to existing’ button to link the new data elements (that really are old) to the updated names in your national database, and make sure that the source database updates its metdata before the next data export. + + + If updates: + Only the newer updates are shown in the preview. This means the record has been updated more recently in the district/hospital than in the zonal/national database you are importing into. If you are not sure whether you want to import the update or not, you can select the record and click on the compare to existing button to see exactly which changes that have been made in the updated object. + +

Standard Reports -

- How to set up and run standard reports + How to create a new standard report + Selecting the standard reporting framework in System settings + In System Settings there is a property called reporting Framework. Two options are currently supported; Jasper Reports and BIRT Reports. When creating and running standard reports the system behave according to this setting, so make sure your report designs match the selected reporting framework. A quick comparison is that Jasper i sfully integrated and requires no extra mainteance while BIRT is run as a separate web application and needs to be deployed and maintained separately, which also adds to the size of the installation package, which can be an important consideration in your project. BIRT has a more user friendly designer than Jasper (Ireport), and both systems are under active development, so stay updated by following their web pages. Both designers have more or less the same functionalty. Add a new standard report: - In Reports module, go to Reports->Standard Reports and click the left side 'Add new' button. Provide a name for the report, upload your design file (.rptdesign) and select the report table(s) you have used in your report. Then Save. - Running standard reports: (NEED TO BE UPDATED FOR 2.0.5) + In Reports module, go to Reports->Standard Reports and click the left side 'Add new' button. Provide a name for the report, upload your design file (.rptdesign or .jrxml) and select the report table(s) you have used in your report. Then Save. + NOTE ON DB CONNECTIONS: all the connection strings in your design file will be automcatilly updated to connect to the database used by the DHIS2 you are uploading to. This means that e.g. you can design reports againts a local copt of the database and upload and use the design on an online server. This of course requires that data elements, indicators, report tables etc. are the same on both databases. + +

+ How to run standard reports + Running standard reports: (NEED TO BE UPDATED FOR 2.0.5) You access the available reports from the Services drop-down menu, by selecting Reports. In the report menu in the left bar, click Standard Report. A list of all pre-defined reports will appear in the main window. SCREENSHOT1 @@ -340,8 +346,7 @@ SCREENSHOT 6 Note that you can select to view these reports again without selecting new report parameters. Just click the icon second from left, and the report will appear with the last selected report parameters. SCREENSHOT 7 -

BIRT reports

@@ -435,6 +440,17 @@

Jasper Reports +

+ Designing Jasper reports with iReport + Under development. Here are a few quick advices: + - Remember to set the report language to Java, and not Groovy (default). This is a setting under report properties and must be set per report. + - Use the same version of IReport and DHIS2's version of Jasper reports. See the About page in DHIS2 for the Jasper version in use. + - Use report tables with cross tab dimensions as your data source for your report designs, this will make it a lot easier to design reports where you need to put specific indictors, periods, or orgunits on columns. + - To comfigure your data source connection in IReport have a look at the hibernate.properties file running DHIS2, or the About page to get the connection URL. Both MySQL and PostgreSQL connectors (jdbc drivers) are available out of the box in IReport. H2 connections are also possible. + - Learn from others, there are many DHIS2 report designs for Jasper and BIRT on launchpad, see http://bazaar.launchpad.net/~dhis2-devs-core/dhis2/trunk/files/head:/resources/ + - + +