Skip to main content

Winbas - Connector settings

Winbas - Connector Settings This document details the configurable settings for the Winbas connector, enabling Application Administr...

Updated over a week ago

Winbas - Connector Settings

This document details the configurable settings for the Winbas connector, enabling Application Administrators and Implementation Consultants to manage its behavior without direct code modifications. These settings govern various aspects of data synchronization, including item and customer file processing, FTP connection parameters, image handling, pricing logic, and order submission.

Data Source Configuration

Connector settings are typically configured via the App4Sales administration portal UI. They are applied at runtime to control how the Winbas connector interacts with external systems and processes data. These settings influence the retrieval and mapping of data from Winbas files or APIs to the internal App4Sales data structures.

Settings Table

Setting

Description

Values / Defaults

Dependencies / Effects

Item filename

Specifies the name of the file from which item data is retrieved.

String

Used by the item synchronization process to locate the correct data file.

Customer filename

Specifies the name of the file from which customer data is retrieved.

String

Used by the customer synchronization process to locate the correct data file.

FTP active connection

Determines whether an active FTP connection is used for data transfers.

Boolean (True/False)

Affects how the connector establishes and maintains FTP connections.

Excluded product group from App4Sales

Defines a product group that should be excluded from synchronization with App4Sales.

String

Items belonging to this product group will not be visible in App4Sales.

Only show webshop items

When enabled, only items marked as "webshop items" in the source data will be displayed in App4Sales.

Boolean (True/False)

Filters the item catalog shown in App4Sales.

Licensekey

A unique identifier, likely used for licensing or authentication with the Winbas system.

String

Required for establishing a licensed or authenticated connection to Winbas services.

Item group description

Defines the field or logic used to determine the item group description.

String

Influences how item groups are categorized and displayed in App4Sales.

Item group alternative description

Defines an alternative field or logic for the item group description.

String

Provides an alternative description for item groups, potentially used as a fallback or for specific displays.

Send original price and calculate discount

If enabled, the original price is sent, and App4Sales calculates the discount. If disabled, the already discounted price is sent.

Boolean (True/False)

Affects how pricing and discounts are handled during order creation and synchronization.

Round order line discount percentages to nearest full number

When enabled, discount percentages on order lines are rounded to the nearest whole number.

Boolean (True/False)

Impacts the precision of discount calculations in order lines.

Split item group on character

Specifies a character that the connector uses to split item group information into multiple parts.

String

Used for parsing complex item group structures.

Set item filter name

Allows setting a filter name for items, potentially impacting which items are synchronized or displayed.

String

Applies a filter to the item data.

Send order date as delivery date

If enabled, the order date is used as the delivery date for all order lines.

Boolean (True/False)

Overrides individual delivery dates with the order date.

Get pictures from product file

If enabled, images are retrieved directly from the product data file.

Boolean (True/False)

Determines the source of product images.

Get pictures from the URL sent in the product file

If enabled, images are downloaded from URLs provided within the product data file.

Boolean (True/False)

Requires internet access for image download; overrides 'Get pictures from product file' if both are enabled.

Use unit for purchasepackagesize

If enabled, the unit of measure is considered for the purchase package size.

Boolean (True/False)

Affects how purchase package sizes are interpreted.

Use instruction as orderline delivery date

If enabled, specific instructions in the order are used as the delivery date for order lines.

Boolean (True/False)

Provides flexibility in setting delivery dates based on order instructions.

Use product stock instead of available stock

When enabled, the product's total stock is used instead of the currently available stock.

Boolean (True/False)

Affects stock level reporting and availability checks in App4Sales.

VatLiable code

Specifies the code used to identify VAT-liable items or customers.

String

Used for tax calculations and reporting.

Not vatLiable code

Specifies the code used to identify non-VAT-liable items or customers.

String

Used for tax calculations and reporting.

Specialpricelist file name

Defines the filename for special price lists.

String

Allows the connector to import and apply special pricing rules.

Set the item vatpercentage

Allows setting a default or overriding VAT percentage for items.

String (e.g., "21.00")

Influences the VAT calculation for items.

Use order date for time of delivery at every orderline

If enabled, the order date is used as the time of delivery for each order line.

Boolean (True/False)

Ensures consistent delivery timing across all order line items based on the order date.

Use no order prefix

If enabled, no prefix will be added to order numbers.

Boolean (True/False)

Affects the formatting of generated order numbers.

Set salesmancode based on customer manager off a customer for sending order

