XFM0012: Difference between revisions

From WMS
(Split into separate pages)
 
(Split into separate pages)
 
(2 intermediate revisions by the same user not shown)
Line 7: Line 7:
!Field Name||Description||Options||Generic Value
!Field Name||Description||Options||Generic Value
|-
|-
|Package Id **||The unique identifier for this message type – note, you will need to remember this for further setup||10 character free text field||Defined by the client
|''Package Id **''||The unique identifier for this message type – note, you will need to remember this for further setup||10 character free text field||Defined by the client
|-
|-
|Inbound/Outbound/Local **||Specifies whether the message is an inbound or an outbound flow (note, ‘local’ is not used for current WMS implementations)||Check box||Defined by the message type
|''Inbound/Outbound/Local **''||Specifies whether the message is an inbound or an outbound flow (note, ‘local’ is not used for current WMS implementations)||Check box||Defined by the message type
|-
|-
|Package SQL Code **||The programming instruction to determine which package the EDI will call||Defined by the hard coding of the program||Defined by the message type
|''Package SQL Code **''||The programming instruction to determine which package the EDI will call||Defined by the hard coding of the program||Defined by the message type
|}
|}
=='''EDI Listings and Setup Matrix''' ==
=== '''Hard-coded EDI outbound messages'''===
{| class="wikitable" border="1"
!Description||EDI Common Name*||XFM Command Screen**||Process Code***||Database Package Name||Notes
|-
|Acknowledgement of Hold Release Message||N/a ||ACK||User Definable||dp_edigen_out_ack.write_flat_file||-
|-
|Despatch message (Client Specific)||N/a||DESP||Not required?||dp_edi_out_desp_conf.write_flat_file||Not to be used in future implementations (Included for completness)
|-
| Generic Receipt Message||N/a||RCPT_CONF1||GEN_RCPT||dp_edigen_out_receipt_confirm.process_out_recp_confirm||-
|-
|Returns and Collections||N/a||N/a||RETCOLL||dp_edigen_retcoll.write_file||-
|-
|Acknowledgement of Allocation||Yes user definable||N/a||Must be same name as used in EDI Common||dp_edigen_out_ack.write_alloc_ack_file ||-
|-
|Allocation Message||N/a||DESP1||GEN_ALLOC||dp_edigen_out_pdp_conf.write_flat_file||-
|-
|Cancellation message||N/a||DESP1|| GEN_CANC||dp_edigen_out_pdp_conf.write_flat_file||-
|-
|Order Details||N/a ||DESP1||GEN_ORD||dp_edigen_out_pdp_conf.write_flat_file||-
|-
|Generic Pick Message ||N/a||DESP1||GEN_PICK||dp_edigen_out_pdp_conf.write_flat_file||-
|-
|Generic Hold Message||N/a||DESP1||GEN_HOLD||dp_edigen_out_pdp_conf.write_flat_file
|Order at status 6 being placed on hold
|-
|Generic Pack Message||N/a||DESP1||GEN_PACK||dp_edigen_out_pdp_conf.write_flat_file||Fully Packed Order
|-
|Generic Despatch||N/a||DESP1||GEN_DESP||dp_edigen_out_pdp_conf.write_flat_file
|<nowiki>-</nowiki>
|-
|Missing Universal Product Code (Barcode information, client specific)||N/a
|N/a||MISSING_UPC||dp_edigen_out_missing_upcs.write_flat_file||-
|-
|Outbound Purchase Ordering||N/a||N/a||POP||dp_edigen_out_pop.write_flat_file||-
|-
| RDT Stock drip feed of updates||N/a||N/a||RDTSTK||dp_rdt_stock_drip_feed.xf_monitor_send_message||-
|}
==='''Stock Snapshot Formats'''===
{| class="wikitable" border="1"
!Description||EDI Common Name*||XFM Command Screen**||Process Code***||Database Package Name||Notes
|-
|Generic Stock Snapshot||SALES_BAL||SALES GEN
SALES_BAL
|User Definable||dp_edigen_out_st_bal.generate_data
DP_EDIGEN_OUT_ST_BAL.write_flat_file
||Requires two packages to be run in the sequence listed.
|-
|Stock Snapshot by Rotation ||SALES_BAL||STROT_BAL||User Definable||dp_edigen_out_strot_bal.write_file||Requires only one package
|-
|Stock Snapshot at Detail Level||SALES_BAL||STKDTL_GEN
STKDTL_WRT
|User Definable||dp_edigen_out_st_bal.write_flat_file_dtl
dp_edigen_out_st_bal.write_flat_file_dtl
|Requires two packages to be run in the sequence listed.
|-
|Client Specific||SALES_BAL||STOCK_GEN
STOCK_BAL
|User Definable||dp_edigen_out_st_bal.generate_data
dp_edigen_out_st_bal.write_flat_file
| Requires two packages to be run in the sequence listed.
|-
|Client Specific, Serials||SERIAL||STOCK_GEN
STOCK_BAL
|STOCK_BAL_NOV||dp_edigen_out_st_bal.generate_data
dp_edigen_out_st_bal.write_flat_file
|Requires two packages to be run in the sequence listed.
Include the value 'NOV' in the format code field in XF Monitor
|}
==='''Hard-coded EDI Inbound messages'''===
{| class="wikitable" border="1"
!Description||EDI Common Name*||XFM Command Screen**||Process Code***||Database Package Name||Notes
|-
|Booking /Reference Number Update (Client Specific)||BOOK||N/a|| BOOK||dp_edigen_book_upd_load.read_file_format
|<nowiki>-</nowiki>
|-
|Hold/Release Process||HOLD_LOAD||N/a||HOLD_LOAD||dp_edigen_hold_load.read_file_format||-
|-
|Pre-Advice or ASN||GEN_GRN||PRE_ADV||GEN_GRN||dp_edigen_pre_advice_load.read_file_format||-
|-
|Product Master Upload (Generic)||PRODUCT||PROD_LOAD||User definable ||dp_edigen_product_master_load.read_file_format||-
|-
|Sales Order Upload||GEN_SOP ||SOP1||SALES_ORDER||dp_edigen_sales_order_load.read_sales_order_file||'''VALUE''' must be GEN_SOP for standard order file uploads but for XML the system requires another value of SOP to be maintained in the EDI Common.-
|-
|Sales Kit Upload||User definable, though must be the same name as the Process command in XF Monitor
||N/a||User definable, though must be the same name as in EDI Common||dp_edigen_stk_kit_load.read_file_format||-
|}
==='''Configurable EDI Outbound messages'''===
{| class="wikitable" border="1"
!Description||EDI Common Name*||XFM Command Screen**||Process Code***||Database Package Name||Notes
|-
|Adjustment Flow||N/a||N/a||Same name as configurable process||dp_conf_edi_out.produce_dyn_edi_files||-
|-
|Serial Adjustment Flow||SERIAL||N/a
|Same name as configurable process||dp_conf_edi_out.produce_dyn_edi_files||Same setup as above but include the EDI common name to produce serial numbering records.
|}
==='''Configurable EDI Inbound Messages'''===
{| class="wikitable" border="1"
!Description||EDI Common Name*||XFM Command Screen**||Process Code***||Database Package Name||Notes
|-
|SW Average Cost Upload||User definable, though must be the same name as the Configuration process and the Process command in XF Monitor||N/a||User definable, though must be the same name as the Configuration process and the EDI Common record||dp_edigen_sw_upd_load.read_file_format||-
|-
|Supplier Upload||User definable, though must be the same name as the Configuration process and the Process command in XF Monitor||N/a||User definable, though must be the same name as the Configuration process and the EDI Common record||dp_conf_edi_in.read_edi_supp_file_format||-
|-
|Customer Upload||User definable, though must be the same name as the Configuration process and the Process command in XF Monitor||N/a||User definable, though must be the same name as the Configuration process and the EDI Common record||dp_conf_edi_in.read_edi_cust_file_format||Option to either upload or amend existing customer records
|-
|Inbound Hold/Release Process||HOLD_LOAD||N/a||HOLD_LOAD||dp_edigen_hold_load.read_file_format||-
|-
|Configurable Serial and Translation Number Upload||User definable, though must be the same name as the Configuration process and the Process command in XF Monitor||N/a||User definable, though must be the same name as the Configuration process and the EDI Common record||dp_conf_edi_in.med_seq_xfm||-
|-
|Stocks Base Selling Price||User definable, though must be the same name as the Configuration process and the Process command in XF Monitor||N/a||User definable, though must be the same name as the Configuration process and the EDI Common record||dp_conf_edi_in.stk_base_sell_xfm||-
|-
|Stock Region and Sales territory (Client Specific)||User definable, though must be the same name as the Configuration process and the Process command in XF Monitor||N/a||User definable, though must be the same name as the Configuration process and the EDI Common record||dp_conf_edi_in.stock_region_xfm||-
|-
|Stock, UOM and Barcode information||User definable, though must be the same name as the Configuration process and the Process command in XF Monitor||N/a||User definable, though must be the same name as the Configuration process and the EDI Common record||dp_conf_edi_in.stk_uom_xfm||-
|-
|Stock Warehouse||User definable, though must be the same name as the Configuration process and the Process command in XF Monitor||N/a||User definable, though must be the same name as the Configuration process and the EDI Common record||dp_conf_edi_in.stock_warehouse_xfm||Putaway anchor points and replenishment levels
|-
|Updating of existing stock records||User definable, though must be the same name as the Configuration process and the Process command in XF Monitor||N/a||User definable, though must be the same name as the Configuration process and the EDI Common record||dp_conf_edi_in.stock_update_xfm||-
|-
|Pallet upload (WLE)||User definable, though must be the same name as the Configuration process and the Process command in XF Monitor||N/a||User definable, though must be the same name as the Configuration process and the EDI Common record||dp_conf_edi_in.read_edi_wle||-
|-
|Pallet upload of held stock||User definable, though must be the same name as the Configuration process and the Process command in XF Monitor||N/a||User definable, though must be the same name as the Configuration process and the EDI Common record||dp_conf_edi_in.wle_held_stock_xfm||-
|-
|Stock Master Upload||User definable, though must be the same name as the Configuration process and the Process command in XF Monitor||N/a||User definable, though must be the same name as the Configuration process and the EDI Common record||dp_conf_edi_in.read_edi_prod_mast_format||-
|-
|Configurable stock warehouse||User definable, though must be the same name as the Configuration process and the Process command in XF Monitor||N/a||User definable, though must be the same name as the Configuration process and the EDI Common record||dp_conf_edi_in.stock_locations_xfm||Putaway anchor points and replenishment levels
|}
==='''Carrier EDI Messages'''===
{| class="wikitable" border="1"
!Description||Direction||EDI Common Name*||XFM Command Screen**||Process Code***||Database Package Name||Notes
|-
|Carrier Interface  - Allocation||Out||N/a||N/a||CICA||dp_cim_outbound.write_cioc_cica_file||-
|-
|Carrier Interface - Order Confirmation||Out||N/a||N/a||CIOC||dp_cim_outbound.write_cioc_cica_file||-
|-
|Carrier interface - Package details||Out||N/a||N/a||CIPD||dp_cim_outbound.write_cipd_file||-
|-
|Manual cancelled orders||Out||N/a||N/a||CANC||dp_cim_outbound.write_canc_file||-
|-
|POD Confirmation (Ireland Specific)||Out||N/a||N/a||PODC||dp_cim_outbound.write_podc_file||-
|-
|Carrier interface - Tracking Details||In||CITD||N/a||CITD||dp_cim_inbound.read_file_format||-
|-
|Carrier Interface - Packing Information||In||CICD||N/a||CICD||dp_cim_inbound.read_cicd_file_format||-
|}
==='''Miscellaneous EDI Messages'''===
{| class="wikitable" border="1"
!Description||Direction||EDI Common Name*||XFM Command Screen**||Process Code***||Database Package Name||Notes
|-
|DHL Labels EDI Generation||Out||DHEG||N/a||DHEG||dp_edigen_out_pack_label.write_dheg_file||-
|-
|DHL Label Tracking Reference||In||DHEG_UPL||N/a||DHEG_UPL||dp_edigen_dheg_upd_load.read_file_format||Will capture a tracking reference number and automatically create pack header records
|}
==='''Local Processes'''===
{| class="wikitable" border="1"
!Description||Direction||EDI Common Name*||XFM Command Screen**||Process Code***||Database Package Name||Notes
|-
|Script to automatically allocate all orders in the well||Local||ALLOC||N/a||ALLOC||dp_edigen_alloc.xf_monitor_allocate||-
|-
|If the order is held in Metapack as status ‘Manifested’, ‘Tracking’ or ‘Complete’, then the EDI process will initiate the WMS despatch process, down-dating the stock and updating the order as despatched.||Local||META_DESP||N/a||META_DESP||dp_edigen_out_metapack.despatch_check||Client specific see [[MetaPack]] for setup details
|}
==='''FTP Processes'''===
{| class="wikitable" border="1"
!Description||Direction||EDI Common Name*||XFM Command Screen**||Process Code***||Database Package Name||Notes
|-
|In bound FTP process||In||N/a||FTP_INBND||User Definable||dp_process_control_xfm.ftp_inbound||-
|-
|Out bound FTP process||Out||N/a||FTP_OUTB||User Definable||dp_process_control_xfm.ftp_outbound||-
|}'''NB'''
'''EDI Common Name *'''  As a general rule an EDI Common Name is required for all inbound messages but is not a requirement for outbound messages, though there are a couple of exceptions as noted above, i.e. Outbound Serial numbering functionality                                                                                             
'''XF Command Screen (XFM0012)**''' These are all user definable, but depending on the system install there may be existing records, as noted above.                                                                       
'''Process Code (XFMonitor XFM0020)***''' As a rule outbound proceses require a specifed Process Code, the required values are listed above.

