Author: hiranya Date: Tue Jul 7 03:53:14 2009 New Revision: 40935 URL: http://wso2.org/svn/browse/wso2?view=rev&revision=40935
Log: Reviewed and updated the quick start guide. Modified: branches/esb/java/2.1/product/docs/xdoc/quickstart_guide.xml Modified: branches/esb/java/2.1/product/docs/xdoc/quickstart_guide.xml URL: http://wso2.org/svn/browse/wso2/branches/esb/java/2.1/product/docs/xdoc/quickstart_guide.xml?rev=40935&r1=40934&r2=40935&view=diff ============================================================================== --- branches/esb/java/2.1/product/docs/xdoc/quickstart_guide.xml (original) +++ branches/esb/java/2.1/product/docs/xdoc/quickstart_guide.xml Tue Jul 7 03:53:14 2009 @@ -144,9 +144,9 @@ </h3> <p> Our first task is to download the WSO2 ESB. Open a Web browser and access - the following URL: http://dist.wso2.org/products/esb/java/. You will then + the following URL: http://wso2.org/downloads/esb. You will then see the list of available releases. Click on the latest release version, - and you will be directed to the WSO2 ESB latestrelease download page. Now + and you will be directed to the WSO2 ESB latest release download page. Now download the binary distribution ZIP or tar.gz archive compatible with your operating system. </p> @@ -154,9 +154,9 @@ Installation </h3> <p> - WSO2 ESB can be installed by extracting the downloaded binary archive. A + WSO2 ESB can be installed by simply extracting the downloaded binary archive. A directory named wso2esb with the version number will be created in the - selected parent directory, containing all the files required for the ESB. + selected parent directory, containing all the files required by the ESB. We will refer to this directory as <esb-home> from now on. </p> <h3 id="Running"> @@ -175,7 +175,7 @@ <p> Let's first start the WSO2 ESB. Set the log level of org.apache.synapse and org.wso2.esb to DEBUG by editing the - webapp/WEB-INF/classes/conf/log4j.properties file. This will cause the ESB + <esb-home>/lib/log4j.properties file. This will cause the ESB to output debug messages for the actions it is performing. We can inspect these logs later using the management console. Then go to the <esb-home>/bin folder and execute the following command. @@ -225,7 +225,7 @@ sufficient for our first scenario. Later on, we will change this configuration using the management console to build different mediations. Now examine the default configuration using the ESB console. Open a Web - browser and point it to the URL https://localhost:9444/esb. You will be + browser and point it to the URL https://localhost:9443/carbon. You will be directed to the log-in screen of the management console shown below. </p> <p/> @@ -238,9 +238,7 @@ "admin". Type "admin" in both the username and password fields and click Sign In. You will be directed to the main page of the ESB management console, which displays information about the ESB as well as brief - descriptions about its core features. Click on the "System Information" - link on the left panel of the console to view more information about the - system on which the ESB is running. Click on the "System Logs" link on the + descriptions about its environment. Click on the "System Logs" link on the same panel to display log messages of the system. You will see the same set of log messages displayed in the command line, when starting the ESB. Now click on the "Statistics" link to view runtime statistics of the @@ -253,11 +251,11 @@ the "Sequences" link on the left panel. You will see that two sequences named "fault" and "main" are currently available. These two sequences are generated automatically by the ESB at start up. We can add any number of - sequences using this page to suit our mediation requirement. However these + sequences using this page to suit our mediation requirements. However these pre-defined sequences are sufficient for this sample application. Let's analyze what happens to the messages inside the main sequence by clicking - on the "main" link. You will see a set of mediators listed for the main - sequence as shown below. + on the "Edit" link in the same row as the "main" sequence. You will see a + set of mediators listed for the main sequence as shown below. </p> <p/> <p> @@ -277,8 +275,8 @@ the messages (i.e. full log level) and Filter Mediator is configured only to pass through messages containing "http://localhost:9000"; in the WS-Addressing header. You can change this default configuration by - clicking the Edit icon (denoted by a pencil) near the corresponding - mediator and selecting different values. Then a Send Mediator is listed as + clicking on the corresponding mediator icon and modifying the parameter values + in the form which appears below. Then a Send Mediator is listed as the child of the Filter Mediator. Therefore, filtered messages will be sent to the specified WS-Addressing destination. That's all we do for the request messages. Now let's look at the Out Mediator. There is only a Send @@ -288,21 +286,12 @@ <p> Now we have a basic understanding about the message flow inside the ESB. We are going to make a small modification to the main sequence to enable - statistics monitoring and tracing. Just click on the "Manage sequences" - link at the top of the page - to display all the available sequences as - shown below. + statistics monitoring and tracing. Just click on the "Sequences" + link in the left menu to display all the available sequences. </p> - <p/> - <p> - <img alt="Manage sequences" src="images/manage_seq.png"/> - </p> - <p/> <p> - Now click on the last two icons under the Actions heading of the "main" - sequence. That is 'enable statistics' and 'enable tracing'. If you are not - sure about the icons, move the mouse over them, which will display a - tooltip explaining its functionality. + Now click on the first two icons under the Actions heading of the "main" + sequence. That is 'enable statistics' and 'enable tracing'. </p> <p> Now we are done with the ESB configuration. It's time to continue the rest @@ -441,8 +430,8 @@ <img alt="System logs" src="images/logs.png"/> </p> <p> - Now click on Trace Messages to view the trace messages emitted by the ESB. - You will see trace messages as listed in the following screen shot. + Now click on "Mediation Tracer" to view the trace messages emitted by the ESB. + You will see trace messages as listed in the following image. </p> <p/> <p> @@ -450,8 +439,8 @@ </p> <p/> <p> - Now let's move on to the most interesting part, system statistics. Click - on Statistics to view the overall runtime statistics graphically using pie + Now let's move on to the most interesting part, mediation statistics. Click + on Mediation Statistics to view the overall runtime statistics graphically using charts. You will see the updated statistics reflecting the message mediation we have just performed. </p> @@ -473,11 +462,6 @@ link in the top left box. You will be presented with a summary of the server statistics containing total messages, average response time, etc. </p> - <p/> - <p> - <img alt="Server statistics" src="images/server_statistics.png"/> - </p> - <p/> <p> In the same way, you will be able to view summarized statistics for sequences by clicking on the Sequence Statistics Summary link in the @@ -530,23 +514,35 @@ Start the ESB as the previous section and log in to the management console. Click "Proxy Services" on the left panel. You will see that currently no proxy services have been defined. Let's add a new proxy - service by clicking "Add" . You will be directed to the basic proxy - service configuration page as shown below. + service by clicking "Add" . You will be directed to the add proxy + service wizard as shown below. </p> <p/> <p> - <img alt="Proxy service basic configuration screen" - src="images/proxy_basic.png"/> + <img alt="Proxy service creation wizard" + src="images/proxy_service_step1.png"/> </p> <p/> <p> First give a name to the new proxy service. In this sample type - "StockQuoteProxy" as the name of the proxy service. Next we will add a - target endpoint to handle request messages and a target out sequence to - handle response messages. To add a target endpoint, click on the button - next to the target endpoint. In the displayed sub menu select "Specify as - Anonymous". In the next sub menu select "Address Endpoint". A pop up - window will be displayed to configure the new endpoint. Type the EPR of + "StockQuoteProxy" as the name of the proxy service. + </p> + <p> + Next we are going to specify a WSDL for this proxy service. It can be + displayed using the ?wsdl operation with an actual service. Select + 'Specify URL' in the 'Publishing WSDL' drop down list under 'General Settings'. + You will be prompted with a text box to enter the URL of the WSDL. Type + file:repository/conf/sample/resources/proxy/sample_proxy_1.wsdl as the WSDL + URL and click on 'Test Connection' to instantly validate the path. + </p> + <p> + Then click 'Next' at the bottom of the page to proceed to the next step of the + proxy service creation wizard. As the next step of the wizard we will add a + target endpoint to handle request messages and a target in sequence to + handle request messages. To add a target endpoint, select the option 'Anonymous' + under 'Endpoint Options' and click on the 'Add' button that appears. + In the next sub menu select "Add Address Endpoint". A web form + will be displayed to configure the new endpoint. Type the EPR of the target endpoint in the Address field. In this case it is "http://localhost:9000/services/SimpleStockQuoteService";. Address endpoint editor with entered values is shown below. Keep other fields unchanged and @@ -559,46 +555,29 @@ </p> <p/> <p> + As for the in sequence we will leave it empty for this sample. So click on + 'Next' to proceed to the next step of the wizard. The next step is to add an out sequence to the proxy service. We just want to send the response messages back to the client in this out sequence. - Click on the button next to the Target out-sequence and select "Specify as - Anonymous" in the displayed sub menu. You will be presented with a + Click on the button next to the Target out-sequence and select " + Anonymous" in the displayed sub menu and click "Add". You will be presented with a sequence editor. Click on the Add Mediator icon and select Core and then Send, from the sub menu. A send mediator with default configuration will be added. The Sequence editor after adding the send mediator is shown - below. Click "Save" to save the out sequence configuration. + below. Click "Save" to save the out sequence configuration. Finally on the wizard + click "Finish". </p> <p/> <p> - <img alt="Out sequence editor" src="images/out_sequence_editor.png"/> - </p> - <p/> - <p> - Next we are going to specify a WSDL for this proxy service. It can be - displayed using the ?wsdl operation with an actual service. Click on the - "Advanced" button to access the advanced configuration options. The first - page displays the transport configuration options. You can see that our - proxy service is exposed on both HTTP and HTTPS transports by default. - Click Next to view the next page. It displays the QoS configuration for - this proxy service. We do not worry about these things at this stage. So - just click Next to skip this. Next is the miscellaneous configuration - shown below. Click on the button next to the Specify WSDL label. Select - "Specify URL" in the displayed submenu. You will be prompted with a text - box to enter the URL of the WSDL. Type - file:repository/conf/sample/resources/proxy/sample_proxy_1.wsdl and click - Finish to complete the proxy service configuration. You will be directed - to the Manage Proxy Services page with the newly created proxy service - listed. - </p> - <p/> - <p> - On the Manage Proxy Services page you will see the actions that can be + Now on the services listing page you will be able to see the newly created + proxy service. Click on the service name link to enter the service dashboard. + On the service dashboard page you will see the actions that can be performed on our new proxy service. Enable the statistics and tracing for the proxy service by clicking on the appropriate icons. </p> <p/> <p> - <img alt="Manage proxy services" src="images/manage_ps.png"/> + <img alt="Manage proxy services" src="images/proxy.png"/> </p> <p/> <p> @@ -654,24 +633,16 @@ As with the previous message mediation sample, you will be able to monitor log messages, trace messages, and statistics for the proxy services based mediation. We will look only at the statistics section, which is going to - be different from the previous sample. Click Statistics. You will be + be different from the previous sample. Click Mediation Statistics. You will be directed to the overall statistics page. </p> <p> - <img alt="Overall statistics" src="images/ps_stats.png"/> - </p> - <p> Note that two messages were mediated through proxy services. To get more information about proxy service statistics click on the Proxy Service Statistics Summary link in the top right box. You will see the summarized statistics for the StockQuoteProxy service, we have created in this example. </p> - <p/> - <p> - <img alt="Proxy services statistics" src="images/ps_stats2.png"/> - </p> - <p/> <p> This quick guide illustrates the visual construction of a proxy service and a simple use case. Please refer to samples #150 and above in the _______________________________________________ Esb-java-dev mailing list [email protected] https://wso2.org/cgi-bin/mailman/listinfo/esb-java-dev
