Previous Next JavaScript must be enabled to correctly display this content

## 26.5 Managing Legacy Web Services

Legacy Web services enable applications to interact with one another over the web in a platform-neutral, language independent environment.

Note:

The SOAP 1.1 specification is a W3C note. SOAP Version 1.2 specification is a W3C recommendation.

For information about Simple Object Access Protocol (SOAP) see:

    http://www.w3.org/TR/SOAP/

- About Legacy Web Services
  Learn about legacy Web services.
- Creating Legacy Web Service References
  Learn about creating legacy Web service references.
- About Working with SSL Enabled Legacy Web Services
  Learn about working with SSL enabled legacy Web services.
- Creating Legacy Web Service References Based on a WSDL
  Learn about creating legacy Web service references based on a WSDL.
- Creating Web Service References Manually
- Creating Legacy RESTful Web Service References
  Learn how to create legacy RESTful Web service references.
- Using the Legacy Web Service Reference Repository
  Learn about the legacy Web Service Reference Repository.
- Creating an Input Form and Report on a Legacy Web Service
  Learn how to create an input form and report on a legacy Web service.
- Creating a Form on a Legacy Web Service
  Learn how to create a form on a legacy Web service.
- Creating a Report on a Web Service
- How to Invoke a Legacy Web Service as a Process
  Learn how to invoke a legacy Web service as a process.
- Viewing a Legacy Web Service Reference History
  View a history of Web service reference changes.

Parent topic: Managing Application Legacy Components

### 26.5.1 About Legacy Web Services

Learn about legacy Web services.

In a typical Web services scenario, a business application sends a request to a service at a given URL by using the protocol over HTTP. The service receives the request, processes it, and returns a response. You can incorporate calls with external Web services in applications developed in App Builder.

Web services are typically based on Simple Object Access Protocol (SOAP) or Representational State Transfer (REST) architectures. SOAP is a World Wide Web Consortium (W3C) standard protocol for sending and receiving requests and responses across the Internet. SOAP messages can be sent back and forth between a service provider and a service user in SOAP envelopes. RESTful Web services are resource oriented. The scope of the Web service is found in the URI and the method of the service is described by the HTTP method that is used such as GET, POST, PUT, HEAD, and DELETE.

SOAP offers two primary advantages:

- SOAP is based on XML, and therefore easy to use.
- SOAP messages are not blocked by firewalls because this protocol uses simple transport protocols, such as HTTP.

REST offers similar advantages:

- REST messages are also not blocked by firewalls because this protocol uses the HTTP protocol.
- REST requests do not require the overhead of XML and SOAP envelopes and inputs are typically provided in the URI.

See Also:

Enabling Network Services in Oracle Database

Parent topic: Managing Legacy Web Services

### 26.5.2 Creating Legacy Web Service References

Learn about creating legacy Web service references.

Note:

Creating a legacy Web service reference is only supported for applications that already have them.

To use Web services in APEX, you create a Web service reference using a wizard. Web service references can be based on a Web Services Description Language (WSDL) document, RESTful style, or created manually by supplying information about the service.

- Accessing the Web Service References Page
- Specifying an Application Proxy Server Address

See Also:

- Creating Legacy Web Service References Based on a WSDL
- Creating Web Service References Manually
- Creating Legacy RESTful Web Service References

Parent topic: Managing Legacy Web Services

#### 26.5.2.1 Accessing the Web Service References Page

You manage Web service references on the Web Service References page.

To access the Web Service References page:

1. Navigate to the Shared Components page:
   1. On the Workspace home page, click App Builder.
   2. Select an application.
   3. On the Application home page, click Shared Components.

      The Shared Components page appears.

2. Under Data Sources, click Legacy Web Service References.

   The Web Service References page appears.

Parent topic: Creating Legacy Web Service References

#### 26.5.2.2 Specifying an Application Proxy Server Address

If your environment requires a proxy server to access the Internet, you must either specify a proxy server address on the Application Attributes page, or your instance administrator must define an instance proxy, before you can create a Web service reference.

To specify a proxy address for an application:

1. On the Workspace home page, click the App Builder icon.

   The App Builder home page appears.

2. Select an application.

   Application home page appears.

3. Click Edit Application Definition.
4. Under Properties, enter the proxy server in the Proxy Server field.
5. Click Apply Changes.

Parent topic: Creating Legacy Web Service References

### 26.5.3 About Working with SSL Enabled Legacy Web Services

