Web Service

An AgilePart that calls a web service method from an AgilePoint process. You can select and configure the method call by connecting to a web service URI.

Good to Know

  • You cannot use overloaded methods or circular type refs.


Prerequisites

  • A valid Web Service — for example a live, valid WSDL file.

Navigation

  1. In AgilePoint Envision, open a process template.
  2. Navigate to the Web Services stencil.
  3. On the Web Services stencil, drag the Web Service AgileShape, and drop it on the process template.
  4. To view the entire list of properties, in the Design Tasks pane, click Show Properties.

Properties for This AgileShape

Field Name Definition

Configure

Opens the Following Window:
Web Service Configuration Window
Purpose of this Window:
Specifies the web service method to call at runtime.
Credential
Opens the Following Window:
Login Window
Purpose of this Window:
Specifies the authentication credentials to run a web service method at runtime.
Proxy
Opens the Following Window:
Configure Proxy Server Window
Purpose of this Window:
Specifies a proxy server used to connect to the web service. This bypasses the permission constraints on the local machine at runtime.
Timeout
Definition:
Specifies the maximum amount of time, in seconds, allowed for the completion of the web service call for the AgileShape.
Allowed Values:
Any positive integer.
Default Value:
600
Custom Attributes:
No
XmlSerializeReturnValue
Definition:
Determines whether to serialize as XML the data returned by the web service method called by the AgileShape.
Allowed Values:
  • False - The return value is stored into the custom attribute exactly as returned by the web service.
  • True - The return value is serialized into an XML string before being stored into the custom attribute exactly as returned by the web service.
Default Value:
False

Common AgilePart Properties

This AgilePart inherits the following common properties. For more information, see AgilePart - Common Setup. Note that only the relevant properties are available in AgilePoint Envision. Unneeded properties are hidden.

Name, (UID), Description, Debug, Audit Level, SessionMode, Wait All Incoming, AssemblyName, ClassName, Method, Optimizing, Activity Entry Message (Email), Task Completed Message (Email), ConfigureAttachments, Reference URL, ExceptionHandlerScope, SaveErrorMessageTo, SaveStatusTo, Configure Yammer Credentials, Retries, HandleException

BPMN Properties

Each AgileShape includes a set of BPMN properties. For more information, see Adding or Modifying BPMN Properties for an AgileShape.