Guide - Transport Framework (valid to 7.9)

1 Introduction

Regarding online shops there is large amount of data import and export processes. Product data and price data has to be imported, order data has to be exported. The origins of the product and price data are often files from another server. The target destination of the order data is also often another server. The Transport Framework can transport files from a location of the network to another, where they can be processed.

2 Sources

The source code belongs to the cartridges bc_transport and bc_transport_orm. Both are part of the p_platform component set.

The UI source code is added to the according Commerce Management cartridge via an extension point. 

3 Functionality

The Transport Framework allows to perform file transports via SFTP, FTP, HTTP(S) or EMAIL.
For SFTP and FTP, pushing and pulling are possible. Because of the nature of HTTP and EMAIL, files can only be read from HTTP(S) and send by mail.

4 Access Privilege

To access the Transport Framework, the user must have the access privilege Transport Manager.

5 Database Tables

A configuration of the Transport Framework is stored in the database tables TRANSPORTCONFIG and TRANSPORTCONFIG_AV.

6 DBInit

The feature requires a dbinit of the cartridge bc_transport_orm from p_platform.

7 DBInit, DBMigrate

A Transport Configuration can also be created with a dbinit- or dbmigrate-step.

The preparers are:

com.intershop.component.transport.dbinit.PrepareTransportConfiguration
com.intershop.component.transport.dbmigrate.AddTransportConfiguration

Each preparer requires a property file for configuration purposes. In the property file, the keys from the class TransportConstants are read and the result is written in the DB. There is no parameter validation. This way, a blueprint can be created via dbmigrate. Such blueprint can be completed later.

Examples are in the source-code in the folder bc_transport_orm/staticfiles/cartridge/lib/com/intershop/component/transport/dbinit.

SFTP.properties
domain 				    = inSPIRED-inTRONICS
process.type 		    = SFTP
# Common settings
process.displayname     = testSFTP
process.id 			    = testSFTP
file.include.pattern    = 
file.exclude.pattern    = 
location.local 		    = ${IS_SHARE}\\sites\\${SITE_NAME}\\units\\${UNIT_NAME}\\impex\\export
location.archive 	    = 
# remote location settings
remote.protocol         = SFTP
remote.hostname 	    = localhost
remote.port 		    = 
location.remote         = ./test
# authentication settings
authentication.method   = PASSPHRASE
authentication.username = tester
authentication.password = password
authentication.keyfilepath = 
# transfer settings
process.direction 		= PUSH
process.transferlimit   = 
process.delete     		= true

 

8 Usage

8.1 Transport Configuration List

  1. Log into the Commerce Management application (organization = Operations).
  2. Ensure you have the required access privilege.
  3. In the left navigation select Transport Configuration.
  4. Each configuration belongs to a domain.

  5. Select a domain and click Apply.
    All available configurations for the domain are displayed in the list.

8.2 Create a New Configuration

  1. Go to the Transport Configuration list.
  2. Select a domain and click Apply.
  3. Enter a Name.
  4. Select a Type.
    EMAIL, HTTP, FTP, SFTP
  5. Click Add.

8.3 Delete a Configuration

  1. Go to the Transport Configuration list.
  2. Select a domain and click Apply.
  3. Mark the checkbox of the desired configuration.
    You may select multiple configurations at once.
  4. Click Delete and confirm with OK.

8.4 Edit a Configuration

  1. Go to the Transport Configuration list.
  2. Select a domain and click Apply.
  3. Click the link (Name column) of the desired configuration
    The configuration's detail page is displayed.
  4. Enter all required parameters.
    Depending on the selected Type of the configuration different parameters have to be specified.
    However, each input field provides substantial help texts.
  5. Click Apply.

Note

A configuration cannot be saved until all mandatory fields are filled with valid parameters. Until this far a message is displayed, which states that the configuration is invalid.

Please note that the input fields have only basic validation. E.g., if an URL is required, there is only a check that the entered string can be parsed as a URL, but there is no check that the endpoint exists.

8.4.1 SFTP Example

For a push or pull, the host and the remote location must be entered. The remote location is then the path to the folder who is source or target of a push- or pull-event.

9 Execute a Transport Job

A Transport Configuration can be executed in the System Management application.

  1. Log into the System Management application.
  2. Select the Domain (site) where you intend to create the schedule and click Apply.
  3. Enter all required parameters and click Apply.

    ParameterValue
    PipelineFileTransportJob
    StartnodeStart

  4. Switch to the Attributes tab.

  5. The job needs two parameters:

    1. The TransportProcessID = Process ID of the transport configuration.
    2. The UnitName (name of the domain)

Disclaimer

The information provided in the Knowledge Base may not be applicable to all systems and situations. Intershop Communications will not be liable to any party for any direct or indirect damages resulting from the use of the Customer Support section of the Intershop Corporate Web site, including, without limitation, any lost profits, business interruption, loss of programs or other data on your information handling system.

Customer Support
Knowledge Base
Product Resources
Support Tickets