Difference between revisions of "Common:Web Service Configuration"
From AgileApps Support Wiki
imported>Aeric |
imported>Aeric |
||
Line 1: | Line 1: | ||
# In the Web Service Configuration form, configure the connection: | # In the Web Service Configuration form, configure the connection: | ||
#* '''Basic Parameters:''' | |||
* '''Basic Parameters:''' | #:* '''Title -''' Required. Give the service a title. (Displays in the '''Name''' column of the Services list.) | ||
:* '''Title -''' Required. Give the service a title. (Displays in the '''Name''' column of the Services list.) | #:* '''Operation''' | ||
:* '''Operation''' | #:*: Required for a SOAP service. Not present for REST. | ||
:*: Required for a SOAP service. Not present for REST. | #:*: Choose one of the operations defined in the WSDL file. | ||
:*: Choose one of the operations defined in the WSDL file. | #:* '''Version -''' Required. Enter text to identify the service version | ||
:* '''Version -''' Required. Enter text to identify the service version | #:* '''Pipeline Service -''' | ||
:* '''Pipeline Service -''' | #:*: Check this box for a service that provides values for use in other web services. | ||
:*: Check this box for a service that provides values for use in other web services. | #:*: Use it, for example, for a service that exists only to log in to a remote server. It will then be available for use in a "two-step service chain", which will be described momentarily. | ||
:*: Use it, for example, for a service that exists only to log in to a remote server. It will then be available for use in a "two-step service chain", which will be described momentarily. | #: | ||
: | #* '''Service Parameters:''' | ||
* '''Service Parameters:''' | #:* '''URL -''' Optional. Use this field to point to a destination other than one defined in the WSDL file | ||
:* '''URL -''' Optional. Use this field to point to a destination other than one defined in the WSDL file | #:* '''Use Basic Auth -''' Check this box when the destination URL requires a username and password to be included in the standard <tt>http</tt> header. | ||
:* '''Use Basic Auth -''' Check this box when the destination URL requires a username and password to be included in the standard <tt>http</tt> header. | #::* '''Username -''' Optional. Username required to use the service, when needed | ||
::* '''Username -''' Optional. Username required to use the service, when needed | #::* '''Password -''' Optional. Password required to use the service, when needed | ||
::* '''Password -''' Optional. Password required to use the service, when needed | #: | ||
: | #:* '''Use a Pipeline Service -''' Check this box when the service request requires a prior login. | ||
:* '''Use a Pipeline Service -''' Check this box when the service request requires a prior login. | #:*: Select a pipeline Web Service defined earlier for use in a two-step service chain. | ||
:*: Select a pipeline Web Service defined earlier for use in a two-step service chain. | #: | ||
: | #:* '''TTL -''' Optional. The "Time to Live", in milliseconds. | ||
:* '''TTL -''' Optional. The "Time to Live", in milliseconds. | #:*: (The amount of time the platform will wait before abandoning a request.) | ||
:*: (The amount of time the platform will wait before abandoning a request.) |
Revision as of 20:40, 27 March 2014
- In the Web Service Configuration form, configure the connection:
- Basic Parameters:
- Title - Required. Give the service a title. (Displays in the Name column of the Services list.)
- Operation
- Required for a SOAP service. Not present for REST.
- Choose one of the operations defined in the WSDL file.
- Version - Required. Enter text to identify the service version
- Pipeline Service -
- Check this box for a service that provides values for use in other web services.
- Use it, for example, for a service that exists only to log in to a remote server. It will then be available for use in a "two-step service chain", which will be described momentarily.
- Service Parameters:
- URL - Optional. Use this field to point to a destination other than one defined in the WSDL file
- Use Basic Auth - Check this box when the destination URL requires a username and password to be included in the standard http header.
- Username - Optional. Username required to use the service, when needed
- Password - Optional. Password required to use the service, when needed
-
- Use a Pipeline Service - Check this box when the service request requires a prior login.
- Select a pipeline Web Service defined earlier for use in a two-step service chain.
- Use a Pipeline Service - Check this box when the service request requires a prior login.
-
- TTL - Optional. The "Time to Live", in milliseconds.
- (The amount of time the platform will wait before abandoning a request.)
- TTL - Optional. The "Time to Live", in milliseconds.