Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

COSMOS Design 214145

Revision as of 16:12, 29 January 2008 by Sleeloy.ca.ibm.com (Talk | contribs) (View Table Mockup)

Back to Data Reporting Design

Change History

Name: Date: Revised Sections:
Sheldon Lee-Loy 01/07/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 2
Test 0.5
Documentation 0.5
Build and infrastructure 0.2
Code review, etc.*
TOTAL 3.4

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

Purpose

A simple generic graph response view is needed catered towards users that are not familiar with CMDBf schemas. This will allow end users to understand and analyze the data easier instead of trying to navigate an XML structure. This view will be used as a default view for the COSMOS UI. This view should be able to render the contents of any graph response in a generic way. There should be extension points to customize the specific contents of the graph response.

Requirement

A table is a likely generic view since users at a glance can determine the number of records in the graph response. A table can scale the cmdbf query response better than a tree since the graph response will most likely be root level heavy (i.e. the tree will contain a large number of root notes rather than many leaf nodes).

As a stretch goal a tool bar should be provided that provides filtering and searching capability. Searching capability may be complicated. Filtering capability can be the definition of a cmdbf query.

Design

Let us first consider the pseudo schema of the CMDBf graph response.

<queryResult>
   <nodes templateId="xs:ID">
      <item>
        <record>
        xs:any
           <recordMetadata>
              <recordId>...</recordId>
              <lastModified>...</lastModified> ?
              <baselineId>...</baselineId> ?
              <snapshotId>...</snapshotId> ?
              xs:any
           </recordMetadata>
        </record> *
         <instanceId>
            <mdrId>xs:anyURI</mdrId>
            <localId>xs:anyURI</localId>
         </instanceId> +
         <additionalRecordType namespace="xs:anyURI" localName="xs:NCName"/> *
      </item> +
    </nodes> *
    <edges templateId="xs:ID">
       <relationship>
          <source>
             <mdrId>xs:anyURI</mdrId>
             <localId>xs:anyURI</localId>
          </source>
          <target>
             <mdrId>xs:anyURI</mdrId>
             <localId>xs:anyURI</localId>
          </target>
          <record>
             xs:any
             <recordMetadata>
                <recordId>...</recordId>
                <lastModified>...</lastModified> ?
                <baselineId>...</baselineId> ?
                <snapshotId>...</snapshotId> ?
             </recordMetadata>
          </record> *
          <instanceId>
             <mdrId>xs:anyURI</mdrId>
             <localId>xs:anyURI</localId>
          </instanceId> +
          <additionalRecordType namespace="xs:anyURI" localName="xs:NCName"/> *
       </relationship> +
    </edges> *
</queryResult>

As stated in the CMDBf 1.0 specification document the graph response is made up of <nodes> and <edges> elements. Each of these elements have an associated 'templateId' attribute that corresponds to the 'templateId' attribute used to construct the CMDBf query.

Creating a tab layout will improve the visualization of the node and edge elements. A tab can be constructed for each node or element. The title of the tab will correspond to the templateId. This will logically separate the edge and node contents. Color coding or icons can be used to distinguish between a node or edge.

Each tab will contain a table that will show the contents of the node or edge.

View Table Mockup

The table view will show item and record information. Note that the node and edges are shown as the top level tabs. The following mockup follows the sample graph response outlined under the "4.3.2 GraphQuery Response" under the CMDBf 1.0 specification document. Note that the mockup uses a sketching tool used for SWT widgets. This tool was used to create mockups easily. The final widget should utilize dojo widgets. As a result buttons were used to represent the tab buttons.

214145ItemTab.jpg

The following user interactions are possible:

  • When the user selects a row in the item table the record table and additional record type table are populated. As a result the last tables show the associated records and additional record types.
  • The second table that lists the records contains expansion rows that the user can expand or collapse. When the row is expanded the content of the record is shown.

Widget Design

The CMDBf graph response widget is constructed from several simple widgets. The following shows the hierarchy of widgets:

  • Tab Widget - responsible for rendering the top level tabs
    • Item Widget - responsible for rendering the item table lists in the details view
    • Relationship Widget - responsible for rendering the relationship table lists in the details view
  • Record Widget - responsible for rendering the record table

For each of the above table a data feed is required to get the header information for the tabs and table. Additional data feeds are required to get the table row content.

Open Issues/Questions

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

Update Mockup

The following is a running mockup of the graph viewer based on feedback. Note that the mockup is not the final version. It is used as a way to communicate ideas. graph viewer mockup

Back to the top