The Configuration View provides context based interfaces to
|
All WebService related functions. A WebService is the SOA Gateway definition exposing an Adabas file, ODBC table etc. to the world.. |
|
The DataViews , XML schema files (XSDs) and Stylesheets (XSLs) available on the target server. |
on any WebService name in the Server Configuration View's 'WebServices' tab to bring up the context menu.
In addition to the context menu, a number of functions are also available from the Views toolbar.
Note: All functions will make 'published' changes to WebService(s) available within a running SOA Gateway server immediately, but these changes are only preserved over a server restart when the configuration is either saved manually, or the server is defined with the "autosave" option.
| Function | Description |
|---|---|
| refresh WebService | 'Refresh' a WebService to purge its cache entry from the server. |
| edit DataView | Edit the DataView associated with the selected WebService. |
| Filter displayed WebService | Set filter criteria for the Configuration View WebService display. |
| add WebService | Add a new WebService |
| duplicate WebService | Duplicate a WebService, use definitions of an existing WebService as the basis for one to be created. |
| Copy WebService definitions to other server(s) | Copy selected WebService(s), including all associated resource files (XRD / XSD / XSL), to one or more other server(s). |
| import Dataview | Import a DataView ( WebService data layout description ) |
| export Dataview to server | Export a DataView ( WebService data layout description ) |
| remove WebService | Remove a WebService from a SOA Gateway Server Configuration |
| Generate wrapper code | Generate a Java wrapper, based on the Axis2 framework, for a WebService. |
| UDDI Register WebService (via JAXR or SOAP) | Register a datasource - a WebService - with a UDDI Business Registry |
| Show WSDL | Opens the WSDL for the selected WebService in a browser window. |
| Create PHYSICAL Resource | Create a Resource (Adabas file, ODBC table etc.), physically, based on the SOA Gateway Definitions. |
| Delete PHYSICAL Resource | Physically delete a Resource (Adabas file etc.) pointed to by a SOA Gateway WebService. |
| ReplicateWebService | Duplicate the WebService definition(s) and (optionally) create a physical copy of the original WebService's resources. |
When parameters of a WebService definition have been changed, the context menu will change as follows
| Function | Description |
|---|---|
| Publish all configuration modifications | Send ALL modifications for all changed WebServices to the server at once |
| Publish WebService modifications | Only modifications for the selected WebService are published, i.e. sent to the server. |
The second tab, 'DataViews / XSDs / XSLs' provides an import function for these WebService Definition file types, more information is given here.
The WebService filtering function allows the display to be limited by WebService name and/or WebService type.
Select the filter function from either the context menu or View toolbar
Enter a WebService name pattern and/or select one or more drivers from the displayed list to limit the WebService display to those mathcing the criteria.
Valid WebService name patterns:
A fully specified name to limit to a single WebService
*<WebService name pattern> for an 'ends with' condition (e.g. *ees will match 'Employees', 'Trainees' etc.)
<WebService name pattern>* for a 'starts with' condition (e.g. ada* will match 'adabas_Employees', 'adatest' etc.)
*<WebService name pattern>* for a 'contains' condition (e.g. *lo* will match 'Employees', 'globals' etc.)
Click the 'Save' button to apply your selection, or 'Cancel' to leave without changing the previously selected criteria.
Click on the WebService name in the Configuration View, modify the WebService definition in the Properties View. Modified WebServices will be indicated by an information icon in the 'Mod'(ified) column. Modifications stay local until one of the is executed.
Important:
Changing the WebService Name will rename the
WebService.
Select the function from the context menu, a new WebService named "*new" will be added, modify the definition as follows, then .
The following definition elements are required to describe an Adabas file to the SOA Gateway:
Name: The WebService name which is used to identify the Adabas file to the outside world.
A WebService is accessible by its URI http://<your_server>/<WebService_name> When retrieving the WSDL for a SOA Gateway URI, append the string "?WSDL" to the above URI.
The URI is preformatted in the 'WSDL URL is' field, either select it, then right-click and copy it, or double-click it to open a browser window and display the WSDL.
Data View: Points to the XRD (and implicitely the XSD with the same name) describing the structure of the Adabas file, enter its name or select from the dropdown-box.
WebService Identification and options: provide the actual pointer to the Adabas file being accessed through the "Database Id" and "File Number" parameters.
The Adabas "FileName" and "MaxIsn" fields in the 'WebService Meta Information' section are used for the "create WebService" function which physically creates the Adabas file, based on the SOA gateway DataView definitions, on the Dbid / File number specified for the WebService.
Select one of the functions from the Configuration View context menu to publish the newly created WebService to the SOA Gateway server.
Select the duplicate WebService function, this will create a WebService named "Copy_of_<original_WebService_name>" and bring up a the Properties for the newly created item, prefilled with the definitions of the WebService specified as the input for duplication. The WebService name will be preset to copyOf_<original_WebService_name>. Make changes as required and the duplicated WebService.
Select the copy WebService definitions to other server(s) to transfer entire WebService definitions, including their resource files (DataView / XSD / XSL), to one or more other servers.
Select the target server(s) and click .
Successful execution of the copy operation will be indicated by a message in the SOA Gateway Action Log
Double-click the log entry to see the details
When a copy operation is initiated for a WebService using a driver name not known on the target system, the following prompt will offer a list of drivers of the same type, select one and click , when is selected the current WebService will not be copied, this fact is also documented in a SOA Gateway Action Log entry.
Select the remove WebService function from the context menu to delete a WebService from the server configuration. You will be requested to confirm the deletion:
Important:
The WebService is only deleted from the configuration currently
active ("live") within the SOA Gateway server, to remove it permanently the
configuration has to be saved (written to disc).
Select the import DataView function from the context menu to import the physical layout description (DataView) into the Eclipse workspace for editing, archiving etc.
Select the workspace folder where the imported DataView is to be stored, click .
The import will be confirmed by a message in the status line:
The imported DataView appears, with an extension of ".xrd", at the selected location:
Select the export DataView function from the context menu to export the physical layout description (DataView) to the SOA Gateway server.
Select the DataView (.xrd) file to be exported, click
You are now asked if the exported DataView is to be activated immediately (answer ) or after the SOA Gateway server is restarted (answer )
The export will be confirmed by a message in the status line:
Java wrapper/stub classes are generated using the Apache Axis2 feature WSDL2Java.
SOA Gateway WebServices, which are essentially "WebServices", can be registered with an UDDI Business Registry, for example Software AG's Centrasite, so that any UDDI enabled client application can find an exposed service, retrieve its signature, issue requests agains it etc.
These are the steps required to register a WebService with an UBR:
Define a UDDI Business Registry to the SOA Gateway Control Center (from the SOA Gateway Eclipse Preferences dialog)
Select the function from the context menu
Select one of the predefined UDDI Business Registries, enter the user credentials required to be able to publish
Select a Business registered with the UDDI Registry for the selected account, click to continue
After successful completion of the registration process the service and tModel registry keys will be shown
Click
A physical Adabas file can be created from a SOA Gateway WebService definition.
For this to work, the WebService in question must have the "File-name" and "Max. ISN" parameters set, the "DbId" and "FileNr" parameters will be used.
Select the create Resource function from the context menu, successful creation will be indicated by a message in the status line
The ADABAS file has been created on the target database.
A physical Adabas file linked to a SOA Gateway WebService can be deleted from a SOA Gateway Control Center.
Select the delete Resource function from the context menu, you will be asked to confirm the deletion
As the Resource (the Adabas file) will be deleted physically from the database, you will be asked to confirm a second time.
Successful deletion will be confirmed by a message in the status line.
A physical copy of a WebService's resources (for example an Adabas file) can be created based on the SOA Gateway definitions.
Select the Replicate WebSerice function from the context menu
You will be asked on which server the copy will be created, and which driver is to be used to create the copy. Click after having selected the required information.
Specify all required parameters required to define the WebService on the target server. Check the "Replicate data as well ?" box in case you want the WebService's data to be copied in addition to the definition. Click
Specify key criteria, this allows you to specify if all, or just a subset, of the data on the "source file" is to be copied. For example, to copy the entire Adabas "Employees" demo file:
Click
The following dialog indicates the amount of data to be copied, start the copy process by clicking , or click and either refine the key criteria, or abendon the copy altogether.
Note:
At that point the physical Adabas fine has already been allocated on
the target database, and will not be deleted automatically, even if the actual
data replication is not carried out.
The following dialog indicates the progress of the replication process
Successful completion of the copy process is indicated by a message at the top of the replication dialog. Click to dismiss the Replication dialog.
When modified WebService definitions files (DataView or XSD) are exported to the SOA Gateway server, WebService(s) using these file(s) may need to be 'refreshed' on the server to pick up the modifications.
Select the Refresh a WebService function from the context menu.
When one or more WebService Definition elements are selected on the 'DataViews / XSDs / XSLs' tab, the 'Import WebService Definition(s) from server' context function, the following import detail dialog will be presented:
Specify the destination folder, or click the 'Browse' button to select it from a file-chooser.
Select the DataView(s), XSD(s), XSL(s) to be imported.
Click 'Import' to execute the import.
