Customer Requirements Document

ProductDashboard

Description:

This application provides a configurable Web Page that serves as a Home Page for a targeted set of users. The identified candidates for whom we will target templates include:
- DB Administrator
- Process Coordinator
- Supervisor
- Project Manager
- Approver
- Author
- Executive
The dashboard is composed of component types, referred to as panels, which are targeted at three user roles - Report, User and Admin. The panels are forms of the dashboard that are specialized for a particular applications.
Within each panel type will be a configurable set of components, referred to as instruments, that will incorporate functionality to support the panel's application.
The first release of the ProductDashboard will provide a base capability for each of the targeted roles.

1.0 Class Admin Instrument

Description:

This instrument allows the administrator to add and modify ProductCenter class definitions. This will include some standard ProductCenter class administration functions as well as some functions that enhance current limitations.

Number	Short Desc	Type	Modified On	Priority	Status
RQ#10264	Register reports from class admin	Functional	MAR-31-2003
RQ#10264	The administrator must be able to identify the set of reports that apply to a specific class when modifying or creating a class. When editing the class properties, a reports option would allow the administrator to select from a list of item specific reports to assign to the current class.
RQ#10263	Create class in dashboard	Functional	MAR-31-2003
RQ#10263	The administrator msut be able to create a new class from within the dashboard. In creating the new class the administrator can set the following parameters: - Name - Parent Class - Derived Form - Default User and Group permissions - Head and Tail link types
RQ#10145	Include rename class component in dashboard	Functional	MAR-31-2003	P2	Proposed
RQ#10145	The administrator must be able to renamea class from within the class admin instrument. This function would allow the user to select a class and rename it. All references to that class in the ProductCenter database will be updated appropriately.
RQ#10270	Allow non-dba users to include admin instruments	Functional	MAR-31-2003	P2	Proposed
RQ#10270	A non-dba user must be able to include admin instruments into their dashboards. This would require that the dashboard be able to switch user context to a dba-enabled user when the user was accessing these specific instruments.
RQ#10146	Reset class permissions from dashboard	Functional	MAR-31-2003	P2	Proposed
RQ#10146	The administrator must be able to update item permissions within a class from the class admin instrument. This function will allow the administrator to select a class and update the permissions for all items in that class to be set to the current class permissions. 1. It would also be nice to be able to extend the existing item permissions in a class to include one or more additional permissions.

2.0 Data Monitor Instrument

Description:

This instrument allows the user to include a defined set of queries against the database, each which return a count to indicate its status.

Number	Short Desc	Type	Modified On	Priority	Status
RQ#10149	Refresh data analysis table in dashboard	Functional	MAR-19-2003	P1	Proposed
RQ#10149	The administrator must be able to refresh the counts of all entries in the data analysis table either by refresshin the whole table or by refreshing each entry individually. The refresh will execute the query associated to the entry and display the updated information in the table.
RQ#10272	Default queries for data monitor	Functional	MAR-31-2003	P1	Proposed
RQ#10272	The data monitor instrument must come installed with the following queries (each of which return a count): - all records in the accounting table - all attributes that do not have associated items - all permissions that do not have associated items - all links that do not have items at both ends
RQ#10150	Configure data monitor instrument	Functional	MAR-31-2003	P1	Proposed
RQ#10150	The administrator must be able to define the entries in the data monitor instrument when personalizing the dashboard. Each entry will be defined by its name, description and queury string. When presented in the dashboard, each entry will display its name, description and the results from the query string.

3.0 Batch Update Instrument

Description:

This instrument allows a user to update multiple items in a single large transaction.

4.0 Group Admin Instrument

Description:

This instrument allows the administrator to add and modify groups.

Number	Short Desc	Type	Modified On	Priority	Status
RQ#10266	Set class permissions by group	Functional	MAR-31-2003	P3	Proposed
RQ#10266	The administrator must be able to set the group permissions for each of the classes from within the group admin instrument when adding or modifying a group. The administratror would be presented with a list fo classes from which he/she could specify the group permissions specifically for each selected class.
RQ#10265	Add and modify groups from dashboard	Functional	MAR-31-2003	P2	Proposed
RQ#10265	The administrator must be able to add or modify group definitions from within the dashboard. The following properties will be editable. - Group Name - Description - Member users
RQ#10270	Allow non-dba users to include admin instruments	Functional	MAR-31-2003	P2	Proposed
RQ#10270	A non-dba user must be able to include admin instruments into their dashboards. This would require that the dashboard be able to switch user context to a dba-enabled user when the user was accessing these specific instruments.

5.0 User Profile Instrument

Description:

This instrument is a component of the ProductDashboard that can be incorporated into a panel so that a user can reference and/or update their current set of preferences.

Number	Short Desc	Type	Modified On	Priority	Status
RQ#10221	Name Instrument	Functional	MAR-27-2003	P1	Planned
RQ#10221	The user must be able to specify the name of any instrument when creating or modifying that instrument.
RQ#10210	Change password from user profile	Functional	MAR-26-2003	P2	Proposed
RQ#10210	The user must be able to change his/her password from within the User Profile instrument.
RQ#10209	Update preferences from User Profile	Functional	MAR-26-2003	P3	Proposed
RQ#10209	The user must be provided a mechanism to change their user preferences from within the user profile. The implementation should be equivalent to the same feature in the current version of the WebClient.
RQ#10208	Identify user attributes to display in profile	Functional	MAR-26-2003	P2	Proposed
RQ#10208	The user must be able to define which set of user attributes to display in the User Profile instrument. The candidate list will include all the attributes that are available in the WebClient user preference dialog.

6.0 License Manager

Description:

The license manager is responsible for accounting for the use of any licensed NorthRidge Software application or product. The user accounting is modeled on a named-user method, which only cares about how many users ever use the application versus how many use it at any particular point in time.

7.0 Consumer Panel

Description:

Number	Short Desc	Type	Modified On	Priority	Status
RQ#10154	Insert Report as Link	Functional	MAR-20-2003
RQ#10154	The administrator must be able to insert a report as a hyperlink into any environment. The URL must have enough information to launch the report or spawn the intermediate attribute window from which the user can modify the criteria.

8.0 Admin Panel

Description:

The AdminDashboard is a template of the ProductDashboard specialized for the ProductCenter database administrator. The components of the dashboard include the following types.
- Database Modeling tools
- User and Group Management tools
- Database Monitoring tools
- Database Repair tools
- Licensing tools
- Syatem Admin tools

Number	Short Desc	Type	Modified On	Priority	Status
RQ#10151	Include database component in dashboard	Functional	MAR-19-2003
RQ#10151	The administrator must be able to include a database profiling component when personalizing the dashboard. The database profiling component will display the following infomation: - SID - Host server - tablespace data - space used - available space - filename - rollback segment data - list of indexes
RQ#10140	Include vault monitor in dashboard	Functional	MAR-18-2003
RQ#10140	The administrator must be able to include a view of all the vaults in a ProductCenter installation. This includes both vault servers and replication servers. The following information will be included about each vault: - Type - Name - Host Server - Port # - Status - Used Space - Available Space
RQ#10147	Include data monitor in dashboard	Functional	MAR-31-2003	P1	Proposed
RQ#10147	The administrator must be able to add a data monitor instrument when personalizing the dashboard. The data monitor instrument will include a set of queries that will identify numbers of records that match a specific criteria. For the most part, the queries will find occurrances of unwanted data.
RQ#10152	Include call tracking component in dashboard	Functional	MAR-19-2003	P2	Proposed
RQ#10152	The administrator must be able to include a call tracking component in the dashboard. The call tracking component will reference a NorthRidge Software generated XML of their call information and apply one or more style sheets to get the appropriate report. The default stylesheet will be a list of calls grouped by status and sorted by priorty.
RQ#10144	Include move items component in dashboard`	Functional	MAR-18-2003	P3	Proposed
RQ#10144	The administrator must be able to include a component that will move items from one class to another when personalizing the dashboard. This function will allow the administrator to find one or more items and modify the class to which it belongs.
RQ#10202	Create report list	Functional	MAR-26-2003	P2	Proposed
RQ#10202	The user must be able to create a report list instrument and include it in the panel. A report list is simply a named set of reports that can be launched from within a panel.
RQ#10143	Include current license usage in dashboard	Functional	MAR-18-2003	P2	Proposed
RQ#10143	The administrator must be able to include a component that lists the currently logged in users when personalizing the dashboard. 1. Is this information available from flexLM?
RQ#10203	Create bookmark list	Functional	MAR-26-2003	P2	Proposed
RQ#10203	The user must be able to create a bookmark list instrument and include it in the panel. A bookmark list is simply a named set of http links that can be launched from within a panel.
RQ#10158	Include tool to identify permissions for non-existant users/groups	Functional	MAR-20-2003	P2	Proposed
RQ#10158	The administrator must be able to include a tool that identifies all permissions that belong to a user or group that is no longer registered in the database when personalizing the dashboard. This tool will return a count of all permissions that meet this criteria.
RQ#10142	Include purge in progress in dashboard	Functional	MAR-18-2003	P2	Proposed
RQ#10142	The administrator must be able to include a purge in progress versions component when personalizing the dashboard. This function will allow the administrator to search the database for one or more items and then to purge all versions that fall between released versions of the item. 1. Should we provide an archive mode that merely moves the items to a separate table?
RQ#10204	Create user profile	Functional	MAR-26-2003	P3	Proposed
RQ#10204	The user must be able to create a user profile instrument and include it in the panel. A user profile is simply a display of a user specified set of ProductCenter user attributes..
RQ#10141	Purge latest version from dashboard	Functional	MAR-18-2003	P2	Proposed
RQ#10141	The administrator must be able to include a component in the dashboard that selectively purges the latest version of an item. This function would allow the administrator to search for one or more items and then purge the latest version. 1. Can this function be extended to purge back to the last release?

9.0 Database Server Instrument

Description:

This instrument is intended to provide the administrator with a view of the currents settings of the ProductCenter database as well as a running status.

Number	Short Desc	Type	Modified On	Priority	Status
RQ#10314	List database indexes in dashboard	Functional	APR-11-2003	P2	Specified
RQ#10314	The administrator must be able to include the current list of database indexes when personalizing the dashboard. The list will include all indexes currently active against any ProductCenter table and will include the following properties: - Index Name - Owner - Table
RQ#10316	List database rollback segments in dashboard	Functional	APR-11-2003	P2	Specified
RQ#10316	The administrator must be able to include the current list of database rollback segments when personalizing the dashboard. The list will include all rollback segments currently in use by ProductCenter and will include the following properties: - Rolback Segment Name - Tablespace to which it belongs - Extents (number) - Status (on or off line)
RQ#10315	List database tablespaces in dashboard	Functional	APR-11-2003	P2	Specified
RQ#10315	The administrator must be able to include the current list of database tablespaces when personalizing the dashboard. The list will include all tablespaces currently in use by ProductCenter and will include the following properties: - Tablespace Name - Size in megabytes - Space used in megabytes - Filename - full path to data file for the tablespace.
RQ#10313	Display database information	Functional	APR-11-2003	P2	Specified
RQ#10313	The administrator must be able to identify if he/she would like to have ProductCenter database information displayed in the dashboard. The base instrument would display the values for the following db instance properties. - Host Name - DB Name - DB Version - Instance Name - Instance Start Time

10.0 Document Server Instrument

Description:

This instrument is intended to provide the administrator with all the information required to assess the status of all vaults and replication servers attached to the ProductCenter instance.

