SFTP Client End Session Service
The SFTP Client End Session service ends an SFTP session with an external trading partner SFTP server.
The following table provides an overview of the SFTP Client End Session service:
Category | Description |
---|---|
System name | SFTP Client End Session Service |
Graphical Process Modeler (GPM) category | All Services, B2B Protocols > SFTP Client |
Description | Ends an SFTP session with an external trading partner SFTP server. This service works through an instance of the SFTP Client adapter. |
Business usage | Use this service as the last functional activity in a business process that sends an SFTP request to a trading partner. This service can only be used if the SFTP Client Begin Session service is used previously in the business process. |
Usage example | A business process is executed to translate a document to send to a trading partner. After the translation, Sterling B2B Integrator begins a session with the trading partner by using the SFTP Client adapter, sends the document, then ends the session by using the SFTP Client End Session service. |
Preconfigured? | Yes. Uses the preconfigured service in a business process. |
Requires third-party files? | No |
Platform availability | All Sterling B2B Integrator supported platforms |
Related services | The following services are related. Configured
in a business process, they initiate the SFTP Client adapter to perform
their operations:
|
Application requirements | An SFTP Server at the external trading partner location. |
Initiates business processes? | No |
Invocation | This service is invoked from a business process. Note: Ensure
business processes using the SFTP Client Begin Session service always
call SFTP Client End Session service, even in error situations. If
the End Session service is not called, the session will remain visible
in the Service Activity Monitor until Sterling B2B Integrator is restarted.
|
Business process context considerations | None |
Returned status values | Returned status values:
|
Restrictions | N/A |
Persistence level | System Default |
Testing considerations | To test this service, run the SFTPClientDemoAllServices business process and verify that it completes successfully. For more information about the SFTPClientDemoAllServices business process, see SFTP Client adapter. Debug information for this service is located at: Operations > System > Logs > SFTP Client Adapter and Services. |
Input from Business Process to Service
The following table contains the parameters passed from the business process to the SFTP Client End Session service:
Field | Description |
---|---|
ResponseTimeout | The maximum number of seconds it can take for the trading partner system to respond before the session times out and terminates. If a number less than 30 is specified, 30 seconds will be used. Optional. Default is ResponseTimeout specified in SFTP Client Begin Session service. |
SessionToken | The returned SessionToken from the Begin Session service that initiated the session to be ended. Required. |
Output from Service to Business Process
The following table contains the parameters passed from the SFTP Client End Session service to the business process:
Parameter | Description |
---|---|
SessionEndTime | The date/time stamp for when the session ended. |
ServerResponse | The SFTP server response, which may include a reply
code and any text associated with the reply code. Valid values are:
|
ServiceStartTime | The date/time stamp for when the service started. |
ServiceEndTime | The date/time stamp for when the service ended. |
SessionStartTime | The date/time stamp for when the session started. |
Business Process Example
The following example business process excerpt illustrates using the SFTP Client End Session service:
[[Insert Begin Session]]
<operation name="SFTP Client End Session Service">
<participant name="SFTPClientEndSession"/>
<output message="SFTPClientEndSessionServiceTypeInputMessage">
<assign to="SessionToken"
from="SFTPClientBeginSessionServiceResults/SessionToken/text()">
</assign>
<assign to="." from="*"></assign>
</output>
<input message="inmsg">
<assign to="SFTPClientEndSessionServiceResults" from="*"></assign>
</input>
</operation>