Optional
applicationapplication related configurations
Optional
dataIf defined, overrides the users default language used for the product data (array of langauges in order of priority).
If the array is empty the UI language will be used as fallback.
The default data language is only used if project.applySessionDefaults
is specified.
Otherwise the language which is currently configured in the eaiws session will be used.
Optional
disabledOptional list of plugins categories that will be disabled.
Optional
disabledOptional list of plugins (plugin names) that will be disabled.
Optional
doneAdditional options for the done button.
Optional
featurePredefined set of features that enable/disable certain application features and plugins. (default: Full
)
Optional
priceEnables/disables article price date support (default: false)
Note: To correctly load/preserve the price date stored in OBK/OBX files it is importent to set the
session property egr.eai.basket.preserve_price_date
of the EAIWS session to true
before loading the OBK/OBX.
Optional
showIf true the application will show a Done
button which can be used
from the user to finish the integration. (default: true)
Optional
showIf true the application will show a Save
button which can be used
from the user to trigger the saving of the current project. (default: false)
The message wbkHost.saveProject
will be send to the host after clicking the button.
The host should then save the project. The basket will be locked until the host sends
the message wbk.saveProjectDone
back to the basket.
Optional
showIf true and user
is defined the application will show the user information. (default: false)
Optional
theme?: { Theme settings which will override the default application theme.
Optional
appApplication bar color of the theme as hex string. (default: #ffffff)
Optional
logo?: null | stringLogo of the application. (default: null)
Optional
logoBackground color of the logo as hex/css color string. (default: transparent)
Optional
primaryPrimary color of the theme as hex string. (default: #0078d4)
Optional
textText color of the theme as hex string. (default: #333333)
Optional
calculationConfiguration for the project and item calculation.
Optional
pricingname of the pricing procedure to use for the project and item calculation
Optional
catalogConfiguration for the catalog.
Optional
customCustom catalog registration
eaiws related configurations
base url of the EAIWS server
Optional
keepinterval for the session keep alive message in milliseconds, 0 disables keep alive (default: 60000)
id of the EAIWS session
Optional
orderOrdering configuration.
If defined a report using the specified template will be generated and attached to the order. (default: null)
Optional
projectproject related configurations
Optional
applyIf true
all of the current default session settings will be assign to the session.
Can be used to initialize a new project with the user defaults.
An array with DefaultSessionSetting
entries can be used to define which settings will be applied.
Optional
editorThe editor mode defines the primary purpose of the project editor. If not defined Default
will be used.
Optional
lockedOptional list of locked items which will be used to lock certain item related operations.
Optional
metaOptional project related meta data which may be used by certain operations (e.g. ordering)
Optional
migrateIf true, legacy data (e.g. header or address data) will be loaded and migrated. (default: false) Should be used when loading obk files of older applications.
Controls if the catalog should be opened automatically for empty/new projects. (default: false)
Optional
title?: stringinitial title
Optional
titleif true the title may be changed by the user
Optional
reportConfiguration for the reporting.
Optional
attachments?: { Predefined attachments for each template which will be added to every report. The name of the template is used as the key for the dictionary. If an empty string is used as the template name the provided attachments will be applied to all templates without explicitly defined attachments.
Optional
appendList of PDF urls which should be added at the end of the report.
Optional
prependList of PDF urls which should be added in front of the report.
Optional
defaultName of the default template
Optional
templates?: string[]Array of template names of report templates which should be available to the user.
Optional
useruser related configurations
Optional
accessOptional pCon.login access token.
Some basket operations are only available for logged in users
e.g. accessing protected PIM article information or to access user/organization preferences
Note: The access token usually expires after 1 hour. Its important to request a new token before that happens and send it
to the basket using the wbk.updateUserAccessToken
message.
Optional
accountOptional url for user account management
Optional
companyOptional url to the company logo.
Optional
fullOptional full name of the user (e.g. first name + last name)
Login name of the user.
Optional
restrictions?: string[]Optional set of restrictions for this user. If not defined the default restrictions of the application will be used. See basket integration manual for a list of available restrictions.
Generated using TypeDoc
wbk.configuration
message parameter.