Learn about working with SSL enabled legacy Web services.

Secure Sockets Layer (SSL) is an industry standard protocol that uses RSA public key cryptography with symmetric key cryptography to provide authentication, encryption, and data integrity.

If the Web service that you need to interact with is SSL-enabled (that is, `https` displays in the URL to the Web service), you must create a wallet and configure APEX to use the wallet. A wallet is a password-protected container that stores authentication and signing credentials (including private keys, certificates, and trusted certificates) needed by SSL.

See Also:

Configuring Wallet Information in Oracle APEX Administration Guide

Parent topic: Managing Legacy Web Services

### 26.5.4 Creating Legacy Web Service References Based on a WSDL

Learn about creating legacy Web service references based on a WSDL.

You can create Web service reference based on a Web Services Description Language (WSDL) document.

- About Creating Web Service References Based on a WSDL
- Creating a Web Service Reference by Specifying a WSDL Document
- Testing a Web Service Reference Created from a WSDL

Parent topic: Managing Legacy Web Services

#### 26.5.4.1 About Creating Web Service References Based on a WSDL

Before you create a Web service reference based on a WSDL, you must decide how to locate the WSDL. You locate a WSDL by entering the URL to the WSDL document.

You then run a wizard which analyzes the WSDL and collects all the necessary information to create a valid SOAP message, including:

- The URL used to post the SOAP request over HTTP(S)

- A Universal Resource Identifier (URI) identifying the SOAP HTTP request

- Operations of the Web Service

- Input parameters for each operation

- Output parameters for each operation

Parent topic: Creating Legacy Web Service References Based on a WSDL

#### 26.5.4.2 Creating a Web Service Reference by Specifying a WSDL Document

To create a Web service by specifying a URL to a specific WSDL document:

1. Navigate to the Web Service References page.
   1. On the Workspace home page, click App Builder.
   2. Select a existing application.
   3. On the Application home page, click Shared Components in the center of the page.
   4. Under Data Sources, select Legacy Web Service References.
2. Click Create.
3. For Web Reference Type, select Based on WSDL and click Next.
4. If prompted to search a UDDI registry to find a WSDL, click No then Next.
5. In WSDL Location, enter the URL to the WSDL document.
6. For Username, enter the username required to access the WSDL.
7. For Password, enter the password required to access the WSDL.
8. Click Next.

   The Web Service Details page appears.

9. For Basic Authentication, select:

   - No - Select this option if authentication credentials are not sent as part of the HTTP request.

   - Yes - Select this option if authentication credentials are sent as part of the HTTP request. Web services that employ basic authentication usually also use the HTTPS (SSL) protocol since the username and password are sent in clear text.

10. Click Create Reference.

    The Web service reference is added to the Web Service References Repository.

11. On the Create page, the following selections are available:

    - View Web Service References - Select to go to the Web Service Reference page.

    - Create Form on Web Service - Select to create a Form for this Web Service Reference.

    - Create Form & Report on Web Service - Select to create a Form and Report for this Web Service Reference.

Parent topic: Creating Legacy Web Service References Based on a WSDL

#### 26.5.4.3 Testing a Web Service Reference Created from a WSDL

After you have created a Web service reference, you can test it on the Test Web Service Reference page.

To test a Web service reference:

1. Navigate to the Web Service References page.
   1. On the Workspace home page, click App Builder.
   2. Select a existing application.
   3. On the Application home page, click Shared Components in the center of the page.
   4. Under Data Sources, select Legacy Web Service References.
2. Select the View Report icon.
3. Click the Test icon for the Web Service reference you want to test.

   The Test Web Service Reference page appears. The Web service name and URL endpoint display at the top of the page.

4. From Operation, select an operation (that is, the method to be executed).
5. Under Input Parameters, enter the appropriate values.
6. Click Test.

   The message request and response appear at the bottom of the page under Messages.

See Also:

Accessing the Web Service References Page

Parent topic: Creating Legacy Web Service References Based on a WSDL

### 26.5.5 Creating Web Service References Manually

You can create a Web service reference manually.

- About Creating Web Service References Manually
- Creating a Web Service Reference Manually
- Testing a Web Service Reference Created Manually

Parent topic: Managing Legacy Web Services

#### 26.5.5.1 About Creating Web Service References Manually

When you create a Web service reference manually, you supply the necessary information to create a valid SOAP request, including:

- The URL used to post the SOAP request over HTTP(S)

