User Tools

Site Tools


implementation:wms: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.

18.1. Configuration

18.1.1. Define the path

Define the input/output path for the EDI on the 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.

Configuration

18.1.2 Set the interfacing controller

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 Extension Parameters tab on the company level of the Organization structure. Select the document type as a Property then set the controller as the Extension.

Extension parameters

Produmex has standard controllers for the following documents:

  • PMX Advance Shipping Notice
  • PMX move order
  • PMX move
  • SBO item master data
  • SBO purchase credit note
  • SBO purchase delivery
  • SBO purchase invoice
  • SBO purchase return
  • SBO purchase order
  • SBO sales credit note
  • SBO sales delivery
  • SBO sales invoice
  • SBO sales return
  • SBO sales order

The following documents have an interface but 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 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
Move PMX_MV_ csv
Move order PMX_MO_ csv
Proof of delivery EPOD_ csv POD_RTHE

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 about the installation of the Notification Listener please see:

To define actions for the Notification Listener, update its configuration file.

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\
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.

Notification Listener

Then run the Notification Listener.

  • 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\.

18.2.1. XML file structure: Sales order

<?xml version="1.0" encoding="UTF-8"?>
<Document>
<DocumentHeader>
	<ObjectType>17</ObjectType>
		<DocumentNumber>15</DocumentNumber>
		<DocumentDate>20120220</DocumentDate>
		<DocumentDueDate>20120220</DocumentDueDate>
		<NumAtCard>7927</NumAtCard>
		<CardCode>C1000</CardCode>
		<CardName>Card name</CardName>
		<BillTo>
			<Street>Lenteakker3</Street>
			<City>SPIJKENISSE</City>
			<ZipCode>3206TB</ZipCode>
			<CountryCode>NL</CountryCode>
			<GLN>5400150100004</GLN>
			<FederalTaxID/>
		</BillTo>
		<ShipTo>
			<Street>Lenteakker 3</Street>
			<City>SPIJKENISSE</City>
			<ZipCode>3206TB</ZipCode>
			<CountryCode>NL</CountryCode>
			<GLN>5400150100004</GLN>
			<FederalTaxID/>
		</ShipTo>
		<DocumentCurrency>EUR</DocumentCurrency>
		<TotalNetto>0</TotalNetto>
		<TotalDiscount>0</TotalDiscount>
		<TotalVAT>0</TotalVAT>
		<TotalBruto>0</TotalBruto>
		<Comments>Comment</Comments>
		<GLN/>
		<FederalTaxID>US25-987634</FederalTaxID>
	</DocumentHeader>
	<DocumentLineList>
		<DocumentLine>
			<BaseDocNum>215</BaseDocNum>
			<BaseLine>0</BaseLine>
			<BaseType>22</BaseType>
			<LineNumber>0</LineNumber>
			<ItemCode>CIA00092</ItemCode>
			<ItemDescription>CIMZIA 200MG/ML 2PFS AT/NL</ItemDescription>
			<Uom>Pcs</Uom>
			<Quantity>1</Quantity>
			<UnitPrice>0</UnitPrice>
			<DiscountPercent>0</DiscountPercent>
			<LineTotal>0</LineTotal>
			<VATCode>6</VATCode>
			<VATPercent>6</VATPercent>
			<LineVAT>0</LineVAT>
			<WarehouseCode>01</WarehouseCode>
			<PmxDocumentLineList>
				<PmxDocumentLine>
					<Quantity>1</Quantity>
					<Uom>Pcs</Uom>
					<QualityStatusCode>RELEASED</QualityStatusCode>
					<SSCC>123456789012345678</SSCC>
					<StorageLocationCode>A01</StorageLocationCode>
					<BatchNumber>BATCH1</BatchNumber>
					<BatchNumber2/>
					<ExpiryDate>20160908</ExpiryDate>
				</PmxDocumentLine>
				<PmxDocumentLine>
					<Quantity>1</Quantity>
					<Uom>Pcs</Uom>
					<QualityStatusCode>RELEASED</QualityStatusCode>
					<SSCC>123456789012345680</SSCC>
					<StorageLocationCode>PIC01</StorageLocationCode>
					<BatchNumber>BATCH1</BatchNumber>
					<BatchNumber2/>
					<ExpiryDate>20160908</ExpiryDate>
				</PmxDocumentLine>
			</PmxDocumentLineList>
		</DocumentLine>
	</DocumentLineList>
</Document>

18.2.2. CSV file structure: Proof of delivery (exported route)

