SOAP Web Services Settings


UseRestInsteadOfSoap

Note: Service Manager SOAP web services are no longer maintened since the Oxygen version. You can still use them but we recommend that you use the Service Manager REST API to take advantage of the latest enhancements and features.

Through steps in the processes (workflows or business rule related processes) defined in the graphic editor, Service Manager can call external web services of Service Manager or other products.

example  Call of an external component that reinitializes the passwords

The SOAP external web service called by Service Manager must be referenced and configured previously before being able to use in a process.

Screens description

Menu access: Administration > Parameters > web services

Access information to the web service

       Web service - step 1.png

WSDL (URL): URL address where the web service is found.

Best Practice icon.png  Consult the UDDI (Universal Description Discovery and Integration) directory that includes all the declared web services by the suppliers.

Login / Password: Login / password used to access the web service.

Proxy: Proxy used by the web service.

Attached Files: All the necessary certificates for a secured web service access.

  • An SSL certificate is necessary when the URL address starts with https.
  • Click Upload icon.png to upload the file (certificate, root certificate, private key).
  • The certificate password is hidden using the * character to safeguard confidentiality.

Description of the web service

       Web service - step 2.png

Name: Description of the web service at the consumer.

Comment: Description of the web service given by the consumer.

Service (Note: Cannot be changed): Description of the web service at the supplier.

Port (Note: Cannot be changed): Address of the web service given by the supplier.

Method: Name of the calling procedure in the web service.

Parameter values of the web service

       Web service - step 3.png

Documentation (Note: Cannot be changed): Description of the web service given by the supplier.

Parameter: List of parameters defined for the web service.

Value: Default value of each parameter. Click on Edit icon.png to enter it.

Expected Return Value: Value returned by the web service when it executed without error.

  • Do not complete this field if the web service returns a variable string.

    example  Returning a new password by the web service Reset Passwords

  • The return value is used on a WebService step in a process to evaluate its exit value.
    • Value returned by the web service = Expected return value: No error. Continuation of the process ==> Exit value of the WebService step = True.
    • Value returned by the web service <> Expected return value: Error. End of process ==> Exit value of the WebService step = False. Error processing (Orientation towards the error management, Notification of the error by email or a log file...).
  • If the return value is not completed, the exit value of the web service step will always be True.

Procedure: How to manage the result of a SOAP web service in a process

Workflows and business rule related processes can contain WebService actions.

  • All Service Manager SOAP web services can be called.
  • You can manage the result of the web service call, i.e. Success or Error, using internal update steps.
     

example  Call of an external component that reinitializes the passwords

  • Send mail step to return the new password to the user.
  • Send mail step to notify the returned error by the web service.
    Example web service - Workflow.png

Step 1: Create and configure the SOAP web service

1. Go to the Administration > Parameters > Web Services menu.

2. Click + New in the top banner.

3. Enter the web service information by browsing the different steps via Next.

4. Click Finish.

Update a web service

  • Go to the web services list.
  • Select the web service you want in the list.
  • Launch the Web service Editor wizard.
     

Step 2: Select the process.

1. Open the process where you want to add the action.

  • Workflow: References > Other References > Workflows (Operation/Transition)
  • Business rule: Administration > Business Rules > Related Processes
     

Step 3: Create the step used to call the SOAP web service

1. Click and drag the WebService Step action from the palette of action types (Automatic Actions category) to the graphic editor.

2. Double-click the outline of the step to specify its properties.

  • Select the SOAP web service in the WEBService Reference field.
  • Complete the parameters used by the web service. Note: The parameters defined during the configuration are displayed automatically.
  • Create an instance variable to store the value returned by the web service.
    • Value Type: Variable  indicating that the instance variable is estimated when the process is run.
    • Variable / Value: @RESULT referring to the result of the web service call.
       

Step 4: Create the step for the exit value, Success.

1. Click and drag the Internal Update Step action from the palette of action types (Automatic Actions category) to the graphic editor.

2. Double-click the outline of the step to specify its properties. Open url.png See Graphic editor > Description of a step.

  • Define the entry condition.
    • Select the step linked to the web service you just created.
    • Select True as exit value, to indicate that the call of the web service is successful.
       

Step 5: Create the step for the exit value, Error.

1. Click and drag the Internal Update Step action from the palette of action types (Automatic Actions category) to the graphic editor.

2. Double-click the outline of the step to specify its properties.

  • Define the entry condition.
    • Select the step linked to the Service Manager REST action you just created.
    • Select the exit value, False, to indicate that the call of the web service failed.
Tags:
Last modified by Unknown User on 2021/07/23 17:05
Created by Administrator XWiki on 2013/03/25 18:23

Shortcuts

Recent changes
•  EV Service Manager
•  Service Apps
•  EV Self Help
•  Service Bots

Powered by XWiki ©, EasyVista 2021