Return to main navigation Page
This topic discusses Web Services 2.0. For information on Web Services 1.0, see WSDL Overview with Web Services 1.0.
Web Services Description Language (WSDL), provides a way to dynamically generate the interface for SOAP interactions. With this interface, you can define and make changes to their product, configuration, and commerce details and easily generate an interface reflecting the latest changes.
The generated WSDL can then be used to generate a SOAP message using standard open source tools including ApacheWSDL2Java. The SOAP interaction can be automated using the generated WSDL.
Types of WSDL
|Generic||Basic description of interface, common across clients||
The Generic WSDL is based on the abstract interface design, which is independent of any configuration done by FullAccess user of a particular client.
This WSDL remains common across all the clients and represents the basic structure of the SOAP message. It can be used for interaction between SOAP server and the client.
The SOAP message generated based on this WSDL cannot be used directly to perform any operation, but it is useful for understanding the basic SOAP message structure and explaining the client's SOAP functionality.
|Specific (Module-based)||Interface description used to send SOAP message. Varies with changes by FullAccess user.||
The Specific WSDL varies for each client, based on their own specified setup. This includes parts, commerce, and other modules.
This WSDL is used for generating the SOAP message and communication between the SOAP server and the client.
Note: Regenerate this WSDL when changes have been made to the modules it affects.
WSDLs per Module
Whenever you makes changes in the following areas, the corresponding WSDL must be regenerated. Look at the table below to understand WSDL regeneration for individual sections.
Generic WSDL: The high level WSDL is independent of any defined processes. Therefore, the <document> and <attribute> elements within it will not be defined.
Since other elements are common for all processes and already defined in CPQ Cloud, the WSDL generates the SOAP message without the document attributes.
Specific WSDL: This concrete WSDL is process-specific, and specifies the document attributes of various documents and sub-documents defined by FullAccess user in a Commerce Process. One concrete WSDL will be generated per Commerce Process defined.
This WSDL is automatically generated every time a Commerce Process is deployed.
Following the commerce approach, configuration has a common high level and concrete WSDL. For deployed segments, the WSDL is automatically generated at the time of deployment. For the non-deployable segments, the WSDL can be generated manually from the web services section.
Note: For deployable segments, the WSDL cannot be generated from the Generate WSDL page.
Generic WSDL: This WSDL is independent of any administration set up, and shows all the available fields of custom attributes, whether they are used or not. This way, the WSDL remains independent of any given configuration and can be used to generate a SOAP message, since custom fields that are not used are not considered.
Specific WSDL: This concrete WSDL will change based on the number of custom attributes defined by each FullAccess user. Every time the FullAccess user modifies and deploys custom attributes, the WSDL regenerates. This WSDL only defines the custom attributes that are used. This WSDL also specifies the properties of the custom attributes, as defined by the FullAccess user, such as whether this attribute is required, if it is a menu type item, and so on.
|Price Book Associations||
This WSDL is available by default. Regenerate this WSDL only when a company’s base information is modified Regenerate this WSDL only when a company's base information is modified (for example, supported languages, supported currencies, and so on).
Generic and Specific WSDLs are the same for Price Book Associations.
Generic WSDL: The high level or generic WSDL will be common across all different tables. To retain the generic property of this WSDL, all the default DB column names of BM_SCRIPT_TABLE are made XML elements.
This makes the WSDL independent of any table and describes the basic SOAP message structure of different operations of the Data Tables Service.
Specific WSDL: For each table, a different WSDL needs to be generated representing the specific columns of that table. The WSDL is automatically generated whenever the table definition is modified.
If a table does not have any rows, a row must be added and the table definition updated, before the WSDL can be generated. The current SOAP message structure will be similar to the SOAP request and the responses generated from a given concrete WSDL of a given table.
|Exchange Rates||Generic WSDL|