HTTP Client End Session Service

The HTTP Client End Session service ends an HTTP session with an external trading partner HTTP server. This service works through an instance of the HTTP Client adapter.

The following table provides an overview of the HTTP Client End Session service:

System name HTTP Client End Session Service
Graphical Process Modeler (GPM) categories All Services, B2B Protocols > HTTP Client
Description This adapter is used to end an HTTP session with an external trading partner HTTP server. This service works through an instance of the HTTP Client adapter.
Business usage A business user would use this service as the last functional activity in a business process that sends an HTTP request to a trading partner. This service can only be used if the HTTP Client Begin Session Service was used at the start of the business process.
Usage example A Sterling B2B Integrator business process is executed that translates a document that must be sent to a trading partner. After the translation, Sterling B2B Integrator looks up information about how to transport data to the trading partner in the trading partner profile. The trading partner profile specifies HTTP as the transport protocol. Sterling B2B Integrator then begins a session with the trading partner by using the HTTP Client Adapter, sends the document, then ends the session by using the HTTP Client End Session Service.
Preconfigured? No
Requires third-party files? No
Platform availability All supported Sterling B2B Integrator platforms
Related services Related services:
  • HTTP Client adapter
  • HTTP Client Begin Session service
  • HTTP Client GET service
  • HTTP Client Method service
  • HTTP Client POST service
Application requirements An HTTP server at the external trading partner location.
Initiates business processes? No
Invocation This service is invoked from a business process.
Business process context considerations None
Returned status values Returned status values:
  • 0 –Success
  • 1 –Error
Restrictions None
Persistence level System Default
Testing considerations To test this service, run the HTTPClientDemoAllServices business process and verify that it completes successfully. For more information about the HTTPClientDemoAllServices business process, see the HTTP Client adapter. Debug information for this service can be found in the HTTP Client adapter and services log files.

Implementing the HTTP Client End Session Service

To implement the HTTP Client End Session service, complete the following tasks:
  1. Create an HTTP Client End Session service configuration. For information, see Managing Services and Adapters.
  2. Configure the HTTP Client End Session service. For information, see Configuring the HTTP Client End Session Service.
  3. Use the HTTP Client End Session service in a business process.

Configuring the HTTP Client End Session Service

To configure the HTTP Client End Session service, you must specify field settings in the GPM:

Field Description
Config Name of the service configuration.
SessionToken Specifies the identifier of the session to be ended. Required.

Output from Service to Business Process

The following table contains the parameters passed from the HTTP Client End Session service to the business process:

Parameter Description
SessionEndTime Specifies the date and time that the session ended. Required.

Output from Business Process to Service

The following table contains the parameters passed from the business process to the HTTP Client End Session service:

Parameter Description
SessionToken Specifies the ID of the session to be ended. Required.

Business Process Example

The following example business process illustrates by using the HTTP Client End Session service:

 <process name="default">
  <sequence>
  [[Insert Begin session operation here]] 
    <operation name="HTTP Client End Session Service">
      <participant name="HTTPClientEndSession"/>
      <output message="HTTPClientEndSessionServiceTypeInputMessage">
        <assign to="SessionToken">SessionToken</assign>
        <assign to="." from="*"></assign>
      </output>
      <input message="inmsg">
        <assign to="." from="*"></assign>
      </input>
    </operation>
  </sequence> 
</process>