Revision: 1880
Author: [email protected]
Date: Tue May 11 04:30:21 2010
Log: Added first version of use case describing submission of projects to a
running Simal instance.
http://code.google.com/p/simal/source/detail?r=1880
Added:
/wiki/UseCases.wiki
=======================================
--- /dev/null
+++ /wiki/UseCases.wiki Tue May 11 04:30:21 2010
@@ -0,0 +1,30 @@
+#summary Use case descriptions
+#labels Phase-Design
+
+== Introduction ==
+
+This page describes use cases for Simal.
+
+== [UC1] Submit project to Simal instance using a web form ==
+
+High-level scenario:
+ # User goes to a web page where there is a form to enter data about a
software project
+ # User fills in the form and hits the submit button
+ # If not all checks are ok a message will be displayed so the user can
correct those
+ # If all checks are ok an RDF/XML document will be created and submitted
to a running Simal instance
+ # The user gets to view the RDF/XML contents to keep for their records
+ # If the submission to the running Simal instance is successful, ie.
results in the project being added to the registry, the user is presented
with a URL where the project details can be seen on the running Simal
instance
+ # If the submission is unsuccessful, the user is presented with an error
message stating in as much detail as possible what went wrong
+
+Technical details:
+ # The web form is a Wookie widget which can be embedded in one of Simal
pages as well as in any other web page.
+ # There is a running Wookie server that serves this Wookie widget
+ # There may be different versions of the form for different kinds of
projects. Eg. JISC projects require some data that is not applicable to
other kinds of projects.
+ # Client-side JavaScript checks are performed after form submission eg.
to check if all required fields are filled in, if URLs and email addresses
are valid, etc.
+ # The RDF/XML document is created client-side using JavaScript and
POST-ed to the running Simal instance's REST API.
+ # Simal processes the RDF/XML. If the operation is successful, ie. a new
project is created, a stable URL to the detail page of the added project is
returned. If the operation is unsuccessful, an error message is returned
stating the nature of the error.
+ # The result from Simal is displayed to the user
+ # The same RDF/XML document that is sent to Simal is displayed to the
user.
+
+
+
--
You received this message because you are subscribed to the Google Groups "Simal
Commits" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to
[email protected].
For more options, visit this group at
http://groups.google.com/group/simal-commits?hl=en.
