wbk.configuration message parameter.

Hierarchy

  • WbkConfiguration

Properties

application?: {
    dataLanguage?: string[];
    disabledPluginCategories?: string[];
    disabledPlugins?: string[];
    doneButtonOptions?: ButtonOptions;
    featureSet?: FeatureSet;
    priceDateSupported?: boolean;
    showDoneButton?: boolean;
    showProjectSaveButton?: boolean;
    showUser?: boolean;
    theme?: {
        appBarColor?: string;
        logo?: null | string;
        logoBackgroundColor?: string;
        primaryColor?: string;
        textColor?: string;
    };
}

application related configurations

Type declaration

  • Optional dataLanguage?: string[]

    If 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 disabledPluginCategories?: string[]

    Optional list of plugins categories that will be disabled.

  • Optional disabledPlugins?: string[]

    Optional list of plugins (plugin names) that will be disabled.

  • Optional doneButtonOptions?: ButtonOptions

    Additional options for the done button.

  • Optional featureSet?: FeatureSet

    Predefined set of features that enable/disable certain application features and plugins. (default: Full)

  • Optional priceDateSupported?: boolean

    Enables/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 showDoneButton?: boolean

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

  • Optional showProjectSaveButton?: 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. (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 showUser?: boolean

    If true and user is defined the application will show the user information. (default: false)

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

    Theme settings which will override the default application theme.

    • Optional appBarColor?: string

      Application bar color of the theme as hex string. (default: #ffffff)

    • Optional logo?: null | string

      Logo of the application. (default: null)

    • Optional logoBackgroundColor?: string

      Background color of the logo as hex/css color string. (default: transparent)

    • Optional primaryColor?: string

      Primary color of the theme as hex string. (default: #0078d4)

    • Optional textColor?: string

      Text color of the theme as hex string. (default: #333333)

calculation?: {
    pricingProcedure?: string;
}

Configuration for the project and item calculation.

Type declaration

  • Optional pricingProcedure?: string

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

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

Configuration for the catalog.

Type declaration

  • Optional customCatalogs?: CustomCatalog[]

    Custom catalog registration

eaiws: {
    baseUrl: string;
    keepAliveInterval?: number;
    sessionId: string;
}

eaiws related configurations

Type declaration

  • baseUrl: string

    base url of the EAIWS server

  • Optional keepAliveInterval?: number

    interval for the session keep alive message in milliseconds, 0 disables keep alive (default: 60000)

  • sessionId: string

    id of the EAIWS session

order?: {
    reportTemplate: null | string;
}

Ordering configuration.

Type declaration

  • reportTemplate: null | string

    If defined a report using the specified template will be generated and attached to the order. (default: null)

project?: {
    applySessionDefaults?: boolean | DefaultSessionSetting[];
    editorMode?: ProjectEditorMode;
    lockedItems?: LockedItem[];
    metaData?: ProjectMetaData;
    migrateLegacyProjectData?: boolean;
    openCatalogForEmptyProjects: boolean;
    title?: string;
    titleEditable?: boolean;
}

project related configurations

Type declaration

  • Optional applySessionDefaults?: 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.

  • Optional editorMode?: ProjectEditorMode

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

  • Optional lockedItems?: LockedItem[]

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

  • Optional metaData?: ProjectMetaData

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

  • Optional migrateLegacyProjectData?: boolean

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

  • openCatalogForEmptyProjects: boolean

    Controls if the catalog should be opened automatically for empty/new projects. (default: false)

  • Optional title?: string

    initial title

  • Optional titleEditable?: boolean

    if true the title may be changed by the user

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

Configuration for the reporting.

Type declaration

  • Optional attachments?: {
        [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.

    • [template: string]: {
          appendUrls?: string[];
          prependUrls?: string[];
      }
      • Optional appendUrls?: string[]

        List of PDF urls which should be added at the end of the report.

      • Optional prependUrls?: string[]

        List of PDF urls which should be added in front of the report.

  • Optional defaultTemplate?: string

    Name of the default template

  • Optional templates?: string[]

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

user?: {
    accessToken?: string;
    accountUrl?: string;
    companyLogo?: string;
    fullName?: string;
    name: string;
    restrictions?: string[];
}

user related configurations

Type declaration

  • Optional accessToken?: string

    Optional 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 accountUrl?: string

    Optional url for user account management

  • Optional companyLogo?: string

    Optional url to the company logo.

  • Optional fullName?: string

    Optional full name of the user (e.g. first name + last name)

  • name: string

    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