SFTP Client DELETE Service

The SFTP Client DELETE service deletes a document in a specified directory on the trading partner's SFTP server.

The following table provides an overview of the SFTP Client DELETE service:

Category Description
System name SFTP Client DELETE Service
Graphical Process Modeler (GPM) category All Services, B2B Protocols > SFTP Client
Description Deletes a document in a specified directory on the trading partner's SFTP server.
Business usage Use this service to delete a document on the trading partner system when the SFTP protocol is required as the communication mechanism with the trading partner.
Usage example A business process is executed that requires the removal of a document on the trading partner's system. The SFTP Client DELETE service, working through the SFTP Client adapter, removes the specified document from the directory on the trading partner system.
Preconfigured? Yes. To implement, use 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:
  • SFTP Client Begin Session service
  • SFTP Client CD service
  • SFTP Client DELETE service
  • SFTP Client End Session service
  • SFTP Client GET service
  • SFTP Client LIST service
  • SFTP Client MKDIR service
  • SFTP Client MOVE service
  • SFTP Client PUT service
  • SFTP Client PWD service
  • SFTP Client RMDIR service
Application requirements An SFTP 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 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 DELETE service:

Field Description
RemoteFileName Name of the file to delete from the remote trading partner directory. Required.
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. Required.

Output from Service to Business Process

The following table contains the parameters passed from the SFTP Client DELETE service to the business process:

Parameter Description
ServerResponse The SFTP server response, which may include a reply code and any text associated with the reply code. Valid values are:
  • OK - 0
  • No Such File - 2
  • Permission Denied - 3
  • General Failure - 4
  • Bad Message - 5
  • No Connection - 6
  • Connection Lost - 7
  • Operation Unsupported - 8
ServiceStartTime The date/time stamp for when the service started.
ServiceEndTime The date/time stamp for when the service ended.

Business Process Example

The following example business process excerpt illustrates by using the SFTP Client DELETE service:

 [[Insert Begin Session]]
<operation name="SFTP Client DELETE Service">
    <participant name="SFTPClientDelete"/>
      <output message="DeleteRequest">
        <assign to="SessionToken" 
       <assign to="RemoteFileName">FilenameToDelete</assign>
      <input message="inmsg">
      <assign to="SFTPClientDeleteServiceResults" from="*"></assign>
[[Insert End Session]]