Web Services Integration
About Web Service Integration
Web Services whose connections are specified using the Web Service Description Language (WSDL) can be integrated into the platform without programming, by performing a few configuration steps.
In addition, the interface defined by the WSDL can be simplified by the IT admin, so it more closely matches the application, by:
- Ignoring fields that are not needed
- Hardcoding data for fields whose values are fixed
- Creating more application-friendly names for the remaining fields defined in the WSDL
Those steps are covered below, under Configuring a Web Service.
Once done, an application designer can add a step in a Process Model to utilize the Web Service. The designer then uses the application-friendly names to:
- Map current record fields to and from WSDL input and output fields
- Specify fixed values or expressions for WSDL input fields
- Define expressions that operate on WSDL output fields and store the results in the record
The mechanisms are discussed further below, under Working with a Web Service.
Configuring a Web Service
Start by uploading the WSDL file:
- Download the WSDL file for the service the application will connect to.
(Web Services managed by the WebMethods integration server are recommended.) - Go to > Developer Resources > Web Services
- Click [New Web Services Invocation]
- Click [Select WSDL]
- Browse to the folder that contains the WSDL file, and upload it.
You can now configure a service:
- In the form that opens, specify:
- Basic Parameters:
- Title - Give the service a title
- Operation - Choose one of the operations defined in the WSDL file
- Version - Optional. Enter text to identify the service version
- Service Parameters:
- URL - Optional. Use this field to point to a destination other than one defined in the WSDL file
- Username -' Username required to use the service, when required
- Password - Password required to use the service, when required
- TTL - Time to Live. Optional. The amount of time the platform will wait before abandoning a service request, in milliseconds.
- Click [Next]
You can now begin to simplify the service for designers.
Start by mapping input fields (fields going to the service) defined for the WSDL file.
- For each input field, choose one of:
- Ask for Mapping -
- Friendly Name - Give the WSDL field a name the application designer will recognize
- Ignore -
- Hardcode - Provided a hardcoded value for the field. (The application will never even see it.)
- Username - Supply the Username value defined in the initial configuration step ($username).
- Password - Supply the Password value defined in the initial configuration step ($password).
- Click [Next]
Then map output fields (fields coming from the service):
- For each output field, choose one of:
- Ask for Mapping - Ask the designer to supply the name of a record field to store the value into.
- Friendly Name - Give the WSDL field a name the application designer will recognize
- Ignore - Ignore this value
- Click [Save]
The Web Service is now ready for use by an application designer.
Working with a Web Service
Once a Web Service has been configured, you can add it as a step in a Process Model: