Copyright © Cloud Software Group, Inc. All Rights Reserved

WSDL

Resource

A WSDL file is an XML instance of the WSDL XML Schema, found at http://schemas.xmlsoap.org/wsdl/. A WSDL resource is composed of a series of definitions that describe the format and roles of messages used in web services. To create a new WSDL resource (with an empty set of definitions), drag the WSDL icon from the palette panel into the project panel. Once the WSDL resource has been created and selected in the project, the key components of abstract WSDL definitions — messages, portTypes, and operations — become available in the WSDL palette.

Configuration

The configuration panel is accessible when working in the model view (which loads by default). The fields in the Configuration tab are described below.

Field	Description
Resource Name	This is the name of the file when persisted. The *.wsdl suffix will be automatically added.
Description	Short description of the activity. This field is optional.
Target Namespace	This is the target name space of the WSDL document. This field will be populated by default with an example target namespace (http://xmlns.example.com). It is recommended that you enter a unique and meaningful namespace for each WSDL file. (In the WSDL source, this field represents the value of the targetNamespace attribute on the definitions element.)
Definition Name	A name for the definitions. Entries in this field are optional. Names must begin with a letter and may contain numbers, underscores, dashes, and periods. (In the WSDL source, this field represents the value of the name attribute for the definitions element.
Copy From URL	Once a new WSDL resource has been added to the project, you can copy the definitions of an existing WSDL file. To do so, enter the URL of the existing WSDL file to the Copy From URL field. Click Copy URL to retrieve the WSDL file and make a copy in the project. Once the copy is complete, all of the WSDL definitions are visible and editable. For example, if your WSDL file is located on the local MS Windows machine, you can use a URL like file:///c:/wsdl/order.wsdl. Instead of using this field, if you have the source code of your WSDL file, you can also copy it onto the clipboard and click the Display Source View button (see Toolbar for a description of toolbar buttons). You can then paste the source of your WSDL into the source window. To locate a WSDL file by browsing a WSIL or UDDI registry, use the Browse UDDI button. (See Copying WSDL Definitions for a description of the browsing interface.) Once the WSDL file has been selected, click Copy URL. Warning: The Copy URL and Browse UDDI buttons add the WSDL from the external resource once. There is no refresh option. If the external WSDL file changes, the Copy URL must be performed again.

Toolbar

When a WSDL resource, or one of its components, is selected in your project, four extra buttons appear on the toolbar. These buttons are described in Table 11.

Table 11 WSDL toolbar buttons

Button	Description
	Opens the model view. The model view is the default view so, by default, this button is inactive. For more information on the model view, see Editing WSDL Resources.
	Opens the content view. For more information on the content view, see Editing WSDL Resources.
	Opens the source view. For more information on the source view, Editing WSDL Resources.
	Checks changes made in the content view to verify that the WSDL resource conforms to the WSDL schema. Errors are reported in an errors panel, which is displayed at the bottom of the content view.

Editing WSDL Resources

The key components (elements) of an abstract WSDL file are messages, portTypes, and operations. Three different views are available when editing the base WSDL file or one of its components. These editing views, accessed using the toolbar buttons (see Table 11) are described below.

View	Description
Model	This is the default view. • When a WSDL resource is selected, the Configuration tab provides fields for setting document level properties as well as an interface for copying existing WSDL definitions. For more information, see Configuration). To add a Message or PortType component to the WSDL resource, drag the representative icon from the WSDL palette into design panel. The Message and PortType components can then be selected and edited. • When a Message component is selected in the project, the Configuration tab provides fields for naming and describing the component and a table for adding part components. For more information, see Message. • When a PortType component is selected, the Configuration tab provides fields for naming and documenting the PortType component. For more information, see PortType. To add an Operation component to the PortType, drag the representative icon from the WSDL palette into the design panel. The Operation component can then be selected and edited. • When an Operation component is selected, the Configuration tab provides fields for naming and describing the component and a table for specifying the messages to be used as input and output. For more information, see Operation. Note: The WSDL palette’s model view enables the creation of an “abstract” WSDL file that may be used in a web service where additional SOAP endpoints and binding information will be added. To specify binding and endpoint information in the WSDL file, use the content or source view.
Content	The content view provides a tabular view of the WSDL file, with the components (elements and attributes) of the WSDL file listed on the left, and the component values listed on the right. The content view provides access to all of the elements and attributes used to build WSDL files, which appear as choices on the factory bar located at the bottom of the view. The content view is useful when viewing concrete WSDL files or when you need to add elements to your resource that are not available in the model view - such as binding or service elements. The Content view provides the same editing environment used to create XML instance resources. For details on the content view, review the documentation for the Instance resource, in TIBCO Designer Palette Reference.
Source	The source view allows you to edit the source code of your document directly. If you are comfortable with WSDL syntax, editing directly in the WSDL source may be useful. To make the other panels reflect the changes you've made in the source, click 'Reparse' at the top of the panel. Any errors found upon reparse will be reported.

Copying WSDL Definitions

To copy the definitions of an existing WSDL file, you must first add a new WSDL resource to your project. If you know the location of the WSDL file you want to copy, enter the URL into the Copy From URL field and click Copy URL. The definitions from the external file will be copied into your WSDL resource.

If you are not sure of the location of the WSDL file, a WSIL and UDDI Registry Browser is provided, enabling you to browse well-known WSIL and UDDI directories. To access the browser, click Browse UDDI.

Use the radio buttons at the top of the browser to indicate whether you want to browse a WSIL directory or a UDDI registry. For the selected registry type, you can type in the location of the registry you want to browse in the field adjacent to the radio buttons or you can use this field’s drop down menu to select from a list of popular registries, as shown in Figure 27.

Figure 27 Specifying a UDDI registry

Once you have selected the registry to browse, use the Search Details section to select the type of services you want to browse. The Search Details section has the following fields.

Field	Description
Search Type	Use this field to specify the facet you want to use to locate the WSDL file. When browsing a WSIL registry, searches are conducted based on service name only. When browsing a UDDI registry, see Table 12 for a description of the available search types.
Search Term	To filter the registry’s services, enter a search term corresponding to the facet selected in the Search Type field.
Max Rows	Specify the number of services you would like to be returned.
Case-sensitive	Indicate if the case of the search term should be considered when locating services.
Order Asc.	Indicate if the results should be ordered ascending. (Files are returned in descending order by default.)
Exact Match	Indicate if the search term must be matched exactly.
Timeout (msec)	Specify the amount of time permitted before a search is aborted.

 

Table 12 UDDI search types

Search Type	Description
Service Name	In the Search Term field, specify a service name.
Business Name	In the Search Term field, specify business name.
Business Key	In the Search Term field, specify a uuid key for a business.
TModel Key	In the Search Term field, specify a uuid key for a tmodel.
ALL WSDLs	In the Search Term field, specify a service name. TModels of type wsdlSpec will be searched.
NAICS	In the Search Term field, specify a NAICS number. For more information, see http://www.naics.com.
ISO 3166	In the Search Term field, specify the code for a particular country. For a list of ISO 3166 codes, see http://www.iso.org/iso/en/prods-services/iso3166ma/02iso-3166-code-lists/list-en1.html
D-U-N-S	In the Search Term field, enter the nine digit D-U-N-S number. For more information, see http://www.dnb.com.
Geo Web	In the Search Term field, enter a Microsoft geoweb classification. For example, the value 514267 would return businesses from London.
SIC Code	In the Search Term field, enter the four digit SIC code. For more information, see http://www.siccode.com.
UNSPSC	In the Search Term field, enter a UNSPSC code. For more information, see http://eccma.org/unspsc/.

Depending on the Search Type specified in the Search Details, either the Get Services or Explore buttons will become active. The Explore option returns a list of company names matching the search criteria, such as the companies with a particular NAICS or SIC code. (To see the services provided one of the companies on the list, select the company and click Get Services.) The results returned by the Explore button are shown in Figure 28.

Figure 28 Companies returned by the Explore button

The Get Services option displays the WSDL files matching the search criteria in the table below the Search Details section, as shown in Figure 29.

Figure 29 List of returned services

From the list of returned WSDL files, highlight the file you want to copy and click OK. The URL for the service will appear in the Copy From URL field of the Configuration tab of the WSDL resource. Click Copy URL. The definitions from the external file will be copied into your WSDL resource.

External References

WSDL or XSD on an HTTP network location can be imported in a local WSDL without physically importing them into the project repository. These external references are restricted to imports only, that is, <wsdl:import> and <xsd:import> elements from WSDL and XSD namespaces, respectively.

Changes made to the external references are included automatically. This behavior is the same as with any locally imported WSDL or XSD.

The property java.property.com.tibco.xml.tns.parse.ImportSpecialResolution should be set to true in designer.tra to enable external WSDL support.

Copyright © Cloud Software Group, Inc. All Rights Reserved