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.
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.
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.
To access the Transport Framework, the user must have the access privilege Transport Manager.
A configuration of the Transport Framework is stored in the database tables TRANSPORTCONFIG
and TRANSPORTCONFIG_AV
.
The feature requires a dbinit of the cartridge bc_transport_orm from p_platform.
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.
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
Each configuration belongs to a domain.
Select a domain and click Apply.
All available configurations for the domain are displayed in the list.
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.
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.
A Transport Configuration can be executed in the System Management application.
Enter all required parameters and click Apply.
Parameter | Value |
---|---|
Pipeline | FileTransportJob |
Startnode | Start |
Switch to the Attributes tab.
The job needs two parameters:
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.