FleXipod Interface
From CTMS
Note: This is an incomplete guide at present.
Configuration
Parameters
Several parameters must be configured:
- FLEXIPOD - Controls whether the FlexiPOD interface is enabled for sending.
- FLEXIPOD_DEPOTS - Controls whether the export to FlexiPOD is configured by Depot Location.
- FLEXIPOD_CARRIERS - Controls whether the export to FlexiPOD is configured by Depot Location.
- FLEXIPOD_WEBSERVICE_UI - The FlexiPOD webservice endpoint for updating items
- FLEXIPOD_WEBSERVICE - The FlexiPOD webservice endpoint for sending manifests
- FLEXIPOD_USERNAME - The username for the FlexiPOD webservices
- FLEXIPOD_PASSWORD - The password for the FlexiPOD webservices
- FLEXIPOD_SYSTEMID - The system ID for the FlexiPOD webservices
- FLEXIPOD_USERCODE - The usercode for the FlexiPOD webservices
- FLEXIPOD_CLIENTNUM - The Client Number for the FlexiPOD webservices
- FLEXIPOD_SYSTEM - The system for the FlexiPOD webservices
- FLEXIPOD_SCAN_LEVEL - Controls how items are sent to FlexiPOD. Values: "1", "2"
- FLEXIPOD_DROP - Controls how drops are updated from FlexiPOD. Values "STOP-OMS", "NONE"
- FLEXIPOD_SCAN_TYPE - Controls how items are sent to FlexiPOD. Values: "ITEMS", "CONTENTS"
Carrier
FLEXIPOD flag must be enabled when configured by carrier (system parameter FLEXIPOD_CARRIERS) for carriers that require the use of FlexiPOD.
Depot Locations
FLEXIPOD flag must be enabled when configured by depot (system parameter FLEXIPOD_DEPOTS) for depots that require the use of FlexiPOD.
EDI Processes
- SOAP Webservice must be set up pointing to DP_FLEXIPOD.flexipod_event_in. This processes the messages from FlexiPOD into an intermediary file and then onto staging files.
- Timed EDI process must be set up based on process get_flexipod_in. This processes the staging files into the system.
Reason Codes
Several ITEM_NON_CON reason codes must be created:
- "SKP" - "Items Skipped on Device"
- "WIP" - "Route in Progress"
- "OD" - "Out for delivery"
- "RM" - "Removed from Route"
Plus any reason codes created in FlexiPOD must be created within TMS for the audit history to accurately represent any reasons selected by the driver.
Sending Trips to FlexiPOD
This happens automatically when:
- the trip is set to status "ACCEPTED" or "EN-ROUTE"
- when any changes happen to the trip i.e. orders are added, removed or moved on a trip that is at those statuses.
- When the driver, carrier or tractor has been added or changed on a trip that is at those statuses.
Actions Taken on Update
Several general status change messages can be sent to CTMS from FlexiPOD with item level information.
105 - Complete/Cancelled
- Updates the stop actual arrive time and sets the actual depart time to that plus 10 minutes, when no item is specified (i.e. an update just for the stop.
- Updates stop actual depart time to the last time of the last item on the order.
- Adds an item reason code for the reason code supplied, which should be set up across both systems
- Updates the item quantity delivered to the quantity in the message
- Validates the order (which may set the order to COMPLETE status)
104 - Items Skipped on Device
- Adds an item reason code for reason code "SKP" - "Items Skipped on Device"
103 - Route in Progress
- Adds an item reason code for reason code "WIP" - "Route in Progress"
102 - Out for Delivery
- Adds an item reason code for reason code "OD" - "Out for delivery"
- Updates the stop actual depart time to the last time of the last item on the order.
- Sets Trip Status to "EN-ROUTE".
101 - Removed from Route
- Adds an item reason code for reason code "RM" - "Removed from Route"