SaveSessionOptions
Synopsis
struct SaveSessionOptions {
string* suffix;
boolean* overwrite;
boolean generateImages,
boolean omitPriceData,
boolean* saveCalculations;
boolean* saveLegacyCalculation;
string* legacyCalculationName;
boolean export;
string[] omittedCalculations;
}
The complex type SaveSessionOptions contains optional elements representing options that control the behavior of the saveSession (§saveSession) operation.
If the suffix option is not specified, the operation uses “.obk” as the suffix of the project file. If the client sets the suffix option to an empty string, then no suffix is appended to the project file name. Otherwise, the Online Configurator checks whether the suffix starts with a dot, prepending one if it does not, and appends the resulting suffix to the project file name.
The optional element saveCalculations controls whether or not (normal) calculation data is saved. Default value is true.
The optional element saveLegacyCalculation controls whether or not legacy calculation data (used by pCon.basket) is saved. Default value is false. The optional element legacyCalculationName explicitly specifies the pricing procedure name of the calculation to use for legacy calculation data. Default value is the empty string. Ignored if saveLegacyCalculation is false.
If access to the file is allowed, and the file already exists, the operation fails unless the overwrite option has been set to true.
export: prevents, when set to true, the project’s URI set to be updated to reflect the location where the project has been saved to. (The default value of this option is false.)
The value of omittedCalculations is the set of names of calculations to be omitted from the saved BSK/OBK file. The name of the default calculation is not written to the BSK/OBK file if the default calculation is contained in the set of omitted calculations. Operation saveSession fails if the set of omitted calculations is not a (possibly empty) subset of the calculations currently added to the basket.