Commit 2d960697 authored by Frank Bergmann's avatar Frank Bergmann

- Upgrade to V4.0

parent 6283130e
<?xml version="1.0"?>
<!-- Generated by the OpenACS Package Manager -->
<package key="acs-reference" url="http://www.arsdigita.com/acs-repository/apm/packages/acs-reference" type="apm_service">
<license>GPL V2.0 or any later version</license>
<package key="acs-reference" url="http://openacs.org/repository/apm/packages/acs-reference" type="apm_service">
<package-name>ACS Reference Data</package-name>
<pretty-plural>ACS Reference Datas</pretty-plural>
<initial-install-p>t</initial-install-p>
<singleton-p>t</singleton-p>
<version name="5.1.5" url="http://openacs.org/repository/download/apm/acs-reference-5.1.5.apm">
<version name="5.6.0" url="http://openacs.org/repository/download/apm/acs-reference-5.6.0.apm">
<owner url="mailto:jon@jongriffin.com">Jon Griffin</owner>
<summary>Tools and API for managing refrence data.</summary>
<release-date>2004-02-28</release-date>
<release-date>2010-06-17</release-date>
<maturity>3</maturity>
<vendor url="http://www.mayuli.com">Mayuli Enterprises, LLC</vendor>
<license url="http://www.gnu.org/copyleft/gpl.html">GPL</license>
<maturity>3</maturity>
<description format="text/html">Reference Data provides an API to support:
&lt;ul&gt;
&lt;li&gt; A common set of reference data.
&lt;li&gt; Running standard reports on this data.
&lt;li&gt; Monitoring the usage of reference data.
&lt;/ul&gt;</description>
<provides url="acs-reference" version="5.1.4"/>
<requires url="acs-kernel" version="5.0.0"/>
<provides url="acs-reference" version="5.6.0"/>
<requires url="acs-kernel" version="5.6.0"/>
<callbacks>
</callbacks>
......
......@@ -46,14 +46,14 @@ create table acs_reference_repositories (
-- what is the table name we are monitoring
table_name varchar2(100)
constraint arr_table_name_nn not null
constraint arr_table_name_uq unique,
constraint arr_table_name_un unique,
-- is this external or internal data
internal_data_p char(1)
constraint arr_internal_data_p_ck
check (internal_data_p in ('t','f')),
-- Does this source include pl/sql package?
package_name varchar2(100)
constraint arr_package_name_uq unique,
constraint arr_package_name_un unique,
-- last updated
last_update date,
-- where is this data from
......@@ -134,7 +134,8 @@ as
creation_date => creation_date,
creation_user => creation_user,
creation_ip => creation_ip,
object_type => object_type
object_type => object_type,
title => source
);
if first_names is not null and last_name is not null then
......
......@@ -41,12 +41,12 @@ create table acs_reference_repositories (
-- what is the table name we are monitoring
table_name varchar(100)
constraint arr_table_name_nn not null
constraint arr_table_name_uq unique,
constraint arr_table_name_un unique,
-- is this external or internal data
internal_data_p boolean,
-- Does this source include pl/sql package?
package_name varchar(100)
constraint arr_package_name_uq unique,
constraint arr_package_name_un unique,
-- last updated
last_update timestamptz,
-- where is this data from
......@@ -108,6 +108,9 @@ begin
now(),
p_creation_user,
p_creation_ip,
null,
''t'',
p_source,
null
);
......@@ -190,6 +193,7 @@ create function acs_reference__is_expired_p (integer)
returns char as '
declare
repository_id alias for $1;
v_expiry_date acs_reference_repositories.expiry_date%TYPE;
begin
select expiry_date into v_expiry_date
from acs_reference_repositories
......
......@@ -2,31 +2,26 @@
<html>
<head><title>acs-reference Design Documentation</title></head>
<body bgcolor=white text=#000000>
<body bgcolor=white text="#000000">
<h2>acs-reference Design Documentation</h2>
<h3>I. Essentials</h3>
<ul>
<li>There is no user accessible directory</li>
<li>There is no sub-site admin accessible diretory</li>
<h3>I. Introduction</h3>
<p>
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.
</p>
<h3>II. Historical Considerations</h3>
<p>
<li>Requirements document: <a href="requirements.html">Requirements</a>
<li>Data model:?? where does this really go? </a>
<li>ER diagram: None yet
</ul>
<h3>II. Introduction</h3>
Reference data is often overlooked in the rush to get coding. In reality, much of ....
<h3>III. Historical Considerations</h3>
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:
</p>
<ul>
<li>No easy way to find out what reference data even existed.</li>
<li>No way to find out how old the data was.</li>
<li>No way to find out where that data came from.</li>
<li>Very US/English slant on the data.</li>
</ul>
<h3> IV. Competitive Analysis</h3>
The only real competition is internally developed solutions.
<h3> V. Design Tradeoffs</h3>
<h3>III. Design Tradeoffs</h3>
<h4>Primary Goals</h4>
<ul>
<li>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.</li>
......@@ -35,26 +30,44 @@ The only real competition is internally developed solutions.
<h4>Performance</h4>
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.
<h3> VI. API</h3>
<h3> VII. Data Model Discussion</h3>
<h3> VIII. User Interface</h3>
Their is no end user interface.
There will
<h3> IX. Configuration/Parameters</h3>
None
<h3> X. Future Improvements/Areas of Likely Change</h3>
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.
<h3>IV. API</h3>
<p>See <a href="/api-doc/index?about_package_key=acs-reference">api-browser</a></p>
<h3>V. Data Model Discussion</h3>
<p>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.</p>
<h3>VI. User Interface</h3>
<p>Their is no end user interface.
There needs to be some kind of admin UI to report status and possibly
manage updates per requirements.
</p>
<h3>VII. Configuration/Parameters</h3>
<p>None</p>
<h3>VIII. Future Improvements/Areas of Likely Change</h3>
<p>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).
<h3> XI. Authors</h3>
<h3> XII. Revision History</h3>
</p>
<h3>IX. Authors</h3>
<p>
Jon Griffin
</p>
<h3>X. Pre-CVS Revision History</h3>
<pre>
$Log$
Revision 1.4 2006/08/06 20:40:20 torbenb
upgrading html, closing li p tags, adding quotes to tag attributes
Revision 1.3 2006/08/06 18:54:02 torbenb
added documentation commentary, applied bs filter, renumbered sections
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
</pre>
</body>
</html>
......@@ -2,20 +2,17 @@
<html>
<head><title>ACS Reference Documentation</title></head>
<body bgcolor=#ffffff>
<body bgcolor="#ffffff">
<h2>ACS Reference Documentation</h2>
<hr>
<h3>Engineering Docs</h3>
<ul>
<li><a href="requirements.html">Requirements</a>
<li><a href="design.html">Design</a>
<li><a href="requirements.html">Requirements</a></li>
<li><a href="design.html">Design</a></li>
</ul>
Current docs are always at:<br>
<p>Current docs are always at:<br>
<a href="http://www.jongriffin.com/static/openacs">jongriffin.com</a>
<h3>Release Notes</h3>
<p>Please file bugs in the <a href="http://www.openacs.org/sdm/">SDM</a>.</p>
</p>
<hr>
<address><a href="mailto:jon@jongriffin.com">jon@jongriffin.com</a></address></body>
</html>
......
<!-- $Id$ -->
<html>
<head>
<title>ACS Reference Requirements</title>
</head>
<body bgcolor=#ffffff>
<body bgcolor="#ffffff">
<h2>ACS Reference Requirements</h2>
by <a href="mailto:jon@jongriffin.com">Jon Griffin</a>
<p>by <a href="mailto:jon@jongriffin.com">Jon Griffin</a></p>
<hr>
<h3>I. Introduction</h3>
This document describes the requirements for the ACS Reference service
<p>This document describes the requirements for the ACS Reference service
package. This package has the following primary functions:
</p>
<ul>
<li>It allows applications to refer to and employ a common set of reference
data.</li>
......@@ -22,7 +24,9 @@ data of this sort.</li>
very often and also in many cases comes from an external source and not
from within the system itself. Many times it is created from a standards
body, i.e. <a href="http://www.iso.ch/">ISO</a> or <a href="http://www.ansi.org">ANSI</a>, and may be required for a client's particular industrial needs.
</p>
<p>Some examples of reference data are:
</p>
<ul>
<li>Geographic data: zip codes, country codes and states/provinces</li>
<li>Standards bodies data: ISO 4217 currency codes, ISO 3166 Country Codes, ITU
......@@ -30,35 +34,38 @@ Vehicle Signs</li>
<li>Quasi-Standards: S&amp;P Long-term Issuer Credit Ratings</li>
<li>Internal: Status Codes, Employee Position Codes</li>
</ul>
Historically, reference data has been looked upon by developers as
<p>Historically, reference data has been looked upon by developers as
something less important than more immediate coding needs, and so most
data models simply defer the issue by treating reference data as
something simple to implement. Elsewhere. The reality is
that for most organizations reference data is extremely important and
also extremely difficult to manage.
</p>
<p>This module will not only <i>package</i> all of a site's reference
data in one place, it will also help manage that data.
</p>
<h3>III. System Overview</h3>
The ACS Reference package consists of:
<p>The ACS Reference package consists of:</p>
<ul>
<li>A standard framework for monjitoring and modifying reference data.
<li>A method of determining whether or not that data is expired.
<li>A standard framework for monjitoring and modifying reference data.</li>
<li>A method of determining whether or not that data is expired.</li>
<li>The ability to include not only the data but also functions to
work with that data.
work with that data.</li>
</ul>
<h3>IV. Use-cases and User-Scenarios</h3>
Papi Programmer is developing a module that will use country codes as
<p>Papi Programmer is developing a module that will use country codes as
part of his table structure. Instead of creating his own table he can
use the ACS Reference package and the country codes therein. If the
country codes change - which does in fact happen from time to time -
the ACS Reference package will maintain that information for him.
</p>
<h3>V. Related Links</h3>
<ul>
<li> <a href=design.html>Design document</a>
</ul>
<li> <a href="design.html">Design document</a>
</li></ul>
<h3>VI.A Requirements: Data Model</h3>
<p>
10.10 The package should use a table that is the <i>master</i> table for all reference tables.
<br>10.20 The package should employ a field to show whether this data is internally derived or not.
<br>10.30 The package should employ a field to signify whether there is a PL/SQL package involved with
......@@ -69,40 +76,51 @@ this table.
<br>10.70 The package should offer a representation of effective datetime
<br>10.80 The package should offer a representation of discontinued datetime
<br>10.90 The package should keep an indication of who the data maintainer is, by user_id.
</p>
<h3>VI.B Requirements: API</h3>
20.10 The package should offer a function to determine if a particular table has expired.<p>
The requirements below are not met by the current implementation:<p>
<p>
20.10 The package should offer a function to determine if a particular
table has expired.
</p><p>
The requirements below are not met by the current implementation:
</p><p>
30.10 There needs to be a way to query the data source and update
automatically. If that isn't possible, as it won't be in many cases,
the application should be able to query a master server and see if
there is new data for a particular table or tables. For example:
refdata.arsdigita.com could hold the reference tables and when newer
table versions become available, simply upload only these versions or
perhaps even only the differences between the tables.
perhaps even only the differences between the tables. In any case,
there should be an admin page that shows current status and revisions
of various data, where to find info about additional sources (if
applicable), and provide a UI to upload or import new data.
</p>
<h3>VII. Implementation Notes</h3>
<p>
The package needs to handle changes to reference data in a graceful
fashion. For example, if a country splits into two or more countries, what should happen?
</p>
<ul>
<li>The reference package should note this change.</li>
<li>The appropriate table is updated. In this case countries et al.</li>
<li>An update to the repository database field effective_date is added.</li>
<li>A <i>diff</i> type of entry into the reference repository history. <font color = "red"><i>This is not in the current data model</i></font>
<li>A <i>diff</i> type of entry into the reference repository history. <font color = "red"><i>This is not in the current data model</i></font></li>
<li>Then any sub-programs using this data will note the change of effective date and be able to handle the change as needed (i.e. simply read the new table).</li>
<li>Historical data will be available using this <i>diff</i> for those applications that need to use the old data</li>
</ul>
Note also that it is possible to have overlapping effective dates.
<p>Note also that it is possible to have overlapping effective dates.
This will not be implemented in the first version, but should be recognized and accomodated throughout the development
process for the service package.
<h3> VIII. Revision History</h3>
</p>
<h3> VIII. Pre-CVS Revision History</h3>
<pre>
$Log$
Revision 1.3 2006/08/06 20:40:20 torbenb
upgrading html, closing li p tags, adding quotes to tag attributes
Revision 1.2 2006/08/06 18:41:43 torbenb
removed c-Ms, added p tags, added a comment to unimplemented requirements / feature request
Revision 1.1 2001/04/22 00:53:12 jong
initial openacs import
......@@ -123,10 +141,7 @@ reorganized content, edited for clarity
Revision 1.2 2000/12/08 02:41:31 ron
initial version
</pre>
</body>
</html>
</body></html>
......@@ -16,7 +16,7 @@ ad_page_contract {
set title "Reference Data"
set package_id [ad_conn package_id]
set context_bar [list $title]
set user_id [ad_verify_and_get_user_id]
set user_id [ad_conn user_id]
set admin_p [ad_permission_p $package_id admin]
......
......@@ -17,7 +17,7 @@ set package_id [ad_conn package_id]
set title "List Reference Data"
set context_bar [list "$title"]
set user_id [ad_verify_and_get_user_id]
set user_id [ad_conn user_id]
db_multirow data data_select {
}
......
......@@ -17,7 +17,7 @@ ad_page_contract {
set package_id [ad_conn package_id]
set title "View one Table Structure"
set context_bar [list "$title"]
set user_id [ad_verify_and_get_user_id]
set user_id [ad_conn user_id]
ad_return_template
\ No newline at end of file
......@@ -17,7 +17,7 @@ ad_page_contract {
set package_id [ad_conn package_id]
set title "View one Table"
set context_bar [list [list "reference-list" "Reference List" ] "$title"]
set user_id [ad_verify_and_get_user_id]
set user_id [ad_conn user_id]
db_1row get_table { *SQL* } -column_array table_info
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment