COSMOS Design 214672

Back to Data Reporting Design

Change History

Name:	Date:	Revised Sections:
Sheldon Lee-Loy	01/24/2008	Initial version

Workload Estimation

Rough workload estimate in person weeks

Process	Sizing	Names of people doing the work
Design	0.2	Sheldon Lee-Loy
Code	3
Test	0.5
Documentation	0.5
Build and infrastructure	0.2
Code review, etc.*
TOTAL	4.4

'* - includes other committer work (e.g. check-in, contribution tracking)

Requirement

This enhancement is required to be able to register a set of Configuration Items belonging to an MDR with a federating CMDB. Two different modes should be provided:

1. All-inclusive registration - The user will be able to select an action from the context menu of a federating CMDB to register all CIs of MDRs.
2. Partial registration - The user will be able to register only a set of configuration items contained by an MDR.

This enhancement also covers the deregistration of Configuration Items on a federating CMDB. Again there will be two different modes:

1. All-inclusive deregistration - The user will be able to select an action from the context menu of a federating CMDB to deregister all CIs of MDRs.
2. Partial deregistration - The user will be able to deregister only a set of configuration items contained by an MDR.

Design

All-inclusive registration

The following steps indicates how the user will interact with the COSMOS ui to register all configuration items with a set of MDRs.

1. User right clicks a federating CMDB from the left panel > selects "Register Configuration Items"

This involves a new menu item . A new tag should be associated with a federating CMDB. A menu configuration option would be added to the this new tag.

2. A dialog appears with all the registered MDRs

This involves creating the following:

1. A query object that instantiates a dialog widget
2. A dialog widget that shows a selection list of MDRs. The user will select the MDRs he/she wishes to register and then click submit.
3. An outputter is needed to get the list of MDRs. The outputter should return a JSON object that returns the resid and epr

3. User selects one or more MDRs and clicks register

The user makes this selection via the dual list. The following components are needed for this step:

1. An outputter that receives a list of mdrs and generates status information. This outputter will interface with the data collection component to send the request to the federating CMDB.
2. This will make use of services provided by 217515.

4. A view opens to display the status of the registration request. The view will indicate the items/relationships that have been accepted or rejected.

The following components are needed.

1. A dialog box will prompt the user indicating some form of progress.
2. Once a response is received the progress indicator will disappear and a view showing the success or failure of the registration. A widget that will visualized the status information. The structure of the status information is as follows:

<registerResponse>
	<instanceResponse>
		<instanceId>cmdbf:MdrScopedIdType</instanceId>
		<accepted>
			<alternateInstanceId>
			cmdbf:MdrScopedIdType
			</alternateInstanceId> *
		</accepted> ?
		<declined>
			<reason>xs:string</reason> *
		</declined> ?
	<instanceResponse> *
</registerResponse>

The following shows the visualization of the response. The visualization is composed of a table that shows whether the configuration item was accepted or rejected. The user can select a particular row and a detail list will show a list of alternateInstanceId if the item was accepted or a reason list if the item was declined.

Partial registration

1. User performs a CMDBf query on an MDR

This support is already provided by the COSMOS UI

2. The items will be displayed in the tabular view

This support is implemented as part of the following enhancement: https://bugs.eclipse.org/bugs/show_bug.cgi?id=214145

3. User will be able to select a subset of the items/relationships and right click to open a menu bar to register the selection with the federating CMDB.

The following are needed

1. A menu option is required that will provide a 'register items' option. The menu bar will show a sub menu that will provide a list of federating cmdb that the selected items can be registered against. This is highlighted in the mockup below.

Once the user selects the particular cmdb a request is sent to the outputter with the list of items. At this point a dialog box will prompt the user indicating some form of progress. Once a response is received the progress indicator will disappear and a view showing the success or failure of the registration. This view is explained in the previous section.

All-inclusive Deregistration

The steps of deregistering configuration items will somewhat mirror the steps to register configuration items. This will make the UI consistent. The user will be able to select an action from the context menu of a federating CMDB to deregister all CIs of MDRs

1. User right clicks on a federating CMDB and selects "Deregister Configuration Items"

This involves a new menu item . A new tag should be associated with a federating CMDB. A menu configuration option would be added to the this new tag.

2. The same dialog used for registration will appear with a selection list of MDRs

5. A dialog will appear displaying the status of the deregistration process

1. A response view will show if the deregristration option failed or succeeded. This view will be similar to the view outlined in the previous section.

Partial deregistration

The user will be able to deregister only a set of configuration items contained by an MDR.

1. User performs a CMDBf query on the federating CMDB

A query is needed to get all configuration items associated with a particular MDR. Should this bring up an additional menu option to execute this query instead of allowing the user to create the CMDBf query.

2. In the tabular view displaying the result of the query, the user will be able to select a set of items > right click > and select deregister.

3. The items are deregistered and the status is displayed to the user

Open Issues/Questions

All reviewer feedback should go in the Talk page for 214672.