Web Service activity

An activity 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.

Configure the Web Service activity

To configure the Web Service activity, do the procedure in this topic.

Prerequisites

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

Good to Know

In some cases, the type of the object instance returned by a web method may need to implement the IConvertible interface in order for the web method to be used with the Web Service activity.
Limitations
These technical limitations apply to Web Service and WCF support in process activities and lookups:
- Arrays of primitive data types.
  Arrays of primitive data types — for example, string, Boolean, integer, decimal — are not supported as input or output data types because this interferes with the deserialization of the array object.
  However this does work with an array of complex classes and custom classes or a list of primitive data types.
  
  If you have a service that returns an array of primitive data types, these workarounds are suggested:
  - Return a list objects instead of arrays — for example, List<string>, instead of string[]
  - Create a custom class that encapsulates that property — for example, a class that has a property of type string.
  - If you do not have control over the service, you can write a wrapper service that encapsulates the call to the underlying service and converts the array to a list object, or create a custom class that encapsulates that property.
- Dictionary objects.
  Dictionary objects are not supported as input or output data type because XMLSerializer interferes with the deserialization of the dictionary object.
- Circular references.
  Circular references are not supported in input and output objects — for example, if a class called Person contains a field of type Person that references the same class. Such a circular structure cannot be loaded in the XML Mapper.
- Nested WSDLs.
  Web services with nested WSDLs are not supported. Consider making your service use single WSDL, or use the .Net Proxy activity.
In most text fields, you can use process data variables as an alternative to literal data values.
You can configure whether this activity waits for other activities before it runs.
For more information, refer to How Do I Configure an Activity to Wait for Other Incoming Activities?
This section shows the configuration settings on the configuration screens for this activity. Other configuration settings apply to system activities. For more information, refer to:
Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

How to Start

Open Process Builder.
For information about how to open this screen, refer to Process Builder.
In Process Builder, in the Activity Library, open the Web Services tab.
On the Web Services tab, drag the Web Service activity onto your process.

Procedure

Complete the fields on the General Configuration screen.
For more information, refer to Configure General Options for Web Service.
Click Web Service Configuration .
Complete the fields on the Web Service Configuration screen.
For more information, refer to Call a Web Service Method from a Process.
(Optional) Click Advanced > Email Notifications .
For more information, refer to Email Notifications screen (Process Activities).

General Configuration

Specifies the basic settings for the Web Service activity.

Fields

Field Name	Definition
Display Name	Description: Specifies the activity name that shows in your process. Allowed Values: One line of text (a string). Accepted: Letters Numbers Spaces Default Value: None Accepts Variables: No Example: This is a common configuration field that is used in many examples. Refer to: Examples - Step-by-step use case examples, information about what types of examples are provided in the AgilePoint NX Product Documentation, and other resources where you can find more examples.
Description	Description: Specifies an optional text description for your activity. Allowed Values: More than one line of text. Default Value: None Accepts Variables: No
Connection Timeout (Seconds)	Description: Specifies the number of seconds permitted to complete an action before the connection stops. Allowed Values: An integer. Represents A number of seconds Default Value: 600 Accepts Variables: No

Web Service Configuration

Specifies the web service method to call when the activity starts.

WSE Configuration screen — Figure: Web Service Configuration screen

Fields

Field Name

Definition

Web Service

Description:: Specifies the access token that connects to your web service.
Allowed Values:: A list of access tokens configured for your environment.
Default Value:: None
Accepts Variables:: No

Create Add Token icon

Opens this Screen:: Access Token for Web Service
Function of this Screen:: Configure an access token to connect to a web service.

Web Method

Description:: Specifies the name of the method to call.
Allowed Values:: A method name from the list.
Default Value:: None
Accepts Variables:: No

Endpoint URL

Description:: Specifies the URL of the endpoint of the web service or WCF service you want to connect.
Allowed Values:: A valid endpoint URL.
Default Value:: None.
However, once a web service is connected, the endpoint URL shows if it is defined in the WSDL file.
Accepts Variables:: No
Limitations:: Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

Decode Message Body

Description:

Specifies whether to treat XML in the message body as literal XML code, or to treat it as text to show in the message.

Allowed Values:

Deselected - Shows the XML as text by adding slashes (/) to make the special characters escape characters.
Selected - Uses the XML code as literal code.

Default Value:

Selected

Request Mapping

Description:

Connects the web service request to your process schema. This is mandatory only if the request passes data from the process schema to parameters in the web method.

To Open this Field:

On the WSE Configuration screen, click the Request tab. You can not map the schema if the web service type is None.

Allowed Values:

Click the Schema Mapping Schema Mapping icon

button to open the Schema Mapper screen.

Use this screen to connect the request to the data model for your process.

Default Value:

None

Example:

Refer to:

(Example) Schema Mapper

Custom Headers

Description:

Specifies the custom headers required for the web service.

To Open this Field:

On the WSE Configuration screen, click the Request tab.

Allowed Values:

Read only - A message is displayed if the custom headers are set for the web service.

Use the Ellipses button to display the custom headers set for the web service.

Default Value:

None

Example:

Custom Header	Value
Authentication Type	OAuth2
Application Redirection URI	https://ServerName
Application Time Zone	PDT
Locale	en-Us

Add Other SOAP Headers

Description:

Specifies to add more SOAP headers.

These SOAP headers may give application-specific about the SOAP message, such as authentication.

To Open this Field:

On the WSE Configuration screen, click the Request tab.

Allowed Values:

Deselected - Does not add other SOAP headers.
Selected - Enables the text box where you can add SOAP headers.

Default Value:

Deselected

Map Response to AgilePoint Schema

Description:

Specifies if the web service response connects to your process schema.

To Open this Field:

On the WSE Configuration screen, click the Response tab. You can not map the schema if the web service type is None.

Allowed Values:

Click the Schema Mapping Schema Mapping icon

button to open the Schema Mapper screen.

Use this screen to connect the response to the data model for your process.

Default Value:

None

Example:

Refer to:

(Example) Schema Mapper

Store the Response in Custom Attribute

Description:

Specifies the name of the process data variable that stores the response to a method call. The call must be a web service, Web Service Extension, WCF service, or web application.

To Open this Field:

On the WSE Configuration screen, click the Response tab. You can not map the schema if the web service type is None.

Allowed Values:

A process data variable.

Default Value:

None

Accepts Variables:

Yes

Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?