SFTP Client MOVE Service
The SFTP Client MOVE service moves or renames a document from one directory to another on the trading partner's SFTP server.
The following table provides an overview of the SFTP Client MOVE service:
Category | Description |
---|---|
System name | SFTP Client MOVE Service |
Graphical Process Modeler (GPM) category | All Services, B2B Protocols > SFTP Client |
Description | Moves or renames a document from one directory to another on the trading partner's SFTP server. |
Business usage | Use this service to move or rename 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 to move or rename a document on the trading partner's system. Sterling B2B Integrator uses the SFTP Client MOVE service, working through the SFTP Client adapter, to move the specified document from one directory to another on the trading partner system. |
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. |
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 the 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 MOVE service:
Field | Description |
---|---|
RemoteFromFileName | The current name of the remote file. Required. Note: Wildcards
are not supported.
|
RemoteToFileName | The new name of the remote file. 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 MOVE 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:
|
Business Process Example
The following example business process excerpt illustrates by using the SFTP Client MOVE service:
[[Insert Begin Session]]
<operation name="SFTP MOVE SERVICE">
<participant name="SFTPClientMove"/>
<output message="MoveRequest1">
<assign to="SessionToken"
from="/ProcessData/SftpBeginSessionServiceResults/SessionToken/text()">
</assign>
<assign to="RemoteFromFileName">OldFilename</assign>
<assign to="RemoteToFileName">NewFilename</assign>
</output>
<input message="inmsg">
<assign to="SftpMoveResults" from="*"></assign>
</input>
</operation>
[[Insert End Session]]