User Tools

Site Tools


implementation:wms:edi_module

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
implementation:wms:edi_module [2019/08/01 09:11]
vise [18.1.2 Set the interfacing controller]
implementation:wms:edi_module [2019/12/11 10:10] (current)
vise [18.3. Importing and exporting with the Interfacing tool]
Line 1: Line 1:
-======18. Produmex ​standard ​EDI module ​====== +======18. Produmex ​Standard ​EDI Module======
-EDI is a communication protocol for electronic data exchange between business partners. ​+
  
-In the Produmex ​solution the standard file formats used for EDI messages are //.xml// and //.csv//. Export ​files with the help of the Notification Listener or the Interfacing tool, import files with the Interfacing tool and monitor the process on the Interface ​monitor.+EDI is a communication protocol for electronic data interchange between business partners.  
 + 
 +With the Produmex EDI module it is possible to: \\ 
 +  * export ​files with the Notification Listener or the Interfacing tool, \\ 
 +  * import files with the Interfacing tool and \\ 
 +  * monitor the process on the Interface ​Monitor screen. 
 + 
 +The standard file formats used for EDI messages are //.xml// and //.csv//.
  
 ===== 18.1. Configuration ===== ===== 18.1. Configuration =====
 +
 ==== 18.1.1. Define the path ==== ==== 18.1.1. Define the path ====
-Define the input/​output path for the EDI on the [[implementation:​wms:​config|Config tab]] on the company level of the Organization structure. 
-  * On the //​‘Interface monitor input archive path’// field define the path where the system moves the file after processing it. 
-  * On the //​‘Interface monitor input error path’// field define the path where the file will be moved in the case there was an error during the processing. 
-  * On the //​‘Interface monitor input path’// field define the path to the folder from the system will import files. 
-  * On the //​‘Interface monitor output archive path’// field define the path where the third party software will put the files after processing. //This path is not used by the Produmex Interfacing tool.// 
-  * On the //​‘Interface monitor output error path’// field define the path where the third party software will put the files if there was an error during the processing. //This path is not used by the Produmex Interfacing tool.// 
-  * On the //​‘Interface monitor output path’// field define the path to the folder where the system will export the file. Set this folder as an input for the third party software. 
  
-{{ :implementation:functionalguide:​edi:​config.png?direct |Configuration}}+Define the input and the output path for the EDI module on the //Config// tab of the Organization Structure. 
 +  - In the //Interface Monitor Input Archive Path// field define the path where the system moves the file after processing it. 
 +  - In the //Interface Monitor Input Error Path// field define the path where the file is moved if there is an error during the processing. 
 +  - In the //Interface Monitor Input Path// field define the path to a folder from where the system imports the file. 
 +  - In the //Interface Monitor Output Archive Path// field define the path where the third party software puts the file after processing it. \\ NoteThis path is not used by the Produmex Interfacing tool. 
 +  - In the //Interface Monitor Output Error Path// field define the path where the third party software puts the file if there is an error while processing it. \\ NoteThis path is not used by the Produmex Interfacing tool. 
 +  - In the //Interface Monitor Output Path// field define the path to the folder where the system exports the file. Set this folder as an input for the third party software.
  
-==== 18.1.2 Set the interfacing controller ==== +{{ :implementation:​wms2:​functional:​edi:​configuration2.png |Configuration}}
-Then set a controller for each document type you would like to implement an EDI process. Produmex offers standard controllers but typically the implementation ​of particular requirements will require custom solutions+
  
-Controllers can be set on the [[implementation:​wms:​extensionparameters|Extension Parameters tab]] on the company level of the Organization structureSelect the document type as a Property then set the controller ​as the Extension.+==== 18.1.2. Set up the interfacing ​controller ​====
  
-{{ :implementation:​functionalguide:​edi:​extensionsparameters.png?​direct |Extension parameters}}+Produmex offers standard controllers for the following documents
  
