Proposed design for New code request
From PTAGISWiki
Contents |
New Validation Code module – Design document
version 1, dated 11/16/07, by Marton Nagy
Introduction
The following document captures the planned design of the New Validation Code module The New Validation Code module shall be a JSP replacement for a similar functionality provided by SiteScape.
Module Design
Functionality
- allows a user to submit a request for a new validation code
- the form presented to the user is one of 3 types: standard, tagging-site specific (for tagging and release sites) or interrogation site specific
- the form type is determined based on the code type the user specifies at the beginning
- when the user fills out all the data and submits the form, the system gathers all this information, puts it in an email and sends it to a ptagis admin account. Ryan confirms that email handling is desired.
Details/Assumptions
- the form fields will be identical to those on the old forms (with the exception of the “send email when a reply is posted for my request” email option, which will be removed, since it is no longer applicable)
- the email account to which the submitted information is sent will be specified in the mail.properties configuration file (e.g. mail.newcode.recipient )
- validation will need to be done to ensure that none of the fields are left empty. Ryan clarifies that the only fields that should be absolutely required (validated) are Code Type and Proposed Code. All others should be optional.
Look and Feel
- similar to existing Sitescape-implemented solution
Implementation Details
- will be implemented under the ptagis web application
- web pages will be placed under web/ptagis/services/newcode
- will use struts to be able to handle a potential file upload (in case of interrogation sites)
