SAPB1SL - Connector Settings
This document details the connector-specific settings for the SAP Business One Service Layer (SAPB1SL) connector. These settings control various aspects of data synchronization, pricing, stock management, order processing, and authentication, enabling administrators to tailor the connector's behavior to specific SAP B1 configurations.
Connector settings are typically configured via the App4Sales portal UI and are applied at runtime to influence the connector's operations.
Setting | Description | Values / Defaults | Dependencies / Effects |
Subscription Key | Key used for authentication with the SAP B1 Service Layer. | String (encrypted) | Required for secure communication with the SAP B1 Service Layer. |
Version of SAP B1 Service layer API | Specifies the version of the SAP B1 Service Layer API to use. | String (default: v2) | Ensures compatibility with the SAP B1 environment. |
Batch size for get calls | Determines the number of records to retrieve in a single batch during data retrieval calls. | Integer (default: 1000) | Affects performance and resource usage during data synchronization. |
Price list code for default item price | The numeric code for the price list in SAP B1 to be used as the default item price. | Integer | Used during item synchronization to determine base pricing. |
Item property name to check for item sync | Specifies a custom item property name in SAP B1 that is checked to determine if an item should be synchronized with App4Sales. | String | Items not meeting the criteria of this property will be excluded from synchronization. |
Item property for purchase package size | Defines the SAP B1 item property that holds information about the purchase package size. | String | Used for accurate stock and order quantity calculations. |
Add comment field to item categories | When enabled, a comment field will be used for item categories instead of the default description field. | Boolean | Modifies how item category information is represented. |
Price list code for recommended market price | The numeric code for the price list in SAP B1 to be used as the recommended market price. | String | Used for displaying recommended pricing in App4Sales. |
Item groups names for related items (CSV) | A comma-separated list of item group names in SAP B1 that are considered for related items functionality in App4Sales. | String (CSV format) | Filters which item groups are used when identifying related products. |
Warehouse codes for items stock (Comma separated) | A comma-separated list of warehouse codes in SAP B1 from which item stock levels should be retrieved. | String (Comma separated) | Limits stock synchronization to specified warehouses. |
Only process product trees from specified warehouses (Comma separated) | A comma-separated list of warehouse codes in SAP B1 from which product trees (BOMs) should be processed. | String (Comma separated) | Restricts the processing of product trees to specific warehouses. |
Use InStock/OnStock as ShelfStock, use Stock Formula for AvailableStock | If enabled, the 'In Stock' or 'On Stock' values from SAP B1 will be used for 'Shelf Stock', and a calculated stock formula will be used for 'Available Stock' in App4Sales. | Boolean | Changes how stock quantities are interpreted and displayed in App4Sales. |
Item description in foreign language mapping | Specifies the foreign language code to retrieve item descriptions from SAP B1. | String | Enables multilingual item descriptions. |
Synchronize only Business Partners (Customers) types | Filters Business Partners during customer synchronization. Only types specified in this comma-separated list will be synchronized. | String (Possible values: cCustomer, vVendor, lLead) | Excludes unwanted Business Partner types (e.g., vendors, leads) from customer sync. |
Use VAT liable for customer VAT liable | When enabled, the VAT liable status as set in SAP B1 will be used to determine the customer's VAT liability in App4Sales. | Boolean | Directly uses SAP's VAT liability flag for customers. |
Use Bill Address Federal Tax ID as customer VAT liable indicator | If enabled, the Federal Tax ID from the customer's billing address in SAP B1 will be used as the indicator for customer VAT liability. | Boolean | Alternative method to determine customer VAT liability based on tax ID. |
CardCode prefix for new Business Partners | A prefix to be added to the CardCode when creating new Business Partners in SAP B1 from App4Sales. | String | Helps in identifying customers created through App4Sales and maintaining numbering schemes. |
CardCode number for new Business Partners to increment from | The starting number for incrementing the CardCode for new Business Partners created from App4Sales. | Integer | Works in conjunction with 'CardCode prefix for new Business Partners' to generate unique IDs. |
Create drafts during send order call | When enabled, orders sent from App4Sales will be created as draft documents in SAP B1 instead of final orders. | Boolean | Allows for review and approval of orders within SAP B1 before finalization. |
Send order reference as BPReferenceNo | If enabled, the order reference from App4Sales will be mapped to the 'BPReferenceNo' field in SAP B1. | Boolean | Facilitates linking orders in SAP B1 back to their origin in App4Sales. |
Use CustomerRefNo as order description | When enabled, the Customer Reference Number from App4Sales will be used as the order description in SAP B1. | Boolean | Provides additional context for orders within SAP B1. |
Exclude invalid customers from sync | If enabled, customers marked as invalid in SAP B1 (based on internal logic) will be excluded from synchronization. | Boolean | Prevents synchronization of incomplete or erroneous customer data. |
Exclude invalid items from sync | If enabled, items marked as invalid in SAP B1 (based on internal logic) will be excluded from synchronization. | Boolean | Prevents synchronization of incomplete or erroneous item data. |
Mapping for custom customer fields (JSON format) | Defines how custom customer fields in SAP B1 are mapped to App4Sales. Expected in JSON format. | String (JSON format: | Allows for flexible integration of custom customer data. |
Use next delivery date from purchase order | If enabled, the next delivery date will be retrieved from the purchase order in SAP B1. | Boolean | Ensures accurate delivery date information is used. |
Field name for shipment tracking code | Specifies the SAP B1 field name that stores the shipment tracking code. | String (default: 'U_PAR_TRACKINGURL') | Used to retrieve and display tracking information in App4Sales. |
Field name for shipment tracking url | Specifies the SAP B1 field name that stores the shipment tracking URL. | String (default: 'U_PAR_LABELURL') | Used to provide a direct link to shipment tracking in App4Sales. |
Field name for shipment tracking method | Specifies the SAP B1 field name that stores the shipment tracking method. | String | Used to retrieve and display the shipping method in App4Sales. |
Country codes that are VAT Liable (separated by ;) | A semicolon-separated list of country codes where customers are considered VAT liable. | String (Semicolon separated) | Used for determining VAT treatment based on customer location. |
Item free field name for brand | Specifies the SAP B1 user-defined field (UDF) name that stores the item's brand information. | String | Maps brand data from SAP B1 to App4Sales. |
Item free field name for color | Specifies the SAP B1 user-defined field (UDF) name that stores the item's color information. | String | Maps color data from SAP B1 to App4Sales. |
Item free field name for status | Specifies the SAP B1 user-defined field (UDF) name that stores the item's status. | String | Maps item status data from SAP B1 to App4Sales. |
Item free field name for type | Specifies the SAP B1 user-defined field (UDF) name that stores the item's type. | String | Maps item type data from SAP B1 to App4Sales. |
Item free field name for mattress | Specifies the SAP B1 user-defined field (UDF) name that stores mattress-specific item information. | String | Maps mattress-related data from SAP B1 to App4Sales. |
Item free field name for quality | Specifies the SAP B1 user-defined field (UDF) name that stores the item's quality information. | String | Maps item quality data from SAP B1 to App4Sales. |
Item free field name for version | Specifies the SAP B1 user-defined field (UDF) name that stores the item's version information. | String | Maps item version data from SAP B1 to App4Sales. |
Item status field | Specifies the SAP B1 field that stores the item's overall status. | String | Used to determine and display the operational status of an item. |
Stock field used for Last available stock | Specifies the SAP B1 stock field to be used for 'Last available stock' calculation in App4Sales. | String | Influences how the last available stock quantity is reported. |
Use endpoint to retrieve item status description | If enabled, a dedicated endpoint will be used to retrieve detailed item status descriptions. | Boolean | Enables more comprehensive status information for items. |
Do next sync as full sync | When enabled, the next synchronization run will perform a full data synchronization, overriding incremental updates. | Boolean | Forces a complete refresh of data; useful for troubleshooting or initial setup. |
Use Get special price call during live prices call | If enabled, the connector will make a special price call to SAP B1 during live price lookups. | Boolean | Ensures special prices configured in SAP B1 are considered for live pricing. |
Include specific discount groups discounts into item live prices | When enabled, discounts specified for customer groups and specific customers in SAP B1 will be applied during live item price calls. | Boolean | Incorporates customer-specific and group-specific discounts into real-time pricing. |
Use Staffle prices for specific discount groups discounts during live prices get | If enabled, "Staffle" (tier) prices from the database and discounts specified for customer groups will be applied during live price retrieval. | Boolean | Applies tiered pricing and specific discount groups for live price calculations. |
Use customer discount relation for live prices discount calculation | When enabled, customer discount relations defined in SAP B1 will be used for calculating discounts during live price calls. | Boolean | Leverages SAP B1's customer discount relationships for accurate live pricing. |
Include All BPs discount groups discounts into item prices | If enabled, discount percentages specified for all Business Partners in SAP B1 will be included in item prices. | Boolean | Applies global Business Partner discounts to item pricing. |
Exclude items from sync based on item category | A list of item categories that, if an item belongs to, will cause the item to be excluded from synchronization. | String | Filters out items based on their category, preventing their sync to App4Sales. |
Add Reference and Your Reference to the NumAtCard field in SAP | When enabled, the 'Reference' and 'Your Reference' fields from App4Sales orders will be concatenated and sent to the 'NumAtCard' field in SAP B1. | Boolean | Consolidates reference information into a single SAP B1 field. |
Mapping of default values for custom order fields (JSON format) | Defines default values for custom order fields in SAP B1, expected in JSON format. | String (JSON format: | Automatically populates custom order fields with predefined values. |
Customer property retrieved as classification | Specifies the SAP B1 customer property that should be retrieved and used as a classification in App4Sales. | String | Categorizes customers in App4Sales based on a SAP B1 property. |
Use customer discount | If enabled, customer-specific discounts from SAP B1 will be applied. | Boolean | Enables the application of individual customer discounts. |
Do not send prices to ERP | When enabled, price information will not be sent from App4Sales to SAP B1 during order creation/updates. | Boolean | Prevents App4Sales from overriding pricing in SAP B1. |
Send discount of 0 on order header to ERP | If enabled, a discount of 0 will be explicitly sent on the order header to SAP B1. This setting requires 'Do not send prices to ERP' to be disabled. | Boolean | Ensures that even zero discounts are communicated to SAP B1. |
Do not send DocTotal to ERP | When enabled, the document total will not be sent from App4Sales to SAP B1 during order creation/updates. | Boolean | Allows SAP B1 to calculate the document total independently. |
Send the vat number in the FederalTaxID field of SAP instead of the default VATRegistrationNumber | If enabled, the VAT number will be sent to the 'FederalTaxID' field in SAP B1 instead of the default 'VATRegistrationNumber' field. | Boolean | Adjusts the mapping of the VAT number to a different field in SAP B1. |
Send empty CardCode | If enabled, an empty CardCode will be sent for new Business Partners if no other CardCode is specified. | Boolean (default: true) | Allows for Business Partner creation without a predefined CardCode. |
Customer Series | Specifies the numeric series to be used when creating new customers in SAP B1. | Integer (Nullable) | Controls the numbering sequence for new customer records. |
UOM Entry value for not complete package sizes | Defines the Unit of Measure (UOM) entry value to be used for package sizes that are not complete. | Integer (Nullable) | Ensures correct UOM assignment for partial packages. |
Use new livecall implementation (Experimental) | Enables an experimental new implementation for live calls. | Boolean | May introduce new features or performance improvements but should be used with caution. |
Filter Customers using OData | Allows filtering customers using an OData query string (e.g., | String | Provides advanced filtering capabilities for customer synchronization. |
Use price on orderline for total calculation instead of LineTotal | If enabled, the price specified on the order line will be used for the total calculation instead of the LineTotal field. | Boolean | Influences how order totals are calculated within SAP B1. |
Years for order history per customer | The number of years to retrieve order history for each customer. Leave empty to retrieve the full history. | Integer | Limits the historical order data synchronized to App4Sales. |
Domain Specifics
Authentication
The Subscription Key is crucial for establishing a secure connection to the SAP Business One Service Layer. It is an encrypted value and should be handled with care.
Catalog
Item property name to check for item sync and Exclude invalid items from sync provide mechanisms to control which items are synchronized, allowing administrators to filter out irrelevant or incomplete product data.
Settings such as Price list code for default item price and Price list code for recommended market price are used to define which SAP B1 price lists are utilized for different pricing scenarios in App4Sales.
The various "Item free field name for..." settings (e.g., Brand, Color, Status) allow for mapping custom item attributes from SAP B1's User-Defined Fields (UDFs) to App4Sales.
Warehouse codes for items stock (Comma separated) and Only process product trees from specified warehouses (Comma separated) enable granular control over stock and product tree synchronization based on warehouse locations.
Customer Management
Synchronize only Business Partners (Customers) types offers precise control over which types of Business Partners are synchronized as customers, preventing the inclusion of vendors or leads.
Use VAT liable for customer VAT liable and Use Bill Address Federal Tax ID as customer VAT liable indicator provide options for how customer VAT liability is determined, aligning with SAP B1's configuration.
NewCustomersCodePrefix and NewCustomerCodeNumber assist in managing the CardCode assignment for newly created Business Partners.
Filter Customers using OData allows for highly flexible and advanced filtering of customer data using OData query syntax.
Order Processing
Create drafts during send order call offers flexibility in the order workflow by allowing orders to be initially created as drafts in SAP B1 for review.
Send order reference as BPReferenceNo and Use CustomerRefNo as order description facilitate the transfer of relevant reference information from App4Sales orders to SAP B1.
The various settings related to discounts (e.g., Include specific discount groups discounts into item live prices, Use Staffle prices for specific discount groups discounts during live prices get) ensure that complex pricing and discount structures from SAP B1 are accurately reflected in App4Sales.
Do not send prices to ERP and Do not send DocTotal to ERP provide control over whether pricing and total amount information is pushed from App4Sales to SAP B1, allowing SAP B1 to be the sole authority for these calculations if desired.
Mapping of default values for custom order fields (JSON format) enables the automatic population of user-defined fields on orders in SAP B1, streamlining order entry processes.
Related Settings & Prerequisites
These settings are located in the connector's configuration section within the App4Sales administrative interface. Proper configuration is essential for the connector's functionality. Incorrect values may lead to data synchronization issues or incorrect business logic application.
Known Limitations
None explicitly identified from the code comments for settings within this scope. Limitations regarding specific API capabilities or data structures would be dependent on the SAP Business One Service Layer version and configuration.