setSessionProperty
Synopsis
void setSessionProperty(SessionId sessionId, string name, string value)
throws SessionServiceFault;
See also: SessionId, SessionServiceFault
This operation is used to set session-specific properties that affect the operation of the Online Configurator. The name argument must be set to the property’s name, and the value argument to the property’s value, converted to a string if numeric.
Instead of a session ID the operation can also be invoked with a session context ID as their first argument (see also §newSessionContext). If so, the session ID stored in the session context will be used as the actual session ID. The properties will be changed for the whole session including all projects loaded in the session.
The following properties are supported:
egr.eai.ws.catalog.preferred_icon_size
Setting this property affects the size of icons returned by the catalog service. This property can also be set through the setPreferredIconSize operation of the CatalogService. For more information, see §setPreferredIconSize.
egr.eai.ws.basket.material_icon_format
Setting this property affects the format of material images returned by operations of the basket service. The value must be a possibly empty comma-separated list of file name extensions. White space around file name extensions is ignored. Each file name extension must consist of a dot, followed by a non-empty sequence of ASCII letter, digit or underscore.
For each material image to be returned, the basket web service will iterate over the list of extensions until it finds an image file using the current extension. If the list of extensions is empty, no material images will be returned.
In this version:
Changed default value of session property ‘egr.eai.ws.basket.material_icon_format’ from ‘.jpg’ to ‘.png,.svg,.jpg’.
egr.eai.basket.preserve_price_date
If set to true always preserve price date when reading a BSK/OBX file if it has been written by the same session, thus preserving the price date during copy/paste in the same session. It also ensures suspend/resume preserves the price date in case the default value of session property egr.eai.basket.preserve_price_date ever changes.
If set to false the price date is ignored, when articles read from OBK/BSK, or from OBX originating from another session.
A SessionServiceFault is returned if any of the following conditions occurs:
-
The
sessionIdparameter is not a valid string representation of an UUID or does not represent an open session. -
The property name is unknown.
-
The format of the property value is invalid (e.g. the value for a property of type integer cannot be parsed as an integer).
-
The property value is out of range or otherwise invalid.