R,202,This is the route description,20160724
J,D,10,C00001,Customer name 1,Address line 1,Address line 2,,,,,
I,S,10,000000000000092241
I,S,10,000000000000092395
I,S,10,000000000000092289
J,D,20,C00002,Customer name 2,Address line 1,Address line 2,Address line 3,Address line 4,,,
I,S,20,000000000000093699
I,S,20,000000000000093651

18.3. 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.

The interfacing tool is located in the installation folder of the Produmex Tools, for example: C:\Program Files\Produmex \Produmex Tools\
The file name is Produmex.Sbo.Logex.Tools.InterfacingTool.exe.

Start the interfacing tool with startup parameters. The following command line parameters are supported:

  • /cs: Contains the connection string that should be used. Default value: 'SboConnectionString'
  • /t: Defines the type of the interface. Possible values:
    • salesorder
    • salesdelivery
    • salesinvoice
    • salescreditnote
    • salesreturn
    • purchaseorder
    • purchasedelivery
    • purchaseinvoice
    • purchasecreditnote
    • purchasereturn
    • productionissue
    • productionreceipt
    • advanceshippingnotice
    • itemmasterdata
    • incomingpayment
    • move
    • moveorder
    • stock
    • stockqschange
    • businesspartnermasterdata
    • warehouseautomation
    • POD
      Default value: ‘stock’
  • /d: Defines the direction of the interface. Possible values:
    • import
    • export
      Default value: ‘export’.
  • /rf: If added, the system reprocesses failed actions.

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.

18.3.1. Move and move order template for importing

For moves/move orders create a csv. file that contains the following fields:

  • 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.
  • SrcQualityStatusCode: The quality status of the stock that should be moved.
  • 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.
  • InternalBatchnumber: If the item has a second batch number, add it here.
  • BestBeforeDate: If the item has a best before date, add it here.
  • SrcStorLocCode: The code of the source storage location.
  • DestStorLocCode: The code of the destination storage location.
  • SrcLogUnitIdentKey: The source LUID.
  • DestLogUnitIdentKey: The destination LUID.

Please note that field names are case sensitive.

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.

Example:

  • Move order: PMX_MO_07032012.csv
  • Move: PMX_MV_07032012.csv

18.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.

To implement the import process, proceed as follows.

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).
Field name (case sensitive)Description/Activity
ObjType In case of a purchase order the value of the field should be 22 while in case of a purchase invoice it should be 18.
Note: If no value is added to the field, the system automatically considers the object type a purchase order.
DocNum Add the document number of the purchase order/purchase invoice.
LineNum and ItemCode It is not mandatory to provide a value for both fields. You can provide only the line number, which you can check in SAP B1. If you provide only the item code, the system uses this value to find the line number.
Note: If the purchase order contains two or more lines with the same item code, the system cannot find the correct line number. In this case you need to provide a value for the line number as well.
Quantity Add the inventory quantity of the item to be received. If you provide value to the SerialNumber column, the value of the Quantity should be 1.
SSCC Add the SSCC of the logistic unit if there is any.
MasterSSCC Add the SSCC number of the master logistic unit if there is any.
Batch If the item is managed by batches, add the batch number in this column.
Batch2 Add the second batch number of the product if there is any.
BBD Add the best before date of the product if there is any.
SerialNumber Add the serial number of the product if there is any.
UF1 User information - optional
UF2 User information - optional
UF3 User information - optional

Example of a CSV file:

ObjType;DocNum;LineNum;ItemCode;Quantity;SSCC;MasterSSCC;Batch;Batch2;BBD;SerialNumber;UF1;UF2;UF3;
22;123;0;ITEM01;10;123456789012345678;;BATCHA;;20200131;;User info 1;;;
22;123;1;SERIAL01;1;123456789012345678;;BATCHA;;20200131;SER01;User info 1;;;
22;123;1;SERIAL01;1;123456789012345678;;BATCHA;;20200131;SER02;User info 1;;;

2. Save your CSV file to the folder defined in the Interface Monitor Input Path.

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 6.3.2. Open ASN lines).

5. Now you can create goods receipt PO documents from the open ASN Lines (see section 28.6. ASN Reception).

18.4. Interface monitor

On the Interface monitor EDI messages can be monitored.

Interface monitor

The list of the interfacing messages can be monitored with the following:

  • 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.

To see more information about a message, select its line.
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, 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.txt · Last modified: 2019/08/01 09:11 by vise