SAP Note

Header Data

Symptom

There are many different BAPIs for classification. There is no overview telling you which BAPI can be used for which purpose.

Other Terms

BAPIs for classification 1. Characteristics maintenance:

Component CA-CL-CHR, function group CTBP

1.1 Characteristics

BAPI_CHARACT_CREATE Create Characteristic Note 1479120 provides a more detailed description of the BAPI and it also contains sample code. BAPI_CHARACT_CHANGE Change Characteristic BAPI_CHARACT_RENAME Rename Characteristic BAPI_CHARACT_GETDETAIL Read Attributes for Characteristic This BAPI displays the attributes for a characteristic including the descriptions, values and value descriptions. Note 1098224 provides a more detailed description of the BAPI and it also contains sample code. BAPI_CHARACT_EXISTENCECHECK Check Existence for Characteristic This BAPI checks whether a characteristic exists. The system returns the result of the check as a message using the return table. BAPI_CHARACT_DELETE Delete Characteristic

1.2 Characteristic long texts

BAPI_CHARACT_ADDLONGTEXT Set Long Text for Characteristic or Value BAPI_CHARACT_GETLONGTEXT Read Long Text for Characteristic or Value Note 1326682 provides a more detailed description of the BAPI and it also contains sample code. BAPI_CHARACT_REMOVELONGTEXT Delete Long Text for Characteristics or Value

1.3 Where-used list and search

BAPI_CHARACT_GETWHEREUSEDLIST Where-Used List for the Characteristic in Classes BAPI_CHARACT_GETLIST Searching for characteristics This BAPI searches for characteristics according to the following criteria: name, characteristic, data type and date. Note 1560572 provides a more detailed description of the BAPI and it also contains sample code.

2. Class maintenance:

Component CA-CL-CLS, function group CLBP

2.1 Class

BAPI_CLASS_CREATE Create Class Note 1323945 provides a more detailed description of the BAPI and it also contains sample code. BAPI_CLASS_CHANGE Change Class Note 1235844 provides a more detailed description of the BAPI and it also contains sample code. BAPI_CLASS_GETDETAIL Read Class Information Note 1348172 provides a more detailed description of the BAPI and it also contains sample code. BAPI_CLASS_GETLIST Read Classes BAPI_CLASS_GET_CHARACTERISTICS Import Characteristics and Allowed Values for Class BAPI_CLASS_GETSTATUS Class: Status Information Note 1110901 provides a more detailed description of the BAPI and it also contains sample code. BAPI_CLASS_EXISTENCECHECK Class: Check Existence BAPI_CLASS_DELETE Delete Class

2.2 Search for classified objects

BAPI_CLASS_SELECT_OBJECTS Find Objects in Class

    1083986 - BAPIs for classification - Overview  

Version   22     Validity: 24.02.2011 - active   Language   English

Released On 24.02.2011 20:06:15

Release Status Released for Customer

Component CA-CL Classification

Priority Recommendations / Additional Info

Category Consulting

3. Classification:

Component CA-CL-CL, function group CLBPA

3.1 Classification using the object key according to transaction O12A

BAPI_OBJCL_CREATE Create Assignment Note 1348099 provides a more detailed description of the BAPI and it also contains sample code. BAPI_OBJCL_CHANGE Change Properties of Assignment BAPI_OBJCL_EXISTENCECHECK Check Existence of a Classification BAPI_OBJCL_GETSTATUS Determine Classification Status of Object The function module determines the classification status of an object. The classification status determines whether the allocation for the class search is released or locked. Note 1415487 provides a more detailed description of the BAPI and it also contains sample code. BAPI_OBJCL_GETCLASSES Determine class assignments for an object You can use this function module to read the class assignments for a classified object. You can also use this function module to display the value assignments that exist for this object. Unlike the BAPI BAPI_OBJCL_GETDETAIL, however, this BAPI displays all the value assignments for the class type and not only the class assignments for a certain class. However, this may have a negative effect on performance. You cannot use this BAPI to read the assignment of classes in class hierarchies. To do this, use the following BAPIs: BAPI_HIERA_GETSUBSTRUCTURE, BAPI_HIERA_GETSUPERSTRUCTURE, BAPI_HIERA_GETSUBCLASSALLOCS and BAPI_HIERA_GETSUPERCLASSALLOCS. Note 1083982 provides a more detailed description of the BAPI and it also contains sample code. BAPI_OBJCL_GETOBJECTS Determine object assignment for a class BAPI_OBJCL_GETDETAIL Read Classification Information on Object You can use this function module to read the value assignments of an object in a class. You cannot use this BAPI to read classifications of classes in a class hierarchy. To do this, use BAPI BAPI_HIERA_GETDETAILSUBCLASS. Note 1083983 provides a more detailed description of the BAPI and it also contains sample code. BAPI_OBJCL_DELETE Delete Assignment The BAPI deletes the assignments of objects and their value assignments, but not from the database (yet). Note 1561620 provides a more detailed description of the BAPI and it also contains sample code.