Latest revision as of 14:27, 1 July 2025

This screen is used to dictate which package is called for each flow. The package id field is user definable, but the ‘Package SQL Code’ is predetermined by the package format.

Once you have entered the package id and the package SQL code, you must then specify whether it is an inbound or outbound flow.

EDI-005a.PNG
Field Name Description Options Generic Value
Package Id ** The unique identifier for this message type – note, you will need to remember this for further setup 10 character free text field Defined by the client
Inbound/Outbound/Local ** Specifies whether the message is an inbound or an outbound flow (note, ‘local’ is not used for current WMS implementations) Check box Defined by the message type
Package SQL Code ** The programming instruction to determine which package the EDI will call Defined by the hard coding of the program Defined by the message type

EDI Listings and Setup Matrix

Hard-coded EDI outbound messages

Description EDI Common Name* XFM Command Screen** Process Code*** Database Package Name Notes
Acknowledgement of Hold Release Message N/a ACK User Definable dp_edigen_out_ack.write_flat_file -
Despatch message (Client Specific) N/a DESP Not required? dp_edi_out_desp_conf.write_flat_file Not to be used in future implementations (Included for completness)
Generic Receipt Message N/a RCPT_CONF1 GEN_RCPT dp_edigen_out_receipt_confirm.process_out_recp_confirm -
Returns and Collections N/a N/a RETCOLL dp_edigen_retcoll.write_file -
Acknowledgement of Allocation Yes user definable N/a Must be same name as used in EDI Common dp_edigen_out_ack.write_alloc_ack_file -
Allocation Message N/a DESP1 GEN_ALLOC dp_edigen_out_pdp_conf.write_flat_file -
Cancellation message N/a DESP1 GEN_CANC dp_edigen_out_pdp_conf.write_flat_file -
Order Details N/a DESP1 GEN_ORD dp_edigen_out_pdp_conf.write_flat_file -
Generic Pick Message N/a DESP1 GEN_PICK dp_edigen_out_pdp_conf.write_flat_file -
Generic Hold Message N/a DESP1 GEN_HOLD dp_edigen_out_pdp_conf.write_flat_file Order at status 6 being placed on hold
Generic Pack Message N/a DESP1 GEN_PACK dp_edigen_out_pdp_conf.write_flat_file Fully Packed Order
Generic Despatch N/a DESP1 GEN_DESP dp_edigen_out_pdp_conf.write_flat_file -
Missing Universal Product Code (Barcode information, client specific) N/a N/a MISSING_UPC dp_edigen_out_missing_upcs.write_flat_file -
Outbound Purchase Ordering N/a N/a POP dp_edigen_out_pop.write_flat_file -
RDT Stock drip feed of updates N/a N/a RDTSTK dp_rdt_stock_drip_feed.xf_monitor_send_message -

