The Mashup Server Web Console

This document describes the WSO2 Mashup Server Web Console, which is accessible through https://localhost:7443 in a vanilla installation. The Web Console helps the user to perform sevaral tasks based on the permissions he is given. The default permissions allow annonymous users to search and view mashups of all users. Users who are logged in can comment, rate, tag and perform routine tasks associated with creating and maintaining their Mashups.

Note:  The primary user for the mashup server should be created on first run. This can be done by accessing the web console locally using your browser 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. Please refer User Management for details.

Mashup UI

The above shows the home page of a vanilla installation (Once you've logged in in that is). It shown all available mashups together with there descriptions and average rating (The rating displayed 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. Any query performed using advanced search can be added to your homepage and you can arrange the results according to your wishes.


Mashup Page


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).

The following resources of a mashup can be accessed from this page.
  1. 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)
  2. Try the service - Link to the try-it page where you can try the service out
  3. API documentation - Link to the documentation of the service
  4. Service source code - Displays the source of the service 
  5. WSDL 2.0 - Link to the WSDL 2.0 document of the service (raw or annotated)
  6. WSDL 1.1 - Link to the WSDL 1.1 description of the service (raw or annotated)
  7. XML Schema - Link to the schema of the service
  8. Javascript (DOM) stub - Displays a Java Script Stub that can be used to invoke the service
  9. Javascript (E4X) stub - Displays a Java Script Stub that can be used to invoke the service
  10. Javascript (E4X) stub using "localhost" endpoints - Displays a Java Script Stub that can be used to invoke the service


Mashup Page


Advanced Search

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.

Search


Sharing a Mashup

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.

Mashup Sharing


Creating a New Mashup or Service

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 Create a new Service 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 cancel the changes depending on your preference. The new mashup will be listed as a service in a few seconds.


Editing Mashups

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 Management 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).

Mashup Editor Design View

You can also use the editor to edit your custom UI.

Mashup Editor Source View

© WSO2 Inc.