[Download]
| [Documentation Index] | [Release Note]
User Guide
This document provides information and instructions on the functionality
of WSO2 Mashup Server. Your feedback on WSO2 Mashup Server is most appreciated. Please send them to our mailing lists.
Introduction
The WSO2 Mashup Server allows you to acquire web based information from a
variety of sources such as Web services, Web pages, Databases or Feeds,
combine it in interesting and useful ways before exposing the result
again as a Web service or page, Feed or a Google gadget. If you still haven't
installed Mashup Server, please take a look at the
installation guide.
The functionality of the Management Console is described below in detail.
Welcome Page
Once WSO2 Mashup Server has been successfully installed (see
Installation Guide
for installation
details), start the WSO2 Mashup Server. Then, launch a Web browser instance and
point it to the URL
https://localhost:9443/carbon/
if you are using the default settings.
This will take you to the welcome page of the WSO2 Mashup Server Console.
Note:
WSO2 Mashup Server has two transport listeners: HTTP and
HTTPS. By default, the HTTP listener opens on port 9763, while the HTTPS
listener opens on port 9443. The administrator functionality is exposed only
via the HTTPS port.
Signing In
Signing in will be available in the upper right hand corner.
When the user clicks the "sign in" link, it will automatically redirect
the request to secure protocol https, if user has already in http protocol. Once the
correct credentials are provided, the user will be logged in to the Mashup Server Management Console.
The default username and password to sign into WSO2 Mashup Server Management
Console:
User name :
admin
Password :
admin
The management console can point to different Mashup Server nodes in a production system. This can
be done using the "Server URL" entry on the Sign In box.
To solve any problems with signing in, click "Sign-in Help"
Home
The Home Page of the Management Console will contain the system summary.
Manage Services
As shown below, this page lists the available services or those deployed
in each service group in the system, along with links to view the WSDLs of each service.
Remove Service Group
A service group can be removed using the 'Remove' action
icon listed for each service group, in which case all the services in that
particular service archive will be removed from the system.
Faulty Services
Deleting Faulty Services:
If a
faulty service
is deployed, it will be displayed on
the Available Services page as
[n] Faulty
Service Group(s)
Clicking on the faulty service link will open the faulty services page, on
which the details of the faulty services will be listed. On this page,
you will be able to delete the faulty service.
Service Group Management
Clicking on the Service Group on the main page of Manage Services,
will open a page on which you can:
- Manage Service Group Parameters: Users can add, update or delete parameters from the
admin console. Parameters should be given a name and a value, which consist of well formatted XML.
- Manage Module Engagements: Lists the modules engaged
at the service group level and on a global level. You can also engage or
disengage modules to the specific service group.
- Create Service Archive: This feature will provide the user to create an Axis2 archive
out of all the configurations available to a given service group. Thus, before shipping the service to a
production environment, users can test whether all related functions such as parameters, module
engagement, polices etc are available or its validity & so on. Though this will give tremendous
development time feature, it has its limitations. Currently this feature could archive a created or
generated .AAR. Mashup Server distribution comes with data services, pojo services, and Axis1 services
support. All these domains do not have archives. They would simply be a file with XML formatted
description. Thus, if such a service is tried to be archived, Mashup Server would not allow it. It
should be noted that an archive can be created only for a service group, not to an individual service.
Service group is mapped to a physical .AAR. Thus, it's logical to create an archive only to a service
group instead.
- MTOM Configuration: MTOM is allowed to be configured in three ways, True, False and
Optional. If one of these values are changed, this will cause all underline services and operations to
change its way of corresponding to MTOM
Service Management
Clicking on the service of a specific service group on the main page of
"
Manage Services", will show the Service Dashboard that contains certain
service specific information
- Edit Mashup: Users can edit their services source, custom UI and gadget code.
- API Documentation: Displays the API Documentation for the service.
- Custom UI: If the service has a custom UI, then this link will be pointed to that.
Otherwise the user will be
redirected to the tryit page of the service.
- Source Code: Source code for this service.
- XML Schema: Schema definition for the service.
- Javascript(DOM) Stub: Javascript DOM stub, which is to be used under browser
environment.
- Javascript(E4X) Stub: Javascript E4X stub, which is to be used to access a servie from
a service.
- Javascript(E4X) Stub [localhost endpoints]: Javascript E4X stub with localhost
endpoints,
which is to be used to access a local service from a service.
Securing a Service
The following image shows the options available for securing a service by applying security scenarios.
For more details see
here
Access Throttling
Access throttling configuration for the HelloService is shown below.
For more details see
here
Response Caching
Response caching configuration for the HelloService is shown below.
For more details see
here
Reliable Messaging
Reliable Messaging Configuration for the HelloService is shown below.
For more details see
here
Edit Policies
Policy editing options for the HelloService is shown below.
For more details see
here
