Differences

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

--- cobi.shipping [2025/08/22 12:51] – [Implementation details] thuth
+++ cobi.shipping [2025/08/25 12:57] (current) – [Coresuite Print configuration] 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 28: / Line 30: @@
   - Delivered as a Windows service (installation via included batch files). \\
   - 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. \\
   - 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.
+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_firstNameField  | Alphanumeric  | 50    | First name of the recipient                      |
-| cobi-shipping\_lastNameField   | Alphanumeric  | 50    | Last 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_companyField    | Alphanumeric  | 100   | Company name of the recipient                    |
-| cobi-shipping\_phoneField      | Alphanumeric  | 30    | Phone number of the recipient                    |
+| cobi-shipping_phoneField      | Alphanumeric  | 30    | Phone number of the recipient                    |
-| cobi-shipping\_emailField      | Alphanumeric  | 100   | Email address 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_trackingInHeaderField  | Alphanumeric  | 100   | Field to store tracking number(s) in delivery note |
-| cobi-shipping\_alarmGroupId           | Numeric       | 11    | Alarm group for invoice errors                     |
+| 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 |
+| cobi-shipping_oitmCommodityCodeField | Alphanumeric  | 20    | Customs tariff code for export/import handling |
-===== Optional toggles (Boolean, 0/1) =====
+===== Installation =====
-All of the following configuration keys are stored in **@CMP\_CONFIG** and are read **on service start** (restart the COBI.shipping service after changes).
+**1. Install Barcode Shipping**
-^ Key                                             ^ Meaning (EN)                                                                                                   ^
+  * Download and install Barcode Shipping from the internal archive (N:\Entwicklung\Barcode Shipping\Downloads.7z).
-| `cobi-shipping_companyFromCardName`             | Use **CardName** as company name on the delivery address.  |
+  * During setup, choose **Shop → Eigenentwicklung** and **Shipper → Einfacher Versender**, then enable additional functions as needed.
-| `cobi-shipping_firstLastNameFromContacts`       | Take **first/last name** from the linked **Contact Person**.  |
+  * Install **Java 11** (required by Barcode Shipping). \\
-| `cobi-shipping_firstNameLastNameFromCardName`   | Derive **first/last name** from **CardName**.  |
+  * Instructions: https://www.barcodeshipping.de/java-installation
-| `cobi-shipping_companyFirstNameLastNameFromAddress3` | Pull **company / first / last name** from **Address3** field.  |
+  * Log in to Barcode Shipping with COMP.net credentials.
-| `cobi-shipping_addressFromAddress2`             | Use **Address2** as the street address.  |
-| `cobi-shipping_companyAddressFromAddress2`      | Take **name/company** from **Address2**.  |
-| `cobi-shipping_privateAddressFromAddress2`      | Treat **Address2** as a **private** address.  |
-| `cobi-shipping_createInvoiceAfterFullyPacked`   | **Auto-create Invoice** when the delivery is fully packed.  |
-| `cobi-shipping_invoiceDateEqDeliveryNoteDate`   | Set **Invoice Date = Delivery Note Date** for auto-created invoices.  |
-| `cobi-shipping_displayClosedDeliveryNotes`      | Also **show closed Delivery Notes** to Barcode Shipping.  |
-===== Related non-boolean keys (for reference) =====
+**2. Install COBI.shipping service**
-These are **not** toggles, but often configured alongside the above:
+  * 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:
-^ Key                                 ^ Type / Example                                               ^ Purpose                                                   ^
+  * InstallService.bat → installs the Windows service.
-| `cobi-shipping_trackingInHeaderFieldName` | Text (UDF name in Delivery header)                          | Stores tracking number(s) in the delivery header.  |
+  * DeleteService.bat → removes the Windows service.
-| `cobi-shipping_alarmGroupId`        | Numeric (e.g., `11`)                                        | Alarm group used for invoice errors.  |
-| `cobi-shipping_oitmCommodityCodeField` | Text (UDF name on `OITM`)                                   | Customs tariff code mapping.  |
-| `cobi-shipping_alternativeRecipient` | Text (UDF name)                                             | Alternative recipient field.  |
-> Note: Address field mappings like `cobi-shipping_firstNameField`, `..._lastNameField`, `..._companyField`, `..._phoneField`, `..._emailField` remain part of the **address configuration** (DLN12 mapping).
+**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://IPvomCOBIShippingServer:Port/api/v1/
+  * (example: http://127.0.0.1:62005/api/v1/)
+  *   API Version: V2
+===== Optional toggles (Boolean, 0/1) =====
+The following toggles are configured in @CMP_CONFIG and must be set to 0 (disabled) or 1 (enabled).
+^ Key ^ Meaning ^
+| cobi-shipping_companyFromCardName | Use CardName as company name on the delivery address. |
+| cobi-shipping_firstLastNameFromContacts | Take first/last name from the linked Contact Person. |
+| cobi-shipping_firstNameLastNameFromCardName | Derive first/last name from CardName. |
+| cobi-shipping_companyFirstNameLastNameFromAddress3 | Pull company / first / last name from Address3 field. |
+| cobi-shipping_addressFromAddress2 | Use Address2 as the street address. |
+| cobi-shipping_companyAddressFromAddress2 | Take name/company from Address2. |
+| cobi-shipping_privateAddressFromAddress2 | Treat Address2 as a private address. |
+| cobi-shipping_createInvoiceAfterFullyPacked | Auto-create Invoice when the delivery is fully packed. |
+| cobi-shipping_invoiceDateEqDeliveryNoteDate | Set Invoice Date = Delivery Note Date for auto-created invoices. |
+| cobi-shipping_displayClosedDeliveryNotes | Also show closed Delivery Notes to Barcode Shipping. |
 ===== Coresuite Print configuration =====
-If the system is configured for automatic invoice creation, COBI.shipping can trigger a Coresuite Print job right after the invoice is generated.
+For environments with automatic invoice creation, COBI.shipping can trigger Coresuite Print. \\
-This requires that the COBI.wms Printservice is installed and reachable.
+The following configuration values must be set:
 ^ Key ^ Type / Example ^ Purpose ^
@@ Line 97: / Line 121: @@
 | cobi-shipping_layoutId | Text / ID (e.g. 1001) | Layout ID for the document |
 | cobi-shipping_printMode | Text (Print or Email) | Determines whether the invoice is printed or sent by email |