Number	Short Desc	Type	Modified On	Priority	Status
RQ#10306	Create new docserver	Functional	APR-10-2003	P3	Proposed
RQ#10306	The administrator must be able to create a new doc server from within the document server instrument.
RQ#10312	File extract from vault server	Functional	APR-10-2003	P2	Proposed
RQ#10312	The administrator must be able to include a file extraction function when personalizing the document server instrument. When using this function from the dashboard, the administrator will be required to identify the class and filename before receiving the results.
RQ#10311	File lookup in vault server	Functional	APR-10-2003	P3	Proposed
RQ#10311	The administrator must be able to include a file lookup function when personalizing the document server instrument. When using this function from the dashboard, the administrator will be required to identify the class and filename before receiving the results.
RQ#10304	Start and stop doc servers	Functional	APR-10-2003	P2	Proposed
RQ#10304	The administrator must be able to start and stop doc servers from the document server instrument.
RQ#10305	Display rules for doc servers	Functional	APR-10-2003	P2	Proposed
RQ#10305	The administrator must be able to view the vault rules and/or replication rules for a selected doc server from within the document server instrument.
RQ#10307	Display vault filters	Functional	APR-10-2003	P3	Proposed
RQ#10307	The administrator must be able to display the vault filter information for a selected vault server within the document server instrument. The inclusion of this component in the instrument must be configurable by the administrator.
RQ#10310	Run vault push	Functional	APR-10-2003	P3	Proposed
RQ#10310	The administrator must be able to include the vault push function when personalizing the document server instrument. This would work the same as the command line function.
RQ#10300	List Vault and Replication Servers	Functional	APR-10-2003	P1	Specified
RQ#10300	The administrator must be able to identify if he/she would like to have vault and/or replication servers displayed in the dashboard. The selection of either would present all servers related to the current ProductCenter instance in a table, one table for each type. The default column for both types are: - Name - Status - Host - Available Space
RQ#10303	Show storage details for doc server	Functional	APR-10-2003	P1	Specified
RQ#10303	The administrator must be able to request details about the storage statistics for a doc server. The following statistics would be displayed. - Total Space - Space Used - Space Available
RQ#10309	Run vault synchronization	Functional	APR-10-2003	P2	Specified
RQ#10309	The administrator must be able to include a vault synchronization function when personalizing the document server instrument. The function would behave the same as it does from within the core ProductCenter admin client.
RQ#10308	Display doc server resource entries	Functional	APR-10-2003	P1	Specified
RQ#10308	The administartor must be able to personalize the document server by including doc server resource variables in the display. All resource variables that affect the behavior of the vault or replication servers will be displayed. This display is not sensitive to the seletion of a doc server.
RQ#10301	Customize doc server table columns	Functional	APR-10-2003	P2	Specified
RQ#10301	The administrator must be able to personalize the doc server columns to include and position the attributes as they need. The customization level will be by doc server type - vault or replication.
RQ#10302	Show details of doc servers	Functional	APR-10-2003	P1	Specified
RQ#10302	The administrator must be able to request detailed information for a doc server. The output of the request will be the same as for vlt_admin -status.

11.0 Base Dashboard

Description:

Number	Short Desc	Type	Modified On	Priority	Status
RQ#10271	Site control of available components	Functional	MAR-31-2003
RQ#10271	The site administrator must be able to define which panels and/or instruments are available from within their site. The dashboard would then only allow users to include the panels and or instruments that the site administrator had authorized.
RQ#10966	Support electronic signature settings	Functional	JUL-31-2003
RQ#10966	The user must be prompted for an electronic signoff for every transaction that is designated in the resource file as requiring electronic signature.
RQ#10965	Referesh setting for instruments	Functional	JUL-31-2003
RQ#10965	The user must be able to set a specific refresh rate for each instrument created. This value will take precedence over the setting for the panel in which it resides.
RQ#10137	Save dashboard as template	Functional	MAR-18-2003
RQ#10137	The user must be able to save a configured dashboard as a template. Saving it as a template will store the components and layout but will remove the user context. Once saved, this template will be available to others for use as a template.
RQ#10124	User login for dashboard	Functional	MAR-18-2003
RQ#10124	The user must be forced to log in the first time that he/she accesses the dashboard in the current browser session. The user will ne able to return to the dashboard without logging in for the full duration of that browser session.
RQ#10963	Support BOM in item form	Functional	JUL-31-2003		Submitted
RQ#10963	The application must bring up part item forms in BOM mode when BOM is enabled for the site. Once in this mode, the form must behave identically to the WebClient with BOM enabled.
RQ#10964	Referesh setting for panels	Functional	JUL-31-2003		Submitted
RQ#10964	The user must be able to set a specific refresh rate for each panel created. This value will take precedence over the setting for the dashboard.