- A Universal Resource Identifier (URI) identifying the SOAP HTTP request

- The SOAP envelope for the request, including any item substitutions

- Optionally the name of a collection to store the response from the Web service

Parent topic: Creating Web Service References Manually

#### 26.5.5.2 Creating a Web Service Reference Manually

Creating a Web service reference manually adds it to Web Service References Repository.

To create a Web service reference manually:

1. Navigate to the Web Service References page.
   1. On the Workspace home page, click App Builder.
   2. Select a existing application.
   3. On the Application home page, click Shared Components in the center of the page.
   4. Under Data Sources, select Legacy Web Service References.
2. Click Create.
3. Select Manual and click Next.
4. On Create Web Service Reference:
   1. Name - Enter a name to identify the reference.
   2. URL - Enter the URL used to post the SOAP request over HTTP. This corresponds to the soap:address location of a service port in the WSDL.
   3. Action - Enter the intent of the SOAP HTTP request (optional). The value is a URI identifying the intent. SOAP places no restrictions on the format or specificity of the URI or requires that it is resolvable.
   4. Proxy - Enter a proxy to override the application proxy for this service.
   5. SOAP Version - Select 1.1 or 1.2.
   6. Basic Authentication - Choose whether the Web service requires authentication. Select Yes or No.
   7. SOAP Envelope - Specify the SOAP envelope to be used for the SOAP request to the Web service..

      Note:

      You can reference items from session state in the SOAP envelope by using `#ITEM_NAME#` syntax.

   8. Store Response in Collection - Enter the name of a collection to store the Web service response. The response will be stored in the CLOB001 column of the collection entered here.
   9. Click Create.

See Also:

Accessing the Web Service References Page

Parent topic: Creating Web Service References Manually

#### 26.5.5.3 Testing a Web Service Reference Created Manually

After you have created a Web service reference, you can test it on the Test Web Service Reference page.

To test a Web service reference:

1. Navigate to the Web Service References page.
   1. On the Workspace home page, click App Builder.
   2. Select a existing application.
   3. On the Application home page, click Shared Components in the center of the page.
   4. Under Data Sources, select Legacy Web Service References.
2. Select the View Report icon.
3. Click the Test icon for the Web Service reference you want to test.

   The Test Web Service Reference page appears. The Web service name and URL endpoint display at the top of the page.

4. If required, enter the username and password under Basic Authentication.
5. In SOAP Envelope text area, optionally edit the SOAP request envelope.
6. Click Test.

   The message request and response appear at the bottom of the page under Messages.

See Also:

Accessing the Web Service References Page

Parent topic: Creating Web Service References Manually

### 26.5.6 Creating Legacy RESTful Web Service References

Learn how to create legacy RESTful Web service references.

You can create a Representational State Transfer (REST) or RESTful web service.

- About Creating RESTful Web Service References
- Creating a RESTful Web Service Reference
- Testing a REST Web Service Reference

Parent topic: Managing Legacy Web Services

#### 26.5.6.1 About Creating RESTful Web Service References

RESTful Web services are resource oriented. The scope of the Web service is found in the URI and the method of the service is described by the HTTP method that is used such as GET, POST, PUT, HEAD, and DELETE. When you create a RESTful Web service reference, you supply the necessary information about the structure of the request and response including:

- A Universal Resource Identifier (URI) identifying the RESTful request

- The HTTP method identifying the method of the Web service

- HTTP Headers, if required, that are part of the request

- The type of input expected by the Web service

- The format of the response and how to identify the response parameters

Parent topic: Creating Legacy RESTful Web Service References

#### 26.5.6.2 Creating a RESTful Web Service Reference

To create a RESTful Web service reference:

1. Navigate to the Web Service References page.
   1. On the Workspace home page, click App Builder.
   2. Select a existing application.
   3. On the Application home page, click Shared Components in the center of the page.
   4. Under Data Sources, select Legacy Web Service References.
2. Click Create.
3. Select REST and click Next.
4. For REST Details, specify the following:
   1. Name - Enter a name to identify the reference.
   2. URL - Enter the URL endpoint of the Web service.
   3. Proxy - Enter a proxy to override the application proxy for this service (optional). This setting is overridden by the proxy setting for this instance.
   4. HTTP Method - Choose the http method used for the request to the Web service. Select GET, HEAD, POST, PUT or DELETE.
   5. Basic Authentication - Select Yes to require HTTP Basic Authentication. Otherwise, select No.
   6. REST HTTP Headers - Enter the names of the HTTP headers to send with the request.
   7. Click Next.