Stock Snapshot Formats

Description EDI Common Name* XFM Command Screen** Process Code*** Database Package Name Notes
Generic Stock Snapshot SALES_BAL SALES GEN

SALES_BAL

User Definable dp_edigen_out_st_bal.generate_data

DP_EDIGEN_OUT_ST_BAL.write_flat_file

Requires two packages to be run in the sequence listed.
Stock Snapshot by Rotation SALES_BAL STROT_BAL User Definable dp_edigen_out_strot_bal.write_file Requires only one package
Stock Snapshot at Detail Level SALES_BAL STKDTL_GEN

STKDTL_WRT

User Definable dp_edigen_out_st_bal.write_flat_file_dtl

dp_edigen_out_st_bal.write_flat_file_dtl

Requires two packages to be run in the sequence listed.
Client Specific SALES_BAL STOCK_GEN

STOCK_BAL

User Definable dp_edigen_out_st_bal.generate_data

dp_edigen_out_st_bal.write_flat_file

Requires two packages to be run in the sequence listed.
Client Specific, Serials SERIAL STOCK_GEN

STOCK_BAL

STOCK_BAL_NOV dp_edigen_out_st_bal.generate_data

dp_edigen_out_st_bal.write_flat_file

Requires two packages to be run in the sequence listed.