12.0 Function List Instrument

Description:

This instrument is a component of the ProductDashboard that can be incorporated into a panel so that a user can launch a specified set of ProductCenter user functions.

Number	Short Desc	Type	Modified On	Priority	Status
RQ#10236	Launch WebClient from function list	Functional	MAR-27-2003	P2	Specified
RQ#10236	The user must be able to add a function to launch the ProductCenter WebClient when personalizing the user function list instrument. The user will not be required to log in again, nor will they acquire a second ProductCenter license.

13.0 Report List Instrument

Description:

This instrument is a component of the ProductDashboard that can be incorporated into a panel so that a user can launch a specified set of reports.

Number	Short Desc	Type	Modified On	Priority	Status
RQ#10219	Include non-ProductCenter reports inreport list	Functional	MAR-27-2003	P2	Planned
RQ#10219	The user must be able to include reports inthe report list instrument that are not derived directly from ProductCenter. This would include all reports that could not effectively be defined and executed in ProductCenter, but would be valuable to the end user. 1. A mechanism must be created whereby these non-PCtr reports can be injected into an environment and subsequently be registered with the instrument and run from the dashboard.

14.0 Query Report Instrument

Description:

This instrument is a component of the ProductDashboard that can be incorporated into a panel so that a user can register a by query report.The user will then have the choice as to whether to embed the query, the output or both.

Number	Short Desc	Type	Modified On	Priority	Status
RQ#10962	Case sensitivity switch	Functional	JUL-31-2003		Submitted
RQ#10962	The user must be able to toggle the query rules at run time between case sensitive and case insensitive searches.

15.0 Object Table Instrument

Description:

This instrument is a component of the ProductDashboard that can be incorporated into a panel so that a user can be presented a table of information from which item and/or process based operations can be executed.

Number	Short Desc	Type	Modified On	Priority	Status
RQ#10129	Combine process lists indashboard	Functional	MAR-18-2003
RQ#10129	The user must be able to combine both their worklist and claimabe process lists when personalizing their desktop. The combined list would need to include an attribute or icon identify if it is claimed or not.
RQ#10224	Add attributes to search & results	Functional	MAR-27-2003
RQ#10224	The user must be able to add attributes to the list of attributes included in a saved search when personalizing an Embedded Search & Results instrument. This should work the same way as it does in the WebClient. The addition of the attributes will only be effective while the current browser window is open.
RQ#11120	Add table type attribute to item table	Functional	SEP-19-2003
RQ#11120	The user must be able to add any column of a table type attribute to his/her item table defintion. This would be accomplished by selecting the derived form for the table type attribute in the table instrument editor and coosing the attribute to be displayed. The attributes will be displayed in the table with a line feed (break) between each row.
RQ#10993	Alter items from item tables	Functional	AUG-14-2003
RQ#10993	The user must be able to use the Alter Info function from all the item tables (Desktop, Item Table). The function should behave as it does in the Web Client.
RQ#10962	Case sensitivity switch	Functional	JUL-31-2003		Submitted
RQ#10962	The user must be able to toggle the query rules at run time between case sensitive and case insensitive searches.

16.0 User Admin Instrument