5. For REST Input parameters, specify the following:
   1. Name - Enter the name of the input parameter expected by the method.
   2. Type - Select the input type.
   3. Click Add Parameter.
   4. Repeat steps a though c for each expected input.
   5. Click Next.
6. For REST Output parameters, specify the following:
   1. Output Format - Select XML, Text or JSON for the response format expected from the Web service.
   2. XPath to Output Parameters (XML only) - Enter an XPath expression to the relevant part of the response.

      For example:

          /ListBucketResult/Contents

   3. Response Namespace (XML only) - Enter the namespace corresponding to the Response XPath.

      For example:

          http://s3.amazonaws.com/doc/2006-03-01/

   4. Parameter Delimiter (Text only) - Enter the character or sequence that separates parameters returned from the Web service. Use `\n` to indicate a new line and `\t` to indicate a tab character.
   5. New Record Delimiter (Text only) - Enter the character or sequence that determines a new record in a text response from the Web service. Use `\n` to indicate a new line and `\t` to indicate a tab character.
   6. Name - Enter the name of the output parameter returned by the method.
   7. Path - Enter the path. If the response is XML, the path is an XPath expression to the node. If the response is Text, the path is a number. If the response is JSON, the entire response is stored in the `CLOB001` column of a collection you specify.
   8. Type - Select the output type.
   9. Click Add Parameter.
   10. Repeat steps f though h for each returned output parameter.

   Note:

   Click Test to send a request to a RESTful Web service and see the response. This test process helps you specify the appropriate Output parameters.

7. Click Create.

The Create Web Service Reference Success page appears. The Web service reference is added to the Web Service References Repository.

See Also:

- Accessing the Web Service References Page
- Creating a Proxy Server for an Instance in Oracle APEX Administration Guide

Parent topic: Creating Legacy RESTful Web Service References

#### 26.5.6.3 Testing a REST Web Service Reference

After you have created a Web service reference, you can test it on the Test Web Service Reference page.

To test a Web service reference:

1. Navigate to the Web Service References page.
   1. On the Workspace home page, click App Builder.
   2. Select a existing application.
   3. On the Application home page, click Shared Components in the center of the page.
   4. Under Data Sources, select Legacy Web Service References.
2. Select the View Report icon.
3. Click the Test icon for the Web Service reference you want to test.

   The Test Web Service Reference page appears. The Web service name and URL endpoint display at the top of the page.

4. In the URL and Proxy Override fields, optionally edit the values for the test.
5. If required, enter the username and password under Basic Authentication.
6. Under HTTP Headers, enter appropriate values.
7. Under Input Parameters, enter appropriate values.
8. Click Test.

   The message response appears at the bottom of the page under Messages.

See Also:

Accessing the Web Service References Page

Parent topic: Creating Legacy RESTful Web Service References

### 26.5.7 Using the Legacy Web Service Reference Repository

Learn about the legacy Web Service Reference Repository.

Web service references are stored in the Web Service Reference Repository.

To access the Web Service References Repository:

1. Navigate to the Web Service References page.
   1. On the Workspace home page, click App Builder.
   2. Select a existing application.
   3. On the Application home page, click Shared Components in the center of the page.
   4. Under Data Sources, select Legacy Web Service References.

   The Web Service Reference page appears.

   A Search bar displays at the top of the page. Available controls include:

   - Search columns icon - Resembles a magnifying glass. Click this icon to narrow your search. To search all columns, select All Columns.

   - Text area - Enter case insensitive search criteria (wildcard characters are implied) and click Go.

   - Go button - Executes a search or applies a filter.

   - View Icons - Displays each Web service reference as a large icon. To edit a Web service reference, click the appropriate icon.

   - View Report - Displays each Web service reference as a line in a report.

   - Actions menu - Displays the Actions menu. Use this menu to customize the report view.

2. Click the View Report icon.
3. In report view you can:

   - Edit a reference by clicking the reference name.

   - Test a reference by clicking the Test icon.

   - View details about a reference by clicking the View icon. Note that this option is not available for manually created or REST Web service references.

See Also:

- Accessing the Web Service References Page
- About the Actions Menu

Parent topic: Managing Legacy Web Services

### 26.5.8 Creating an Input Form and Report on a Legacy Web Service

Learn how to create an input form and report on a legacy Web service.

