Facilities Assessment Server

Setup development environment

1. Download and install Postgres Server version 9.5 or higher in 9.x
2. Install Java version 8
3. Ensure that Make utility is available.
4. To test whether you set up is working fine from command line in the root folder of the project run: make build_server_online test_server. For automated test facilities_assessment_test is created.
5. For production data facilities_assessment_nhsrc database is used - which you can create from a dump. Once your database is created from the dump, you can run the server using make run_server_nhsrc. The server is started on port 6001. You can check whether the server is running by http://localhost:6001/api/ping which should response with text pong.

Background jobs

Gunak server has one background job which is not run by the command in step 5. To run the server with background job use command make run_server_background_nhsrc. This will trigger the job every three seconds. This job performs two tasks:

1. Assessment scoring job - to score any new assessment submitted.
2. Facility download job - to download any new facilities created in the nin database. You will require a valid NIN API key.

Creating assessment tools

This can be done using a tool like Postman as there is currently no user interface for this. There in one endpoint (/api/assessmentTool/asFile) with two methods (HEAD and PUT) that can be used. HEAD is used to check whether the file is correct or not and PUT for creating the assessment tool with complete hierarchy of data. When you use the HEAD method then there are two files created in log directory.

• On success an HTML file with the name of assessment tool
• On failure and HTML file with the name ("%s-error.html", assessment tool name) In case of error the excel file may be corrected and then rechecked via HEAD method. When one gets a success then can use the PUT method.

The API takes following parameters (mandatory parameters marked as *)

• assessmentTool (*), name of the assessment to be created
• assessmentToolMode (*), the name of program which is already present in the system (e.g. NQAS, LAKSHYA)
• overrideAssessmentToolId, if this new assessment tool will override a universal checklist then the assessment tool id of the universal checklist is provided here
• state, if it is state specific checklist then the name of the state
• sortOrder (*), to control the order in which the assessment tool is displayed in the mobile app (higher sort order is shown first in the app)
• themed, if the assessment tool uses the themes (tags). true/false. default false.

Once you create the assessment tool in development/test environment it can be tested via the mobile app. Also one should submit assessment in test/development environment to ensure the tool is imported correctly. After this this can be deployed to production via the same process.