FTP Client MOVE Service

The FTP Client MOVE service renames a document or moves it from one directory to another.

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

System name	FTP Client MOVE Service
Graphical Process Modeler (GPM) categories	All Services, B2B Protocols > FTP Client
Description	This service is used to rename a document or move it from one directory to another.
Business usage	You would use this service to rename or move a document on a trading partner's system when the FTP protocol is required as the communication mechanism with the trading partner.
Usage example	A Sterling B2B Integrator business process is executed that requires moving a document on the trading partner's system. Sterling B2B Integrator uses the FTP Client MOVE service, working through the FTP Client adapter, to move the specified document from one directory to another on the trading partner system.
Preconfigured?	No
Requires third-party files?	No
Platform availability	All supported Sterling B2B Integrator platforms
Related services	Related services: FTP Client adapter FTP Client Begin Session service FTP Client CD service FTP Client DELETE service FTP Client End Session service FTP Client LIST service FTP Client GET service FTP Client PUT service FTP Client PWD service FTP Client SITE service FTP Client QUOTE service
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: 0 –Success 1 –Error
Restrictions	No
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: Run As User = Admin Server filename = <install_directory>/installed_data/ psftpclient/FTPClientDemoImport.xml. 4. Verify that the business process runs successfullyDebug 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 (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: 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 MOVE Service

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

Create an FTP Client MOVE 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 MOVE service. For information, see Configuring the FTP Client MOVE Service.
Use the FTP Client MOVE service in a business process.

Configuring the FTP Client MOVE Service

To configure the FTP Client MOVE service, you must specify settings for the following fields in the GPM:

Field	Description
Config	Name of the service configuration.
RemoteFromFileName	The current name of the remote file. Required.
RemoteToFileName	The new name of the remote file. Required.
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 MOVE service resets the value to 1 second.
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.
SaveTranscript	Indicates how to handle the transcript. Valid values are: erroronly – persists the transcript only when an error occurs on – always persists the transcript Default is on. Optional.

Output from Service to Business Process

The following table contains the parameters passed from the FTP Client MOVE 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 MOVE service:

Parameter	Description
RemoteFromFileName	The current name of the remote file. Required.
RemoteToFileName	The new name of the remote file. Required.
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 MOVE service resets the value to 1 second.
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.
SaveTranscript	Indicates how to handle the transcript. Valid values are: erroronly – persists the transcript only when an error occurs on – always persists the transcript Default is on. Optional.

Business Process Example

The following example business process illustrates by using the FTP Client MOVE service:

<sequence>
  [[Insert FTP Client Begin Session ]] 
    <operation name="FTP MOVE SERVICE"> 
    <participant name="FTPClientMove"/> 
    <output message="MoveRequest"> 
      <assign to="SessionToken" 
          from="/ProcessData/FtpBeginSessionServiceResults/SessionToken/text()">
      </assign> 
      <assign to="RemoteFromFileName">oldFileNameAndDirectory</assign> 
      <assign to="RemoteToFileName">newFileNameAndDirectory</assign> 
    </output> 
    <input message="inmsg"> 
      <assign to="FtpMoveResults" from="*"></assign> 
    </input> 
    </operation> 
  [[Insert FTP Client End Session]] 
</sequence>