Differences

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

--- cobi.shipping [2025/08/22 12:46] – [Implementation details] thuth
+++ cobi.shipping [2025/08/22 13:40] (current) – [Installation] thuth
@@ Line 2: / Line 2: @@
 COBI.shipping is a REST-API service that acts as a connector between **Barcode Shipping** and **SAP Business One**.
-Its primary purpose is to exchange delivery and shipping data: it retrieves open delivery notes from SAP and reports back shipping information (including tracking numbers, weights, and item details) after the shipment has been processed.
+Its primary purpose is to exchange delivery and shipping data: \\
+  - It retrieves open delivery notes from SAP Business One and
+  - reports back shipping information (including tracking numbers, weights, and item details) after the shipment has been processed.
 ===== Features =====
@@ Line 26: / Line 28: @@
 ===== Implementation details =====
-* Delivered as a Windows service (installation via included batch files). \\
+  - Delivered as a Windows service (installation via included batch files). \\
-* Requires **Barcode Shipping** software and **Java 11**.
+  - Requires Barcode Shipping software and Java 11. \\
-* API endpoints are provided under `/api/v1/` with authentication through an API key.
+  - API endpoints are provided under `/api/v1/` with authentication through an API key. \\
-* Configuration is stored in SAP Business One (`@CMP_CONFIG`) and must be reloaded by restarting the service after changes.
+  - Configuration is stored in SAP Business One (`@CMP_CONFIG`) and must be reloaded by restarting the service after changes. \\
-* Supports customizable UDF mappings for address fields, tracking numbers, and commodity codes.
+  - Supports customizable UDF mappings for address fields, tracking numbers, and commodity codes. \\
-* Optional automatic invoice creation and Coresuite Print integration.
+  - Optional automatic invoice creation and Coresuite Print integration. \\
-* Reads address and shipping information directly from SAP table `DLN12`.
+  - Reads address and shipping information directly from SAP table `DLN12`.
+===== Required UDFs in SAP Business One =====
+For COBI.shipping to function properly, several **User-Defined Fields (UDFs)** must be created in SAP Business One. These fields store address information, shipping metadata, and customs information that are required by the integration.
+Under //Delivery Notes -> Lines (DLN12)//:
+^ Title                         ^ Data type     ^ Size  ^ Description                                      ^
+| cobi-shipping\_firstNameField  | Alphanumeric  | 50    | First name of the recipient                      |
+| cobi-shipping\_lastNameField   | Alphanumeric  | 50    | Last name of the recipient                       |
+| cobi-shipping\_companyField    | Alphanumeric  | 100   | Company name of the recipient                    |
+| cobi-shipping\_phoneField      | Alphanumeric  | 30    | Phone number of the recipient                    |
+| cobi-shipping\_emailField      | Alphanumeric  | 100   | Email address of the recipient                   |
+Under //Delivery Notes -> Header//:
+^ Title                                ^ Data type     ^ Size  ^ Description                                        ^
+| cobi-shipping\_trackingInHeaderField  | Alphanumeric  | 100   | Field to store tracking number(s) in delivery note |
+| cobi-shipping\_alarmGroupId           | Numeric       | 11    | Alarm group for invoice errors                     |
+Under //Items (OITM)//:
+^ Title                                ^ Data type     ^ Size  ^ Description                                  ^
+| cobi-shipping\_oitmCommodityCodeField | Alphanumeric  | 20    | Customs tariff code for export/import handling |
+===== Installation =====
+**1. Install Barcode Shipping**
+  * Download and install Barcode Shipping from the internal archive (`N:\Entwicklung\Barcode Shipping\Downloads.7z`).
+  * During setup, choose **Shop → Eigentwicklung** and **Shipper → Einfacher Versender**, then enable additional functions as needed.
+  * Install **Java 11** (required by Barcode Shipping). Instructions: [https://www.barcodeshipping.de/java-installation/](https://www.barcodeshipping.de/java-installation/)
+  * Log in to Barcode Shipping with COMP.net credentials.
+**2. Install COBI.shipping service**
+  * Extract the `cobi-shipping` ZIP archive (recommended path: `C:\cobi-shipping`).
+  * Configure the connection values in the file `cobi-shipping-service.exe.config` (SAP database settings).
+  * Run the provided batch files:
+  * `InstallService.bat` → installs the Windows service.
+  * `DeleteService.bat` → removes the Windows service.
+**3. Configure Barcode Shipping**
+  * Open Barcode Shipping → File → Settings.
+  * General:
+  * Default shipper: *Einfacher Versender*
+  * Disable *Check order status*
+  * Enable *Mouse Mode*
+  * Default shop: *Connector*
+  * Connector: \\
+  * API URL: http://<COBI.shipping server IP>:<Port>/api/v1 \\