Web application
This chapter explains how the Web application is structured and how to use it.
All the operation on the configuration that are performed with the Web application can also be done directly on the configuration files.
It's important to read this chapter to be able to follow the rest of the document.
Views
The SoaBox is composed by the following views:
- Menu
- Virtual Client starter
- Log viewer
- Console (Virtual Client, Virtual Server)
- File manager
- Beans list
- Bean creation
- Bean editing
Menu
To move on the sections of the Web Application a Menu is provided.
The following table lists the menu items and the section/view they open.
| Menu item | Section/view |
|---|---|
| File > File manager | From here you can edit all the files of the box, creating new ones like the requests etc. |
| File > Import > WSDL.. | The WSDL import form. |
| File > Import > Box.. | To import a box. |
| File > Export | To export the box. |
| File > Clear | To clear the box. You can select to remove all the configuration and files or only part of them. |
| Virtualization > Console | The console used to start and stop the Virtual Client, to check the status of it and the Virtual Server, to check the logs. |
| Virtualization > Client > Configuration | The view to work on the Virtual Client jobs. |
| Virtualization > Client > Destinations | The view to work on the Virtual Client destinations. |
| Virtualization > Client > Selectors | The view to work on the Virtual Client selectors. |
| Virtualization > Server > Configuration | The view to work on the Virtual Server. |
| Virtualization > Values | To view the list of the values and to create new ones. |
| Virtualization > Triggers | To view the list of the triggers and to create new ones. |
| Virtualization > Tasks | To view the list of the tasks and to create new ones. |
Virtual Client starter
In any page of the WepApplication, on the right, there is the Virtual Client starter panel.
This panel permits you to start a Virtual Client job, selecting his group and name.
Being available on all the pages you can test immediately the changes you've done.
Log viewer
At the bottom of all the pages you'll find the Log viewer panel that you can see the logs relative to SoaBox and virtualization.
The level list is to control the verbose, number of entries defines how many rows of log to keep, the refresh button refresh the view, the clear button clears it.
Console
The console is the view from which you can start and control the activities performed by the box.
You can move around using the provided tabs that are:
- Virtual Client
- Virtual Server
Virtual Client
In the Virtual Client tab all the client job are listed.
The field of the table are listed in the following table.
| Field | Data/operation |
|---|---|
| Group | Job group. All the header you'll find also the filter to filter the table by the Job Group. |
| Name | Job name. |
| Threads | The number of threads that are running the job. |
| Total | The amount of actions (WS/HTTP cals, file writes etc.) performed since the last clearing. It's formula is: number of files * selector quantity * number of runs. |
| Quantity | The amount of action performed during the last run. It's formula is: number of files * selector quantity. |
| Progression | When running the progression percentage is displayed. |
| Last call | The time when the job run the last time. |
| Time | The last time to perform the job. |
| Actions | From this column you can start, stop and edit the job. |
At the bottom of the list there are the following buttons:
- Add new - to add a new job to the client
- Start all - to start all the job of the client
- Pause all - to pause all the job of the client
- Clear - to clear all the statistical data
Virtual Server
In the Virtual Server tab all the server statistical data is displayed.
This data will be displayed when the call are made not when the server configuration is created.
The field of the table are listed in the following table.
| Field | Data |
|---|---|
| Request | The request's URL - the protocol, domain, context and port are omitted. If running standalone it's http://localhost:8680/virtual |
| File | The file that as been served. |
| Total | Total amount of requests received. |
| Last call | When the last call was made. |
| Time | The amount of time taken to serve the last request. |
At the bottom of the list there are the clear button to clear the statistical data.
File manager
The file manager permits to:
- Browse the directories and files
- Create directories and files
- Edit directories and files
- Upload files
On the left you'll have the Explorer panel to navigate and manipulate folders and files.
When a file is selected on the right the text area to edit the file will be displayed.
To perform the create and upload operations select the parent directory.
On the really right, as in the other pages, the Virtual Client panel is present. This way you can test the changes you made without having to leave the page.
The most of the operations are possible only on the sub directories to not permit to break the product.
Beans
The most of the element of SoaBox are beans, as common in the Java programming language, and the way you work with them is the same.
The following are the SoaBox beans:
- Jobs
- Destinations
- Selectors
- Values
- Triggers
- Tasks
For a detailed description of those beans read the relative chapters and paragraphs.
Beans list
The first view when you choose to work on a type of beans from the Menu is the list.
In all the list view you we'll have the following fields.
| Field | Data |
|---|---|
| BID | The Bean ID, this must be a unique id of the bean used then to get a reference to it in the other configurations. |
| Type | The type/class of the bean. This field is present in the most of the cases. |
| Actions | The actions that can be performed on the bean. Edit, copy and delete. |
At the bottom of the page there is the Add button to add a new bean to the list.
Bean creation
With the Add button in the list view, you can add a new Bean.
Usually the adding of a bean is performed in two steps/forms.
In the first step/form the BID, the file and the type have to be provided.
SoaBox permits to save the beans in different files, but a default one is provided.
In the second step/form the details of the bean will be asked.
Bean editing
To edit a bean select, from the list view in the Action field, the Edit button.
The form to edit the bean will be displayed, the field on it depends on the bean's type.
After you've created a bean you can't change the BID, the file and the Type/Class.
If you need that you'll have to work directly on the configuration files.
Custom beans
It's possible also to add custom code in the form of custom beans.
This permits you to extend SoaBox using your code inside the WebApplication.
Is it possible to add Custom beans for the following bean types:
- Destinations
- Selectors
- Values
- Triggers
- Tasks
As you can see from the list, you can add custom code for mostly all the bean types, the only beans that can't be customized are Job beans.
To add a custom bean just select Custom as bean type in the first form of the bean creation.
In the second you'll have to provide the BID of the Custom bean.
If you want to code your custom bean, read the Developers Guide.
File menu
With the file menu you can access the File manager and perform the following action:
- Import an exported box
- Export your current configuration or part of it
- Clear the box from all the configurations and files
