Index: openacs-4/packages/acs-reference/www/doc/design.html
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-reference/www/doc/design.html,v
diff -u -N -r1.2 -r1.3
--- openacs-4/packages/acs-reference/www/doc/design.html 6 Aug 2006 18:30:57 -0000 1.2
+++ openacs-4/packages/acs-reference/www/doc/design.html 6 Aug 2006 18:54:02 -0000 1.3
@@ -4,19 +4,14 @@
acs-reference Design Documentation
acs-reference Design Documentation
-I. Essentials
-
-- There is no user accessible directory
-- There is no sub-site admin accessible diretory
+I. Introduction
-
- Requirements document: Requirements
-
-
-II. Introduction
-
-Reference data is often overlooked in the rush to get coding. In reality, much of ....
+Reference data services are often overlooked in the rush to get
+coding. Much of the code is redundant or of similarly patterned
+implementations. This package intends to address some common features
+and needs.
-III. Historical Considerations
+II. Historical Considerations
Before the existence of acs-reference, the ACS required that you preload some tables in a script to get some basic reference functionality. There were many problems with this:
@@ -26,10 +21,7 @@
No way to find out where that data came from.
Very US/English slant on the data.
- IV. Competitive Analysis
-The only real competition is internally developed solutions.
-
- V. Design Tradeoffs
+III. Design Tradeoffs
Primary Goals
- This system was designed with maintainability and reusability as its primary goals. By wrapping a layer around all of the reference tables we have increased the maintainability immensely.
@@ -38,33 +30,38 @@
Performance
When updating the reference tables their is overhead due to the fact that the table is registered with the repository. This should rarely occur anyway as the tables are only added once.
By not having the actual data itself in the acs-object system, subsequent additions and deletions to the reference tables themselves are unaffected by this overhead.
- VI. API
+IV. API
See api-browser
- VII. Data Model Discussion
- VIII. User Interface
+V. Data Model Discussion
+The UNSPSC reference data has a data model for handling data
+revisions. An application can determine any new/revised category based
+on existing, obsolete data.
+VI. User Interface
Their is no end user interface.
There needs to be some kind of admin UI to report status and possibly
manage updates per requirements.
- IX. Configuration/Parameters
+VII. Configuration/Parameters
None
- X. Future Improvements/Areas of Likely Change
+VIII. Future Improvements/Areas of Likely Change
A server based update mechanism will be supported. This will allow for tables to be updated (and preferably diffed) instead of being reloaded with a package upgrade.
An interface to produce xml/csv from the reference data would be a nice service to the community (allowing legacy applications a way to import this data).
- XI. Authors
+IX. Authors
Jon Griffin
- XII. Revision History
+X. Pre-CVS Revision History
$Log$
+Revision 1.2 2006/08/06 18:30:57 torbenb
+removing c-Ms, wrapping text with p tags, added link to api-browser in api section
+
Revision 1.1 2001/04/22 00:53:12 jong
initial openacs import
Revision 1.2 2000/12/13 04:39:00 jong
Added Revision History and corrected typo in reference link
-