You've already forked reflex-wms-connector
46 lines
2.5 KiB
Markdown
46 lines
2.5 KiB
Markdown
# HARDIS SC NETWORK Core FTLs
|
|
|
|
## Overview
|
|
|
|
The **HARDIS WMS Connector** is a set of **FreeMarker templates (FTL)** designed to transform **outgoing JSON flows from HARDIS WMS** into **flows compatible with HARDIS SC NETWORK**.
|
|
|
|
This connector does not contain any standalone executable code: it is intended to be used by **HARDIS WMS 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, appointment 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 HARDIS SC NETWORK.
|
|
|
|
## Useful Resources
|
|
|
|
- [FreeMarker Documentation](https://freemarker.apache.org/docs/index.html)
|
|
- [HARDIS SC NETWORK](https://auth.reflex-platform.com/)
|
|
|
|
## Tagging & Deployment
|
|
|
|
Steps to follow in order to create a new patch for an existing release :
|
|
|
|
### Update the `release/x.y` branch
|
|
1. Create a branch from the `release/x.y` branch.
|
|
2. Cherry pick the relevant commits from the `develop` branch into your branch.
|
|
3. Merge your branch into the `release/x.y` branch.
|
|
|
|
### Tag the new release patch
|
|
1. Using the [Plaform Release Management Tools](https://gitlab.hardis-group.com/r-d-technique/reflex-platform/tools), use the `tag.sh` script in order to patch the FTLs.
|
|
2. Type in `reflex-wms-connector` as the target repository.
|
|
3. Select option 4 `New build patch number (+n)`.
|
|
4. A new tag will be created for your patch.
|
|
5. Create and approve a merge request once changes are ready from the `release/x.y` branch to the `main-x.y` branch.
|
|
|
|
### Deployment
|
|
1. On [Integration Setup Repository](https://gitlab.hardis-group.com/r-d-technique/reflex-platform/deployment/integration-setup), `source init.context.sh <env>` to set the environment.
|
|
2. Update the connectors versions using the latest tag created in the previous step in `env-var/versions.app.integration-<env>.sh`
|
|
3. `./publish-ftl.sh "releases" "all" "all"`
|
|
4. From the [Platform Setup Repository](https://gitlab.hardis-group.com/r-d-technique/reflex-platform/deployment/platform-setup), `source init.context.sh <env>` to set the environment.
|
|
5. `./100.upgrade-release/pause-watchdog-restart-all-connections.sh`
|
|
6. `./100.upgrade-release/save-connections-status.sh`
|
|
7. `./100.upgrade-release/update-connections-ftl-save.sh`
|
|
8. `./100.upgrade-release/resume-watchdog-restart-all-connections.sh` |