[cvs] Expresso commit by mtraum: DB help files were missing

Mon Oct 11 21:00:52 PDT 2004

Log Message:
-----------
DB help files were missing

Added Files:
-----------
    expresso/expresso-web/expresso/help:
        ValidationQueueParam.html
        ValidationQueue.html

Revision Data
-------------

--- /dev/null
+++ expresso-web/expresso/help/ValidationQueueParam.html
@@ -0,0 +1,42 @@
+<html>
+
+<head>
+<meta http-equiv="content-type" content="text/html;charset=iso-8859-1">
+<title>Validation Queue Parameters Help</title>
+<link href="../style/default.css" rel="styleSheet" type="text/css">
+</head>
+
+<body class="jc-default">
+<p class="jc-pageheader">Validation Queue Parameters</p>
+<p>Contains parameters associated with a validation queue entry.</p>
+<p>The following fields are used for validation queue parameters:</p>
+<center>
+<p></p>
+<table align="center" border="1" cellpadding="2" cellspacing="0">
+	<tr>
+		<th class="jc-tabletitle">Field Name</th>
+		<th class="jc-tabletitle">Description</th>
+	</tr>
+	<tr>
+		<td>Job entry number</td>
+		<td>A serial number is automatically assigned to each validation entry
+		as it is created</td>
+	</tr>
+	<tr>
+		<td>Parameter Number</td>
+		<td>The serial number of the parameter (first parameter is numbered 1,
+		then 2, etc)</td>
+	</tr>
+	<tr>
+		<td>Parameter Value</td>
+		<td>The data value of this parameter</td>
+	</tr>
+	<tr>
+		<td>Parameter Code</td>
+		<td>The code name of this parameter</td>
+	</tr>
+</table>
+</center>
+</body>
+
+</html>
--- /dev/null
+++ expresso-web/expresso/help/ValidationQueue.html
@@ -0,0 +1,89 @@
+<html>
+
+<head>
+<meta http-equiv="content-type" content="text/html;charset=iso-8859-1">
+<title>Validation Queue Help</title>
+<link href="../style/default.css" rel="styleSheet" type="text/css">
+</head>
+
+<body class="jc-default">
+<p class="jc-pageheader">Validation Queue</p>
+<p>The Validation Queue is the queue for the 'validation framework'. The
+validation framework is provided for a specific group of problems
+described as follows:</p>
+<ol>
+	<li>User enters some information to perform some sort of action, let's
+	say to unsubscribe from a mail list. <br>
+	<br>
+	</li>
+	<li>The validation framework then sends a confirmation email to the
+	user that includes a clickable URL. This URL contains a 128-bit random
+	number.<br>
+	<br>
+	</li>
+	<li>The user clicks on the random number. The framework then looks up
+	that random number and dispatches the request to the appropriate
+	ValidationHandler class.<br>
+	<br>
+	</li>
+	<li>The validation handler then performs the appropriate actions and
+	displays the final message to the user.</li>
+</ol>
+<p>You can see this system in action in Expresso's registration system
+in: <code>com.jcorporate.expresso.services.controller.Registration</code></p>
+<p>&nbsp;</p>
+<p>The following fields are used for validation queues:</p>
+<center>
+<p></p>
+<table align="center" border="1" cellpadding="2" cellspacing="0">
+	<tr>
+		<th class="jc-tabletitle">Field Name</th>
+		<th class="jc-tabletitle">Description</th>
+	</tr>
+	<tr>
+		<td>Job entry number</td>
+		<td>A serial number is automatically assigned to each validation entry
+		as it is created</td>
+	</tr>
+	<tr>
+		<td>Status Code</td>
+		<td>
+		<ol>
+			<li>New</li>
+			<li>Available</li>
+			<li>Wait</li>
+			<li>Validated</li>
+			<li>Denied</li>
+			<li>Expired</li>
+		</ol>
+		</td>
+	</tr>
+	<tr>
+		<td>Added On</td>
+		<td>The date and time the job was intitially requested</td>
+	</tr>
+	<tr>
+		<td>Expires At</td>
+		<td>When the validation entry is no longer valid</td>
+	</tr>
+	<tr>
+		<td>Processed On</td>
+		<td>When the validation entry was processed</td>
+	</tr>
+	<tr>
+		<td>Processed By</td>
+		<td>The username who processed the validation entry</td>
+	</tr>
+	<tr>
+		<td>Validation Security Code</td>
+		<td>A random number to give security to the URL</td>
+	</tr>
+	<tr>
+		<td>Validation Handler Class</td>
+		<td>A class which extends com.jcorporate.expresso.services.validation.ValidationHandler</td>
+	</tr>
+</table>
+</center>
+</body>
+
+</html>
