Support for SOAP client
Introduction
The SOAP client requests the service. This includes creating compliant XML documents, either explicitly or using the Oracle SOAP client API. The SOAP client sends the XML document to the SOAP server. This SOAP request is sent over HTTP or HTTPS to the SOAP request handler running as a Servlet on the web server.
Overview
SOAP is an acronym for simple object access protocol. It is an XML-based communicative protocol for exchanging information among different systems. SOAP task is used to interact with the cloud applications which uses SOAP-based authentication mechanism and performs various actions. SOAP is a cloud service, also known as web services. The web service describes the inbuilt library of applications that contains all the services. Each application has its own console that is directly connected with the SOAP client. These consoles are generally represented as a URL. For example, if you wanted to use the Workday application, then you will be able to find a specific URL connected with the SOAP client for this particular application. Under this application, the different services are categorized under a specific category. You just need to select the specific service and you will get the required task under it. Suppose you have selected Human resource operation from the Workday system, you will be able to access all the related HR tasks under it. Such as Add workplace test, Assign Employee collective assessment, Change additional name, Change business tittle, change legal name and so on. These services are the pre-built services. Here you will get the various option for use the services with these actions i.e., GET, PUT, UPDATE, MANAGE and IMPORT.
Key | Description |
|---|---|
GET | In SOAP client GET is used for fetching a prebuilt services from the server. |
PUT | In SOAP client PUT is used for creating prebuilt services in the server. |
UPDATE | In SOAP client UPDATE is used for updating some new information or data in the prebuilt services. |
MANAGE | In SOAP client MANAGE is used for handling the data or information under the prebuilt services. |
IMPORT | In SOPA client IMPORT is used for importing the data or information from the prebuilt services. |
Data Slots
A data slots is a collection of individual items of related data that can be accessed individually or in combination and managed as a whole. Records are organized in some sort of data structure. It is a collection of individual items of related data that can be accessed individually or in combination and managed as a whole. The records are organized in some sort of data structure. For example, a database record may contain a collection of business data (name, salary, contact information, sales, and so on). The database itself can be viewed as a record, as is the body of data associated with a particular type of information in the database.
Once the SOAP client task is configured, the automation will generate a set of data slots for further use.
The data slots for the Soap client task are:
Response: User-defined content.
Error: Contains specific information about the error that occurred.
Status: The status code is returned from server to server at the request of the client.
How to use SOAP Client
The webservice related to the SOAP client can be found in the respective applications WorkSpace. Suppose we have selected Workday WorkSpace, for viewing the SOAP clients web services.
In this WorkSpace you will be able to get the details related to the all Workday webservices associated with the particular operations. It also can represent as a library of webservices. It can be found in the Schema Explorer window. Here you can add the required services based on your requirements. For example, Absence Management. You will be able to get all the related services associated with the absence management.
The SOAP services can be used in a SOAP request and response process. This means, you can request for a specific action in the left side of the SOAP Request field and the SOAP response will be present in the right side of the screen. If you want to get a particular details related to any operation you just need to add it in the request body and the entire response will be generated in a XML format. For example, If you want to view the employee id, you just needed to add it in the request body, and all the employees id for the specific organization will be represented in the response field.
In the location field you will be able to view the WSDL URL associated with the specific operations. For each webservices there will be a unique WSDL URL.
Key | Description | Example |
|---|---|---|
Location | The location field will be represented in the WorkSpace of the specific SOAP operations. This field helps to store and view the WSDL URL associated with the specific operation. | http://webservices.oorsprong.org/websamples.countryinfo/CountryInfoService.wso?WSDL |
Content Type | The content type represent the type of content is used for the SOAP client. | Text, string, Numbers. |
SOAP Request | A SOAP client (e.g. web browser) connects to a server and passes a request (fetch a web page). It’s known as the SOAP Request. |
|
SOAP Response | After the SOAP client connects to a server and passes a request, then waits for the server to respond. It known as the SOAP Response. |
|
How to use SOAP client on SOAPUI
Open the SOAPUI application from your System. Now click on the SOAP option from the app.
Once you click on the app the form will be open on the screen. Now, you need to add the Project name and the WSDL URL in the initial WSDL option. The URL you will be get from the respective webservice worksapce.
Once you click on ok you will be able to see all the webservices related to the specific operation on the left side of the SOAPUI application.
Steps to use SOAP Client in Sapper
Click on the automation tab from the Sapper home page.
Select the specific automation from the list of the automations.
3. Drag and drop the SOAP core task in the automation and click on it. The form will appear on the screen.
4. From the connection field select the required connection, here we have selected Workday SOAP connection.
5. Now select the required prebuilt services related to the application from the below list.
6. Once you select the prebuilt services, the version and WSDL URL will be automatically updated.
7. The WSDL URL is predefined as per the application, click on the hamburger button to get the operations of the selected WSDL URL link. WSDL, or Web Service Description Language, is an XML based definition language. It's used for describing the functionality of a SOAP based web service.
8. After clicking on the hamburger button, a list of operations provided by the particular WSDL file will appear on the left part of the screen. Select the desired operation you wish to work upon.
9. From the list you can select the operation name based on the requirements.
10. Service EndPoint namespace input field is predefined. Add the request in the request body input field. Click on the get request button to get the dummy request or you can feed the request by just copying the request and pasting it into the request body input field.
11. Addressing should be enabled to append a custom header. The custom header fields provide the required information about the request/response, or about the object sent in the message body.
12. The addressing mode and custom header fields work for GRP only. For Workday, you don’t have to enable addressing mode or to feed custom headers. Click on custom header fields and the following form will appear. Fill in the input fields, click on the plus icon to add more custom headers. You can add any number of headers.
13. You can also view the operational data by selecting the drop down field of “Selected Operational Data”.
14. In this field you will get option for “Get Request”, that can be used based on your requirement.
15. Once you click on the “Get Request” tab you will be able to view the detail related to the Request Body in a new display area.
16. Save the details after adding the custom headers.
17. Now click on save to complete the configuration.