WSO2 Tungsten Administrator's Guide

This document will provide you with information & instructions on the functionality of WSO2 Tungsten's Management Console which is the administration application of Tungsten.

Your feedback on WSO2 Tungsten is most appreciated. Please send them to our Mailing Lists.

Content

Introduction

WSO2 Tungsten is a lightweight, high performant integrated web services middleware platform.

To learn more about Tungsten see here

Tungsten Management Console is your one stop shop to administer the WSO2 Tungsten Server. You can administer/configure your modules/services as well as monitor the system through this interface.

WSO2 Tungsten Management Console runs on AJAX (Asynchronous Javascript and XML) and SOAP, making it a fast administration tool. All the functionality is provided by a set of web services exposed by the WSO2 Tungsten Server.

The functionality of this management console is described in detail below.

Signing In

Once Tungsten 1.0 is successfully installed (See Installation Guide for installation details), start Tungsten server, launch web browser and point it to the URL https://localhost:9443/ (for the standalone installation) or https://localhost:9443/tungsten/ (for the embeddable installation) if you are using the default settings. This will take you to the Sign In page of Tungsten Management Console seen as below.

Note: Tungsten server has two listeners, HTTP and HTTPS. The HTTP listener opens on port 9762, while the HTTPS listener opens on port 9443. The admin client only works through the HTTPS port.

Figure:mgtconsole

The default username and password to sign in to Tungsten Management Console:

User name : admin

Password : admin

To solve any problems with signing in click on sign-in Help

The Sign In page contains links to the FAQ and the about Tungsten page which gives an introduction about WSO2 Tungsten server and WSO2 Inc.

Navigation Bar

The following links are available on the navigation bar

Home

Home Page of the Management Console will contain following useful information on Tungsten server.

Figure:Home

Manage System

This page shows you the environmental setup of the server, such as Axis2 installation location, Java Home, Java version & other Java information, OS information, Repository location, Server name & User information

On this page you have the option of saving the state of the system (after making changes to the state) using 'Save System' button, and restarting system from that saved state using the 'Restart System' button.

Figure:System

Manage Services

Figure:Available Services

As shown above, this page will list each of the services available in each service group of this system along with links to view WSDL, Schema & Policy of each service.

This page also carries a link that displays RSS an Atom feeds.

Remove Service Group:

A service group can be removed using the 'Remove' action button/icon listed for each service group, in which case all the services in that particular service archive will be removed from system.

Deploying Services:

The most important feature of this page is the ability to deploy and manage services. In the case where the service archive of the relevant service is an .aar you can deploy the service by simply selecting the service archive using 'Browse' button, then uploading service using the 'Upload' button. For example, Axis2 packages services as .aar files. You can simply deploy an Axis2 service by uploading the relevant .aar file.

Where the service archive of the relevant service is a .jar or .zip file then deployment requires a few more steps. In this case you must select the service archive using 'Browse' button, then upload service using the 'Upload' button, where in doing so a page containing the classes of the archive will appear as shown below. Here you need to select the relevant classes of the web services you wish to deploy, by clicking on the corresponding check boxes. Once you have selected all the classes, click on 'Generate' button to deploy the relevant services.This process is called Dynamic Service Generation.

Figure: Dynamic Web Services

If services were successfully depolyed, then a message will appear saying so. The service that you deployed will now be listed under the 'Available Services' as shown below.

Figure: Deployed New Dynamic Web Services

Deleting Faulty Services:

If a faulty service is deployed it will be displayed in this Available Services page as [n] faulty service(s):

Click on the faulty service link and it will take you to a page as shown below where details of the faulty service(s) will be listed. By using the 'Delete Faulty Service' icon on this page you will be able to delete the deployed faulty service.

Figure: Delete Faulty Service

Service Information:

Select a particular service listed in 'Available Services', and it will take you to a page with service information.

Figure:Service information

Service information will consist of:

WSDL Viewer

WSDL Viewer tries to simplify the way that you see the WSDL file. It tries to give you a easier way to look at any specific part of the WSDL file by arranging the parts of the WSDL file in a logical hierarchy. This will help some one who is not fluent in WSDL jargon to have a quick look at the service. However if you are one of those guys who dream in ports and bindings you might prefer the raw WSDL file. Please note that the WSDL viewer does not support policies.

Figure:WSDL viewr

Manage Service Operations

This link will lead to a page containing a List of operations of the service with 'Edit operation specific parameters' and 'View engaged modules' icons for each operation.

RSS

RSS feed gives the subscriber updates about any status changes in services in WSO2 tungsten. These include activation, de-activation, removal, etc. of the services. The RSS standard that is used is 2.0.

Figure:RSS

Atom