- About the Create Form and Report on Web Service Wizard
- Creating a Form and Report by Adding a New Page

Parent topic: Managing Legacy Web Services

#### 26.5.8.1 About the Create Form and Report on Web Service Wizard

The Create Form and Report on Web Service Wizard creates an input form, a submit button, and a report for displaying results. You can execute this wizard directly after creating the Web service reference from a WSDL or a RESTful style Web service, or by adding a page.

Use this wizard when you expect a nonscalar result from the Web service. The Amazon Product API Web service is a good example. This Web service returns many results based on the search criteria entered in an input form.

Parent topic: Creating an Input Form and Report on a Legacy Web Service

#### 26.5.8.2 Creating a Form and Report by Adding a New Page

If you have an existing Web service reference, you can create an input form and report by adding a new page.

To create a form and report by adding a new page:

1. Create the Web service reference.
2. Select the application.
3. On the Application home page, click Create Page.
   Create a Page appears and features three tabs: Component, Feature, and Legacy Pages.
4. Click Legacy Pages and select Report and Form on Legacy Web Service.
5. For Choose Service and Operation:
   1. Web Service Reference - Select the Web service reference.
   2. Operation - Select the method to be executed. For RESTful style Web references, doREST is selected automatically. The Operation option does not appear for Manual style Web references.
   3. Click Next.
6. For Page and Region Attributes, review and update the page and region attributes and click Next.

   Note:

   If the page you specify does not exist, the wizard creates the page for you.
7. For Input Items:
   1. Identify which items to add to the form. To include an item, select Yes in the Create column. Otherwise, select No.
   2. If necessary, edit the Item Name.
   3. If necessary, edit the Item Label.
   4. Click Next.
8. If applicable, specify the Item Names and Item Labels for basic authentication, then click Next.

   Note:

   This step only appears if basic authentication was specified for this Web service reference when it was created.
9. Follow the on-screen instructions.
10. Click Create.

See Also:

- Creating Legacy Web Service References Based on a WSDL

- Creating Web Service References Manually

- Creating Legacy RESTful Web Service References

Parent topic: Creating an Input Form and Report on a Legacy Web Service

### 26.5.9 Creating a Form on a Legacy Web Service

Learn how to create a form on a legacy Web service.

- About the Create Form on Web Service Wizard
- Creating a Form by Adding a New Page

Parent topic: Managing Legacy Web Services

#### 26.5.9.1 About the Create Form on Web Service Wizard

The Create Form on Web Service Wizard creates a form and a submit button. You can execute this wizard after creating the Web service reference from a WSDL or on a RESTful style Web service, or by running the Create Page Wizard.

Use this wizard when you expect a scalar result from the Web service. A Web service that looks up a stock price is a good example because the input is a stock symbol and the output is the scalar value price.

Parent topic: Creating a Form on a Legacy Web Service

#### 26.5.9.2 Creating a Form by Adding a New Page

If you have an existing Web service reference, you can create a form based on a Web service reference by adding a new page.

To create a form by adding a new page:

1. Create the Web service reference.
2. Select the application.
3. Click Create Page.

   Create a Page appears.

4. Click Legacy Pages and select Form on Legacy Web Service.
5. For Page Attributes:
   1. Page Number - Select a page to contain the new form, or enter a new page number.
   2. Page Name - Specify a name for the page.
   3. Page Mode - Identify the page mode. To learn more, see field-level Help.
   4. Page Group - Identify the name of the page group you would like to associate with this page. Page groups help developers manage the pages within an application. To create a page group, enter the name. To use an existing page group, select the name from the list of values.
   5. Region Title - Select whether you want to use a breadcrumb navigation control on your page, and which breadcrumb navigation control you want to use.
   6. Breadcrumb - Enter a title for the region in which the form will appear.
   7. Click Next.
6. For Navigation Preference:
   1. Select how you want this page integrated into the Navigation Menu. To learn more, see field-level Help.
   2. Click Next.
7. For Choose Service:
   1. Web Service Reference - Select the Web service reference.
   2. Operation - Select the method to be executed. For RESTful style Web references, doREST is selected automatically. The Operation option does not appear for Manual style Web references.
   3. Click Next.
8. For Input Items, make these selections and click Next:
   1. Identify which items to add to the form. To include an item, select Yes in the Create column. Otherwise, select No.
   2. If necessary, edit the Item Name.
   3. If necessary, edit the Item Label.
