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

Difference between revisions of "COSMOS UG Web Component Library"

(→‎View)
 
(9 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
[[COSMOS|COSMOS Wiki]] > [[COSMOS_Documentation_Plan|COSMOS Document Plan]] > [[COSMOS_Manual_Guide |COSMOS Manual Guide]]
 
[[COSMOS|COSMOS Wiki]] > [[COSMOS_Documentation_Plan|COSMOS Document Plan]] > [[COSMOS_Manual_Guide |COSMOS Manual Guide]]
  
−
== COSMOS Widget Library ==
+
== COSMOS Component Library ==
 
    
 
    
 
Category: [http://wiki.eclipse.org/Category:COSMOS_Users_Guide User's Guide]
 
Category: [http://wiki.eclipse.org/Category:COSMOS_Users_Guide User's Guide]
Line 28: Line 28:
 
* View - components that visualizes information from a data manager
 
* View - components that visualizes information from a data manager
 
* Manage - components that manages a data manager
 
* Manage - components that manages a data manager
 +
* Utility - components that provide utility functions
  
 
==Navigate==
 
==Navigate==
Line 37: Line 38:
 
'''Purpose:''' This dialog provides a simple text input box to submit a CMDBf query document to a MDR.
 
'''Purpose:''' This dialog provides a simple text input box to submit a CMDBf query document to a MDR.
  
−
===CMDBf Query Builder Dialog===
+
===[[CMDBf Query Builder Dialog]]===
 
'''Purpose:''' This web based component provides a dialog box to construct a CMDBf query document and submit the constructed  document to a MDR.  Users familiar with the CMDBf query document structure can use this dialog box to construct a CMDBf query document instead of hand typing the document.  The query builder processes the service meta data from an MDR to determine what kind of query capabilities the user is allowed to specify.
 
'''Purpose:''' This web based component provides a dialog box to construct a CMDBf query document and submit the constructed  document to a MDR.  Users familiar with the CMDBf query document structure can use this dialog box to construct a CMDBf query document instead of hand typing the document.  The query builder processes the service meta data from an MDR to determine what kind of query capabilities the user is allowed to specify.
  
−
[[Image:cosmos_exambuilder.jpg]]
+
==View==
 +
===[[XML Viewer]]===
 +
'''Purpose:''' This view visualizes the structure of a XML document as a tree structure.
  
−
Application can configure the [navigator] component to show this dialog box by selecting the "Submit a Query" menu option.  Typically, the user would right-click the MDR he/she wants to submit a query to.  This would bring up a pop-up menu with an option to "Submit a Query".
+
===[[Frame Viewer]]===
 +
'''Purpose:''' This view provides a frame to embed html content.
  
−
The query builder is composed of three panes.  The top level pane manages the <itemTemplate> and <relationshipTemplate> nodes of a CMDBf query document.  Users can add and remove itemTemplate and relationshipTemplate nodes within this pane.  The top level nodes in the tree shows the list of itemTemplates defined in the query.  <relationshipTemplate> nodes are defined as children nodes of an <itemTemplate>.  Adding a <relationshipTemplate> underneath an <itemTemplate> node indicates that the parent node of the <relationshipTemplate> is the source template and the child node of the <relationshipTemplate> is the target template.  Consider the following screen capture.
+
===[[Properties Viewer]]===
 +
'''Purpose:''' This view displays name value pairs within a table.
  
−
[[Image:cosmos_buildertop.jpg]]
+
===[[CMDBf Graph Reponse Viewer]]===
 +
'''Purpose:''' This view visualize the structure of a CMDBf response document.
  
−
The above picture illustrates a query that has two <itemTemplate> nodes.  The first <itemTemplate> has an id set to "user" while the second <itemTemplate> has an id set to "computer".  The pane further shows that a <relationshipTemplate> is defined where the source template node is the "user" and the target template node is the "computer".  Furthremore, the name of the "relationsihpTemplate" is set to "usage".
+
===[[CMDBf Graph Reponse Tree Viewer]]===
 +
'''Purpose:''' This view visualize the structure of a CMDBf response document as a tree.
  
−
To add an <itemTemplate> the user can right click the "query" node in the top pane and select 'Add Item'.  A dialog box will prompt the user to enter the id of the <itemTemplate>.  To add a <relationshipTemplate> the user can right click an <itemTemplate> node and select 'Add Relationship'.  This will prompt the user with a dialog box that will allow the user to enter the id of the <relationshipTemplate> and the id of the target template.  Note that a drop down box is provided that lists existing 'itemTemplates'.  The user should note that if the MDR does not support queries that include <relationshipTemplate> nodes the user will not have the ability to add <relationshipTemplate> nodes.
 
−
 
−
The bottom left pane manages the structure of an <itemTemplate> or <relationshipTemplate> element that is selected in the top pane.  The user can add query capabilities to these elements.  The types of capabilities that the user can add is dictated by what is supported in the service meta data provided by the MDR.  The user can right click the top level node to add a particular query capability as shown below:
 
−
 
−
[[Image:cosmos_builderleft.jpg]]
 
−
 
−
The user can add or remove capabilities within this pane.  As the user adds capabilities under either an <itemTemplate> or <relationshipTemplate> they are building the XML structure of the <itemTemplate> or <relationshipTemplate> element.  Consider the following illustration.
 
−
 
−
[[Image:cosmos_leftrecordConstraint.jpg]]
 
−
 
−
The above tree structure would produce the following XML structure under the <itemTemplate> element.
 
−
 
−
<pre>
 
−
  <s:itemTemplate id="user" suppressFromResult="false" >
 
−
      <s:recordConstraint >
 
−
        <s:recordType namespace="" localName="" >
 
−
        </s:recordType>
 
−
      </s:recordConstraint>
 
−
</pre>
 
−
 
−
Once the user is done creating the query document they would click on the "Submit" button to send the document to the MDR. 
 
−
 
−
 
−
Once the user submits the a node is added under the selected MDR that represents the query. 
 
−
 
−
[[Image: cosmos_submitted.jpg]]
 
−
 
−
==View==
 
 
==Manage==
 
==Manage==
  
 +
===[[Configuration Item Registration Dialog]]===
 +
'''Purpose:''' This dialog box provides the ability for users to register configuration items to a federating CMDB.
  
 +
===[[Configuration Item DeRegistration Dialog]]===
 +
'''Purpose:''' This dialog box provides the ability for users to deregister configuration items to a federating CMDB.
  
 +
==Utility==
  
 +
===[[Error Dialog]]===
 +
'''Purpose:''' This dialog box displays error message to the user. 
  
  
  
 
[[Category:COSMOS_Users_Guide]]
 
[[Category:COSMOS_Users_Guide]]

Latest revision as of 12:28, 24 June 2008

COSMOS Wiki > COSMOS Document Plan > COSMOS Manual Guide

COSMOS Component Library

Category: User's Guide

Owner Sheldon Lee-Loy
Bug #218838 218838
Due dates Schedule

Outline

COSMOS defines a set of web-based components that provides access to the underlying COSMOS services. These web-based components can be configured and integrated with each other to create a very dynamic web based application.

Each component carries out one of the following basic action.

  • Navigate - components that help the end user locate a data manager within the COSMOS system
  • Query - components that builds and submits queries to a data manager
  • View - components that visualizes information from a data manager
  • Manage - components that manages a data manager
  • Utility - components that provide utility functions

Navigate

Data Manager Navigator

Purpose: The Data Manager Navigator displays a list of data managers that are registered with a broker. The user would use this UI component to submit queries to a particular data manager.

Query

Basic CMDBf Query Dialog

Purpose: This dialog provides a simple text input box to submit a CMDBf query document to a MDR.

CMDBf Query Builder Dialog

Purpose: This web based component provides a dialog box to construct a CMDBf query document and submit the constructed document to a MDR. Users familiar with the CMDBf query document structure can use this dialog box to construct a CMDBf query document instead of hand typing the document. The query builder processes the service meta data from an MDR to determine what kind of query capabilities the user is allowed to specify.

View

XML Viewer

Purpose: This view visualizes the structure of a XML document as a tree structure.

Frame Viewer

Purpose: This view provides a frame to embed html content.

Properties Viewer

Purpose: This view displays name value pairs within a table.

CMDBf Graph Reponse Viewer

Purpose: This view visualize the structure of a CMDBf response document.

CMDBf Graph Reponse Tree Viewer

Purpose: This view visualize the structure of a CMDBf response document as a tree.

Manage

Configuration Item Registration Dialog

Purpose: This dialog box provides the ability for users to register configuration items to a federating CMDB.

Configuration Item DeRegistration Dialog

Purpose: This dialog box provides the ability for users to deregister configuration items to a federating CMDB.

Utility

Error Dialog

Purpose: This dialog box displays error message to the user.

Retrieved from "https://wiki.eclipse.org/index.php?title=COSMOS_UG_Web_Component_Library&oldid=106512"

This page was last modified 12:28, 24 June 2008 by Sheldon Lee-Loy.

Back to the top