About Web Service Settings

The Web Service Settings dialog box lets you create the SOAP message to send to the web service to invoke a web service operation.

After you provide the URL to the web service definition, Web Service Settings interprets the definition and populates other values on the tab. You can then select the web service operation to invoke. Based on the operation that you select, a template of the SOAP request message is generated. You then insert values into the message as required.

Web Service Settings also let you test your invocation request by sending a test message and displaying the response message that the web service sends.

Settings tab

Use the settings tab to provide a link to the web service definition and to provide the information required to connect to a web service. You can also access web services from a LiveCycle Server. (See Invoking services in LiveCycle using Web Services.)

WSDL URL

The URL of the web service definition. The definition is written in web service definition language (WSDL). WSDLs contain all the information that web service clients require to call web service operations and process the response.

Hinweis: The LiveCycle Server must be able to access the WSDL URL at run time and at design time.

If you have access to the service, click Load after you enter the value for WSDL URL. Clicking Load causes Web Service Settings to read and interpret the definition. It then automatically populates many of the properties on the Settings tab, such as the Target URL property.

If your development environment has network limitations that prevent you from accessing the web service, save the WSDL file to the file system, and load that file to populate the other property values. After loading the file, you replace the value of the WSDL URL property with the actual URL for the service definition.

User Name

The user name of the account that you can use to access the web service. Provide a user name only if the web service requires authentication.

If the user name is saved as process data, you can type the XPath expression that resolves to the location where the user name is stored. Click XPath to open XPath Builder.

Password

The password that corresponds with the user name that you provided for the User Name property.

If the password is saved as process data, you can type the XPath expression that resolves to the location where the password is stored. If the expression resolves to a variable, set a default value for the variable to use for testing. Click XPath to open XPath Builder.

Port

The service that you want to use, that is exposed through the WSDL URL. A WSDL URL can have multiple services available. After the WSDL URL is loaded, this list is populated with the available ports. (See WSDL URL.)

Target URL

The URL that provides access to the web service. After the value for Port is specified, the default target URL as defined in the WSDL is displayed. You can override this target URL value by typing the actual target URL for the selected port.

If the URL is saved as process data, you can type the XPath expression that resolves to the location where the value is stored. If the expression resolves to a variable, set a default value for the variable to use for testing. Click XPath to open XPath Builder.

When you access web services from a LiveCycle Server, append ?wsdl&async=true&lc&lc_version=9.0.0 to the URL when the service is an asynchronous service. Services for long-lived processes are asynchronous.

Operation

The web service operation to invoke. The list is populated automatically if you loaded the web service definition. (See WSDL URL.)

Time Out (in secs)

The amount of time that you want to wait for a response from the web service before abandoning the web service invocation. The value you provide is in seconds.

If the time-out value is saved as process data, you can type the XPath expression that resolves to the location where the value is stored. If the expression resolves to a variable, set a default value for the variable to use for testing. Click XPath to open XPath Builder.

WSDL Content

The WSDL that is retrieved from the URL provided for the WSDL URL property. The WSDL appears when you click the Load button.

Embed WSDL

Select this option to embed the WSDL in the process. When selected, the embedded WSDL is used when the invoke operation executes at run time. The embedded WSDL is updated each time you click the Load button.

If this option is not selected, the WSDL is retrieved from the WSDL URL at run time.

HTTP Settings tab

Use the HTTP Settings tab to configure settings related to the HTTP protocol.

Send Authentication Headers Without First Receiving An Authentication Challenge:
Select when the web service does not send a challenge request for authentication.

Request tab

Use the Request tab to create the SOAP request message that is sent to the web service to invoke the operation.

SOAP Request

The SOAP message to send to the web service at run time. For more information about SOAP messages, see About SOAP invocation messages.

If you loaded the WSDL and selected the port and operation to invoke, click Generate to populate the editing box with a template message. (See WSDL URL.) The template message is complete except for the values that you must provide for the required operation parameters. Question marks (?) indicate values that you must provide.

Click Remove ’?’ to remove all the question marks from the SOAP request.

If the operation has optional parameters that you want to provide values for, select Include Optional. This option includes the XML for optional parameters in the message.

If you cannot load the service definition, enter the message manually.

To use values in process data for operation parameters, use XPath expressions that evaluate to the data location. XPath expressions must appear inside braces and between dollar signs, as in {$expression$}. Click XPath to open XPath Builder. The expression that you create with XPath builder is inserted at the location of the cursor in the editing box.

The following example template message shows a request to invoke a web service’s invoke operation. The values for the parameters intvar and strvar have a question mark as placeholder values.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"  
                             xmlns:ser="http://adobe.com/idp/services"> 
    <soapenv:Header/> 
    <soapenv:Body> 
        <ser:invoke> 
            <ser:intvar>?</ser:intvar> 
            <ser:strvar>?</ser:strvar> 
    </ser:invoke> 
    </soapenv:Body> 
</soapenv:Envelope>

SOAP Request For Test

The SOAP request to send to the web service for testing at design time.

As with the SOAP Request property, if you have loaded the web service definition, click Generate to populate the editing box with a template message. (See WSDL URL.) The template message is complete except for the values that you must provide for operation parameters. Question marks (?) indicate values that you must provide.

Click Remove ’?’ to remove all the question marks from the SOAP request.

If the message includes XPath expressions as parameter values, the expressions must resolve to process variables that are configured with a default value. Otherwise, replace the parameters with literal values for testing.

You use the Test tab to test the message. (See Test tab.)

Attachment tab

Use the Attachments tab to add file attachments to the SOAP message. You can add attachments only if the web service definition indicates that they are allowed or required. Also, the file to attach must already be saved as process data so that you can reference it.

Hinweis: To add required attachments, you must have already loaded the WSDL, selected the port and operation, and defined the SOAP request message. (See WSDL URL.)

Each row in the table represents a file attachment:

  • Click Load Attachment Part to add rows to the table for the attachments that must be specified for the web service operation that you are invoking. The Part and Type columns are populated with values automatically.

  • Click Add Attachment Part to add rows to the table for optional attachments that the WSDL does require. The default value for Part is <anonymous>. You can change the value as required. When you click the button, XPath Builder opens so that you can create an expression that evaluates to the document to attach.

  • Select a row and click Remove Attachment Part to remove the attachment.

For each attachment, you must provide values for Attachment and Content-type:

Attachment:
Click the cell, and then click the ellipsis button that appears to open XPath Builder. The XPath expression that you create must resolve to the location where the attachment is saved.

Content-Type:
Type the MIME type of the file that you are attaching, for example application/pdf.

Test tab

Use this tab to test the SOAP message that you created for testing on the Request tab. To test the message, the message is sent to invoke the web service operation that you previously specified.

Click Test to send the test message to invoke the web service operation. The response message that the web service returns appears in the text area.

Hinweis: To test, you cannot use XPath Expression as property values because the process data that they resolve to does not yet exist at design time.