[#SAK-7556] Clear documentation for the creation of report templates

Sakai

Clear documentation for the creation of report templates

Created: 07-Jan-2007 19:25 Updated: 23-Oct-2008 10:49

Component/s:

Reports

Affects Version/s:

2.4.0, 2.4.1

Fix Version/s:

None

Time Tracking:

Not Specified

2.6.x Status:	None
2.5.x Status:	None
2.4.x Status:	None

Description

« Hide

OSP-24-RPT-02 -
http://bugs.sakaiproject.org/confluence/display/OSP/OSP-24-REQ-RPT

DBA/XML/XSLT developers need clear documentation for the development of reports based on user requests.
* Use cases to determine report parameters, fields, and layouts and allow developers to easily create report templates
* Information on how to specify which roles can run reports on all sites or only sites in which they have membership.

Documentation requirements for the OSP Report tool.

The documentation for the OSP 2.4 report tool will provide step by step instructions for 3 audiences:
# End users (Program Coordinators, faculty, deans, system administrators) that may want to request and view reports
## This section will inform end users about what the report tool is capable of doing, its limitations and strengths and how it fits in with other OSP/Sakai tools.
## This section will help a non-technical user to be able to be able to articulate their needs to a Report Developer, including:
### what data they want to include in the report
### the display format for the data
### how often the report should be run and by whom
### access, dissemination and publication requirements for the report results
# Report developers (XML developers and/or DBA's)
## This section will document:
### Some ethics and privacy concerns to be considered
### Steps and files needed for a "Hello World" report, including:
#### Reports configuration and definition files (or whatever they are going to be in 2.4)
#### Report results files
#### XSL files for the desired format
#### Implementation
# System Administrators and IT managers
## This section will contain:
### Some ethics and privacy concerns to be considered
### Time estimates and staffing suggestions for tool use

All

Comments

Work Log

Change History

Subversion Commits

git Commits

Sort Order:

[ Permlink | « Hide ]

Peter A. Knoop added a comment - 12-Mar-2007 10:24

This issue is currently scheduled to be addressed for the 2.4 release. There are only 3 days left until code freeze. If know already that this issue will not be addressed for 2.4, please updated the Fix Version with a new estimate of when it will be addressed. Thanks.

[ Permlink | « Hide ]

Peter A. Knoop added a comment - 24-Mar-2007 14:55

[Bulk Comment] This issue is currenlty classified as a Task scheduled to be addressed for 2.4, however, we are now past the Sakai 2.4 Code Freeze. At this time, work should be focused only on resolving Bugs and addressing release-related Tasks; no features should be added or modified at this point without notifying the Release Mangement team. Please update the estimated Fix Version of this issue to reflect more accurately when it will get addressed, such as in the next release, 2.5.0.000 [Tentative], or set it to Unknown. Thanks.

[ Permlink | « Hide ]

Peter A. Knoop added a comment - 15-May-2007 09:30

This issue still had an estimated Fix Version which indicates it will be addressed for the 2.4.0 release; however, the issue is not flagged as a Blocker, therefore, the issue will not be included in the release and its Fix Version is being reset to "Unknown". If you have an updated esitmate of when this issue will likely be addressed, such as 2.5.0 [Tentative], please update the Fix Version accordingly.