cobi.shipping
Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
| cobi.shipping [2025/08/22 13:31] – [Installation] thuth | cobi.shipping [2025/08/25 12:57] (current) – [Coresuite Print configuration] thuth | ||
|---|---|---|---|
| Line 30: | Line 30: | ||
| - 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 ===== | ===== 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, | + | For COBI.shipping to function properly, several **User-Defined Fields (UDFs)** must be created in SAP Business One. \\ |
| + | These fields store address information, | ||
| Under //Delivery Notes -> Lines (DLN12)//: | Under //Delivery Notes -> Lines (DLN12)//: | ||
| ^ Title ^ Data type ^ Size ^ Description | ^ Title ^ Data type ^ Size ^ Description | ||
| - | | cobi-shipping\_firstNameField | + | | cobi-shipping_firstNameField |
| - | | cobi-shipping\_lastNameField | + | | cobi-shipping_lastNameField |
| - | | cobi-shipping\_companyField | + | | cobi-shipping_companyField |
| - | | cobi-shipping\_phoneField | + | | cobi-shipping_phoneField |
| - | | cobi-shipping\_emailField | + | | cobi-shipping_emailField |
| Under //Delivery Notes -> Header//: | Under //Delivery Notes -> Header//: | ||
| ^ Title ^ Data type ^ Size ^ Description | ^ Title ^ Data type ^ Size ^ Description | ||
| - | | cobi-shipping\_trackingInHeaderField | + | | cobi-shipping_trackingInHeaderField |
| - | | cobi-shipping\_alarmGroupId | + | | cobi-shipping_alarmGroupId |
| Under //Items (OITM)//: | Under //Items (OITM)//: | ||
| ^ Title ^ Data type ^ Size ^ Description | ^ Title ^ Data type ^ Size ^ Description | ||
| - | | cobi-shipping\_oitmCommodityCodeField | + | | cobi-shipping_oitmCommodityCodeField |
| Line 65: | Line 66: | ||
| **1. Install Barcode Shipping** | **1. Install Barcode Shipping** | ||
| - | * Download and install Barcode Shipping from the internal archive (`N: | + | * Download and install Barcode Shipping from the internal archive (N: |
| - | * During setup, choose **Shop → Eigentwicklung** and **Shipper → Einfacher Versender**, | + | * During setup, choose **Shop → Eigenentwicklung** and **Shipper → Einfacher Versender**, |
| - | * Install **Java 11** (required by Barcode Shipping). Instructions: | + | * Install **Java 11** (required by Barcode Shipping). |
| + | * Instructions: | ||
| * Log in to Barcode Shipping with COMP.net credentials. | * Log in to Barcode Shipping with COMP.net credentials. | ||
| **2. Install COBI.shipping service** | **2. Install COBI.shipping service** | ||
| - | * Extract the `cobi-shipping` ZIP archive (recommended path: `C: | + | * Extract the cobi-shipping ZIP archive (recommended path: C: |
| - | * Configure the connection values in the file `cobi-shipping-service.exe.config` (SAP database settings). | + | * Configure the connection values in the file cobi-shipping-service.exe.config (SAP database settings). |
| * Run the provided batch files: | * Run the provided batch files: | ||
| - | * `InstallService.bat` → installs the Windows service. | + | * InstallService.bat → installs the Windows service. |
| - | * `DeleteService.bat` → removes the Windows service. | + | * DeleteService.bat → removes the Windows service. |
| **3. Configure Barcode Shipping** | **3. Configure Barcode Shipping** | ||
| * Open Barcode Shipping → File → Settings. | * Open Barcode Shipping → File → Settings. | ||
| - | | + | * General: |
| * Default shipper: *Einfacher Versender* | * Default shipper: *Einfacher Versender* | ||
| Line 88: | Line 90: | ||
| * Enable *Mouse Mode* | * Enable *Mouse Mode* | ||
| * Default shop: *Connector* | * Default shop: *Connector* | ||
| - | * Connector: | + | * Connector: |
| - | + | * API URL: http://IPvomCOBIShippingServer: | |
| - | * API URL: `http://< | + | |
| - | (example: | + | * |
| - | * API Version: | + | |
| - | * API Key: `Y29iaXNoaXBwaW5nOkRoNUchNnM=` (Base64 of `cobishipping: | + | |
| - | + | ||
| - | **4. Configure COBI.shipping in SAP Business One** | + | |
| - | + | ||
| - | * Go to **Extras → User-Defined Windows → @CMP\_CONFIG**. | + | |
| - | * Set the configuration values as documented (see sections *UDFs* and *Optional toggles*). | + | |
| - | * Mark shipping methods as “Barcode Shipping enabled”: | + | |
| - | **Administration → Definition → Inventory Management → Shipping Methods**. | + | |
| - | + | ||
| - | ⚠️ **Note:** Configuration values are only loaded at service startup. \\ | + | |
| - | After making changes, always restart the COBI.shipping Windows service. \\ | + | |
| ===== Optional toggles (Boolean, 0/1) ===== | ===== Optional toggles (Boolean, 0/1) ===== | ||
| - | All of the following | + | The following |
| - | ^ Key | + | ^ Key ^ Meaning ^ |
| - | | `cobi-shipping_companyFromCardName` | Use **CardName** as company name on the delivery address. | + | | cobi-shipping_companyFromCardName | Use CardName as company name on the delivery address. | |
| - | | `cobi-shipping_firstLastNameFromContacts` | Take **first/last name** from the linked | + | | cobi-shipping_firstLastNameFromContacts | Take first/last name from the linked Contact Person. | |
| - | | `cobi-shipping_firstNameLastNameFromCardName` | Derive | + | | cobi-shipping_firstNameLastNameFromCardName | Derive first/last name from CardName. | |
| - | | `cobi-shipping_companyFirstNameLastNameFromAddress3` | Pull **company / first / last name** from **Address3** field. | + | | cobi-shipping_companyFirstNameLastNameFromAddress3 | Pull company / first / last name from Address3 field. | |
| - | | `cobi-shipping_addressFromAddress2` | Use **Address2** as the street address. | + | | cobi-shipping_addressFromAddress2 | Use Address2 as the street address. | |
| - | | `cobi-shipping_companyAddressFromAddress2` | + | | cobi-shipping_companyAddressFromAddress2 | Take name/ |
| - | | `cobi-shipping_privateAddressFromAddress2` | + | | cobi-shipping_privateAddressFromAddress2 | Treat Address2 as a private address. | |
| - | | `cobi-shipping_createInvoiceAfterFullyPacked` | **Auto-create Invoice** when the delivery is fully packed. | + | | 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_invoiceDateEqDeliveryNoteDate | Set Invoice Date = Delivery Note Date for auto-created invoices. | |
| - | | `cobi-shipping_displayClosedDeliveryNotes` | + | | cobi-shipping_displayClosedDeliveryNotes | Also show closed Delivery Notes to Barcode Shipping. | |
| - | + | ||
| - | ===== Related non-boolean keys (for reference) ===== | + | |
| - | + | ||
| - | These are **not** toggles, but often configured alongside the above: | + | |
| - | + | ||
| - | ^ Key ^ Type / Example | + | |
| - | | `cobi-shipping_trackingInHeaderFieldName` | Text (UDF name in Delivery header) | + | |
| - | | `cobi-shipping_alarmGroupId` | + | |
| - | | `cobi-shipping_oitmCommodityCodeField` | Text (UDF name on `OITM`) | + | |
| - | | `cobi-shipping_alternativeRecipient` | Text (UDF name) | Alternative recipient field. | + | |
| - | + | ||
| - | > Note: Address field mappings like `cobi-shipping_firstNameField`, | + | |
| ===== Coresuite Print configuration ===== | ===== Coresuite Print configuration ===== | ||
| - | If the system is configured for automatic invoice creation, COBI.shipping can trigger | + | 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 ^ | ^ Key ^ Type / Example ^ Purpose ^ | ||
| Line 143: | Line 121: | ||
| | cobi-shipping_layoutId | Text / ID (e.g. 1001) | Layout ID for the document | | | 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 | | | cobi-shipping_printMode | Text (Print or Email) | Determines whether the invoice is printed or sent by email | | ||
| - | |||
cobi.shipping.1755862273.txt.gz · Last modified: by thuth