The document discusses hot folders in SAP Hybris, which allow for automated import of data from files placed in a monitored folder. A hot folder uses Spring Integration to continuously monitor a folder for new files and process them. Key advantages are that hot folders automate data import without needing Impex knowledge and allow importing from other systems via CSV files. The document reviews hot folder configuration options and provides an example of importing stock data. It also discusses customizing hot folder processing through filters, cell decorators, and translators.

1. ABDELGHANIAZRI
HYBRIS TECHNICAL LEAD

2. + Summary:
✓ What is Hot folder ?
✓ Hot folder in other integration frameworks
✓ Advantages of Hot folder
✓ Basics configuration
✓ Demo
✓ Advanced customization
HOT FOLDER
15/09/2015© SQLI GROUP 2015 – Gestion des flux avec SAP Hybris Hot folder 2

3. Hot folder
✓ What is Hot-folder ?
✓ A folder that serves as a staging area for some purpose. The hot folder is continuously
monitored, and when files are copied or dropped into it, they are automatically
processed. (PC Magazine)
✓ Following Hybris:
✓ Hot Folder = Scanned Folder periodically + processed
HOT FOLDER
© SQLI GROUP 2015 – Gestion des flux avec SAP Hybris Hot folder 15/09/2015 3

4. Hot folder
✓ Implementations
The hot folder mechanism is implemented by many frameworks:
▪ Camel
▪ Spring integration
▪ Mule ESB
▪ …
✓ Hybris case
▪ Hybris support hot folder by using Spring integration which:
▪ pluggable,
▪ highly configurable service-based design
▪ extendable.
▪ Easy integration with Hybris
HOT FOLDER
© SQLI GROUP 2015 – Gestion des flux avec SAP Hybris Hot folder 15/09/2015 4

5. Hot folder
✓ Why using Hot folder ?
✓ Automatize data import: product, stock, vendors…
✓ No need of Impex knowledge
✓ The use of .csv files instead of impex files (other formats: xml need
customization)
✓ Files can be generated by other systems: Talend for example.
HOT FOLDER
© SQLI GROUP 2015 – Gestion des flux avec SAP Hybris Hot folder 15/09/2015 5

6. + Hot-folder mechanism: Batch diagram
HOT FOLDER
© SQLI GROUP 2015 – Gestion des flux avec SAP Hybris Hot folder 15/09/2015 6

7. + Hot-folder mechanism
HOT FOLDER
© SQLI GROUP 2015 – Gestion des flux avec SAP Hybris Hot folder 15/09/2015 7

8. + Hot-folder mechanism
✓ Batch integration
HOT FOLDER
© SQLI GROUP 2015 – Gestion des flux avec SAP Hybris Hot folder 15/09/2015 8

9. + Hot-folder mechanism
✓ Batch import
HOT FOLDER
© SQLI GROUP 2015 – Gestion des flux avec SAP Hybris Hot folder 15/09/2015 9

10. + Configuration
10
Configuration
HOT FOLDER
File Name Description
hot-folder-common-spring.xml Common configuration: delimeter, parser, fallback
extensionName-spring-
integration-siteName.xml
Extension related spring integration infrastructure including hot
folder setup.
Extension related ImpEx converters, filters and converter
mappings…
project.properties acceleratorservices.batch.impex.max-threads: number of
threads used for ImpEx.
acceleratorservices.batch.impex.basefolder: base folder of the
import infrastructure containing catalog specific sub folders.
© SQLI GROUP 2015 – Gestion des flux avec SAP Hybris Hot folder 15/09/2015

11. + Task configuration
11
Configuration
HOT FOLDER
Configuration option Parameters
ImpexTransformerTask converterMap: used to map file prefixes to one or multiple converters to produce ImpEx files.
encoding: the file encoding to use (default: UTF-8).
linesToSkip: the lines to skip in all CSV files (default: 0).
fieldSeparator: the separator to use to read CSV files (default: ,).
HeaderSetupTask catalog: the catalog to use. This setting is applied to the default header substitution $CATALOG$
net: the net setting to apply to prices. This setting is applied to the default header substitution
$NET$
HeaderInitTask sequenceIdParser: the regular expression used to extract the sequence ID from the file name. In
the sample configuration, the sequence ID precedes the file extension separated by a hyphen, for
example: base_product-1.csv.
languageParser: the regular expression used to extract the language from the file name. In the
sample configuration, the language optionally precedes the sequence ID, for example:
base_product-de-1.csv.
fallbackLanguage: the language to use if the language is not set in the file name.
CleanupTask CleanupHelper.timeStampFormat: if set, append timestamp in the specified format to input files
moved to the archive or error subdirectory
© SQLI GROUP 2015 – Gestion des flux avec SAP Hybris Hot folder 15/09/2015