3.2 Create and split object key

BAPI_OBJCL_CONCATENATEKEY Generate Concatenated Key This BAPI creates the object key for a classified object. Note 1083984 provides a more detailed description of the BAPI and it also contains sample code. BAPI_OBJCL_SPLITKEY Decomposition of Concatenated Key This BAPI determines the key fields from the object key. Note 1083984 provides a more detailed description of the BAPI and it also contains sample code. If the indicator "Multiple Objects Allowed" (TCLA-MULTOBJ) is set in Customizing of the class types in transaction O1CL, the classified objects are identified using an internal key (table INOB). If such an internal key exists and is known or is to be used, you can also use the following function modules:

3.3 Classification using the internal key

BAPI_OBJCL_CREATE_KEY Create Assignment Note 1348102 provides a more detailed description of the BAPI and it also contains sample code. BAPI_OBJCL_CHANGE_KEY Change Properties of Assignment BAPI_OBJCL_EXISTENCECHECK_KEY Check Existence of a Classification BAPI_OBJCL_GETSTATUS_KEY Classification Status for Object BAPI_OBJCL_GETCLASSES_KEY Classes for Object BAPI_OBJCL_GETOBJECTS_KEY Find Assignment BAPI_OBJCL_GETDETAIL_KEY Read Classification Information BAPI_OBJCL_DELETE_KEY Delete Assignment

3.4 Create and split internal key

BAPI_OBJCL_CONCATENATEKEY_KEY Generate concatenated key BAPI_OBJCL_SPLITKEY_KEY Decomposition of Concatenated Key You can convert the object key into an internal key and the other way around: 3.5 Conversion between object key and internal key BAPI_OBJCL_GET_KEY_OF_OBJECT Key of Object BAPI_OBJCL_GET_OBJECT_OF_KEY Object for Key

4. Class hierarchy:

Component CA-CL-CL, function group CLBPH

4.1 Assignments

BAPI_HIERA_ADDSUBCLASS Create Assignment Note 1486565 provides a more detailed description of the BAPI and it also contains sample code. BAPI_HIERA_CHANGESUBCLASS Change Assignment BAPI_HIERA_GETDETAILSUBCLASS Assignment Information BAPI_HIERA_CHECKSUBCLASSALLOC Check Existence BAPI_HIERA_REMOVESUBCLASS Delete Assignment

4.2 Class hierarchy top-down

BAPI_HIERA_ADDSUBSTRUCTURE Create Hierarchy (Top Down) Note 1350546 provides a more detailed description of the BAPI and it also contains sample code. BAPI_HIERA_CHANGESUBSTRUCTURE Change Hierarchy (Top Down) Note 1359324 provides a more detailed description of the BAPI and it also contains sample code. BAPI_HIERA_GETSUBSTRUCTURE Read Hierarchy (Top Down) This BAPI reads the assignments of classes in the class hierarchy top-down. BAPI_HIERA_GETSUBCLASSALLOCS

(Directly) Subordinate Classes This BAPI reads only the direct assignments of classes in the class hierarchy top-down. BAPI_HIERA_REMOVESUBSTRUCTURE Delete Hierarchy (Top Down)

4.3 Class hierarchy bottom-up