Description:

This instrument allows the administrator to add and modify user accounts as well as their membership in specified groups.

Number	Short Desc	Type	Modified On	Priority	Status
RQ#10270	Allow non-dba users to include admin instruments	Functional	MAR-31-2003	P2	Proposed
RQ#10270	A non-dba user must be able to include admin instruments into their dashboards. This would require that the dashboard be able to switch user context to a dba-enabled user when the user was accessing these specific instruments.
RQ#10268	Add and modify users from dashboard	Functional	MAR-31-2003	P1	Proposed
RQ#10268	The administrator must be able to add or modify user definitions from within the dashboard. All the properties that can be modified from within the ProductCenter User Admin function will be accessible.

17.0 ProductDashboard Administrator

Description:

This module is intended for the users that will be adding authors and consumesr to the ProductDashboard registry. In addition, this module will allow the user to manage all ProductDashboard adminstrative tasks.

Number	Short Desc	Type	Modified On	Priority	Status
RQ#11032	Control access to panels	Functional	AUG-21-2003
RQ#11032	The PDb administrator must be able to identify to which panels a registered user has access. Only the panels to which the user has access will appear in the candidate panel lists in the dashboard editor for that user.
RQ#11030	Control access to functions	Functional	AUG-21-2003
RQ#11030	The PDb administrator must be able to identify to which functions a registered user has access. Only the functions to which the user has access will appear in the candidate function lists in the instrument editors for that user.
RQ#11031	Control access to instruments	Functional	AUG-21-2003
RQ#11031	The PDb administrator must be able to identify to which instruments a registered user has access. Only the instrumentgs to which the user has access will appear in the candidate instrument lists in the panel editors for that user.

18.0 ProductDashboard Platform Support

Description:

This module identifies all new operating platforms to be supported in this release.

Number	Short Desc	Type	Modified On	Priority	Status
RQ#11152	Support Netscape browser	Technical	SEP-30-2003	P2	Proposed
RQ#11152	The application must run in the Netscape 6.2 browser.
RQ#11151	Support IIS	Technical	SEP-30-2003	P2	Proposed
RQ#11151	The application must be supported on the IIS web server 1. Need to identify the specific release

19.0 Application Adapters

Description:

Application Adapters provide a framework for integrating information from non-ProductCenter data sources into ProductDashboard. The framework must provide the administrator to register their applcation and create queries to extract and present the data.

Number	Short Desc	Type	Modified On	Priority	Status
RQ#11064	Register query for application adapter	Functional	SEP-02-2003
RQ#11064	The administrator must be able to specify a query that can be sent to a specific application adapter so that an instrument can receive an information stream to display. The query can be configured to either be embedded in the instrument for user modification or not embedded and run at instrument initialization.
RQ#11063	Register functions for application adapter	Functional	SEP-02-2003
RQ#11063	The administrator must be able to register functions for a specific application adapter. This would store all the necessary information for the PDb to execute the function and to recieve the response.
RQ#11062	Register attributes with adapter	Functional	SEP-02-2003
RQ#11062	The administrator must be able to register a set of attributes with a registered adapter. This would then provide the input for the attributes section for the table editors. All attributes registered for a particular adapter would be presented in the attributes candidates list of the editor.
RQ#11065	Register application adapter instrument	Functional	SEP-02-2003
RQ#11065	The administrator must be able to register an application adapter instrument with a specific panel type (consumer, author) so that it can be included by the user in the panel editor.
RQ#11060	Register application adapter	Functional	SEP-02-2003
RQ#11060	The administrator must be able to register an adapter to the ProductDashboard. This would provide the administrator a way to tell ProductDashboard how to send and receive information to and from the adapter.
RQ#11061	Display adapter data as table	Functional	SEP-02-2003
RQ#11061	The data that is retrieved from any adapter must be able to be displayed as a table instrument. The user must be able to define which attributes show up as columns and how those columns are displayed.

REPORT GENERATED ON