Scheduling Exports for endTB:

Exports Overview: 

For endTB we need to regularly export all of the data in the system so that analysis can be performed on it. We can model this export as a set of CSVs that would have all of the data. These CSVs would be linkable through identifier columns in them. The data managers at the local sites would be able to generate these exports and send them to the central location for analysis, as and when needed. 

Background Job to generate the exports:

 Since the exports would take some time to generate (depending on the amount of data in the system), it makes sense to have a background job to generate these exports so that they are readily available for the end user and can be quickly and easily downloaded. Thus we have provided a background job "bahmni_batch" that would generate the exports. This background job's schedule and frequency can be adjusted as per requirement

Once the frequency is set, the job would run everyday according to that frequency and generate the exports at a prefixed location. These exports would be accessible for the end user through the bahmni application.

/home/bahmni/endtb_export

Steps to run the export

The export can be run at any time by following the steps below.

1. Login to the server system and open terminal. 

2. Switch to 'bahmni' user using the following command :

   Switching to bahmni user

   sudo su bahmni

3. Now execute the command below

   /usr/bin/bahmni-batch

   The system should show "Running bahmni-batch..."

   When the export is generated the system would give a message "Done".

   Export can now be accessed at /home/bahmni/endtb_export

Scheduling the background job:

1. Open the terminal and change the user to "bahmni" by executing the command "sudo su bahmni"

2. List all the cron jobs (background jobs for bahmni user) user following command

   Command to list the cron jobs

   crontab -l

   Output for above command

   The above command shows the line "30 23 * * * /usr/bin/bahmni-batch >/dev/null 2>&1" as the output. This is because there is a cron job provided by default to schedule the exports. This schedule would run the job everyday at 11:30PM 

   One can change the schedule of the job as per requirement.

   Changing/ Adding a new schedule

   To change this schedule or to add a new schedule one can take the help of a cron generator which can be accessed at: http://crontab-generator.org/

   
   

3. After selecting the schedule, (for example in the above image the schedule that I would want to generate for my job is every 30 minutes.) you will see a field below labeled "Command to execute". Enter the following in this field and click on "Generate Crontab Line". 
4. After clicking the button you will see that your crontab expression is generated and shown at the top of the page. 
   
5. Now you should copy this expression and go to the terminal again. Execute the command "crontab -e"
6. You would be seeing the file that lists all the schedules for different cron jobs. If you have not saved any, you would only see one line in the file which would represent the schedule that has been set for the jobs by default. (11:30PM every day) 
7. Insert the line into this file and save it. (insert and save will work as per your editor). This should set the schedule for the background job. 

Accessing the error log:

1. The error log for the background job can be accessed at "/var/log/bahmni-batch"
2. In this directory there would be a file that would have the log.