Oracle Service Bus - Getting started with Workspace Studio
By Chris Tomkins on Apr 11, 2008
Note: This post was first published before Oracle merged with BEA when the Oracle Service Bus product was known as AquaLogic Service Bus, hence the occasional reference to BEA and AquaLogic Service Bus.
One of the major changes in Oracle Service Bus v3.0 was to enable you to create service bus artifacts in Workspace Studio as well as the web-based console. This post explains how to get started with Workspace Studio including - how to add a server, how to create a service bus project, how to start creating service bus resources and how to deploy and test them.
Launching Workspace Studio
When you first launch Workspace Studio, the first dialog box you get presented with is the Workspace Launcher:
This is asking you where you want your workspace (the place where your Workspace Studio work will be stored) to be located on your file system. Once you have selected a location, click OK and Workspace Studio will finish launching.
Note: If you always want your work to be stored in this location, then tick the box to make this the default location (you can always change this setting from within Workspace Studio by going to Window>Preferences>General>Startup and Shutdown).
Once Workspace Studio has launched, you should see the Welcome screen:
This provides links to an overview of the product, samples, tutorials and other web based resources - if this is your first time using the product it is definitely worth spending some time on these.
Once you have finished looking at the links from the Welcome screen then click the Go to the Workspace button - you are now ready to start doing some work.
Defining your Oracle Service Bus server
Before we start creating actual service bus resources we need to define a local server instance which we can use to deploy our resources to. To do this, click on the Servers view tab in the lower half of the screen and then right click in this view and choose New>Server.
- Keep the default of BEA WebLogic Server v10.0 (Oracle Service Bus v3.0 is built on this version of WebLogic Server) and click the Next button.
- Optional: Modify the Server name to be Oracle Service Bus v3.0 @ localhost - I find this makes it easier to work out which server I am working with.
- Click the browse button to navigate to an existing Oracle Service Bus v3.0 domain or click the link to launch the Configuration Wizard to create a new one.
- Click Finish
You should now see the service bus server you created has been added to the Servers view and is currently in the Stopped state:
- To start the server, simply click on the green arrow or right click on the server and select Start.
Creating a Service Bus Project and Service Bus Configuration
Now we have a server, the next step is to create an ALSB Project which will contain our service bus resources. To do this, right click on the whitespace in the Project Explorer view on the left hand side, and choose New>ALSB Project:
Give the project a name and leave the <Default ALSB Configuration> option selected. By default the project contents will reside in a folder with the same name as the project, under the directory you selected for the workspace when you launched Workspace Studio, although you can select a different location if you wish.
Click Finish. When prompted as to whether you want to switch to the AquaLogic Service Bus perspective, tick the Remember my decision check box and click Yes.
You should see 2 projects have been created for you - an ALSB Project with the name you defined and an ALSB Configuration project called ALSB Configuration. You typically have one ALSB Configuration project per server instance and it handles access to the server, the automatic creation of sessions (to manage changes through Change Center) and is where cross project resources - such as SMTP server, JNDI provider and UDDI registry connections reside.
The ALSB Project you created is where resources such as business and proxy service definitions, XML Schema, XSLT and XQuery transformations etc. reside. For those of you familiar with earlier versions of service bus - this is analogous to a project in the project explorer view in the web based console.
To create resources simply right click on either the ALSB Configuration project (if you want to create a cross project resource) or on the ALSB Project (if you want to create a project resource - this is what you will be doing most often) and select New and then the type of resource you want to create. This will launch the appropriate wizard to help you create the resource. If you already have existing resources you can import these by choosing one of the import options. To demonstrate how to do this, here is a simple example where we import a WSDL file from a URL, create a business service from it and then create a proxy service from it:
- Right click on the ALSB project and select Import>Resources from URL and complete the necessary information to identify the WSDL we are interested in:
- Right click on the ALSB project and choose New>Business Service
- Accept the default location (i.e. in the root of this project) and give the business service a name:
- Click Next
- Choose the Service Type to be WSDL Web Service and browse to the WSDL you just imported, selecting the port you need (I have chosen the SOAP one for my example) and click Finish (note if you want to perform any more configuration of the business service click Next instead of Finish).
- To create the proxy service, right click on the ALSB Project and choose New>Proxy Service.
- Accept the default location (i.e. the root of this project) and give the proxy service a name:
- Choose to create this proxy from a business service and select the business service you have just created:
- Click Finish to accept all the defaults (if you need to customise any of the options for your proxy service, just click on Next instead of Finish)
This completes the construction of the service bus resources needed for this example - if you wish to further customise the business service or proxy service you can double click on them in the Project Explorer view and modify their properties via the various tabs (these correspond to the various panels you would see if you completed every panel in the creation wizard).
Deploying and Testing
Right click on the proxy service and choose Run As>Run on Server which will publish the resources to the server and also launch the test client.
Note: If you want to just publish the resources, you can do so by right clicking on your server and choosing publish or clicking the publish icon (next to the red square stop server icon).
- Check the "Set server as project default (do not ask again)" option so that you are not prompted with this screen for each subsequent publish.
- Click Finish (if you need to customise which applications are deployed to the server, click Next instead of Finish)
- You should now see the Test Client launch and be able to test your proxy service by entering sample data and clicking execute:
Note: If you would prefer to see the Test Client launched in your own web browser rather than in Workspace Studio, you can configure this by going to Window>Preferences>General>Web Browser.
Congratulations - you have just developed, deployed and tested your first proxy service from within the Workspace Studio IDE.
Note: To enable operational settings, SLAs etc. you will still need to use the web based console - this can easily be launched by right clicking on the server you created and choosing Launch ALSB Administration Console.