12. + Converter configuration
12
Configuration
HOT FOLDER
Configuration Option Parameters
header $NET$: the net setting
$CATALOG$: the catalog prefix
$LANGUAGE$: the language setting
$TYPE$: an optional type attribute that can be applied if filtering is configured
impexRow {('+')? (<columnId> | 'S')}.: {+0} to make check of mandatory attribute, {+S} to generate a
sequence ID.
rowFilter: an optional row filter. Allow use of expression which must be a valid Groovy expression
For example, querying if the first column is not empty can be written as !row.
type: an optional type that can be retrieved in the header using the header substitution $TYPE$.
© SQLI GROUP 2015 – Gestion des flux avec SAP Hybris Hot folder 15/09/2015

13. + Spring integration configuration
13
Configuration
HOT FOLDER
Configuration Option Parameters
int:channel Setup of a channel
int:service-activator activates a referenced bean when receiving a message on a configured channel to act as service
file:inbound-channel-adapter Scan a directory in a configurable interval and send files to a configured channel following order
defined by FileOrderComparator
file:outbound-gateway Move a file to the processing subdirectory.
© SQLI GROUP 2015 – Gestion des flux avec SAP Hybris Hot folder 15/09/2015

14. + Configuration
1. 1-Base directory
HOT FOLDER
© SQLI GROUP 2015 – Gestion des flux avec SAP Hybris Hot folder 15/09/2015 14

15. + Configuration
1. 2- Define inbound-channel-adapter to scan the input folder
HOT FOLDER
© SQLI GROUP 2015 – Gestion des flux avec SAP Hybris Hot folder 15/09/2015 15

16. + Configuration
1. 3- Create an outbound-gateway to copy files to the usual processing folder
HOT FOLDER
© SQLI GROUP 2015 – Gestion des flux avec SAP Hybris Hot folder 15/09/2015 16

17. Hot folder Basics
✓ Configuration
1. 4- Define a specific converter for stock and according to this a converter mapping
Stock example:
HOT FOLDER
© SQLI GROUP 2015 – Gestion des flux avec SAP Hybris Hot folder 15/09/2015 17

18. Hot folder Basics
✓ Configuration
Vendors example:
HOT FOLDER
© SQLI GROUP 2015 – Gestion des flux avec SAP Hybris Hot folder 15/09/2015 18

19. Hot folder Basics
✓ Configuration
Converter mapping:
HOT FOLDER
© SQLI GROUP 2015 – Gestion des flux avec SAP Hybris Hot folder 15/09/2015 19

20. ✓ Base directory structure
HOT FOLDER
© SQLI GROUP 2015 – Gestion des flux avec SAP Hybris Hot folder 15/09/2015 20

21. ✓ Hot folder Basics
Input
Archive:
Files after
processing
processing
Error:
mandatory
attributes
HOT FOLDER
© SQLI GROUP 2015 – Gestion des flux avec SAP Hybris Hot folder 15/09/2015 21

22. Demo
HOT FOLDER
© SQLI GROUP 2015 – Gestion des flux avec SAP Hybris Hot folder 15/09/2015 22

23. ✓ Hot folder Customization
Filter
• Used before
conversion
• Intercept format
errors: date,
numbers…
• Reject or import
line
Cell decorator
• intercept the
interpreting of a
specific cell of a
value line between
parsing and
translating
• Acts on a specific
column
Translator
• Change the
translate logic for
some attribute.
• Ex: header
attributes that have
no counterpart at
the type system
• Act on a specific
column
HOT FOLDER
© SQLI GROUP 2015 – Gestion des flux avec SAP Hybris Hot folder 15/09/2015 23

24. ✓ Advanced customization: Filter
HOT FOLDER
© SQLI GROUP 2015 – Gestion des flux avec SAP Hybris Hot folder 15/09/2015 24

25. ✓ Hot folder Customization: Decorator
HOT FOLDER
© SQLI GROUP 2015 – Gestion des flux avec SAP Hybris Hot folder 15/09/2015 25

26. ✓ Hot folder Customization: Other customizations convert XML to CSV
HOT FOLDER
© SQLI GROUP 2015 – Gestion des flux avec SAP Hybris Hot folder 15/09/2015 26

27. ✓ Conclusion:
✓ Hot folder as alternative solution to ImpEx
✓ Usability
✓ Configuration
✓ Customization
HOT FOLDER
© SQLI GROUP 2015 – Gestion des flux avec SAP Hybris Hot folder 15/09/2015 27

28. ✓ References
✓ http://www.pcmag.com/encyclopedia/term/67604/hot-folder
✓ https://wiki.hybris.com/display/R5T/Hot+Folder
✓ http://www.enterpriseintegrationpatterns.com/patterns/messaging/Channel
Adapter.html
✓ https://wiki.hybris.com/display/forum/Execute+JOB+Now
✓ http://stackoverflow.com/questions/21413978/convert-an-xml-file-to-csv-
file-using-java
✓ https://wiki.hybris.com/display/release5/ImpEx+API
HOT FOLDER
© SQLI GROUP 2015 – Gestion des flux avec SAP Hybris Hot folder 15/09/2015 28

29. Merci …
QUESTIONS ?