Product documentation
Product Search Flintfox Add-on

Flintfox Pricing and Promotions Execution calculates prices and rebates based on product and customer (or order). With the Flintfox PPE add-on, it's possible to fetch the Flintfox prices from the Flintfox API and show them within Product search.

 

Pre-requisites

The setup described in this topic only focuses on the additions needed to display prices from Flintfox and assumes Product search is already fully set up and running. 

The Flintfox add-on requires an additional license. Make sure that both the license is correctly loaded in the environment and the configuration key for the add-on is activated. The key can be found under System administration > Setup > License configuration and scroll down to DYS Advanced search > Product search > Product search add-on's > Flintfox PPE

 

Parameter setup

To start using the Flintofx add-on, the connection settings and mappings have to be setup.

Navigate to Product information management > Setup > Advanced search > Product search parameters and select the tab Flintfox PPE

General

This section is used for the connection settings to the Flintfox API and some default settings.

Field Description
API SETUP
Enabled When Enabled, the Flintfox API will be used to fetch prices.
API Key Fill in the key for the Flintfox API that is to be used.
API URL Fill in the URL for the Flintfox API.
API Client datasource Fill in the client datasource for the Flintfox API.
ENDPOINT
Endpoint URL This fields shows the full URL used to fetch the prices from the Flintfox API. It is based on the filled in URL + a hardcoded suffix for the correct price fetching method.
SETUP
Default customer Fill in the default customer. This customer account will be used if no other customer context is available when fetching prices (i.e. when the Product search forms are opened from the menu and not from a (sales) order).
Order customer Select which customer account should be used when Product search is opened from an order. The system can use the account on the order (Order account) or the invoice account associated with the account on the order.  
Num. of decimals Set the default number of decimals to be used on a new record when mapping a calculated field

 

Calculated field mapping

In this section, the mappings are made between the available fields (as part of the Flintfox PP collection) and the required Level order (number) of the price model within Flintfox.

The 'Add' button can be used to create new records, the 'Remove' button can be used to delete records, and the 'Translations' button can be used to add translations for the mapped fields/labels (when working with a multi-language Search setup).

Field Description
Method name Select the (F&O) field/method to be used for this mapping record. There are a maximum of 12 fields supported to be mapped to/fetched from Flintfox. These generically named fields are numbered to enable keeping track of them individually.  
Price model Specify which Flintfox price model should be used for this mapped record by filling in the price model ID.
Level order Specify which level order from the price model to be used for this mapping. The price from the level specified here will be shown within Search (when this mapping is used). 
Field Specify the field name of the line field. In most cases this will be 'unitAmount' to simply get the price for the level order from the API, but from a technical standpoint could be something else if needed.    
Num. of decimals Specify the number of decimals to use when displaying the amount. The value of this field is defaulted from the general settings but can be changed if wanted.
Description If wanted a description or additional comment can be filled in here for the mapped record. It has no other functional purpose.
Field label Fill in the label for this mapped field when shown in the View/Compare function. (Note that the label that is used on the Search result card is set up on the Search layout tab when creating the calculated field records.)

Setting up the calculated fields

To display the Flintfox prices on the Product search result cards, they have to be added to the layout.

Navigate to Product information management > Setup > Advanced search > Search configuration, select the configuration and Category hierarchy you want to add the Flintfox prices to and click 'Configure search hierarchy'. 

Scroll down to the 'Search layout' tab and add a new calculated record, by selecting 'Calculated' from the 'Add' dropdown. Select 'FlintfoxPPE' in the collection column and then select the desired Calculated field in the next column. Note that the fields available here are the ones that are added/mapped in the parameter setup. Also make sure to fill in the Field label with the label this mapped field should show on the Search result card. Repeat this step for all mapped fields that need to be displayed on the layout.

Once all fields have been added, make sure to 'Publish definitions' and double check that the fields are indeed displayed within the Product search forms and that the prices are being fetched.  

 

Displaying Flintfox fields in the compare

As the Flintfox fields are set up as calculated fields - fetched directly from the Flintfox API, they do not automatically show up within the view/compare function. It is possible to have them show up in the view/compare function, by also setting up the Custom search source for the Flintfox PPE.

Navigate to Product information management > Setup > Advanced search > Search configuration, select the relevant configuration and Category hierarchy and click 'Configure search hierarchy'.

Scroll down to the 'Custom search' tab and add a new record with the 'Add' button. dropdown. Select 'FlintfoxPPE' as the Custom search source.

Any mapped Flinftfox fields will now appear when the view/compare function is used.