namespace sap.ui.fl.write.api.SmartBusinessWriteAPI

Visiblity: restricted
Available since: N/A
Module: sap/ui/fl/write/api/SmartBusinessWriteAPI
Application Component: CA-UI5-FL

Provides an API for tools to create, update, delete app variants only for ABAP systems.


Nodes Overview

Node Description

Methods Overview

Method Description
sap.ui.fl.write.api.SmartBusinessWriteAPI.add

Adds a descriptor inline change to the flex persistence.

sap.ui.fl.write.api.SmartBusinessWriteAPI.create

Creates and saves the app variant in backend.

sap.ui.fl.write.api.SmartBusinessWriteAPI.createDescriptorInlineChanges

Creates a descriptor inline change content.

sap.ui.fl.write.api.SmartBusinessWriteAPI.getDesignTimeVariant

Returns the design time representation of the app variant.

sap.ui.fl.write.api.SmartBusinessWriteAPI.getRunTimeVariant

Returns the run time representation of the app variant.

sap.ui.fl.write.api.SmartBusinessWriteAPI.remove

Deletes the app variant from the backend.

sap.ui.fl.write.api.SmartBusinessWriteAPI.update

Updates the app variants in the back end.

sap.ui.fl.write.api.SmartBusinessWriteAPI.add

Adds a descriptor inline change to the flex persistence.

Param Type DefaultValue Description
mPropertyBag object

Object with parameters as properties

appId string

Reference app ID or an app variant ID

change sap.ui.fl.Change

Change instance

sap.ui.fl.write.api.SmartBusinessWriteAPI.create

Creates and saves the app variant in backend.

Param Type DefaultValue Description
mPropertyBag object

Object with parameters as properties

selector sap.ui.fl.Selector

Selector

appId string

ID of the reference application

id string

App variant ID

layer sap.ui.fl.Layer

Current working layer

transport string

Transport request for the app variant; Transport is required for onPremise systems until the app variant is not intended to be saved as a local object; Transport is not required for S4/Hana Cloud systems

package string

Package info for the app variant; Package is required if the app variant is intended for VENDOR or CUSTOMER_BASE layer in onPremise systems; Package could be filled with $TMP if the app variant is intended to be saved as a local object

version string

Version of the app variant

sap.ui.fl.write.api.SmartBusinessWriteAPI.createDescriptorInlineChanges

Creates a descriptor inline change content.

Param Type DefaultValue Description
mPropertyBag object

Object with parameters as properties

appId string

Reference app ID or an app variant ID

changeSpecificData object

Property bag holding the change information, see sap.ui.fl.Change#createInitialFileContent The property mPropertyBag.changeSpecificData.packageName is set to $TMP and internally since flex changes are always local when they are created.

sap.ui.fl.write.api.SmartBusinessWriteAPI.getDesignTimeVariant

Returns the design time representation of the app variant.

Param Type DefaultValue Description
mPropertyBag object

Object with parameters as properties

id string

App variant ID

sap.ui.fl.write.api.SmartBusinessWriteAPI.getRunTimeVariant

Returns the run time representation of the app variant.

Param Type DefaultValue Description
mPropertyBag object

Object with parameters as properties

appId string

ID of the reference application

id string

App variant ID

sap.ui.fl.write.api.SmartBusinessWriteAPI.remove

Deletes the app variant from the backend.

Param Type DefaultValue Description
mPropertyBag object

Object with parameters as properties

appId string

App Variant ID

transport string

Transport request for the app variant; Transport is required for onPremise systems until the app variant is not intended to be updated as a local object; Transport is not required for S4/Hana Cloud systems

sap.ui.fl.write.api.SmartBusinessWriteAPI.update

Updates the app variants in the back end.

Param Type DefaultValue Description
mPropertyBag object

Object with parameters as properties

appId string

App variant ID

transport string

Transport request for the app variant; Transport is required for onPremise systems until the app variant is not intended to be updated as a local object; Transport is not required for S4/Hana Cloud systems