Use the Call Web Service action.

Transcription

1 How to Use the Call Web Service action. Background The Call Web Service action is for advanced users and allows the workflow to make a call to a SOAP web service method. This can be used to create/edit/delete list items across team sites as well as many other features listed and documented at It also can be used to interact with custom created web services. This document will demonstrate a simple web service call and show how to view its results, and how it can be used with other Nintex Workflow actions. Prerequisites This workflow will be running on a list with 3 fields: Title (default field), Data1 (Single line of text) and Data2 (Number). The example list used in this document was set up as shown: The sample items used in this document have the following data: Page 1

2 Workflow Design The completed workflow will look as shown below: Page 2

3 Creating the Workflow 1. The first step is to create the Workflow Variables that will be required. Configure the variables as shown below. 2. Next add the first workflow action Call Web Service. Configure it with the following information. URL: Insert a reference to Web URL first, and then add the text: /_vti_bin/lists.asmx. This changes depending on which web service method you will be using. In this case we are using the Lists.GetListItems Method. Please see this article for additional information: Username & Password: Configure these with the appropriate account that has permissions relative to what the web service will be doing. For example if you are only reading the list then only an account with Read is required, however if you are adding new items to a list you will need Contribute access and so on. 3. Once this information has been entered click the Refresh button, and press OK when prompted. You should now be able to select a web method from the drop down list. Page 3

4 4. Select GetListItems from the Web method drop down list, and then select SOAP Editor as the Editor mode. You should see an editor window as shown below. Page 4

5 5. Insert the following text in the SOAP editor window: <?xml version="1.0" encoding="utf-8"?> <soap:envelope xmlns:xsi=" xmlns:xsd=" xmlns:soap=" <soap:body> <GetListItems xmlns=" <listname>{common:listname}</listname> <viewname></viewname> <query> <Query> <Where> <Eq> <FieldRef Name="Title" /> <Value Type="Text">A</Value> </Eq> </Where> </Query> </query> <viewfields></viewfields> <rowlimit></rowlimit> <queryoptions xmlns:soapsdk9= " > <QueryOptions/> </queryoptions> <webid></webid> </GetListItems> </soap:body> </soap:envelope> NOTE: Detailed information about each of these XML fields can be found from the Microsoft SDK - as well as other information. 6. Configure the Store result in field to be the variable you created earlier getlistitems_result. Set the Result format to XML. Now that the web service action is configured, click Save. NOTE: The next action in the workflow is optional but relevant because is it a good way of seeing the results of your web service call in XML format. This view can be used when determining the name of fields and to see if the output is correct before performing other actions on these results. Page 5

6 7. Add a Send Notification action and configure it so the is sent to the Lookup Reference, Initiator. Add the subject line GetListItems Result. In the body of the , insert a reference to getlistitems_result, and set the Format to Plain Text. This is important because without it the will seem blank. The configuration will look as shown below. Page 6

7 8. The next step is to convert the web service output XML to data which can be used in other workflow actions (such as workflow text variables). To do this we use the Query XML action. Two Query XML actions are used, one for each variable we are going to set. We get this information using Xpath processing. Configure the first Query XML action as shown below. This will get the ows_data1 field returned from the web service and store it in the resultpart1 variable. Page 7

8 9. Configure the second Query XML action almost identically except instead use ows_data2 instead of ows_data1 and resultpart2 instead of resutpart1. Configure the action as shown below. 10. Now we can use these variables by logging them to the history list. Add a Log in History List action as the final step. Configure the action as shown below. Page 8

9 11. Publish and Run the workflow. When running the workflow on the example list created at the start of this document, the Workflow History should look as shown below. The body of the you receive should look similar to the text shown below. Workflow 2010 Workflow Notification <xml><listitems xmlns:s="uuid:bdc6e3f0-6da3-11d1-a2a3-00aa00c14882" xmlns:dt="uuid:c2f b3-11d1-a29f-00aa00c14882" xmlns:rs="urn:schemasmicrosoft-com:rowset" xmlns:z="#rowsetschema" xmlns=" ItemCount="1"><z:row ows_attachments="0" ows_linktitle="a" ows_data1="example Data 1" ows_data2=" " ows_docupdat="2" ows_metainfo="1;#" ows ModerationStatus="0" ows Level="1" ows_title="a" ows_id="1" ows_uniqueid="1;#{62f73811-c94e-470c-8358-a452121c28b4}" ows_owshiddenversion="1" ows_fsobjtype="1;#0" ows_created_x0020_date="1;# :06:04" ows_created=" :06:04" ows_fileleafref="1;#1_.000" ows_permmask="0x7fffffffffffffff" ows_modified=" :06:04" ows_fileref="1;#test/lists/test/1_.000" /></rs:data></listitems></xml> Page 9