Skip to content
pCon.configurator onlineDocumentation
Esc
↑↓navigate↵open⌘Jpreview
On this page

Application-Specific Data

The client is able to attach application-specific data to the project, the basket, and individual basket items. This data is written to and read from project files by the saveSession (§saveSession) and loadSession (§loadSession) operations of the SessionService. The operations used to access this data are:

  • setProjectAppData (§setProjectAppData) and getProjectAppData (§getProjectAppData) of the SessionService for data attached to the project. This data is written to the metainf.xml project file member as child elements of the <appData> element.

  • setBasketAppData (§setBasketAppData) and getBasketAppData (§getBasketAppData) of the BasketService for data attached to the basket. This data is written to the 1.bsk project file member as child elements of the <appData> element that is a child of the <basket> element.

  • setItemAppData (§setItemAppData) and getItemAppData (§getItemAppData) of the BasketService for data attached to individual items. This data is written to the 1.bsk project file member as child elements of the <appData> element that is a child of the element representing the basket item. It is also part of the OBX stream that is used for cut/copy/paste and may be used by some export routines exporting commercial data (§getExportedGeometry, GFX export).

All operations that access application data have an argument of type string named appKey. This argument is intended to identify the application managing this particular kind of data. For each application key, the Online Configurator uses an <application> element as child of the <appData> element, with an attribute named key whose value is the specified application key. The <application> elements are created by operations that set the application data. Operations that get the application data do not create this (or any other) element.

Contents