Include the value 'NOV' in the format code field in XF Monitor

Hard-coded EDI Inbound messages

Description EDI Common Name* XFM Command Screen** Process Code*** Database Package Name Notes
Booking /Reference Number Update (Client Specific) BOOK N/a BOOK dp_edigen_book_upd_load.read_file_format -
Hold/Release Process HOLD_LOAD N/a HOLD_LOAD dp_edigen_hold_load.read_file_format -
Pre-Advice or ASN GEN_GRN PRE_ADV GEN_GRN dp_edigen_pre_advice_load.read_file_format -
Product Master Upload (Generic) PRODUCT PROD_LOAD User definable dp_edigen_product_master_load.read_file_format -
Sales Order Upload GEN_SOP SOP1 SALES_ORDER dp_edigen_sales_order_load.read_sales_order_file VALUE must be GEN_SOP for standard order file uploads but for XML the system requires another value of SOP to be maintained in the EDI Common.-
Sales Kit Upload User definable, though must be the same name as the Process command in XF Monitor N/a User definable, though must be the same name as in EDI Common dp_edigen_stk_kit_load.read_file_format -

Configurable EDI Outbound messages

Description EDI Common Name* XFM Command Screen** Process Code*** Database Package Name Notes
Adjustment Flow N/a N/a Same name as configurable process dp_conf_edi_out.produce_dyn_edi_files -
Serial Adjustment Flow SERIAL N/a Same name as configurable process dp_conf_edi_out.produce_dyn_edi_files Same setup as above but include the EDI common name to produce serial numbering records.

