Namespace chip.writeConfiguration
The namespace for the CHIP API's writeConfiguration contract which
allows you to write configuration parameters.
Defined in: configuration.js.
| Constructor Attributes | Constructor Name and Description |
|---|---|
| Method Attributes | Method Name and Description |
|---|---|
| <static> |
chip.writeConfiguration.setParameterValues(mConfigurationUpdates, fnSuccess, fnFailure)
Sets the values of the given configuration parameters and persists the updated chip
instance.
|
Method Detail
<static>
chip.writeConfiguration.setParameterValues(mConfigurationUpdates, fnSuccess, fnFailure)
Sets the values of the given configuration parameters and persists the updated chip
instance. All parameters that actually were defined in the CHIP definition XML are accepted.
All others will raise a warning to the log.
The CHIP has two properties:
The configuration is maintained as JSON string in a single property. This has the following consequences regarding the scopes:
- If the CHIP instance has never been persisted in the current scope, the configuration is inherited from lower scopes. If there are no changes either, the properties have their default values from the CHIP definition.
- When persisting the CHIP instance in a given scope for the first time (may it be due to configuration changes or title changes...), the configuration changes are merged with inherited changes from lower scopes and persisted in the current scope. Subsequent changes in lower scopes will then remain invisible.
- A property for which never an update was supplied has the default value from the CHIP
definition. This also applies if you delete the update again by setting it to
undefined.
The CHIP has two properties:
a with default value "foo" and b with
default value "bar". The administrator changes a to "baz" in scope CUST. Later
a user changes b in PERS. Then the administrator decides to change
a back to "foo", but our user will never see this again, because the system
persisted both a and b in PERS.
- Parameters:
-
{map
- The configuration updates. The values must be strings. You can however set a value to
undefined. This removes it from the list of updated properties and effectively resets it to the default value. - {function ()} fnSuccess Optional
- no-args success handler
- {function (string|[object])} fnFailure Optional
- error handler taking an error message and, since version 1.28.6, an optional object containing the complete error information as delivered by the ODataService. See fnFailure parameter of sap.ui2.srvc.ODataWrapper#onError for more details. The default error handler is provided by the page builder
- Since:
- 1.7.0