Atom feed gives the subscriber updates about any status changes in services in WSO2 tungsten. These include activation, de-activation, removal, etc. of the services. The Atom standard that is used is 2.0.


Manage Quality of Service (QoS)

You can view all the available modules in the system on this page. It will give name, version and description of the modules. Each module can be removed using the remove module icon and can be globally engaged/disengaged through the globally engage/disengage icon.

When you remove a module that module will be completely removed from the system. That is the module handlers will be removed from the handler chain and the module mar file will be deleted. However if you disable a module then the module will be still in the system while the handlers from that module will be removed from the handler chain.

Figure:QoS

When you click on the module name it takes you to a page where module configuration is possible.

Figure:QoS

When the Configure Parameters link is clicked the page that appears will contain editable parameters allowing you to add or update parameters using 'Add' or 'Update' buttons. For example, when the Configure icon in the Sandesha2 is clicked we would see the following page.

Figure: Module Configuration

In the case where there are no editable parameters, page will say that there are no editable parameters found, with the option of adding a new parameter using the 'Add' button. For example, when the Configure Parameters link in the Rampart module is clicked we would see the following page.

Figure: Module Parameter Configuaration for Security

Similarly, when the 'Configure Policies' link is clicked you would obtain the following pages for Sandesha2 (where policies are present) and Rampart (where policies are not present).

Figure: Module Configuaration for Security

Figure: Module Configuaration for Security

Manage Users

This page will list 2 areas of management

  1. Role Management - Create new roles and edit existing roles.
  2. User Management - Create new users, assign roles to users and edit existing users.

Figure:Users

Role Management

Clicking on the Role Management link will take you to a page that consists of a list of existing role names with the option of adding new role names. This is done by typing in new role name and clicking on 'Add' button. If role was added successfully an alert message will pop up.

Figure:Role Management

User Management

User Management link will take you to a page with a list of present users with the option of adding in new users to this list. In order to add a new user, Username, Password & Confirm password (same as password) need to be typed in and user role selected from the list and  then click on the 'Add' button. If the user was added successfully an alert message will pop up saying so.

Note that user role list contains all role names listed in Role Management page from which new roles can be added as well.

Figure:User Management

The present users list comes in pairs of user name (role name) pairs. Clicking on Edit icon next to each present user will take you to a page that allows you to edit user- change the role name of the user and reset password. Once new user role is selected from the list in order to update change click on 'Update Role' button. If role has been successfully changed an alert message will pop up saying so. To reset the password, the new password & the confirmation of new password (same as new password) should be correctly typed in, then click on 'Reset Password' button. If password was reset successfully an alter message will pop up.

Figure:Edit User

Manage Configuration

This page contains server settings for logging and message monitoring.

Logging settings include values for log level, log pattern and log file. The log level list contains TRACE, INFO, DEBUG, WARN, ERROR, FATAL and OFF from which any one can be selected. The log pattern allows you to edit the format or the layout in which the logs are created. Finally you can change the location of the log file with the Log File option. These logging settings are based on log4j. Values for these settings can be edited/changed and updated using Update button. You can have a look at the log4j PatternLayout page to get the meanings of the values that are used in the log pattern.

Message monitoring can be turned ON/OFF.Select one of the two options, then click on Update button. Make sure to turn this option ON if you want to view the SOAP messages in the Tracer.

Figure:Manage Configuration

Monitor Statistics

This page shows some statistics related to the Tungsten server. These include Free memory, Request count, Server name, Server start time, System up time, Active services,  Total memory, Average response time, Minimum response time and the Maximum response time.

Figure: Monitor Statistics

Monitor Logs

The system log can be viewed on this page. Log entries will be catergorized into information messages, warning messages, error messages, fatal error messages & debug messages.

Figure:System Log

Monitor Tracer

This tracer shows the soap messages, their respective SOAP message requests and responses when services are deployed on the server and their operations invoked. Make sure that the Message monitoring is turned ON in the configuration page. The tracer will only show the messages of operations invoked after that point onwards.

Using this SOAP tracer it is possible to see SOAP messages with their timestamps, service name, operation invoked and the number of requests to the server. The most recent SOAP messages are listed on the top. When a particular SOAP message is selected it's Request and the Response can be viewed in collapsible/expandable text boxes.

Note: This tracer does not apply to operations invoked in the admin services, as they are filtered out.

Soap Tracer

Miscellaneous

Signing Out

Once signed in, in order to sign out form the system simply click on the Sign Out link on the right hand-top end of any page.

Register

You can register WSO2 Tungsten by clicking this link. By registering you will be providing the developers with valuable information to make WSO2 Tungsten better product. Only information that is shown to you on the Register Product page will be submitted to the server and you can change the information that is extracted from your Tungsten instance before you submit them to the server if you wish to do so.

Figure:Register