Lab 3: Simple Integration Use Case

Transcription

1 Exercise 1 : Create the web service...2 Exercise 2 : Deploy the web service...4 Exercise 3 : Test the service...8 1/16

2 In this exercise, you will learn how to activate a Maximo inbound web service. This web service will allow an external system / application to create a Service Request in Maximo. From this remote creation, any regular Maximo action could then be taken by the users. Enabling this type of capability consists in performing the following tasks : Create the web service (in our case, we will start from the default MXSR object structure) Deploy the web service Test it. Since we don t have any external system to test with, you will simulate the external system by using SOAP UI ( that is installed on the virtual image and that can be used to test web services. Exercise 1 : Create the web service 1. Sign in to Maximo as Mike Wilson. User: Password: wilson wilson 2. Go to the Web Services Library (Go To Integration Web Services Library) 3. Use the Select Action drop down menu to create a new web service from an Object Structure (Select Action Create Web Service Create WS from Object Structure) 2/16

3 4. The Create Web Service from an Object Structure Service Definition window opens. Select the MXSR object structure by selecting the corresponding checkbox. 5. Click on the Create button : The MXSR object structure service has been created and now appears on the Web Services Library list: 3/16

4 Exercise 2 : Deploy the web service 1. In the List, select the MXSR service : 2. Review the service you have just created. As it is an Object Structure based service, the Create, Update, Delete, Sync and Query operations have been automatically defined. You can click on Generate Schema / View XML to view sample input/ouput messages for each operations : A new View XML window open : 4/16

5 3. Click on OK when you are done reviewing the messages. As you could see, by default, all Service Request attributes are included in the messages. Maximo provides an easy way of selecting which attributes will be available through that web service. Should you be interested in this, you can : a. Go to the Object Structures module (Go To Integration Object Structures) b. Search for the object structure we are working with (MXSR) : c. Click on MXSR to open the record. d. Use the Select Action Exclude/Include Fields action (Select Action Exclude / Include Fields) e. This opens the Exclude / Include Fields window. In this window, you can select which attributes should be excluded from the integration messages (by default none are excluded but some system fields) : 5/16

6 f. When you are done reviewing this capability, go back to the Web Service Library to go on with the lab (Go To Integration Web Services Library). 4. Use the Select Action menu to deploy the web service (Select Action Deploy Web Service) Once deployed, a confirmation message gets displayed : 6/16

7 5. You can double-check that you can reach the web service endpoint : a. Open an Internet Explorer page b. Browse to You should be able to visualize the service WSDL that describes the different operations available : 7/16

8 Exercise 3 : Test the service You will now use soapui to test the service and remotely create a Service Request. 1. Use the desktop shortcut to launch soapui 2. Add the MXSR WSDL to the existing MX71 project. Right-click on the MX71 project and select Add WSDL : 3. The Add WSDL window opens. Copy & Paste the previous WSDL URL ( in the WSDL location input field : 8/16

9 4. soapui loads the service definition. When it is done, you should see the different ports and related operations in the project explorer: 5. Default request messages have been created for each operation. Open the request1 request under the CreateMXSR operation of the MXSRSOAP11Binding (double-click on MXSRSOAP11Binding / CreateMXSR / request1) 9/16

10 As you can see, all Service Request attributes are available to be filled by the external system. They are optional though. Thanks to this, in the context of this exercise you will enter a minimal set of information. 6. Create a New request message for the CreateMXSR operation, by right-clicking on the CreateMXSR operation of the MXSRSOAP11Binding port : 10/16

11 7. Give the request message a name of your choice : 8. Do not choose to create the optional elements in schema, as you will only specify a small subset of them : 9. Replace the generated content by the following XML message (you can find a createsr.xml file on your virtual machine hard drive that contains the same content under My Documents) : <soapenv:envelope xmlns:soapenv=" xmlns:max=" <soapenv:header/> <soapenv:body> <max:createmxsr> <max:mxsrset> <max:sr> <max:description>window and Frame are broken</max:description> <max:location>conf300</max:location> <max:siteid>bedford</max:siteid> </max:sr> </max:mxsrset> </max:createmxsr> </soapenv:body> </soapenv:envelope> 11/16

12 10. Basic authentication is activated on your Maximo application server. Therefore, you have to specify some credentials in order to be able to perform the service request creation. Within soapui, click on the Auth section at the bottom of the request to specify those credentials : 12/16

13 11. The Authentication area opens. Specify the following credentials : Username : Password : wilson wilson 13/16

14 12. With those settings set, you are ready to submit the request. Click on the green arrow to submit the request : 13. After a couple of seconds, you should see the Maximo response in the response area (right panel) : 14/16

15 In this example you can see that the Service Request 1149 was created. Any error would also been displayed in that area. If you have any issue, please reach out to one of the instructors. 14. Back to Maximo, we will now check the details of the Service Request you just created. If needed, log in as wilson / wilson. Go to the Service Requests module (Go To Service Desk Service Requests) : 15. Look for your service request by filtering on the service request ticket id that was returned to you in soapui (in our example : 1149) : 15/16

16 16. You can click on the record link to display the content of the Service Request. Once you have reached this point, you can go on with the next lab (Lab 4 : Using the Workflow Engine). 16/16