Simple step-by-step guide for creating web service WSDLs for WCC 11g OOTB

06 / 17 / 2018
Andrew Blackman

WSDL web service Generation Guide for Oracle WebCenter Content 11g

Objective:

This document serves as a step-by-step guide to creating WSDL web service for Oracle WebCenter Content 11g OOTB and custom services.

Prerequisite:
a. Please make sure the ‘WsdlGenerator’ component is installed and enabled on the content server.
b. Please ensure that your account has the admin role on the content server to access the ‘Administration’ Menu.

Service used as an example: GET_DISPLAY_FIELDS

GET_DISPLAY_FIELDS Service Info*:

Service that returns information about custom metadata fields for different Content Server pages. This information can be used by front-end clients to render custom metadata fields.

The service requires an action which maps to a specific Content Server page. The service then returns metadata information for that page.

The service also provides support to generate Dynamic Choice List (DCL) options and Dynamic Tree.

WSDL Generation Framework:

1. Create new WSDL:

Log on to the WCC content server with the user that has admin credentials.
Go to ‘Administration’ -> Click on ‘SOAP WSDLs’. (Figure 1)
On the ‘WSDL List**’ page that opens, on top right, expand ‘Actions’. (Figure 2)
Click on ‘Add WSDL’. (Figure 3)
Enter WSDL Name (mandatory) and Description (obligatory). (Figure 4)
Click on ‘Add’

2. Create DataList (Optional):

We can consolidate all the data types/fields required by a ResultSet in a DataList. Data Lists are defined once but can be referenced multiple times with different WSDLs and services.
Steps as follows:

On the ‘WSDL List**’ page, on top right, expand ‘Actions’ drop-down menu.
Click on ‘Data Lists’
On top right, expand ‘Actions’
Click on ‘Add Data List’
Enter Data List Name (mandatory) and Description (obligatory).
In the Data List Elements section, enter the ‘Name’ (mandatory), ‘Type’ (mandatory) and ‘IdcName’(obligatory).
Click on Update.

3. Create ‘Complex’ Types:

We need to create a ‘Complex’ for every ‘ResultSet’ included in the service response. (In this case: ‘DisplayFieldInfo’, ‘DisplayGroupInfo’, ‘xFieldName.options’ being the 3 ‘ResultSet’s’ returned by the service).
Steps as follows:

1. On the ‘WSDL Information’ page, on top right, expand ‘Actions’ drop-down menu.
2. Click on ‘Add Complex Type’. Figure 6)
3. Enter WSDL ‘Name’ (mandatory) and ‘Type’ (mandatory, from the list of options: ‘resultset’, ‘container’). (Figure 7)
4. Click on ‘Add’.

4. Edit ‘Complex’ Types:

In the complex we can either add the response fields individually or we can just add the ‘Data List’ which is a collection of all the response parameters for a ‘ResultSet’. (Figure 8)
Steps as follows:

On the ‘WSDL Information’ page, in the ‘Complex Types’ section, Click on ‘Edit’ for the required ‘Complex’ Type.
Add the response fields/metadata returned by service by entering the ‘Name’, ‘Type’ and ‘IdcName’ (obligatory). (Figure 9, 10, 11)
OR
Add the ‘Data List’ name with the corresponding type which begins with ‘d:’, for instance: ‘d:CommonDocMetaFields’.

5. Create New Service:

On the ‘WSDL Information’ page, on top right, expand ‘Actions’ drop-down menu.
Click on ‘Add Service’. (Figure 12)
Enter ‘Name’ (mandatory) and ‘IdcService’ (mandatory). (Figure 13)
Click on ‘Add’.

6. Update Request Parameters:

On the ‘WSDL Information’ page, on top right, expand ‘Actions’ drop-down menu.
Click on ‘Update Request Parameters’. (Figure 14)
Add the request fields/metadata required by the service by entering the ‘Name’, ‘Type’ and ‘IdcName’ (obligatory). (Figure 15)
Click on Update.

7. Update Response Parameters:

On the ‘WSDL Information’ page, on top right, expand ‘Actions’ drop-down menu.
Click on ‘Update Response Parameters’. (Figure 16)
Add the ‘Complex’ Types defined earlier for all ‘ResultSets’ returned by the service. (Figure 17)
Click on Update for all sections.

8. Generate WSDL: