Difference between revisions of "ESciDoc Admin"
Jump to navigation
Jump to search
| Line 1: | Line 1: | ||
== Overview == | |||
''eSciDoc admin'' is a a solution for the management of master data in an installation of the eSciDoc framework. Currently it is implemented as TurboGears web application talking to the framework's REST interface. | ''eSciDoc admin'' is a a solution for the management of master data in an installation of the eSciDoc framework. Currently it is implemented as TurboGears web application talking to the framework's REST interface. | ||
| Line 5: | Line 7: | ||
*[[PubMan_Func_Spec_Collection_Administration]] | *[[PubMan_Func_Spec_Collection_Administration]] | ||
*[[PubMan_Func_Spec_User_Management]] | *[[PubMan_Func_Spec_User_Management]] | ||
Repository URL: https://subversion1.escidoc.mpg.de/admin/ | Repository URL: https://subversion1.escidoc.mpg.de/admin/ | ||
| Line 29: | Line 30: | ||
in a suitable directory. | in a suitable directory. | ||
== Technical Documentation == | |||
=== Overview === | |||
''eSciDoc admin'' manages framework resources of the following kinds: | |||
*Organizational Units, abbreviated ''ou'', | |||
*Contexts, abbreviated ''ctx'', | |||
*User Accounts (and Grants), subsumed under ''aa'' (for ''authentication and authorization''). | |||
== Architecture == | === Architecture === | ||
''eSciDoc admin'' - as a web interface to the framework's CRUD services for its resources - has a very simple architecture: | ''eSciDoc admin'' - as a web interface to the framework's CRUD services for its resources - has a very simple architecture: | ||
Revision as of 17:40, 27 May 2008
Overview[edit]
eSciDoc admin is a a solution for the management of master data in an installation of the eSciDoc framework. Currently it is implemented as TurboGears web application talking to the framework's REST interface.
It implements (parts of) the use cases specified in
- PubMan_Func_Spec_Organizational_Unit_Management
- PubMan_Func_Spec_Collection_Administration
- PubMan_Func_Spec_User_Management
Repository URL: https://subversion1.escidoc.mpg.de/admin/
Installation/Deployment[edit]
Requirements[edit]
- Python (>= 2.4),
- TurboGears (see http://docs.turbogears.org/1.0/Install for details),
- SQLAlchemy (install with easy_install),
- it may be necessary to upgrade to a newer version of pysqlite,
- httplib2
Installation[edit]
To run escidocadmin from a repository checkout, run
svn co https://subversion1.escidoc.mpg.de/admin/trunk/escidocadmin
in a suitable directory.
Technical Documentation[edit]
Overview[edit]
eSciDoc admin manages framework resources of the following kinds:
- Organizational Units, abbreviated ou,
- Contexts, abbreviated ctx,
- User Accounts (and Grants), subsumed under aa (for authentication and authorization).
Architecture[edit]
eSciDoc admin - as a web interface to the framework's CRUD services for its resources - has a very simple architecture:
- All communication with the framework is implemented in a framework client library
- As a !TurboGears aplication, escidocadmin subscribes to the MVC pattern, or better the VC pattern, because the persistence layer is implemented by the framework.
- The management logic for each resource is implemented in one controller class.
- The views for each resource are implemented in one (or several) templates.