7 Custom Catalogs

If you have a database/catalog with non-OFML articles and want to use them inside pCon.basket, you can use the "custom catalogs" feature to do this. To enable this feature you have to register your custom catalog as part of the wbk.configuration as shown in the integration example.

pCon.basket supports two types of non.OFML catalogs. External Catalogs and Custom Catalogs.

Custom Catalogs

After registering the catalog you have to listen and handle the messages wbkHost.getCustomCatalogArticles and wbkHost.getCustomArticle to provide pCon.basket with the required catalog/article data.

Illustration of the message sequence:

%%{init:{"theme":"dark"}}%% sequenceDiagram autonumber actor U as User participant H as Host participant B as Basket U ->> B : user selects custom catalog in basket UI activate B B ->> H : request catalog articles <br/> message: wbkHost.getCustomCatalogArticles deactivate B activate H H ->> B : send catalog articles <br/> message: wbk.customCatalogArticles deactivate H activate B U ->> B : user selects article in basket catalog UI B ->> H : request full article data <br/> message: wbkHost.getCustomArticle deactivate B activate H H ->> B : send article data <br/> message: wbk.customArticle deactivate H activate B B ->> B : insert article into article list deactivate B
%%{init:{"theme":"default"}}%% sequenceDiagram autonumber actor U as User participant H as Host participant B as Basket U ->> B : user selects custom catalog in basket UI activate B B ->> H : request catalog articles <br/> message: wbkHost.getCustomCatalogArticles deactivate B activate H H ->> B : send catalog articles <br/> message: wbk.customCatalogArticles deactivate H activate B U ->> B : user selects article in basket catalog UI B ->> H : request full article data <br/> message: wbkHost.getCustomArticle deactivate B activate H H ->> B : send article data <br/> message: wbk.customArticle deactivate H activate B B ->> B : insert article into article list deactivate B
sequenceDiagram
    autonumber
    actor U as User
    participant H as Host
    participant B as Basket
    U ->> B : user selects custom catalog in basket UI
    activate B
    B ->> H : request catalog articles <br/> message: wbkHost.getCustomCatalogArticles
    deactivate B
    activate H
    H ->> B : send catalog articles <br/> message: wbk.customCatalogArticles
    deactivate H
    activate B
    U ->> B : user selects article in basket catalog UI
    B ->> H : request full article data <br/> message: wbkHost.getCustomArticle
    deactivate B
    activate H
    H ->> B : send article data <br/> message: wbk.customArticle
    deactivate H
    activate B
    B ->> B : insert article into article list
    deactivate B

External Catalogs

If you provide an externalUrl when registering the catalog, the catalog will be handeld as external and embedded inside the basket UI using an iFrame. More details can be found in the external catalogs documentation.

Generated using TypeDoc