Skip to content

Latest commit

 

History

History
116 lines (85 loc) · 5.35 KB

README.md

File metadata and controls

116 lines (85 loc) · 5.35 KB
Raw

datim-dedupe

Build Status Coverage Status Code Climate

Dependency Status Dependency Status

Deduplication app for DATIM

##Installing the app into your DHIS2

####Step 1: Create the sql view Installing and preparing the sql view has two steps.

Firstly you will need to install the duplication_record type into your database. The sql to do this can be found on the following url. https://raw.githubusercontent.com/dhis2/datim-dedupe/master/sql/create_duplicate_type.sql

Following that you will have to run the query that will add the function to get the duplicates. This one can be found here https://raw.githubusercontent.com/dhis2/datim-dedupe/master/sql/dedupe_plpgsql.sql

When both of those are installed correctly you can create the SQLView in DHIS2. This you can find by navigating to Apps in the top menu followed by the Data administration app. Then on the left side menu you click SQL View. Click the Add button on the top right to create a new SQL View.

Select SQL query (allows for variables) as an Sql type You can use the SQL below to get the duplicates from the server using the added sql function in the previous step.

SELECT * FROM view_duplicates('${ou}', '${pe}', ${rs}, ${ps}, ${pg}, '${dt}');

Note that when creating the view the ou, pe and dt variables are surrounded by single quotes to indicate that they are strings.

The parameters specified represent the following:

  • ou: Organisation Unit Uid {String}
  • pe: Period to use (formatted in iso format like 2013Oct) {String}
  • rs: Include resolved records {Boolean}
  • ps: Page size {Integer} Defaults to 100
  • pg: Current page number to be requested
  • dt: Data type to be selected {String} that is one of the following values RESULTS, TARGETS, NULL

Lastly when you added the SQL View you can find it in the list and click on it, then select Show Details to make the details show up where you will find the id to use in the next step.

####Step 2: Create a system setting In order for the app to know which SQL view to ask for the data you need to add a system setting. The system setting should have the following name keyDedupeSqlViewId

The value for this system setting is as shown below. This is a basic javascript object with the property name id and the sql view uid as its value.

{
	"id": "AuL6zTSLxNc"
}

To set the system setting using curl you can do:

curl "https://test.datim.org/api/systemSettings/keyDedupeSqlViewId" -d '{"id": "AuL6zTSLxNc"}' -H "Content-Type:text/plain" -X POST -u user:pw -v

####Step 3: Install the datim-dedupe app You will find the latest version of the dedupe app here http://dhis2.github.io/pepfar-releases/. Download the zipfile and install it into dhis2 using the app management app you will find in the app menu.

That should be all.

Contribute

Setup the dhis.json config file

To get started clone the repository and add a dhis.json file to the root of the project. This will help gulp determine where your dhis2 instance is running and will make it easier to deploy the app. Additionally it will also update the webapp manifest for you so you do not have to install the app.

The dhis.json file should look something like the following. The dhisBaseUrl is the url for the manifest. This is the address you use in your browser. The dhisDeployDirectory is the directory on disk where the app should be copied to. (Note the last folder being the app folder. This folder is the app installation folder as defined in the dhis app management settings module + the name of the app.)

{
    "dhisBaseUrl": "http://localhost:8080/dhis",
    "dhisDeployDirectory": "/usr/local/apache-tomcat-8.0.5/webapps/dhis/apps/datim-dedupe/"
}

Install the dependencies

We make use of some tools to build the application, that you would need to install before being able to do any of the commands needed. You need to run nodejs or io.js and have bower and gulp installed as global modules. Additionally to pre-process the sass files to css you need to have sass for ruby installed as well. All these can be installed using the following commands.

#Install bower for dependency management
npm install -g bower

#Install gulp to run build tasks
npm install -g gulp

#You might have to use sudo to install the ruby gem.
gem install sass 
#or
sudo gem install sass

Run the following command to install the nodejs dependencies (This requires you to have nodejs installed)

npm install

Install the bower dependencies

bower install

Run the gulp build command to see if everything is installed correctly

gulp build

After running gulp copy-to-dev your app should be available at http://localhost:8080/dhis/datim-dedupe if your settings are the same as above.

Happy hacking!