Web Config Crop Module

Target release

2.2.3

Epic

https://gobiiproject.atlassian.net/browse/GE-216

Document status

DRAFT

Document owner

@Yaw Nti-Addae

Designer

@KevinPalis

Tech lead

@Angel Manica Raquel

Technical writers

 

QA

@Yaw Nti-Addae

Objective

Timescope extension (module) that will allow system administrators to add/edit/delete crops from GDM

Information needed

  • Crop name

  • Database name

  • Web application name (WAR)

  • Seed data

Requirements

Requirement

User Story

Importance

Jira Issue

Requirement

User Story

Importance

Jira Issue

1

Add crop

  • Create a PostgreSQL database for the given database name with nomenclature for crop database as “gobii_cropname”, e.g. gobii_maize, gobii_wheat, gobii_rice

  • Populate the newly created database with basic liquibase seed data (context: general, seed_general)

  • Load the given seed data for contacts (typically provided by the organization/client)

  • Duplicate the WAR file of an existing crop (ex. gobii_dev.war, gobii_wheat.war) as gobii_<cropname>.war

  • Ensure that the new WAR file is expanded by tomcat (usually via the manager’s redeploy/deploy functionality)

  • Add the corresponding entries to the gobii-web.xml file (the entire crop xml block)

  • Create the new crop’s subdirectory in gobii_bundle/crops/*

  • Create the corresponding cron jobs for the new crop

  • Redeploy the new gobii-*.war application

  • Modify Marker Portal’s XML to add Extract UI for new crop

HIGH

 

2

 Edit crop

  1. Backup GDM (including files and database) 

  2. Stop CRON service for crop

  3. Stop Tomcat service for crop

  4. Rename PostgreSQL database for the given database name to new name

  5. Rename the WAR file of an existing crop (ex. gobii_dev.war, gobii_wheat.war) as gobii_<newcropname>.war

  6. Ensure that the new WAR file is expanded by tomcat (usually via the manager’s redeploy/deploy functionality)

  7. Edit the corresponding entries to the gobii-web.xml file (the entire crop xml block)

  8. Rename the crop’s subdirectory in gobii_bundle/crops/*

  9. Rename the corresponding cron jobs for the new crop

  10. Redeploy the new gobii-*.war application

  11. Start CRON service for new crop

 medium

 

3

Delete crop

  1. Backup GDM (including files and database)

  2. Stop CRON service for crop

  3. Stop Tomcat service for crop

  4. Drop PostgreSQL database for the given database name

  5. Edit liquibase to reflect changes

  6. Remove crop service from Tomcat

  7. Edit the corresponding entries to the gobii-web.xml file (the entire crop xml block)

  8. Delete crop’s subdirectory in gobii_bundle/crops/*

  9. Remove the corresponding cron jobs for crop

low

 

User interaction and design

Open Questions

Question

Answer

Date Answered

Question

Answer

Date Answered

 

Links