If enabled, the salesperson code is derived from the customer's assigned manager when sending orders.

Boolean (True/False)

Ensures orders are attributed to the correct salesperson based on customer management.

Set salesmancode based on username for sending order

If enabled, the salesperson code is derived from the App4Sales username when sending orders.

Boolean (True/False)

Provides an alternative method for attributing orders to salespeople, based on the user placing the order.

Add the search name to the customer name

If enabled, the customer's search name will be appended to their primary name.

Boolean (True/False)

Affects how customer names are displayed and searchable within App4Sales.

Rename the freefields which are selected as extra fields (JSON format)

Allows renaming free fields that are mapped as extra fields using a JSON format string (e.g., {"FreeField1": "CustomLabel"}).

String (JSON)

Customizes the display names of free fields in App4Sales.

Item field name for item status

Specifies the name of the field in the item data that contains the item's status.

String

Used to map the item status from the source system to App4Sales.

Item field name for webshop flag

Specifies the name of the field in the item data that indicates if an item is a webshop item.

String

Used to identify webshop items for filtering or display.

Use Webshop field to exclude from Portal4Sales Pro

If enabled, items marked with the webshop flag will be excluded from Portal4Sales Pro.

Boolean (True/False)

Provides granular control over item visibility in Portal4Sales Pro based on their webshop status.

Places of storage code for stock sync (comma separated)

A comma-separated list of storage codes from which stock levels should be synchronized.

String (e.g., "WH1,WH2")

Filters stock synchronization to specific storage locations.

Create price lists based on customer discount and discount allowed

If enabled, price lists are generated considering both customer-specific discounts and overall allowed discounts.

Boolean (True/False)

Affects the dynamic generation of pricing for customers.

Maximum amount of parallel request allowed for downloading images from urls

Sets the maximum number of simultaneous requests for downloading images from URLs.

Integer

Controls the concurrency of image downloads, impacting performance and server load.

Delivery Address Type

Defines the type of delivery address to be used.

Dropdown: None, Delivery, Invoice, Visit

Determines how delivery addresses are categorized and utilized.

Shipping Address Type

Defines the type of shipping address to be used.

Dropdown: None, Delivery, Invoice, Visit

Determines how shipping addresses are categorized and utilized.

Special Logic & Filters

The connector applies various filters, such as excluding specific product groups or showing only webshop items, based on the settings above. It also handles dynamic logic for price calculation, image downloading, and salesperson attribution. For image downloads, a maximum number of parallel requests can be configured to manage system resources.

Domain Specifics

Authentication

The Licensekey setting is crucial for establishing authenticated connections to the Winbas system, ensuring secure data exchange.

Catalog & Item Management

  • Settings like Item filename, Customer filename, Excluded product group from App4Sales, and Only show webshop items directly control which items and customers are synchronized and displayed.

  • Item group description and Item group alternative description define how items are categorized.

  • Item field name for item status and Item field name for webshop flag map custom fields from Winbas to App4Sales's item status and webshop flag.

  • Use Webshop field to exclude from Portal4Sales Pro provides specific control over item visibility in the Portal4Sales Pro environment.

Pricing & Discounts

  • Send original price and calculate discount and Round order line discount percentages to nearest full number manage the calculation and presentation of pricing and discounts.

  • Specialpricelist file name allows for the integration of complex pricing structures.

  • Set the item vatpercentage controls the VAT applied to items.

  • Create price lists based on customer discount and discount allowed enables dynamic price list generation.

Order Processing

  • Settings like Send order date as delivery date, Use instruction as orderline delivery date, and Use order date for time of delivery at every orderline dictate how delivery dates are handled.

  • Use no order prefix affects order numbering.

  • Set salesmancode based on customer manager off a customer for sending order and Set salesmancode based on username for sending order determine how salesperson attribution occurs during order submission.

Stock Management

  • Use product stock instead of available stock and Places of storage code for stock sync (comma separated) are vital for accurate stock level synchronization and reporting.

Image Handling

  • Get pictures from product file and Get pictures from the URL sent in the product file determine the source and method of retrieving product images.

  • Maximum amount of parallel request allowed for downloading images from urls helps optimize image download performance.

Related Settings & Prerequisites

No specific external prerequisites are explicitly defined in the settings beyond the availability of the Winbas data source (files or API) and a properly configured FTP connection if FTP active connection is enabled. Authentication is managed via the Licensekey.

Known Limitations

Based on the available settings, there are no explicitly stated limitations in the code itself.

Did this answer your question?