Contents
Document Logs
Change log:
Date: |
Author: |
Version: |
Changes: |
Completed |
Ext. |
Int. |
Is in Core |
|---|---|---|---|---|---|---|---|
Unknown macro: {page-info}
|
Unknown macro: {page-info}
|
0.1 |
Doc. created |
No |
|
|
|
Terms and definitions:
Terms/definitions: |
Meaning: |
|---|---|
TBD |
To be defined |
N/A |
Not applicable |
----
1 - Purpose of Document
This document provides the overall technical details and design of implementing and using the functionality as specified in section 2 - Introduction. This document will not cover implementation details – for this the code base should be inspected.
2 - Introduction to Functionality
The Electra Logistics Engine handles the order placing and the retrieval of the order status from Electra. The general process is:
- The Electra Logistics Engine picks up new ShopOrders (ShopOrder status is READY) or ShopOrders already tried registered at Electra (ShopOrder status is PLACEORDER_FAILED).
The Electra Logistics Engine validates each ShopOrder and related ShopOrderLine and Users entries before placing the order at Electra. Name and Address fields of Users entry must be present. A unique OrderNumber present on the ShopOrder is also validated. Invalid ShopOrders are set to status Error.
The Electra Logistics Engine registers valid ShopOrders at Electra. Succesfully placed ShopOrders at Electra is set to status PLACEORDER_SUCCESFUL.
ShopOrders failed to be registered at Electra are set to either status PLACEORDER_FAILURE or ERROR. ShopOrders set to status PLACEORDER_FAILURE are being picked up again and tried to be placed at Electra by the Electra Logistics Engine at the next time it runs. - The Electra Logistics Engine picks up registered or placed ShopOrders (ShopOrder status is PLACEORDER_SUCCESFUL) and gets the status of the order and order information from Electra. If the order has been shipped by Electra package tracking ids, ICC numbers are updated on the ShopOrder and ShopOrder lines.
4 - Configuration
Parameters under ENGINE.LOGISTICS.ELECTRA
Key |
Default |
Description |
Optional |
|---|---|---|---|
WSDL_PATH |
|
Absolute path for the WSDL file for the engine. Mandatory. |
No |
MAX_ORDER_REQUESTS |
50 |
Maximum number of orders handled by engine each run |
Yes |
ORDER_EXPIRE_PERIOD |
30 |
Number of days it takes for an order to expire |
Yes |
5 - Operational Considerations
Security
At time of writing Electra validates incoming requests based upon the senders IP. No other security is used.
Migration
The Electra Logistics Engine solely picks up ShopOrders with the field logistic_key set 'ELECTRA'.
ShopSKU's which should be handled by Electra should have the field logistics_provider_key changed to 'ELECTRA'.