pCon.basket - Integration
    Preparing search index...

    Interface WbkConfiguration

    message parameter for wbk.configuration

    interface WbkConfiguration {
        application?: {
            contactSupportUrl?: string | null;
            customActions?: CustomActions;
            dataLanguage?: string[];
            disabledPluginCategories?: string[];
            disabledPlugins?: string[];
            doneButtonOptions?: ButtonOptions;
            errorReportEmailAddress?: string;
            featureSet?: FeatureSet;
            inputFieldCharacterLimits?: Partial<Record<InputField, number>>;
            priceDateSupported?: boolean;
            showDoneButton?: boolean;
            showProjectSaveButton?: boolean;
            showUser?: boolean;
            supportedAPIs?: SupportedAPIs;
            supportEmailAddress?: string | null;
            theme?: {
                appBarColor?: string;
                logo?: string | null;
                logoBackgroundColor?: string;
                primaryColor?: string;
                textColor?: string;
            };
        };
        calculation?: {
            importForeignCalculationSupported?: boolean;
            pricingProcedure?: string;
        };
        catalog?: { customCatalogs?: CustomCatalog[]; favoriteCatalogs?: string[] };
        eaiws?: EaiwsConfig;
        order?: { reportTemplate: string | null };
        project?: {
            applySessionDefaults?: boolean | DefaultSessionSetting[];
            basketColumns?: BasketColumn[];
            clipboardData?: ClipboardData;
            editorMode?: ProjectEditorMode;
            importForeignCalculation?: boolean;
            lockedItems?: LockedItem[];
            metaData?: ProjectMetaData;
            migrateLegacyProjectData?: boolean;
            openCatalogForEmptyProjects?: boolean;
            selectedItems?: string[];
            title?: string;
            titleEditable?: boolean;
        };
        report?: {
            attachments?: {
                [template: string]: { appendUrls?: string[]; prependUrls?: string[] };
            };
            defaultTemplate?: string;
            filterUserTemplates?: boolean;
            showAdoptReportButton?: boolean;
            templates?: string[];
        };
        user?: UserConfig;
    }
    Index
    application?: {
        contactSupportUrl?: string | null;
        customActions?: CustomActions;
        dataLanguage?: string[];
        disabledPluginCategories?: string[];
        disabledPlugins?: string[];
        doneButtonOptions?: ButtonOptions;
        errorReportEmailAddress?: string;
        featureSet?: FeatureSet;
        inputFieldCharacterLimits?: Partial<Record<InputField, number>>;
        priceDateSupported?: boolean;
        showDoneButton?: boolean;
        showProjectSaveButton?: boolean;
        showUser?: boolean;
        supportedAPIs?: SupportedAPIs;
        supportEmailAddress?: string | null;
        theme?: {
            appBarColor?: string;
            logo?: string | null;
            logoBackgroundColor?: string;
            primaryColor?: string;
            textColor?: string;
        };
    }

    application related configurations

    Type Declaration

    • OptionalcontactSupportUrl?: string | null

      Url to the Contact Support document/form of the application.

      null
      
    • OptionalcustomActions?: CustomActions

      Can 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?: ButtonOptions

      Additional options for the done button.

    • OptionalerrorReportEmailAddress?: string

      Email address used for error reporting

    • OptionalfeatureSet?: FeatureSet

      Predefined set of features that enable/disable certain application features and plugins.

      'Full'
      
    • OptionalinputFieldCharacterLimits?: Partial<Record<InputField, number>>

      Custom character limit definition for input fields.

    • OptionalpriceDateSupported?: boolean

      Enables/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.

      false
      
    • OptionalshowDoneButton?: boolean

      If true the application will show a Done button which can be used from the user to finish the integration.

      true
      
    • OptionalshowProjectSaveButton?: boolean

      If 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.

      false
      
    • OptionalshowUser?: boolean

      If true and user is defined the application will show the user information.

      false
      
    • OptionalsupportedAPIs?: SupportedAPIs

      Optional APIs which need to be enabled explicitly.

    • OptionalsupportEmailAddress?: string | null

      Email address used to contact the support

      null
      
    • Optionaltheme?: {
          appBarColor?: string;
          logo?: string | null;
          logoBackgroundColor?: string;
          primaryColor?: string;
          textColor?: string;
      }

      Theme settings which will override the default application theme.

      • OptionalappBarColor?: string

        Application bar color of the theme as hex string.

        '#ffffff'
        
      • Optionallogo?: string | null

        Logo of the application.

        null
        
      • OptionallogoBackgroundColor?: string

        Background color of the logo as hex/css color string.

        'transparent'
        
      • OptionalprimaryColor?: string

        Primary color of the theme as hex string.

        '#0078d4'
        
      • OptionaltextColor?: string

        Text color of the theme as hex string.

        '#333333'
        
    calculation?: {
        importForeignCalculationSupported?: boolean;
        pricingProcedure?: string;
    }

    Configuration for the project and item calculation.

    Type Declaration

    • OptionalimportForeignCalculationSupported?: boolean

      Defines if the current pricing procedure supports the import of a foreign calculation/pricing procedures.

      false
      
    • OptionalpricingProcedure?: string

      name of the pricing procedure to use for the project and item calculation

    catalog?: { customCatalogs?: CustomCatalog[]; favoriteCatalogs?: string[] }

    Configuration for the catalog.

    Type Declaration

    • 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.

    eaiws?: EaiwsConfig

    (Advanced integration only) EAIWS session configuration.

    order?: { reportTemplate: string | null }

    Ordering configuration.

    Type Declaration

    • reportTemplate: string | null

      If defined a report using the specified template will be generated and attached to the order.

      null
      
    project?: {
        applySessionDefaults?: boolean | DefaultSessionSetting[];
        basketColumns?: BasketColumn[];
        clipboardData?: ClipboardData;
        editorMode?: ProjectEditorMode;
        importForeignCalculation?: boolean;
        lockedItems?: LockedItem[];
        metaData?: ProjectMetaData;
        migrateLegacyProjectData?: boolean;
        openCatalogForEmptyProjects?: boolean;
        selectedItems?: string[];
        title?: string;
        titleEditable?: boolean;
    }

    project related configurations

    Type Declaration

    • 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.

      ["Image"]
      
    • OptionalclipboardData?: ClipboardData

      Optional predefined clipboard data which can be used to fill the clipboard of the basket in advance.

    • OptionaleditorMode?: ProjectEditorMode

      The editor mode defines the primary purpose of the project editor. If not defined Default will be used.

    • OptionalimportForeignCalculation?: boolean

      If 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.

      false
      
    • OptionallockedItems?: LockedItem[]

      Optional list of locked items which will be used to lock certain item related operations.

    • OptionalmetaData?: ProjectMetaData

      Optional project related meta data which may be used by certain operations (e.g. ordering)

    • OptionalmigrateLegacyProjectData?: boolean

      If true, legacy data (e.g. header or address data) will be loaded and migrated. Should be used when loading obk files of older applications.

      false
      
    • OptionalopenCatalogForEmptyProjects?: boolean

      Controls if the catalog should be opened automatically for empty/new projects.

      false
      
    • OptionalselectedItems?: string[]

      List of item ids for items which should be initially selected.

    • Optionaltitle?: string

      initial title

    • OptionaltitleEditable?: boolean

      if true the title may be changed by the user

    report?: {
        attachments?: {
            [template: string]: { appendUrls?: string[]; prependUrls?: string[] };
        };
        defaultTemplate?: string;
        filterUserTemplates?: boolean;
        showAdoptReportButton?: boolean;
        templates?: string[];
    }

    Configuration for the reporting.

    Type Declaration

    • 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?: string

      Name of the default template

    • OptionalfilterUserTemplates?: boolean

      If true, reporting templates assigned to the current user will also be filtered by the templates option. Otherwise, these templates will always be available.

      false
      
    • OptionalshowAdoptReportButton?: boolean

      If 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.

      false
      
    • Optionaltemplates?: string[]

      Array of template names of report templates which should be available to the user.

    user?: UserConfig

    user related configurations