Author: keith
Date: Mon Jan 28 04:06:19 2008
New Revision: 13063
Log:
Updating admin guide
Modified:
trunk/mashup/java/xdocs/adminguide.html
Modified: trunk/mashup/java/xdocs/adminguide.html
==============================================================================
--- trunk/mashup/java/xdocs/adminguide.html (original)
+++ trunk/mashup/java/xdocs/adminguide.html Mon Jan 28 04:06:19 2008
@@ -3,15 +3,20 @@
<head>
+
+
<meta http-equiv="content-type" content="">
+
+
+
<title>The Mashup Server Admin UI</title>
<link href="styles.css" rel="stylesheet" type="text/css" media="all">
</head>
@@ -20,12 +25,14 @@
<body lang="en">
+
<div id="main-content">
<h1>The Mashup Server Web Console</h1>
+
<p> This document describes the WSO2 Mashup Server Web Console, which
is accessible through https://localhost:7443 in a vanilla installation.
@@ -41,6 +48,7 @@
+
<p>
<span style="font-weight: bold;">
@@ -51,262 +59,190 @@
and entering a user id and password in the displayed page. If
a browser
is not available on the local system, set the 'CreatePrimary'
config parameter
to 'true' in the 'PrimaryUserConfig' section of the server.xml
file,
- specifying your preferred PrimaryUser ID and password.
+ specifying your preferred PrimaryUser ID and password. Please
refer <a href="usermanagement.html">User Management</a> for details.</p>
+<p>
</p>
+
<p>
<img src="images/mashup-ui.png" alt="Mashup UI"></p>
-<p>The above shows the home page of a vanilla installation. It shown
+
+<p>The above shows the home page of a vanilla installation (Once you've
+loggin in that is). It shown
all avalable mashups together with there descriptions and average
-rating. Once the user logs in he's home page would also display the
+rating (The rating displyed in the foreground is the rating you've
+given the mashup while the one in the background represents the average
+rating). Once the user logs in he's home page would also display the
mashups he has authored and his recent activities. Each user can
customize there home page as to which queries appear on it and can even
-add new queries in a simple manner. In order to add a new query you can
-perform any arbritary search
- </p>
-
-
-
-
+add new queries in a simple manner. Any query performed using advanced
+serach can be added to your homepage and you can arrange the results
+according to your wishes.</p>
+<br>
+<h2>Mashup Page</h2>
+<br>
+The mashup page lists all resources associated with a mashup. It gives
+links to all resources that are associated with that mashup and also
+helps manage and create mashups. It will also show you the tags and
+comments associated with that mashup. You can also comment and tag on
+mashups. You may also delete comments and tags based on permissions (A
+user can delete a tag or comment he creates while the admin has rights
+to delete any tag or comment). <br>
+<br>
+The following resources of a mashup can be accessed from this page.<br>
+<ol>
+ <li>HTML Interface - Link to the custom UI of the service (The link is shown
only if
+ the service has a custom UI, figured out by the presence
of an
+ index.html or index.htm file within its www folder)</li>
+ <li>Try the service - Link to the try-it page where you can try the service
out</li>
+ <li>API documentation - Link to the documentation of the service</li>
+ <li>Service source code - Displays the source of the service </li>
+ <li>WSDL 2.0 - Link to the WSDL 2.0 document of the service (raw or
annotated)</li>
+ <li>WSDL 1.1 - Link to the WSDL 1.1 description of the service (raw or
annotated)</li>
+ <li>XML Schema - Link to the schema of the service</li>
+ <li>Javascript (DOM) stub - Displays a Java Script Stub that can be used to
invoke the service</li>
+ <li>Javascript (E4X) stub - Displays a Java Script Stub that can be used to
invoke the service</li>
+ <li>Javascript (E4X) stub using "localhost" endpoints - Displays a Java
Script Stub that can be used to invoke the service<br>
+ </li>
+</ol>
+<br>
+<br>
+<img src="images/mashup.png" style="width: 1001px; height: 663px;" alt="Mashup
Page"><br>
<h2><br>
-</h2>
-
-<h2><br>
</h2>
-<h2>Available Mashups</h2>
+<h2>Advanced Search</h2>
-
-<p>
- The Available Mashups list contains a list of Mashups and
- Services
- deployed and running in the server. Each item in the list can
be
- dragged to
- the pane on the left, which will transform them into Mashup
Widgets,
- which
- display further information and documentation.
- </p>
-
-<p>You can also do the following:</p>
+<p>The advanced search page helps you search for mashups based on tags,
+titles or descriptions. You can also perform searches on comments and
+Recent activities. It also have some pre populated special queries. </p>
-
-<ol>
-
-
- <li>Start/Stop a Service</li>
-
-
- <li>Share a service with another WSO2 Mashup Server</li>
-
-
- <li>Edit the service source and documentation using the buttons
- on the listed items
- </li>
-
-
-
-</ol>
-
-
<p>
- <img src="images/available_mashups.png" alt="Available Mashups
List">
- </p>
+ <img src="images/search.png" style="width: 994px; height:
566px;" alt="Search"><br>
+ </p>
- <br>
+ <br>
-
-<h2 id="sharing">Sharing a Mashup</h2>
-<p>
- You can share a mashup running in your server with another
- server by a click of a button.
- </p>
+<h2 id="sharing">Sharing a Mashup</h2>
- <img src="images/sharing.png" alt="Mashup Sharing">
-<p>Enter the http (unsecured) address of the destination server.</p>
+<p> You can share a mashup running in your server with another server
+by a click of a button. You need to provide the address (https) of
+the remote server and your credentials. Note that you will need to have
+an account on the remote server in order to share with it. </p>
+<img src="images/sharing_dialog.png" alt="Mashup Sharing">
+ <br>
- <img src="images/sharing_dialog.png" alt="Mashup Sharing">
<br>
- <br>
-
<br>
-
-<h2><a name="CreatingNewMashup"></a>Creating a New Mashup or Service</h2>
-
-
-<p>
- The Web Console is capable of generating a skeleton
JavaScript
- service for
- the user (A user should be logged in to perform this
operation). Click the <strong>Create a new Mashup</strong>
- icon at top of the
- Available Mashups list, as illustrated in this screenshot.
When you
- enter a
- name for the new service, the Admin UI will create the service
skeleton
- and
- deploy it. It will be listed as a service in the Available
Mashups list
- after
- a few seconds. If you do not wish to wait till the Admin UI
refreshes
- the
- list, click the <strong>Refresh</strong> icon (next to the
- <strong>Create new Mashup</strong> icon), which results in a
manual refresh of the
- list.
- </p>
+<h2><a name="CreatingNewMashup"></a>Creating a New Mashup or Service</h2>
-<p>
- <strong>Note</strong>: From release 0.2 onwards
- this operation will be
- wizard based, allowing greater customization of the initial
skeleton.
- </p>
-
-
-<p>
- <img src="images/create_new_mashup.png" alt="Create a new
mashup">
- </p>
-<h2>Mashup Widgets</h2>
-
-
-<p>
- A Mashup Widget displays a complete set of information
- regarding a Mashup
- or a Service. It also provides links to resources such as:
- </p>
-
-<ol>
-
-
- <li>WSDL - Link to the WSDL 1.1 description of the service</li>
-
-
- <li>WSDL2 - Link to the WSDL 2.0 document of the service</li>
-
-
- <li>Try service - Link to the try-it page where you can try
the service out</li>
-
-
- <li>Stub source- Displays a Java Script Stub that can be used
to invoke the service</li>
-
-
- <li>Schema - Link to the schema of the service</li>
-
-
- <li>API docs - Link to the documentation of the
service </li>
-
-
- <li>Service source - Displays the source of the service</li>
-
-
- <li>Custom
- UI - Link to the custom UI of the service (The link is
shown only if
- the service has a custom UI, fogured out by the presence
ofan
- index.html or index.htm file within its www folder)<br>
-
-
- </li>
+<p>
+ The Web Console is capable of generating a skeleton
JavaScript
+ service and a skeleton custom UI for
+ the user (A user should be logged in to perform this
operation). Click the <strong>Create a new Service</strong>
+link which is located in the Management Tasks panel. When you enter a
+name for the new service, you will be taken to the edit mashup window.
+There you can do the necessary editing and save or calcel the chnages
+depending on your preference. The new mashup will be listed as a
+service in a few seconds.<br>
+ </p>
+<br>
+<h2>Editing Mashups</h2>
-
-</ol>
-<p>
- <img src="images/mashup_widget.png" alt="The Mashup Widget">
+<p> The Mashup Editor allows you to edit the source code or the custom
+UI of your Services and Mashups. You can launch the editor from
+link in the Manegement Tasks panel (Edit this service). Once you have
+completed editing the service, you can Apply the changes (Saves the
+mashup and keeps you on the editor page), Save Changes (Takes you to
+the bounceback page) or Discard the changes (No Mashup is created).
</p>
-
-<h2>Editing Mashups</h2>
-
-
<p>
- The Mashup Editor allows you to edit the source code and
- documentation of
- your Services and Mashups. You can launch the editor from the
buttons
- in the
- service items listed in the Available Mashups list. Once you
have
- completed
- editing the service, click the<strong> Save</strong>
- button, at the top of
- the edit area.
- </p>
-
-
-
-
+ <img src="images/mashup_editor_source.png" style="width:
996px; height: 854px;" alt="Mashup Editor Design View"></p>
+<p>You can also use the editor to edit your custom UI.</p>
<p>
- <img src="images/mashup_editor_design.png" alt="Mashup Editor
Design View">
</p>
+
<p>
- <img src="images/mashup_editor_source.png" alt="Mashup Editor
Source View">
+ <img src="images/mashup_editor_ui.png" style="width: 995px;
height: 847px;" alt="Mashup Editor Source View">
</p>
+
<p>� WSO2 Inc.</p>
+
</div>
+
</body>
_______________________________________________
Mashup-dev mailing list
[email protected]
http://www.wso2.org/cgi-bin/mailman/listinfo/mashup-dev