BAPI_HIERA_GETSUPERSTRUCTURE Read Hierarchy (Bottom Up) It reads the upward assignment of classes in the class hierarchy. See Note 1555448 for a more detailed description of the BAPI with sample code. BAPI_HIERA_GETSUPERCLASSALLOCS (Directly) Superior Classes This BAPI reads only the direct assignments of classes in the class hierarchy bottom-up. Note 1555450 provides a more detailed description of the BAPI and it also contains sample code.

Validity

This document is not restricted to a software component or software component version

References

This document refers to:

SAP Notes

This document is referenced by:

SAP Notes (24)

1083982   BAPI_OBJCL_GETCLASSES: Instructions

1083983   BAPI_OBJCL_GETDETAIL: Instructions

1083984   BAPI_OBJCL_CONCATENATEKEY and BAPI_OBJCL_SPLITKEY: Condition

1098224   BAPI_CHARACT_GETDETAIL: instructions

1110901   BAPI_CLASS_GETSTATUS: instructions for use

1235844   BAPI_CLASS_CHANGE: Operating instructions

1270937   BAPI_CLASS_CHANGE, change for only some characteristics

1307965   BAPI_CLASS_CHANGE: Changing KLAH-LEIST

1320373   BAPI_CLASS_CREATE does not transfer the VALUE_HIGH value

1323945   BAPI_CLASS_CREATE: Instructions for use

1326682   BAPI_CHARACT_GETLONGTEXT: Instructions for use

1338804   LANGU_ISO of BAPI_CLASS_GET_DETAIL is not used

1348099   BAPI_OBJCL_CREATE: Operating instructions

1348102   BAPI_OBJCL_CREATE_KEY: User instructions

1348172   BAPI_CLASS_GETDETAIL: Operating instructions

1350410   BAPI_HIERA_CHANGESUBSTRUCTURE does not change

1350546   BAPI_HIERA_ADDSUBSTRUCTURE: Operating instructions

1359324   BAPI_HIERA_CHANGESUBSTRUCTURE: operating instructions

1479120   BAPI_CHARACT_CREATE: Operating instructions

1486565   BAPI_HIERA_ADDSUBCLASS: User instructions

1555448   BAPI_HIERA_GETSUPERSTRUCTURE: Operating instructions

1555450   BAPI_HIERA_GETSUPERCLASSALLOCS: Operating instructions

1560572   BAPI_CHARACT_GETLIST: Operating instructions

1561620   Operating instructions for BAPI_OBJCL_DELETE

1320373   BAPI_CLASS_CREATE does not transfer the VALUE_HIGH value

1323945   BAPI_CLASS_CREATE: Instructions for use

1326682   BAPI_CHARACT_GETLONGTEXT: Instructions for use

1581535   Features of class type 026

1338804   LANGU_ISO of BAPI_CLASS_GET_DETAIL is not used

1348099   BAPI_OBJCL_CREATE: Operating instructions

1348102   BAPI_OBJCL_CREATE_KEY: User instructions

1348172   BAPI_CLASS_GETDETAIL: Operating instructions

1555448   BAPI_HIERA_GETSUPERSTRUCTURE: Operating instructions

1555450   BAPI_HIERA_GETSUPERCLASSALLOCS: Operating instructions

1560572   BAPI_CHARACT_GETLIST: Operating instructions

1561620   Operating instructions for BAPI_OBJCL_DELETE

1307965   BAPI_CLASS_CHANGE: Changing KLAH-LEIST

1479120   BAPI_CHARACT_CREATE: Operating instructions

1350410   BAPI_HIERA_CHANGESUBSTRUCTURE does not change

1350546   BAPI_HIERA_ADDSUBSTRUCTURE: Operating instructions

1486565   BAPI_HIERA_ADDSUBCLASS: User instructions

1235844   BAPI_CLASS_CHANGE: Operating instructions

1359324   BAPI_HIERA_CHANGESUBSTRUCTURE: operating instructions

1083982   BAPI_OBJCL_GETCLASSES: Instructions

1083983   BAPI_OBJCL_GETDETAIL: Instructions

1083984   BAPI_OBJCL_CONCATENATEKEY and BAPI_OBJCL_SPLITKEY: Condition

1098224   BAPI_CHARACT_GETDETAIL: instructions

1110901   BAPI_CLASS_GETSTATUS: instructions for use