Kontakt

Ansicht
Dokumentation

ABENCDS_F1_FUNCTION_ANNOTATIONS - CDS F1 FUNCTION ANNOTATIONS

ABENCDS_F1_FUNCTION_ANNOTATIONS - CDS F1 FUNCTION ANNOTATIONS

Addresses (Business Address Services)   ROGBILLS - Synchronize billing plans  
This documentation is copyright by SAP AG.
SAP E-Book

- DEFINE TABLE FUNCTION, function_annot

... @annotation ...

Effect

Specifies an annotation annotation in the definition of a CDS table function in front of the statement DEFINE TABLE FUNCTION as a function notation. The character @ must be placed in front of the name annotation of the annotation. The annotation should be defined as a CDS object in a CDS annotation definition and the annotation definition annotation @Scope should be specified here using the value #TABLE_FUNCTION.

Note

Alongside the function annotations shown here, the globally valid entity annotations can also be specified for a table function.

AbapCatalog Annotations

Technical settings of a CDS table function.
AbapCatalog.dataMaintenance,,Can be used to restrict data preview for a CDS table function,, #RESTRICTED:\lbr Display allowed with restrictions \lbr\lbr #DISPLAY_ONLY:\lbr Display only. Data preview is allowed \lbr\lbr #NOT_ALLOWED:\lbr Display not allowed \lbr\lbr ,, #RESTRICTED,,-

Notes

The annotation AbapCatalog.dataMaintenance defines whether the CDS table function can be displayed or maintained by certain tools such as Data Preview in ABAP Development Tools (ADT). The annotation is evaluated by these tools. Restrictions imposed by that annotation are user-independent and they are evaluated before accessing the data. Additional restrictions imposed by CDS roles are evaluated during the actual data access, if this is done by.



AccessControl Annotations

Defines access control for the CDS table function.
AccessControl.authorizationCheck,,Defines implicit access control when is used to access the CDS table function,,#CHECK:\lbr If is used to access the table function, access control is applied implicitly if a CDS role is assigned to the table function. If there is no role for the table function, a syntax check warning occurs. \lbr\lbr #NOT_REQUIRED:\lbr Like #CHECK, but there is no syntax check warning. \lbr\lbr#NOT_ALLOWED:\lbr No access control is performed. This produces a syntax check warning in the DCL source code of a role for the table function. \lbr\lbr#PRIVILEGED_ONLY:\lbr Privileged CDS association (evaluated by SADL).,, #CHECK,,#CHECK

Notes

  • The value #NOT_REQUIRED is recommended for CDS table functions not subject to access control when created, but for which roles can be defined later.
  • The value #NOT_ALLOWED disables implicit access control when the CDS table function is accessed in . The addition WITH PRIVILEGED ACCESS can be used in the FROM clause to disable access control for table functions not annotated with this annotation.
  • CDS access control does not work for client-independent access. This is why in , the addition USING and the obsolete addition CLIENT SPECIFIED can only be used when accessing CDS entities where access control is disabled. It is recommended that the annotation AccessControl.authorizationCheck:#NOT_ALLOWED is only specified for CDS table functions that are subject to client-independent access.

ClientDependent Annotations (Obsolete)

Obsolete control of client handling for the CDS table function.
ClientDependent,,Defines client handling when is used to access the CDS table function (obsolete).,, true:\lbr The CDS table function is client-dependent. When accessed using SELECT, implicit client handling is applied. \lbr\lbrfalse:\lbr The CDS table function is a client-independent table function. No implicit client handling is applied.,,-,,true

Notes

  • The obsolete annotation @ClientDependent is replaced by the annotation @ClientHandling.type.
  • The obsolete annotation @ClientDependent does not have a default value if it is not used. If neither of the annotations @ClientDependent or @ClientHandling.type are specified, the default values of the @ClientHandling annotation apply.
  • The obsolete annotation @ClientDependent cannot be specified together with the annotation @ClientHandling.type.

ClientHandling Annotations

Control of the client handling for the CDS table function.
ClientHandling.type,,Defines client handling when is used to access the CDS table function.,,#CLIENT_DEPENDENT:\lbr The CDS table function is client-dependent. When accessed using SELECT, implicit client handling is applied. \lbr\lbr#CLIENT_INDEPENDENT:\lbr The CDS table function is a client-independent function. No implicit client handling is applied.,,#CLIENT_DEPENDENT,,#CLIENT_DEPENDENT

Notes

  • Any other annotations specified using the main annotation ClientHandling and any other values than those shown here cannot be specified in the definition of a CDS table function.
  • An annotation @ClientHandling cannot be specified together with the obsolete annotation @ClientDependent.

DataAging Annotations

Defines data aging for the CDS table function.
DataAging.noAgingRestriction,,Defines how data aging is respected on a SAP HANA database when the CDS table function is accessed using . ,,true:\lbr reads all data \lbr\lbrfalse:\lbr reads current data only,,false,,true

ObjectModel Annotations

The following subannotations of ObjectModel characterize CDS table functions with respect to the data they deliver.
ObjectModel.usageType.dataClass,,Specifies the data category of the CDS view.,,A CDS table function can be assigned to one of the following data categories: \lbr\lbr#TRANSACTIONAL: \lbr The CDS table function delivers data written or modified in high volume transactions or in background transactions. \lbr\lbr#MASTER: \lbr The CDS table function delivers master data. The master data is read in high volume transactions or background transactions, but not written or modified. \lbr\lbr #ORGANIZATIONAL: \lbr The CDS table function delivers data that describes organizational structures and customer processes. \lbr\lbr#CUSTOMIZING: \lbr The CDS table function delivers data that describes customizing data. \lbr\lbr #META: \lbr The CDS table function delivers technical system configuration data or the structure of entities. \lbr\lbr#MIXED: \lbr The CDS table function delivers data of mixed data categories.,, #MIXED,,#MIXED
ObjectModel.usageType.serviceQuality,,The quality of the service with respect to the performance that can be expected by the consumer of the CDS table function.,,A CDS table function can be assigned to one of the following quality categories: \lbr\lbr #A: \lbr The CDS table function can be used for high volume transactions or for background transactions. \lbr\lbr#B: \lbr The CDS table function can be used for transactions or for background transactions. \lbr\lbr #C: \lbr The CDS table function can be used to query individual objects in transactions. \lbr\lbr #D: \lbr The CDS table function can be used for analytical queries. \lbr\lbr #X: \lbr The CDS table function is designed for special application cases, such as data migration. \lbr\lbr#P: \lbr The CDS table function is used to structure hierarchies of CDS entities and must not be used outside of such a hierarchy.,, #X,,#X
ObjectModel.usageType.sizeCategory,,Specifies the size of the data volume that must be scanned to return the result.,,A CDS table function can be assigned to one of the following size categories: \lbr\lbr#S: \lbr The expected size of the data volume that needs to be scanned is less than 1000. \lbr\lbr #M: \lbr The expected size of the data volume that needs to be scanned is less than 100,000. \lbr\lbr#L: \lbr The expected size of the data volume that needs to be scanned is less than 10,000,000. \lbr\lbr #XL: \lbr The expected size of the data volume that needs to be scanned is less than 100,000,000. \lbr\lbr#XXL: \lbr The expected size of the data volume that needs to be scanned is 100,000,000 or greater.,,#S,,#S

Notes

  • The above subannotations of ObjectModel can be used to document for which kind of application a table function is intended and which kind of data is expected. This information is especially important in regards of performance that can be expected by the consumer of the function. In contrast to the corresponding annotations for DEFINE VIEW ENTITY, however, no detailed rules for specifying values can be given for CDS table functions. It is up to the developer of a function to assess how it is annotated in regard of its performance-relevant properties.





General Material Data   CL_GUI_FRONTEND_SERVICES - Frontend Services  
This documentation is copyright by SAP AG.

Length: 18375 Date: 20240424 Time: 131516     sap01-206 ( 246 ms )