9. If applicable, specify the Item Names and Item Labels for basic authentication and click Next.

   Note:

   This step only appears if basic authentication was specified for this Web service reference when it was created.
10. If applicable, specify the Item Names and Item Labels for basic authentication.

    Note that this step only appears if basic authentication was specified for this Web service reference when it was created.

11. For Output Items, make these selections and click Next:
    1. Identify which items to add to the form. To include an item, select Yes in the Create column. Otherwise, select No.
    2. If necessary, edit the Item Name.
    3. If necessary, edit the Item Label.
12. Click Create.

See Also:

- Creating Legacy Web Service References Based on a WSDL

- Creating Web Service References Manually

- Managing Pages in an Application

- Editing User Interface Attributes

Parent topic: Creating a Form on a Legacy Web Service

### 26.5.10 Creating a Report on a Web Service

If you have an existing Web service reference, you can create a report based on a Web service reference by adding a new page.

To create a report by adding a new page:

1. Create the Web service reference.
2. Select the application.
3. On the Application home page, click Create Page.
   Create a Page appears and features three tabs: Component, Feature, and Legacy Pages.
4. Click Legacy Pages and select Report on Legacy Web Service.
5. For Page Attributes:
   1. Page Number - Select a page to contain the new form, or enter a new page number.
   2. Page Name - Specify a name for the page.
   3. Page Mode - Identify the page mode. To learn more, see field-level Help.
   4. Breadcrumb - Enter a title for the region in which the form will appear.
   5. Click Next.
6. For Navigation Preference:
   1. Select how you want this page integrated into the Navigation Menu. To learn more, see field-level Help.
   2. Click Next.
7. If Web Reference Type is REST:
   1. Web Reference Type - Choose REST.
   2. Web Service Reference - Select the name of the Web service reference and click Next.
   3. Result Stored in Collection - Enter the name of the temporary result set name where the Web service result is stored. The temporary result set is stored in an Application Express collection.
   4. Report Template - Choose the report template to be used by this report region.
   5. Rows Per Page- Select the number of rows to display per page.
   6. Select the parameters to be included in the report.
   7. Click Next.
8. For Web Reference Type, choose REST, Generated from WSDL , or Manually Created.
   What appears next depends upon your selection.
9. If Web Reference Type is Generated from WSDL:
   1. Web Reference Type - Choose Generated from WSDL.
   2. Web Service Reference - Select the name of the Web service reference.
   3. Operation - Select the operation. The operation is the method that will be executed..
   4. Result Tree to Report On - Select the portion of the resulting XML document that contains the information you want to include in the report.
   5. Report Parameters and Options:

      - Temporary Result Set Name - Enter a name for the collection that stores the Web service result.

      - Select and deselect the appropriate parameters.

   6. Click Next.
10. If Web Reference Type is Manually Created:
    1. Web Reference Type - Choose Manually Created.
    2. Web Service Reference - Select the name of the Web service reference.
    3. SOAP Style - Choose the style of the SOAP response. The style can be determined from the style attribute of the soap:binding element from the WSDL for this operation.
    4. Message Format - Choose the message format. The encoding can be determined from the use attribute of the soap:body element of the output message in the WSDL for this operation.
    5. Result Node Path (XPath)(Value Required)- Enter the XPath expression to the node of the response message that you are creating the report on. The node is a child of the soap:Body element.

       For example:

       `/result/myNode`

    6. Message Namespace - Enter the namespace for the response message. This can typically be determined by looking for the targetNamespace attribute of the WSDL and click Next.
    7. Enter the name of the collection where the response message is stored.
    8. Enter the names of the parameters that you want to be included in the report.
    9. Click Next.
11. Click Create.

Parent topic: Managing Legacy Web Services

### 26.5.11 How to Invoke a Legacy Web Service as a Process

Learn how to invoke a legacy Web service as a process.

You can invoke a Web service as a process on the page. The process is created for you if you run one of the Create Form wizards for Web services. Running the process submits the request to the service provider. You can then display the request results in the report.

- Invoking a Web Service as a Process
- Editing a Web Service Process

Parent topic: Managing Legacy Web Services

#### 26.5.11.1 Invoking a Web Service as a Process

To invoke a Web service as a process:

1. Create a Web Service Reference.
2. Run the Create Page Wizard. On Create a Page:
   1. For User Interface, if applicable select a user interface for the page.
      This attribute only displays for applications using older themes for which Desktop and Mobile User Interfaces have been defined.
   2. For Page Type, select Component and then Blank Page.
