FTP Client RMD Service

The FTP Client RMD service removes a specific directory on the trading partner's FTP server.

The following table provides an overview of the FTP Client RMD service:

System name	FTP Client RMD Service
Graphical Process Modeler (GPM) categories	All Services, B2B Protocols > FTP Client
Description	This service removes a specific directory on the trading partner's FTP server.
Business usage	A business user would use this service to remove desired directories on the server side when the FTP protocol is required as the transport mechanism.
Usage example	A business process is executed that translates documents that must be sent to a trading partner on a daily basis and places them in the directory named for the current date. Once the documents are processed, a business process is executed that removes the directory. This prevents an accumulation of unused and obsolete directories on the server.
Preconfigured?	No
Requires third-party files?	No
Platform availability	All supported Sterling B2B Integrator platforms
Related services	The FTP Client RMD service must be placed between an FTP Begin Session service and an FTP End Session service in a business process. Related services are: FTP Client adapter FTP Client Begin Session service FTP Client CD service FTP Client DELETE service FTP Client End Session service FTP Client GET service FTP Client LIST service FTP Client MOVE service FTP Client PWD service FTP Client PUT service FTP Client QUOTE service FTP Client SITE service FTP Client MODE service FTP Client MKD service
Application requirements	An FTP server at the external trading partner location.
Initiates business processes?	No
Invocation	This service is invoked from a business process.
Business process context considerations	Business processes using the FTP client services should not be marked as Auto Resume. The nature of these protocol services requires an established session, which will no longer exist in a re-start situation.
Returned status values	0 – Success 1 – Error
Restrictions	None
Persistence level	Default
Testing considerations	Debug information for this service can be found in the FTP Client adapter and services log files.
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 (4xx or 5xx) then the business process will produce a fault. If the error code is expected, use a BPML activity to continue interacting with the trading partner. There are two exceptions to this rule: FTP Client GET service: If using the remoteFilePattern parameter and one of the files returns an error code indicating that the file could not be found, the GET command will continue without producing a fault. The error code will still be visible in the Transcript Document. FTP Client QUOTE service: This service never produces a fault, because the service does not know what constitutes a valid response from the quoted command.

Implementing the FTP Client RMD Service

To implement the FTP Client RMD service, complete the following tasks:

Create an FTP Client RMD service configuration (or enable the configuration installed with Sterling B2B Integrator and edit parameters as needed).
Configure the FTP Client RMD service.
Use the FTP Client RMD service in a business process.

Configuring the FTP Client RMD Service

To configure the FTP Client RMD service, you must specify settings for the following fields in the Admin Console and in the GPM:

UI Field	GPM Field	Description
Name		Unique and meaningful name for the service configuration. Required.
Description		Meaningful description for the service configuration, for reference purposes. Required.
Select a group		Select one of the options: None – Do not include the configuration in a service group at this time. Create New Group – Enter a unique name for a new group, which will be created with this configuration. (You can then add other services to the group as well.) Select Group – If service groups already exist for this service type, they are displayed in the list. Select a group from the list.
	Config	Name of the service configuration.
	RemoteDirName	The directory name to be removed from the remote system. Required.
	ResponseTimeout	The maximum number of seconds where no data transfer over the data channel is allowed before the service times out and raises a timeout exception. Optional. Valid value is any numeric value. If no value specified or a timeout value of less than 30 is specified, ResponseTimeout defaults to 30 seconds.
	SaveTranscript	Indicates how to handle the transcript. Optional. Valid values are: Error only – Persists the transcript only when an error occurs On – Always persists the transcript (Default)
	SessionToken	Specifies the identifier for the session established between the FTP Client adapter and an FTP server. Required. Note: The session token is returned from the FTP Client Begin Session service.

Parameters Passed from Business Process to Service

The following table contains the parameters passed from the business process to the FTP Client RMD service:

Parameter	Description
RemoteDirName	The directory name to be removed from the remote system. Required.
ResponseTimeout	The maximum number of seconds where no data transfer over the data channel is allowed before the service times out and raises a timeout exception. Optional. Valid value is any numeric value. If no value specified or a timeout value of less than 30 is specified, it will be defaulted to 30 seconds.
SaveTranscript	Indicates how to handle the transcript. Optional. Valid values are: Error only – Persists the transcript only when an error occurs On – Always persists the transcript (Default)
SessionToken	Specifies the identifier for the session established between the FTP Client adapter and an FTP server. Required. Note: The session token is returned from the FTP Client Begin Session service.

Parameters Passed from Service to Business Process

The following table contains the parameters passed from the FTP Client RMD 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.
TranscriptDocumentId	Identifies the document that contains a transcript of the exact exchange with the FTP server.

Business Process Example

The following business process uses the FTP Client RMD service to remove a directory on the remote FTP server.

<process name="FtpExample">
  <sequence> 
[[Insert Begin Session ]] 
<operation name="FTP Client RMD Service">
      <participant name="FTPClientRmd"/>
      <output message=" RmdRequest ">
                <assign to="." from="*"></assign>
                <assign to="RemoteDirName">FTPTEST</assign>
      </output>
      <input message="FtpRmdResults ">
	<assign to=”RmdResults” from=”*”/>
      </input>
  </operation>          
    </operation>
 [[Insert end session here]]
  </sequence> 
</process>