-Produmex has standard controllers for the following documents: +^Document^Property^Extension^ 
-  ​* ​PMX Advance Shipping Notice +|PMX advance shipping notice|Interface for PMX Advance Shipping Notice (Im-Exporter)|IPmx ​Advance Shipping Notice ​Interface| 
-  ​* ​PMX move order  +|PMX move order|Interface for PMX Move Order Im-/​Export|IPmx Move Order Interface| 
-  ​* ​PMX move  +|PMX move |Interface for PMX Move Im-/​Export|IPmx Move Interface| 
-  ​* ​SBO item master data  +|SBO item master data| Interface for SBO Item Master Data Im-/​Export|ISBO Item Master Data Interface| 
-  ​* ​SBO purchase credit note  +|SBO purchase credit note |Interface for SBO Purchase Credit Note Im-/​Export|ISBO Purchase Credit Note Interface| 
-  ​* ​SBO purchase delivery  +|SBO purchase delivery ​|Interface for SBO Purchase Delivery Im-/​Export|ISBO Purchase Delivery Interface| 
-  ​* ​SBO purchase invoice  +|SBO purchase invoice ​|Interface for SBO Purchase Invoice Im-/​Export|ISBO Purchase Invoice Interface| 
-  ​* ​SBO purchase ​return ​ +|SBO purchase ​order| Interface for SBO Purchase Order Im-/​Export|ISBO Purchase Order Interface| 
-  ​* ​SBO purchase ​order  +|SBO purchase ​return |Interface for SBO Purchase Return Im-/​Export|ISBO Purchase Return Interface| 
-  ​* ​SBO sales credit note  +|SBO sales credit note |Interface for SBO Sales Credit Note Im-/​Export|ISBO Sales Credit Note Interface| 
-  ​* ​SBO sales delivery  +|SBO sales delivery ​|Interface for SBO Sales Delivery Note Im-/​Export|ISBO Sales Delivery Interface| 
-  ​* ​SBO sales invoice  +|SBO sales invoice ​|Interface for SBO Sales Invoice Im-/​Export|ISBO Sales Invoice Interface| 
-  ​* ​SBO sales return  +|SBO sales return ​|Interface for SBO Sales Return Im-/​Export|ISBO Sales Return Interface| 
-  ​* ​SBO sales order +|SBO sales order|Interface for SBO Sales Order Im-/​Export|ISBO Sales Order Interface|
  
-The following documents have an interface but they require custom ​controllers: +The following documents have an interfacebut __they ​require custom ​controllers__:
-  * PMX picklist +
-  * PMX serial number +
-  * PMX stock QS change +
-  * PMX stock  +
-  * SBO business partner +
-  * SBO goods issue +
-  * SBO goods receipt +
-  * SBO incoming payment +
-  * SBO production issue +
-  * SBO production receipt +
-  * SBO sales delivery 2 +
-  * SBO sales return 2 +
-  * SBO whs transfer+
  
-==== 18.1.3. Documents ==== +^Document^Property
-^ Document ​Type Prefix ^ Extension ^ Object type +|PMX picklist|Interface for PMX Pick List Im-/​Export| 
-Purchase order OPOR_ xml 22 +|PMX serial number|Interface for PMX Serial Number Im-/Export
-Purchase delivery ​OPDN_ | xml | 20 +|PMX stock QS change|Interface for PMX Stock QS Change Import
-Purchase invoice ​OPCH_ | xml | 18 +|PMX stock |IPmx Stock Interface – Pmx Stock Im-/​Exporter
-Purchase credit note | ORPC_ | xml 19 +|SBO business partner|Interface for SBO Business Partner Im-/​Exporter
-Purchase return ​ORPD_ | xml | 21 +|SBO goods issue|Interface for SBO Goods Issue Im-/​Exporter
-Sales order ORDR_ | xml | 17 +|SBO goods receipt|Interface for SBO Goods Receipt Im-/Export
-Sales delivery | ODLN_ | xml 15 +|SBO incoming payment|Interface for SBO Incoming Payment Im-/Export
-Sales invoice ​OINV_ | xml | 13 +|SBO production issue|Interface for SBO Production Issue Im-/Export
-Sales credit note ORIN_ xml 14 | +|SBO production receipt|Interface for SBO Production Receipt Im-/Export| 
-| Sales return | ORDN_ | xml | 16 +|SBO sales delivery 2|Interface for SBO Sales Delivery 2 Im-/Export
-Move PMX_MV_ | csv |  ​|  +|SBO sales return 2|Interface for SBO Sales Return 2 Im-/Export
-Move order PMX_MO_ | csv |  ​+|SBO whs transfer|Interface for SBO Sales Order Im-/Export
-Proof of delivery | EPOD_ | csv | POD_RTHE ​|+ 
 +Configuration steps: \\ 
 +1. Select the controller for the necessary document type on the [[implementation:​wms:​extensionparameters|Extension Parameters tab]] of the Organization Structure. \\ 
 +2. Select the Property and the Extension. \\ 
 +3. Click ''​OK''​. 
 + 
 +{{ :​implementation:​wms:​tools:​edi:​controllers.png ​|Extension Parameters}} 
 + 
 +===== 18.2. Exporting with the Notification Listener tool=====
  