Configurable EDI Inbound Messages

Description EDI Common Name* XFM Command Screen** Process Code*** Database Package Name Notes
SW Average Cost Upload User definable, though must be the same name as the Configuration process and the Process command in XF Monitor N/a User definable, though must be the same name as the Configuration process and the EDI Common record dp_edigen_sw_upd_load.read_file_format -
Supplier Upload User definable, though must be the same name as the Configuration process and the Process command in XF Monitor N/a User definable, though must be the same name as the Configuration process and the EDI Common record dp_conf_edi_in.read_edi_supp_file_format -
Customer Upload User definable, though must be the same name as the Configuration process and the Process command in XF Monitor N/a User definable, though must be the same name as the Configuration process and the EDI Common record dp_conf_edi_in.read_edi_cust_file_format Option to either upload or amend existing customer records
Inbound Hold/Release Process HOLD_LOAD N/a HOLD_LOAD dp_edigen_hold_load.read_file_format -
Configurable Serial and Translation Number Upload User definable, though must be the same name as the Configuration process and the Process command in XF Monitor N/a User definable, though must be the same name as the Configuration process and the EDI Common record dp_conf_edi_in.med_seq_xfm -
Stocks Base Selling Price User definable, though must be the same name as the Configuration process and the Process command in XF Monitor N/a User definable, though must be the same name as the Configuration process and the EDI Common record dp_conf_edi_in.stk_base_sell_xfm -
Stock Region and Sales territory (Client Specific) User definable, though must be the same name as the Configuration process and the Process command in XF Monitor N/a User definable, though must be the same name as the Configuration process and the EDI Common record dp_conf_edi_in.stock_region_xfm -
Stock, UOM and Barcode information User definable, though must be the same name as the Configuration process and the Process command in XF Monitor N/a User definable, though must be the same name as the Configuration process and the EDI Common record dp_conf_edi_in.stk_uom_xfm -
Stock Warehouse User definable, though must be the same name as the Configuration process and the Process command in XF Monitor N/a User definable, though must be the same name as the Configuration process and the EDI Common record dp_conf_edi_in.stock_warehouse_xfm Putaway anchor points and replenishment levels
Updating of existing stock records User definable, though must be the same name as the Configuration process and the Process command in XF Monitor N/a User definable, though must be the same name as the Configuration process and the EDI Common record dp_conf_edi_in.stock_update_xfm -
Pallet upload (WLE) User definable, though must be the same name as the Configuration process and the Process command in XF Monitor N/a User definable, though must be the same name as the Configuration process and the EDI Common record dp_conf_edi_in.read_edi_wle -
Pallet upload of held stock User definable, though must be the same name as the Configuration process and the Process command in XF Monitor N/a User definable, though must be the same name as the Configuration process and the EDI Common record dp_conf_edi_in.wle_held_stock_xfm -
Stock Master Upload User definable, though must be the same name as the Configuration process and the Process command in XF Monitor N/a User definable, though must be the same name as the Configuration process and the EDI Common record dp_conf_edi_in.read_edi_prod_mast_format -
Configurable stock warehouse User definable, though must be the same name as the Configuration process and the Process command in XF Monitor N/a User definable, though must be the same name as the Configuration process and the EDI Common record dp_conf_edi_in.stock_locations_xfm Putaway anchor points and replenishment levels