3. For Page Attributes:
   1. Page Number - Select a page to contain the new form, or enter a new page number.
   2. Page Name - Specify a name for the page.
   3. Page Mode - Identify the page mode. To learn more, see field-level Help.
   4. Page Group - Identify the name of the page group you would like to associate with this page. Page groups help developers manage the pages within an application. To create a page group, enter the name. To use an existing page group, select the name from the list of values.
   5. Breadcrumb - Enter a title for the region in which the form will appear.
   6. Click Next.
4. For Navigation Preference:
   1. Select Do not associate this page with a navigation menu entry.
   2. Click Next.
5. Click Finish.
   Page Designer appears.
6. Under Page Rendering or Page Processing, locate the Processes section, right-click and select Create Process.
   The New process appears.
7. Edit the process attributes in the Property Editor.
   Attributes are organized in groups. To find a group or attribute, enter keywords in the Filter Properties field. The Property Editor displays the group or attributes. Or, you can click Go to Group and select the group.

   Tip:

   To view help for an attribute, select the attribute in the Property Editor and click the Help tab in the central pane.

8. Edit Identification attributes:
   1. Find the Identification group.
   2. Name - Enter the name of the page process for easy identification by developers.
   3. Type - Select Web Service.
9. Edit Settings:
   1. Find the Settings group.
   2. Web Service Operation - Select a Web Service Operation.
   3. Store Result In - Select Item(s) or Collection.
10. Edit Execution Options Options:
    1. Find the Execution Options group.
    2. Sequence - Specify the sequence for this component. The sequence determines the order of execution.
    3. Point - Select the processing point.
11. Edit Success Message:
    1. Find the Success Message group.
    2. Success Message - Enter the success message for this process. If the process runs and does not generate an error, then this process success message displays in the notification section of the resulting page displayed.
       To learn more, click the Help tab.
12. Edit Error Message:
    1. Find the Error Message group.
    2. Error Message - Enter the error message for this process. This message displays if an unhandled exception is raised. After any error processing stops, a rollback is issued and an error message displays..
       To learn more, click the Help tab.
13. Edit Server-side Condition:
    1. Find the Server-side Condition group.
    2. When Button Pressed - If you want this page processing component to execute only when the specified button is clicked, select a button from the list. You can incorporate this button condition with other conditions to further refine when this page processing component executes.
    3. Condition Type - Select a condition type that must be met in order for this component to be processed. Depending upon your selection, additional attributes may appear.
14. Click Save.

See Also:

- Creating Legacy Web Service References Based on a WSDL
- Creating Web Service References Manually
- Creating a RESTful Web Service Reference
- Managing Pages in an Application

Parent topic: How to Invoke a Legacy Web Service as a Process

#### 26.5.11.2 Editing a Web Service Process

After you create a process of type Web service on a Web service reference created from a WSDL or a RESTful style Web reference, you can change the attributes of the input and output parameters to the service.

To edit a Web service process:

1. Create a Web service process.
2. Navigate to the page containing the Web service process.
   Page Designer appears.
3. In the left pane, find the process name and expand the tree.
   In Parameters and Out Parameters display under the process.
4. Expand In Parameters and Out Parameters. Defined parameters apear.
5. Select a parameter and edit the attributes in the Property Editor.
   Attributes are organized in groups. To find a group or attribute, enter keywords in the Filter Properties field. The Property Editor displays the group or attributes. Or, you can click Go to Group and select the group.

   Tip:

   To view help for an attribute, select the attribute in the Property Editor and click the Help tab in the central pane.

6. Click Save.

See Also:

How to Invoke a Legacy Web Service as a Process

Parent topic: How to Invoke a Legacy Web Service as a Process

### 26.5.12 Viewing a Legacy Web Service Reference History

View a history of Web service reference changes.

The Web Services History displays changes to Web service references for the current application by application ID, Web service references name, developer, and date.

To view a history of Web service reference changes:

1. Navigate to the Shared Components page:
   1. On the Workspace home page, click App Builder.
   2. Select an application.
   3. On the Application home page, click Shared Components.

      The Shared Components page appears.

2. Under Data Sources, click Legacy Web Service References.

   The Web Service References page appears.

3. Click History.

Note:

The History button only appears on the Web Service Reference page if at least one reference exists.

Parent topic: Managing Legacy Web Services