Learn how to use the scoping API.
Scoping is a mechanism that determines the visibility of certain development object types at configuration time. Depending on your decisions, some object types may be hidden or displayed in the current client.
For instance, in the Business Roles app, not all business catalogs shall be available for the administrator user, because their usage is subject to additional license constraints.
To scope the relevant objects, you can use the API IF_APS_BC_SCOPE_CHANGE_API. The interface provides mass-enabled methods for setting the scope state of scoping-enabled TADIR objects in the current client.
The objects to be scoped must be in the same software component as the caller.
The following TADIR types are supported:
List of TADIR Objects That Can Be Scoped
|
Constant |
|
|---|---|
|
|
Cloud Management Health Check |
|
|
ESH: CDS Search Model |
|
|
Technical Job Definition |
|
|
Predefined Field: Extensible Node |
|
|
Application Job Catalog Entry |
|
|
Communication Scenario |
|
|
Business Catalog |
|
|
IAM App |
|
|
Business Role Template |
|
|
Fiori Launchpad Space Template |
|
|
Fiori Launchpad Page Template |
To scope one of these objects, you have to provide the object type, object name, and the desired scoping state (ON or OFF).
Objects that are set to scoping state
ONshould not be set toOFF. The object must remain available to the customer to guarantee further access to the data maintained via the object.
For further information, see the long text documentation of the API IF_APS_BC_SCOPE_CHANGE_API.