KF7014 Advanced Programming Assignment Brief Sem 2, 2025

LEARNING OUTCOMES OF KF7014: 

The learning outcomes (LOs) for this module are: 

• LO1. Demonstrate in-depth knowledge and understanding of current best professional practice in the design and development of applications. 
• LO2. Design and develop a system that demonstrates a professional understanding of current software development best practices and explore opportunities for innovation.
• LO3. Work as part of a self-organising team in the implementation and testing of a software system, using appropriate advanced techniques.
• LO4. Demonstrate the effectiveness of the implemented application, in adhering to current software development best practices and critically evaluate your work.
• LO5. Demonstrate a professional understanding of the importance of legal, social, and ethical requirements in producing a system that holds third party information. In particular, the need for application-level security both in terms of access control and data security.

This assessment addresses the learning outcomes, as follows: 

• Individual component will assess LO1, LO2, and LO5. 
• Group component will assess LO1, LO2, LO3, LO4, and LO5.

KF7014 ASSESSMENT INSTRUCTIONS 

Specifications of each component are detailed below.

INDIVIDUAL COMPONENT

This component includes micro services development and technical documentation. 

Micro service development:

For the individual component, you will create microservices responsible for reading the water quality monitoring data from CSV file, storing records in a permanent database, checking the safe drinking water limits, and triggering necessary alerts.

The developed solution should be structured in the following projects and fulfil the following functionalities:

• Monitoring microservice - This microservice is responsible for reading data records from the CSV file (available on Blackboard1 ), store records in a permanent database; one record at time with 30 seconds apart between each record. Each record should be stored with the current time instance and should have a generated UUID.
• Water Quality microservice - This microservice is responsible for continuously reading the records from the monitoring microservice, one record at a time, check if any of the parameters exceeds the safe limits of drinking water (as per the below table2 ), and setting a Green/Red flag for the water safety. Water safety flags don't need to be stored. The Total Dissolved Solids should be calculated as the sum of CUSOL1(mg/l) Copper Dissolved, CUSOL2(ug/l) Copper Dissolved, FESOL1(ug/l) Iron Dissolved and ZN SOL(ug/l) Zinc Dissolved - noting the conversion of mg/l and ug/l. 
• Testing project - This should include Unit Testing for each microservice. 
• Data folder - This folder should include the database files used to permanently store the collected data with sample data stored.

The developed solution should fulfil the following technical requirements: 

• Development in Java using any code editor or IDE (e.g. Eclipse). 
• Implementing API Gateway for the communication between the microservices. 
• Using a suitable database (e.g., MongoDB, SQLite) to store the collected data. Each microservice should have its own database if needed. 
• Implementing error and exception handling. 
• Testing APIs to ensure functionality and reliability.
• Writing code documentation.

The developed solution should follow the following best practices: 

• Solution and projects should be well-structured. -Object-oriented principles should be used in designing the solution. 
• Functions should be used. 
• Code conventions should be followed. -Professional code styling and formatting should be followed. 

Notes: 

• The developed solution should not call any external APIs. 
• The developed solution should not use any datasets, except the provided CSV file. 
• The submitted database files should not include large amounts of stored data, only few records.

KF7014 Technical Documentation 

The report should document the developed microservices-based solution, and should include: 

• Architecture diagram - provide a diagram of the architecture of the developed solution, clarifying the communication between different microservices. -Database Schema - provide the schema for the database used by the developed solution, in the form of clear diagrams, including tables, fields, and relationships. 
• Class diagram - provide the design of the classes implemented in the developed solution, in the form of clear diagrams, including classes, interfaces, properties and functions. 
• APIs documentation - list all APIs endpoints and their associated HTTP methods, e.g., GET, POST, PUT, DELETE, their Request and Response, and returned error codes. Screenshots of Postman could be used. 
• Critical evaluation - (~ 500 words) critically evaluate your product's inception to completion, i.e. what have been done well, what could have been done better and how. 
• References - include references to relevant external documentation or resources. 

The technical documentation should include only the above figures and 500 words for the critical reflection. More details about the requirements of the report are listed below. You should use the template provided on Blackboard.