Carrier EDI Messages

Description Direction EDI Common Name* XFM Command Screen** Process Code*** Database Package Name Notes
Carrier Interface - Allocation Out N/a N/a CICA dp_cim_outbound.write_cioc_cica_file -
Carrier Interface - Order Confirmation Out N/a N/a CIOC dp_cim_outbound.write_cioc_cica_file -
Carrier interface - Package details Out N/a N/a CIPD dp_cim_outbound.write_cipd_file -
Manual cancelled orders Out N/a N/a CANC dp_cim_outbound.write_canc_file -
POD Confirmation (Ireland Specific) Out N/a N/a PODC dp_cim_outbound.write_podc_file -
Carrier interface - Tracking Details In CITD N/a CITD dp_cim_inbound.read_file_format -
Carrier Interface - Packing Information In CICD N/a CICD dp_cim_inbound.read_cicd_file_format -

Miscellaneous EDI Messages

Description Direction EDI Common Name* XFM Command Screen** Process Code*** Database Package Name Notes
DHL Labels EDI Generation Out DHEG N/a DHEG dp_edigen_out_pack_label.write_dheg_file -
DHL Label Tracking Reference In DHEG_UPL N/a DHEG_UPL dp_edigen_dheg_upd_load.read_file_format Will capture a tracking reference number and automatically create pack header records

Local Processes

Description Direction EDI Common Name* XFM Command Screen** Process Code*** Database Package Name Notes
Script to automatically allocate all orders in the well Local ALLOC N/a ALLOC dp_edigen_alloc.xf_monitor_allocate -
If the order is held in Metapack as status ‘Manifested’, ‘Tracking’ or ‘Complete’, then the EDI process will initiate the WMS despatch process, down-dating the stock and updating the order as despatched. Local META_DESP N/a META_DESP dp_edigen_out_metapack.despatch_check Client specific see MetaPack for setup details

FTP Processes

Description Direction EDI Common Name* XFM Command Screen** Process Code*** Database Package Name Notes
In bound FTP process In N/a FTP_INBND User Definable dp_process_control_xfm.ftp_inbound -
Out bound FTP process Out N/a FTP_OUTB User Definable dp_process_control_xfm.ftp_outbound -

NB

EDI Common Name * As a general rule an EDI Common Name is required for all inbound messages but is not a requirement for outbound messages, though there are a couple of exceptions as noted above, i.e. Outbound Serial numbering functionality

XF Command Screen (XFM0012)** These are all user definable, but depending on the system install there may be existing records, as noted above.

Process Code (XFMonitor XFM0020)*** As a rule outbound proceses require a specifed Process Code, the required values are listed above.