Variant Configuration Settings
The host application configures the Variant Configuration UI (VC UI) through the AppSettings.VC object in the initial context sent to Cloud UI. These settings control what users see and which actions are available during a configuration session.
All settings are optional. When a setting is not provided, the default behavior described below applies.
Related: Variant Configuration UI · Applications overview
Where Settings Are Applied
Provide AppSettings.VC in the initial context from the host application.
When VC UI opens from another Cloud UI experience that embeds Variant Configuration, the same AppSettings.VC object controls the configuration session.
Display and Interaction
ForceReadOnly
Type: boolean
Default: false
When set to true, all characteristic inputs are display-only. Users can review the configuration but cannot change any values, even when SAP would otherwise allow editing.
| Value | Behavior |
|---|---|
true | All inputs are read-only. |
false (default) | Each input follows the normal SAP rules for that characteristic. |
Use true to show an existing configuration — for example, on a confirmed order or a locked quote line — when the user should review but not modify it.
DisplayQuantity
Type: boolean
Default: false
Controls whether the order quantity field appears in the navigation bar.
| Value | Behavior |
|---|---|
true | The order quantity field is shown. |
false (default) | The order quantity field is hidden. |
AllowQuantityEdit
Type: boolean
Default: false
Controls whether the user can edit the order quantity. This setting only takes effect when DisplayQuantity is also enabled. Quantity editing is disabled when the configuration is read-only.
| Value | Behavior |
|---|---|
true | The user can edit the order quantity. |
false (default) | The order quantity field is displayed as read-only. |
DisplayShowPrices
Type: boolean
Default: false
Controls whether pricing controls and pricing information appear in the configuration summary when the configuration is complete.
| Value | Behavior |
|---|---|
true | Pricing controls and summary pricing information are shown. |
false (default) | Pricing controls and summary pricing information are hidden. |
DefaultShowPrices
Type: boolean
Default: false
Controls whether pricing is turned on by default in the summary panel.
| Value | Behavior |
|---|---|
true | Pricing is enabled by default in the summary panel. |
false (default) | Pricing is disabled by default; the user must enable it manually. |
Use true together with DisplayShowPrices when you want users to see pricing without enabling it manually.
DefaultSummaryExpanded
Type: boolean
Default: false
Controls whether the summary panel is expanded when the configuration session starts.
| Value | Behavior |
|---|---|
true | The summary panel opens expanded. |
false (default) | The summary panel opens collapsed. |
DisplayVcValueWithDescription
Type: boolean
Default: false
Controls how characteristic values are displayed in selection controls.
| Value | Behavior |
|---|---|
true | Each value is shown together with its description. |
false (default) | Each value is shown with its description alone as the default display. |
DisplayVcTemplate
Type: boolean
Default: false
Controls whether the template manager is available to users.
| Value | Behavior |
|---|---|
true | The template manager is shown, allowing users to save, load, import, and export configurations. |
false (default) | The template manager is hidden. |
The template manager is always hidden in read-only mode, regardless of this setting.
DisplayVcLog
Type: boolean
Default: false
Controls whether users can report an issue from the configuration screen.
| Value | Behavior |
|---|---|
true | The issue reporting option is shown. |
false (default) | The issue reporting option is hidden. |
Finalize and Reset Behavior
ResetToInitialValues
Type: boolean
Default: false
Controls what happens when the user clicks Reset.
| Value | Behavior |
|---|---|
true | Restores the configuration to the values present when the session started (the initial values returned by SAP during initialization). |
false (default) | Clears the configuration and starts a fresh session with no selections. |
Use true when users should return to a known starting point — for example, a pre-configured product passed in from the host. Use false (or omit the setting) when Reset should return to a blank configuration.
IsIncompleteAllowed
Type: boolean
Default: false
Controls whether users can finalize an incomplete or invalid configuration.
| Value | Behavior |
|---|---|
true | Users can finalize even if the configuration is incomplete or invalid. The finalize button label reflects this. |
false (default) | Users can finalize only when the configuration is valid and complete. |
HasNextStep
Type: boolean
Default: false
Controls how the finalize action is labeled.
| Value | Behavior |
|---|---|
true | The finalize action is labeled as a next step. |
false (default) | The finalize action is labeled as a final complete action. |
Use true when VC UI is one step in a larger host workflow.
Characteristic Input Behavior
IgnoreSingleAllowedWithAdditionalValues
Type: boolean
Default: false
Controls how a characteristic is displayed when it allows only one selectable value and also allows additional free-form values.
| Value | Behavior |
|---|---|
true | The characteristic is shown as a text input. |
false (default) | The characteristic is shown as a single-select control. |
BypassInvalidationLogic
Type: boolean
Default: false
Controls whether VC UI clears inconsistent or invalid values before asking SAP to reprocess the configuration.
| Value | Behavior |
|---|---|
true | Inconsistent or invalid values are kept and sent as-is when SAP reprocesses the configuration. |
false (default) | Inconsistent or invalid values are cleared before SAP reprocesses the configuration. |
Leave this set to false unless your process specifically requires keeping those values during reprocessing.
Messaging and Logging
AutoLogVCErrors
Type: boolean
Default: false
Controls whether VC UI automatically reports qualifying SAP error messages to the host application during configuration processing.
| Value | Behavior |
|---|---|
true | Qualifying SAP error messages are automatically reported to the host application. |
false (default) | SAP error messages are not automatically reported. |
VCMsgNumbersToIgnoreForAutoLog
Type: string[]
Default: none
List of SAP message numbers to exclude from automatic error reporting when AutoLogVCErrors is enabled.
| Value | Behavior |
|---|---|
| Not provided | All qualifying SAP error messages are eligible for auto-reporting. |
| List of numbers | Messages whose numbers appear in the list are excluded from reporting. |