Web Service activity

Display Name

Function:

Specifies the activity name that shows in your process.

Accepted Values:

One line of text that can have spaces.

Default Value:

None

Accepts Process Data Variables:

No

Description

Function:

Specifies an optional description for your activity.

Accepted Values:

More than one line of text.

Default Value:

None

Accepts Process Data Variables:

No

Connection Timeout (Seconds)

Function:

Specifies the number of seconds permitted to complete an action before the connection stops.

Accepted Values:

An integer that represents a number of seconds.

Default Value:

600

Accepts Process Data Variables:

No

Web Service

Function:

Specifies the access token that connects to your web service.

Accepted Values:

A list of access tokens configured for your environment.

Default Value:

None

Accepts Process Data Variables:

No

Add Token

Opens this Screen:

New Web Service Access Token

Function of this Screen:

Configures a new access token for the web service.

Web Method

Function:

Specifies the name of the method to call.

Accepted Values:

A method name from the list.

Default Value:

None

Accepts Process Data Variables:

No

Endpoint URL

Function:

Specifies the URL of the endpoint of the web service or WCF service you want to connect.

Accepted 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 Process Data Variables:

No

Request Mapping

Function:

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:

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

Accepted Values:

Click the Ellipses button to open the Schema Mapper screen.

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

Default Value:

None

Custom Headers

Function:

Specifies the custom headers required for the web service.

Custom headers contain application-specific information in the SOAP header. Custom headers are mostly used to provide security information, such as authentication credentials.

To Open this Field:

1. On the WSE Configuration screen, click the Request tab.

Accepted 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

Function:

Specifies to add more SOAP headers.

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

To Open this Field:

1. On the WSE Configuration screen, click the Request tab.

Accepted 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

Function:

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

To Open this Field:

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

Accepted Values:

Click the Ellipses button to open the Schema Mapper screen.

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

Default Value:

None

Store the Response in Custom Attribute

Function:

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:

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

Accepted Values:

A process data variable.

You can use Process Data screen to specify a process data variable.

Default Value:

None

Accepts Process Data Variables:

Yes