From cb8f9d84b2e5686fdfdc9140df678198ee6cacf8 Mon Sep 17 00:00:00 2001 From: Laurie Montant Date: Thu, 7 Aug 2025 16:38:25 +0200 Subject: [PATCH] readme --- README.md | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 53cf1e5..0f1ecdd 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,20 @@ # Reflex Platform Core FTLs +## Overview +The **Reflex WMS Connector** is a set of **FreeMarker templates (FTL)** designed to transform **outgoing JSON flows from Reflex WMS** into **flows compatible with Reflex Platform**. -These FTL core files aim to translate data flow from Reflex WMS into Reflex platform API. +This connector does not contain any standalone executable code: it is intended to be used by **Reflex integration engines** or **data exchange pipelines**, where it applies the mapping rules defined in the `.ftl` files. +## Role of the FTL Files +- Each `.ftl` file corresponds to a **flow type** (order, stock, receipt, shipment, etc.). +- These templates use the **FreeMarker** syntax to: + - Extract the required fields from the WMS source flow. + - Apply transformation rules (mapping, conversions, enrichments). + - Generate a **final structured JSON** for Reflex Platform. -You can find more info about those files in the Reflex platform documentation center : https://docs.viz.reflex-platform.com/connectivity/partnerapp/reflex-wms-connector/ +## Useful Resources + +- [FreeMarker Documentation](https://freemarker.apache.org/docs/index.html) +- [Reflex Platform](https://auth.reflex-platform.com/)