Optionalapplicationapplication related configurations
OptionalcontactSupportUrl?: string | nullUrl to the Contact Support document/form of the application.
OptionalcustomActions?: CustomActionsCan be used to add custom buttons/actions to the basket GUI.
OptionaldataLanguage?: string[]If defined, overrides the users default language used for the product data (array of languages 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.
OptionaldisabledPluginCategories?: string[]Optional list of plugins categories that will be disabled.
OptionaldisabledPlugins?: string[]Optional list of plugins (plugin names) that will be disabled.
OptionaldoneButtonOptions?: ButtonOptionsAdditional options for the done button.
OptionalerrorReportEmailAddress?: stringEmail address used for error reporting
OptionalfeatureSet?: FeatureSetPredefined set of features that enable/disable certain application features and plugins.
OptionalinputFieldCharacterLimits?: Partial<Record<InputField, number>>Custom character limit definition for input fields.
OptionalpriceDateSupported?: booleanEnables/disables article price date support.
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.
OptionalshowDoneButton?: booleanIf true the application will show a Done button which can be used
from the user to finish the integration.
OptionalshowProjectSaveButton?: booleanIf true the application will show a Save button which can be used
from the user to trigger the saving of the current project.
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.
OptionalshowUser?: booleanIf true and user is defined the application will show the user information.
OptionalsupportedAPIs?: SupportedAPIsOptional APIs which need to be enabled explicitly.
OptionalsupportEmailAddress?: string | nullEmail address used to contact the support
Optionaltheme?: {Theme settings which will override the default application theme.
OptionalappBarColor?: stringApplication bar color of the theme as hex string.
Optionallogo?: string | nullLogo of the application.
OptionallogoBackgroundColor?: stringBackground color of the logo as hex/css color string.
OptionalprimaryColor?: stringPrimary color of the theme as hex string.
OptionaltextColor?: stringText color of the theme as hex string.
OptionalcalculationConfiguration for the project and item calculation.
OptionalimportForeignCalculationSupported?: booleanDefines if the current pricing procedure supports the import of a foreign calculation/pricing procedures.
OptionalpricingProcedure?: stringname of the pricing procedure to use for the project and item calculation
OptionalcatalogConfiguration for the catalog.
OptionalcustomCatalogs?: CustomCatalog[]Custom catalog registration
OptionalfavoriteCatalogs?: string[]Array of catalog ids used as the favorite catalogs. If defined the user will not be able to define its own favorites. The favorites will be fixed.
Optionaleaiws(Advanced integration only) EAIWS session configuration.
OptionalorderOrdering configuration.
Optionalprojectproject related configurations
OptionalapplySessionDefaults?: boolean | DefaultSessionSetting[]If 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.
OptionalbasketColumns?: BasketColumn[]The default columns shown in the item list.
OptionalclipboardData?: ClipboardDataOptional predefined clipboard data which can be used to fill the clipboard of the basket in advance.
OptionaleditorMode?: ProjectEditorModeThe editor mode defines the primary purpose of the project editor. If not defined Default
will be used.
OptionalimportForeignCalculation?: booleanIf true and the project was last edited using a different pricing procedure than the current default one,
the user will be asked if he wants to import the calculation.
Note: The option calculation.importForeignCalculationSupported also has to be true.
OptionallockedItems?: LockedItem[]Optional list of locked items which will be used to lock certain item related operations.
OptionalmetaData?: ProjectMetaDataOptional project related meta data which may be used by certain operations (e.g. ordering)
OptionalmigrateLegacyProjectData?: booleanIf true, legacy data (e.g. header or address data) will be loaded and migrated. Should be used when loading obk files of older applications.
OptionalopenCatalogForEmptyProjects?: booleanControls if the catalog should be opened automatically for empty/new projects.
OptionalselectedItems?: string[]List of item ids for items which should be initially selected.
Optionaltitle?: stringinitial title
OptionaltitleEditable?: booleanif true the title may be changed by the user
OptionalreportConfiguration for the reporting.
Optionalattachments?: { [template: string]: { appendUrls?: string[]; prependUrls?: string[] } }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.
OptionaldefaultTemplate?: stringName of the default template
OptionalfilterUserTemplates?: booleanIf true, reporting templates assigned to the current user will also be filtered by the
templates option. Otherwise, these templates will always be available.
OptionalshowAdoptReportButton?: booleanIf true, an Adopt Report button will be shown. The user can use this to inform the application,
that current report should be stored as the final report for the current quote. If clicked the adoptReport
property of the wbkHost.reportGenerated message will be true.
Optionaltemplates?: string[]Array of template names of report templates which should be available to the user.
Optionaluseruser related configurations
message parameter for
wbk.configuration