Configuring an SFTP transport to retrieve external files for the Data Load utility

You can create and configure an SFTP transport for a Data Load utility scheduled job to use to retrieve an input file from an external source for loading into WebSphere Commerce.

Before you begin

Ensure that you complete the following tasks:

Ensure that the data in the file that you are retrieving is compatible with the corresponding data in WebSphere Commerce.

About this task

When the SFTP transport is configured, a Data Load utility scheduled job can use the defined parameters for the transport to retrieve one or more CSV files from an external site. The job can then call the Data Load utility to use the files as input files to load data into WebSphere Commerce.

Note: If your WebSphere Commerce instance includes multiple stores, each store needs to have a separate SFTP transport configured.

WebSphere Commerce Enterprise If your site uses the extended sites store model, configure an SFTP transport for each extended site store and for your catalog asset store. With these transports, you can use a scheduled job and the Data Load utility to load prices into the asset store. These prices can be inherited by one or more extended sites stores. You can then load prices into each extended site store to override the inherited prices when needed.

Procedure

Connect to the WebSphere Commerce database and update the TRANSPORT database table to include an entry for your new transport method. Choose a transport ID that is not in use.
For example,
TRANSPORT_ID TIMEOUT IMPLEMENTED ADDRESSABLE CODE NAME DESCRIPTION
101 0 'Y' 'N' NULL MySFTPTransport MySFTPTransportDesc

Update the WebSphere Commerce configuration file to include your new transport. By including your transport in this file, you can access the transport in the Administration Console for your site. Add the following configuration.

<OutboundConnector default="true" enabled="true" id="101" name="MySFTPTransport" retries="3">
  <JNDI JndiName="eis/JCAMySFTPTransport" display="false"/>
  <InteractionSpec
    ClassName="com.ibm.commerce.wc.messaging.adapters.jcaftp.JCAFTPInteractionImpl" default="true"/>
  <ConnectionSpec
    ClassName="com.ibm.commerce.wc.messaging.adapters.jcaftp.JCAFTPConnectionSpecImpl" default="true">
    <EditableProperty Admin="host" display="true" editable="Yes" encrypt="No" name="setHost" value=""/>
    <EditableProperty Admin="port" display="true" editable="Yes" encrypt="No" name="setPort" value=""/>
    <EditableProperty Admin="userName" display="true" editable="Yes" encrypt="No" name="setUserName" value=""/>
    <EditableProperty Admin="password" display="true" editable="Yes" encrypt="Yes" name="setPassword" value=""/>
    <EditableProperty Admin="remoteDirectory" display="true" editable="Yes" encrypt="No" name="setRemoteDirectory" value=""/>
  </ConnectionSpec>
</OutboundConnector>

Restart the WebSphere Commerce server.
Open the Administration Console and select Site on the Administration Console Site/Store Selection page.
Click Configuration > Transports. The Transport Configuration page displays.
Click Add. The Add Transport page displays.
In the list of Available Transports, select your new transport type and click Add.
On the Transport Configuration page, select the newly added transport and click Configure.
On the Transport Configuration Parameters page, enter the values to configure your transport.
For example:

Host

The host name or IP address for your external site.

Port

The port number for your external site. The default port number is 22.

User name

The user name to access the external site.

Password

The password to access the external site.

Remote directory

The directory on the external site where the exported CSV files are located for a Data Load utility to retrieve.

Note: Your transport can include more or different customization parameters that depend on how you created your transport type.
Click the OK. Your custom SFTP transport for the Data Load utility scheduled job is configured.

What to do next

After you define and enable the transport, you can use the WebSphere Commerce Administration Console to configure a scheduled job to use the transport to retrieve the input file from the external source. For more information, see Configuring a Data Load utility scheduler job.

Note: When you configure a scheduler job to use your new transport, you must include the job parameter "transport=TRANSPORT_ID", where TRANSPORT_ID is the ID for your new transport. For example, "transport=101"