-===== 18.2. Notification Listener ===== +The Notification Listener is a tool that monitors the record in the PMX_NOTQ table and performs custom actions when a certain type of data is adjusted. For information ​on the installation of the Notification Listener see:  
-The Notification Listener is a tool that monitors the record in the PMX_NOTQ table and performs custom actions when a certain type of data is adjusted. ​\\ +  * [[implementation:​wms:​install_pdmx_suite#​install_components|3.2. Install components]]
-For information ​about the installation of the Notification Listener ​please ​see:  +
-  * [[implementation:​wms:​install_pdmx_suite#​produmex_sb1_notification_listener|3.2.4. Produmex SB1 Notification listener]]+
   * [[implementation:​wms:​install_pdmx_suite#​enable_the_notification_listener_stored_procedure|3.3.3. Enable the Notification Listener stored procedure]]   * [[implementation:​wms:​install_pdmx_suite#​enable_the_notification_listener_stored_procedure|3.3.3. Enable the Notification Listener stored procedure]]
  
-To define actions for the Notification Listener, update its configuration file. +To export documents proceed as follows:
  
-The configuration file is called //​‘Produmex.Foundation.SboNotification.ServiceHost.exe.config’//​. It is located in the installation folder ​of the Produmex SB1 Notification Listener, for example: C:\Program Files(x86)\Produmex\Produmex SB1 Notification Listener\ \\ +1. Locate the configuration file of the Notification Listener ​tool. \\
-Open the file with a text editor (e.g. Notepad). Locate the line of the transaction and uncomment it then save the file.+
  
-//Example: Proof of delivery route export action defined for the Notification Listener.//+The configuration file is called ​//Produmex.Foundation.SboNotification.ServiceHost.exe.config//​ and it is located in the installation folder of the tool, for example: C:\Program Files(x86)\Produmex\Produmex SB1 Notification Listener. 
 + 
 +2. Open the file with a text editor (e.g. Notepad).  
 + 
 +3. Locate the line of the transaction and uncomment it. 
 + 
 +Example: Proof of delivery route export action defined for the Notification Listener
  
 {{ :​implementation:​functionalguide:​edi:​enabled_pod.png?​direct |Notification Listener}} {{ :​implementation:​functionalguide:​edi:​enabled_pod.png?​direct |Notification Listener}}
  
-Then run the Notification Listener.  +4. Save the file. 
-  * To run the Notification Listener in the background, start it from Windows\Control Panel\ Programs and Features\. + 
-  * To run the Notification Listener with an open console, launch the RunConsole.bat file from the installation folder of the Produmex SB1 Notification Listener, for example: C:\Program Files//​(x86)//​\Produmex\Produmex SB1 Notification Listener\.+5. Run the Notification Listener ​tool.  
 +  * To run the Notification Listener ​tool in the background, start it from Windows\Control Panel\ Programs and Features\. 
 +  * To run the Notification Listener ​tool with an open console, launch the RunConsole.bat file from the installation folder of the tool, for example: C:\Program Files//​(x86)//​\Produmex\Produmex SB1 Notification Listener\.
  
-==== 18.2.1. XML file structure: Sales order ====+==== 18.2.1. ​Example: exported ​XML file structure ​of a sales order ====
 <​code>​ <​code>​
 <?xml version="​1.0"​ encoding="​UTF-8"?>​ <?xml version="​1.0"​ encoding="​UTF-8"?>​
Line 171: Line 176:
 </​code>​ </​code>​
  
-==== 18.2.2. CSV file structure: Proof of delivery (exported route) ==== +==== 18.2.2. ​Example: exported ​CSV file structure ​of proof of delivery (exported route) ==== 
 <​code>​ <​code>​
 R,202,This is the route description,​20160724 R,202,This is the route description,​20160724
Line 183: Line 188:
 </​code>​ </​code>​
  
-===== 18.3. Interfacing tool =====  +===== 18.3. Importing and exporting with the Interfacing tool ===== 
-With the interfacing tool certain documents can be imported to/exported from the system. This application is installed during the Produmex Tools installation. ​+
  
-In the standard solution ​documents can only be imported ​with this tool+With the Interfacing tool certain ​documents can be imported ​to and exported from the system. This application is installed during the Produmex Tools installation (see [[implementation:​wms:​install_pdmx_suite#​install_components|3.2. Install components]])
  
-The interfacing ​tool is located in the installation folder of the Produmex Tools, for example: C:\Program Files\Produmex \Produmex Tools\ ​ \\ +==== 18.3.1. Preparing documents for import===== 
-The file name is Produmex.Sbo.Logex.Tools.InterfacingTool.exe. ​+ 
 +The following table shows the prefixes, the extensions and the object types to be used while preparing documents for import. The table lists documents with standard controllers. 
 + 
 +^ Document Type ^ Prefix ^ Extension ^ Object type ^ 
 +| Purchase order | OPOR_ | xml | 22 | 
 +| Purchase delivery | OPDN_ | xml | 20 | 
 +| Purchase invoice | OPCH_ | xml | 18 | 
 +| Purchase credit note | ORPC_ | xml | 19 | 
 +| Purchase return | ORPD_ | xml | 21 | 
 +| Sales order | ORDR_ | xml | 17 | 
 +| Sales delivery | ODLN_ | xml | 15 | 
 +| Sales invoice | OINV_ | xml | 13 | 
 +| Sales credit note | ORIN_ | xml | 14 | 
 +| Sales return | ORDN_ | xml | 16 | 
 +| Proof of delivery | EPOD_ | csv | POD_RTHE | 
 +|Advance shipping notice*| N/A|csv|18 or 22| 
 +| Move* | PMX_MV_ | csv | N/A | 
 +| Move order* | PMX_MO_ | csv | N/A | 
 + 
 +*See section [[implementation:​wms:​edi_module#​templates_for_importing|18.3.3.Templates for importing]]. 
 + 
 +==== 18.3.2. Running the Interfacing tool===== 
 + 
 +The tool is located in the installation folder of the Produmex Tools, for example: C:\Program Files\Produmex \Produmex Tools\ ​and the file name is Produmex.Sbo.Logex.Tools.InterfacingTool.exe. ​
  
 Start the interfacing tool with startup parameters. The following command line parameters are supported: Start the interfacing tool with startup parameters. The following command line parameters are supported:
Line 223: Line 250:
 Example: Produmex.Sbo.Logex.Tools.InterfacingTool.exe /​cs:​SboConnectionString /t:move /​d:​import ​ Example: Produmex.Sbo.Logex.Tools.InterfacingTool.exe /​cs:​SboConnectionString /t:move /​d:​import ​
  
-It is recommended to run the interfacing tool as a scheduled task.+Note: It is recommended to run the interfacing tool as a scheduled task.
  
-====18.3.1. Move and move order template for importing==== +====18.3.3. Templates for importing==== 
-For moves/move orders create a csv. file that contains ​the following fields: + 
-  * //​FromPmxWhsCode//: ​The code of the source warehouse. +===18.3.3.1. Move and move order template for importing=== 
-  * //​ToPmxWhsCode//: ​The code of the destination warehouse. + 
-  * //​ItemCode//: ​The item code of the product. +1. For moves/move orders create a csv. file with the following fields: 
-  * //​Quantity//: ​Quantity ​to move or to make a move order from.+  * //​FromPmxWhsCode//: ​the code of the source warehouse 
 +  * //​ToPmxWhsCode//: ​the code of the destination warehouse 
 +  * //​ItemCode//: ​the item code of the product 
 +  * //​Quantity//: ​quantity ​to move or to make a move order from
   * //​Serialnumber//:​ If the item is managed by serial numbers, add the serial number here.   * //​Serialnumber//:​ If the item is managed by serial numbers, add the serial number here.
-  * //​SrcQualityStatusCode//: ​The quality status of the stock that should be moved. +  * //​SrcQualityStatusCode//: ​the quality status of the stock that should be moved 
-  * //​DestQualityStatusCode//: ​The quality status that the stock should get after the move.+  * //​DestQualityStatusCode//: ​the quality status that the stock should get after the move
   * //​Batchnumber//:​ If the item is managed by batches, add the batch number here.   * //​Batchnumber//:​ If the item is managed by batches, add the batch number here.
   * //​InternalBatchnumber//:​ If the item has a second batch number, add it here.    * //​InternalBatchnumber//:​ If the item has a second batch number, add it here. 
   * //​BestBeforeDate//:​ If the item has a best before date, add it here.   * //​BestBeforeDate//:​ If the item has a best before date, add it here.
-  * //​SrcStorLocCode//: ​The code of the source storage location. +  * //​SrcStorLocCode//: ​the code of the source storage location 
-  * //​DestStorLocCode//: ​The code of the destination storage location. +  * //​DestStorLocCode//: ​the code of the destination storage location 
-  * //​SrcLogUnitIdentKey//: ​The source LUID. +  * //​SrcLogUnitIdentKey//: ​the source LUID 
-  * //​DestLogUnitIdentKey//: ​The destination LUID.+  * //​DestLogUnitIdentKey//: ​the destination LUID
  
-//Please note that field names are case sensitive.// +Note: The field names are case sensitive.
  
-Save the file as a .csv file. +2. Save the file as a .csv file. 
  
-Naming convention: Use the PMX_MO_ prefix for move order templates and the PMX_MV_ prefix for move templates. The system ​will check the file name in order to determine whether a move order or a move should be created.+Naming convention: Use the PMX_MO_ prefix for move order templates and the PMX_MV_ prefix for move templates. The system ​checks ​the file name to determine whether a move order or a move should be created.
  
 Example: Example:
Line 252: Line 282:
   * Move: //​PMX_MV_07032012.csv//​   * Move: //​PMX_MV_07032012.csv//​
  
-====18.3.2. ASN template for importing====+===18.3.3.2. ASN template for importing===
  
-With the Interfacing Tool goods that will be received against purchase orders or purchase invoices can be imported from CSV files to SAP B1. As a result of the import, the system generates open ASN lines, which you can use to create goods receipt PO documents. ​+With the Interfacing Tool goods that are received against purchase orders or purchase invoices can be imported from CSV files to SAP B1. As a result of the import, the system generates open ASN lines, which you can use to create goods receipt PO documents. ​
  
 To implement the import process, proceed as follows. To implement the import process, proceed as follows.
Line 260: Line 290:
 1. Prepare the CSV file with the 14 columns listed in the table below and provide the necessary data. \\ Make sure that you list all the 14 columns, keep the column names and the order of the columns as indicated in the table. 1. Prepare the CSV file with the 14 columns listed in the table below and provide the necessary data. \\ Make sure that you list all the 14 columns, keep the column names and the order of the columns as indicated in the table.
  
-  * Alternatively, ​you can also use the ASN template, which is available in your installation folder (Templates > Import Templates folder).+  * Alternatively,​ the ASN template ​can be used, which is available in your installation folder (Templates > Import Templates folder).
  
-  * If you receive CSV files from your supplier and you define a CSV Custom Header, the order of the columns in the CSV file depends on the order you define in the //CSV Customer Header// field (see configuration ​[[implementation:​wms:​interfaceasn|5.1.3.15. ​Interface for PMX advance shipping notice importer and exporter]].)+  * If you receive CSV files from your supplier and you define a CSV Custom Header, the order of the columns in the CSV file depends on the order you define in the //CSV Customer Header// field (see [[implementation:​wms:​interfaceasn|Interface for PMX advance shipping notice importer and exporter]]).
  
 ^Field name (case sensitive)^Description/​Activity^ ^Field name (case sensitive)^Description/​Activity^
Line 292: Line 322:
 3. Run the Interfacing Tool. 3. Run the Interfacing Tool.
  
-4. You can check the imported data in SAP B1 by navigating to Produmex > Purchasing > ASN. The system ​ displays the //Open ASN Lines// screen (see section ​[[implementation:​wms:​open_asn_lines|6.3.2. Open ASN lines]]).+4. You can check the imported data in SAP B1 by navigating to Produmex > Purchasing > ASN. The system ​ displays the //Open ASN Lines// screen (see [[implementation:​wms:​open_asn_lines|6.3.2. Open ASN lines]]). 
 + 
 +5. Now you can create goods receipt PO documents from the open ASN Lines (see [[implementation:​wms:​asn_reception|28.6. ASN Reception]]). 
 + 
 +===== 18.4. Monitoring EDI messages=====  
 + 
 +EDI messages can be monitored on the //Interface Monitor// screen. The function is available by navigating to Produmex > Interfacing > Interface Monitor.  
 + 
 +{{ :​implementation:​functionalguide:​edi:​interfacemonitor.png?​direct |Interface Monitor}}
  
-5. Now you can create goods receipt PO documents from the open ASN Lines (see section [[implementation:wms:asn_reception|28.6. ASN Reception]]).+The list of the interfacing messages ​can be monitored with the following filters: 
 +  * Type of messagethe document type 
 +  * Status: the status of the entry 
 +    * Possible values are: //All, Error, New, Processed//​ 
 +  * Text filter: Only those lines get listed which contain the text added to the field 
 +  * From - To: The lines get listed based on the defined period.
  
-===== 18.4. Interface monitor =====  +Click on the ''​Refresh''​ button to apply the filters.
-On the Interface monitor EDI messages can be monitored.+
  
-{{ :​implementation:​functionalguide:​edi:​interfacemonitor.png?direct |Interface monitor}}+To see more information about a message, select its line.
  
-The list of the interfacing messages can be monitored with the following:​ +Click on the ''​Log''​ button to see the log entryIf the status of an entry is //Error//the error message can be seen here.
-  * Type of message: The document type +
-  * Status: The status of the entry. The possible values are: //‘All’Error‘New’‘Processed’//​ +
-  * Text filter: Only lines containing ​the added text will be listed. +
-  * From - To: Define the displayed period on the //​‘From’ – ‘To’// fields.+
  
-Click on the **‘Refresh’** ​button ​to apply the filters.+The ''​Reprocess'' ​button ​is active if the status is //Error//.
  
-To see more information about a message, select its line. \\ +The ''​Show file'' ​button ​is active if the status is //Error// and the direction is //Import//.
-Click on the **‘Log’** ​button ​to see the log entry. If the status ​of an entry is Error’ the error message can be seen here.+
  
-The Reprocess’ button is only active if the status is ‘Error’ and the Show file’ button ​is only active when the status is ‘Error’ ​and the direction is ‘Import’.+To correct a failed import proceed as follows: 
 +  - select ​the entry line, 
 +  - click on the ''​Show file'' ​button
 +  - correct ​the file and save it, 
 +  - click on the ''​Reprocess''​ button to process the file again.
  
-To correct a failed import, select the entry line and click on the **‘Show file’** button. The failed file will open. Correct the file and save it then click on the **‘Reprocess’** button to process the file again. 
  
implementation/wms/edi_module.1564650718.txt.gz · Last modified: 2019/08/01 09:11 by vise