FTP Client Adapter

Business Scenario

You want to send a file to a trading partner, using FTP. The file must be placed in a specific directory on the trading partner's FTP server. After putting the file in the directory, you want to list the contents of the directory to verify that it was copied correctly.

Business Solution Example

This business solution is described for both the GPM and the BPML.

GPM Example

The following example shows a solution to the above business scenario using the GPM:

Business Process Modeling Language (BPML) Example

The following example shows the corresponding business process solution by using BPML:

<process name="default">
  <sequence>
    <operation name="FTP Client Begin Session Service">
      <participant name="FTPClientBeginSession"/>
      <output message="FTPClientBeginSessionServiceTypeInputMessage">
        <assign to="CipherStrength">STRONG</assign>
        <assign to="ClearControlChannel">NO</assign>
        <assign to="ConnectionRetries">2</assign>
        <assign to="FTPClientAdapter">FTPClientAdapter</assign>
        <assign to="ProfileId">tradingpartner1</assign>
        <assign to="RemoteHost">000.00.000.00</assign>
        <assign to="RemotePasswd">uuuuuuuu</assign>
        <assign to="." from="*"></assign>
      </output>
      <input message="inmsg">
        <assign to="." from="*"></assign>
      </input>
    </operation>
    <operation name="FTP Client CD Service">
      <participant name="FTPClientCd"/>
      <output message="FTPClientCdServiceTypeInputMessage">
        <assign to="CdUp">YES</assign>
        <assign to="." from="*"></assign>
      </output>
      <input message="inmsg">
        <assign to="." from="*"></assign>
      </input>
    </operation> 
<operation name="FTP Client LIST Service">
      <participant name="FTPClientList"/>
      <output message="FTPClientListServiceTypeInputMessage">
        <assign to="ConnectionType">ACTIVE</assign>
        <assign to="." from="*"></assign>
      </output>
      <input message="inmsg">
        <assign to="." from="*"></assign>
      </input>
    </operation>
    <operation name="FTP Client PUT Service">
      <participant name="FTPClientPut"/>
      <output message="FTPClientPutServiceTypeInputMessage">
        <assign to="DocumentId">doc12345</assign>
        <assign to="." from="*"></assign>
      </output>
      <input message="inmsg">
        <assign to="." from="*"></assign>
      </input>
    </operation> 
<operation name="FTP Client End Session Service">
      <participant name="FTPClientEndSession"/>
      <output message="FTPClientEndSessionServiceTypeInputMessage">
        <assign to="." from="*"></assign>
      </output>
      <input message="inmsg">
        <assign to="." from="*"></assign>
      </input>
    </operation> 
</sequence> 
</process>

Implementing the FTP Client adapter

Configuring the FTP Client adapter

To configure the FTP Client adapter, you must specify field settings in Sterling B2B Integrator.

Support for FTP Adapters in Active mode on a Certified Container platform

During file transfer using FTP protocol, in Active mode, the FTP client initiates the control connection with the FTP server and sends an IP address and a range of ports to which the server opens the data connection channel. While setting up the FTP adapters for a Certified Container deployment, you can provide the IP information to be passed by the FTP client.

You must set the property ps_ftpclient.afterNATAddress with the external IP address.