Index: openacs-4/packages/ams/www/doc/index.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/ams/www/doc/index.html,v diff -u --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ openacs-4/packages/ams/www/doc/index.html 21 Oct 2004 01:56:36 -0000 1.1 @@ -0,0 +1,62 @@ + + +AMS (Attribute Management System) + + + +

AMS (Attribute Management System)

+

First define the elements via tcl - this could be in a package init proc:

+
+ams::define_list list_name "pretty list name" package_key object_type { attributes }
+
+

For example

+
+ams::define_list contact_person_ae "The Fields used to Add/Edit a Contact Person" contacts ct_contact {
+        {first_names textbox {First Name(s)} {First Names} required}
+        {middle_names textbox {Middle Name(s)} {Middle Names}}
+        {last_name textbox {Last Name} {Last Names} required}
+        {email email {Email Address} {Email Addresses}}
+        {url url {Website} {Websites}}
+        {home_address address {Home Address} {Home Addresses}}
+        {organization_address address {Organization Address} {Organization Addresses}}
+    }
+
+

Then on a object-ae page you simply call:

+
+ad_form -name form_name -form [ams::ad_form::elements package_key list_name]
+
+

and in the ad_form -edit_request block put

+
+ams::object::attribute::values -names -varenv $object_id
+
+

(this returns the variables upvared, i.e. first_names could be returned with a value of "Matthew"... etc.

+ +

in the -on_submit block you put in:

+
+ams::ad_form::save -name form_name package_key list_name object_id
+
+

This is how you interface with AMS... then to display attributes you can call ams::object::attribute::values to get the results back as upvared variables, as an array or as a list however you want. So, if on the contact index package you do, for example +

+
+db_multirow -extend { first_names last_name email home_phone } get_contacts { select ct_contact_id from ct_contacts order by names } {
+#      set first_names [ams::object::attribute::value object_id object_type attribute_name]
+    set first_names [ams::object::attribute::value $ct_contact_id ct_contact first_names]
+}
+
+

That's it, you can also get upvared values like this

+
+db_multirow -extend { first_names last_name email home_phone } get_contacts { select ct_contact_id from ct_contacts order by names } {
+    ams::object::attributes::values -names -varenv $object_id { first_names last_name email home_phone }
+}
+
+

+Anyways, that's how it integrates with other packages. I've made it pretty efficient and i think the integration is pretty straight forward. If you have any questions please feel free to ask. AMS takes care of ALL content repository stuff, so what AMS does is effectively make it easy to make ANY package use the content repository without a steep learning curve. I am continuing to develop AMS since it fits our institutional priorities right now, and i don't think contacts will be too much work once ams is working correctly. I am currently working on an ETP revision that uses AMS as the attribute store for all page attributes... this way pretty much all data on a system can be housed in AMS, and other package are then in charge of relational issues. I want to work on contacts, and hope to get to it as soon as this other stuff is done. My boss went on a 2 month study leave, so once this is done i'm completely in charge of my time. +

+ +