FTP Client DELETE Service
The FTP Client DELETE service deletes a document on the trading partner system when FTP is used.
The following table provides an overview of the FTP Client DELETE service:
System name | FTP Client DELETE Service |
---|---|
Graphical Process Modeler (GPM) categories | All Services, B2B Protocols > FTP Client |
Description | Use to delete a document in a specified directory on the trading partner's FTP server. |
Business usage | Use this service to delete a document on the trading partner system when FTP is used. |
Usage example | A Sterling B2B Integrator business process is executed that requires the removal of a document on the trading partner's system. Sterling B2B Integrator uses the FTP Client DELETE service, working through the FTP Client adapter, to remove the specified document from the directory on the trading partner system. |
Preconfigured? | No |
Requires third-party files? | No |
Platform availability | All supported Sterling B2B Integrator platforms |
Related services | Related services:
|
Application requirements | An FTP server at the external trading partner location. |
Initiates business processes? | This service does not initiate business processes. |
Invocation | This service is invoked from a business process. |
Business process context considerations | None |
Returned status values | Returned status values:
|
Restrictions | None |
Persistence level | Default |
Testing considerations | Test this service by running the FTPClientDemoAllServices
business process provided with Sterling B2B Integrator. This
business process tests the FTP Client adapter and all its related
services. The FTPClientDemoAllServices business process uses the preconfigured
instance of the FTP Server adapter, which is disabled by default,
and must be enabled before running this test. To verify that the preconfigured FTP Server adapter is enabled, perform the following steps from the Sterling B2B Integrator Admin Console: 1. Choose Business Processes > Deployment > Services > Configuration. 2. Find FTP Server Adapter. 3. If not already selected, select the Enabled check box. To test this service, perform the following steps from the Sterling B2B Integrator Admin Console: 1. Choose Business Processes > Manager. 2. Find the FTPClientDemoAllServices business process. 3. Run the
FTPClientDemoAllServices business process with the following settings:
|
Notes | Every FTP Client service returns a response code
from the server. If this code is an error code as defined by the FTP
specification (that is, 4xx or 5xx) then the business process will
produce a fault. If the error code is expected, use an OnFault service
to continue interacting with the trading partner. There are two exceptions
to this rule:
|
Implementing the FTP Client DELETE Service
- Create an FTP Client DELETE service configuration (or enable the configuration installed with Sterling B2B Integrator and edit parameters as needed). For information, see Managing Services and Adapters.
- Configure the FTP Client DELETE service. For information, see Configuring the FTP Client DELETE Service.
- Use the FTP Client DELETE service in a business process.
Configuring the FTP Client DELETE Service
To configure the FTP Client DELETE service, you must specify settings for the following fields in the GPM:
Field | Description |
---|---|
Config | Name of the service configuration. |
RemoteFileName | The name of the file to delete from the remote trading partner directory. Optional. |
ResponseTimeout | Maximum number of seconds the FTP client waits for the server to respond before the session times out and terminates. Optional. Valid value is any numeric value. The default is the value from the FTP Client Begin Session service ResponseTimeout parameter. Minimum value you can specify is 1 second. If the value you specify is less than 1 second, the FTP Client DELETE service resets the value to 1 second. |
SessionToken | Specifies the identifier for the session established between the FTP Client adapter and the FTP server. Required. |
SaveTranscript | Indicates how to handle the transcript. Valid values
are:
|
Output from Service to Business Process
The following table contains the parameters passed from the FTP Client DELETE service to the business process:
Parameter | Description |
---|---|
ServerResponse | Indicates the FTP server response, which may include a reply code and any text associated with the reply code. Required. |
TranscriptDocumentId | Identifies the document that contains a transcript of the exact exchange with the FTP server. Required. |
Output from Business Process to Service
The following table contains the parameters passed from the business process to the FTP Client DELETE service:
Parameter | Description |
---|---|
RemoteFileName | The name of the file to delete from the remote trading partner directory. Optional. |
ResponseTimeout | Maximum number of seconds the FTP client waits for the server to respond before the session times out and terminates. Optional. Valid value is any numeric value. The default is the value from the FTP Client Begin Session service ResponseTimeout parameter. Minimum value you can specify is 1 second. If the value you specify is less than 1 second, the FTP Client DELETE service resets the value to 1 second. |
SessionToken | Specifies the identifier for the session established
between the FTP Client adapter and the FTP server. Required. Note: The
session token is returned from the FTP Client Begin Session service.
|
SaveTranscript | Indicates how to handle the transcript. Valid values
are:
|
Business Process Example
The following example business process illustrates by using the FTP Client DELETE service.
<sequence>
[[ Insert FTP Client Begin Session ]]
<operation name="FTP DELETE SERVICE">
<participant name="FTPClientDelete"/>
<output message="DeleteRequest">
<assign to="SessionToken" from="/ProcessData/FtpBeginSessionServiceResults/SessionToken/text()">
</assign>
<assign to="RemoteFileName">Filename.txt</assign>
</output>
<input message="inmsg">
<assign to="FtpGetServiceResults" from="*"></assign>
</input>
</operation>
[[ Insert FTP Client End Session ]]
</sequence>