Sapass

 Simplify SAP R/3 development with Excel VBA/VB RFC  
Home> Bapi>ObjectClassification



Index

ObjectClassification

ObjectClassification


Business object Classification describes the assignment of
objects, such as materials, batches, or documents, to classes (business object 1003).


Values that correspond to the properties of the object being classified
are assigned to the characteristics (business object 1088) of the class.


The key of the classification comprises the key of the class (ClassNum
and ClassType) and the key of the classified object (ObjektKey and ObjektTable).


Due to technical problems, this model cannot be displayed here. The key
is only the key of of the class (ClassNum and ClassType), but the key
of the object to be classified is a required import parameter in the
interface. For this reason, this business object and its methods are
not released. As soon as possible, the key will be created correctly.
Then the interfaces will look different and instances will be handled
differently. The contents of the interfaces will remain the same.


11-Dec-2005


Methods

Available Methods


  • Change : Classification BAPI: Change Properties of Assignment (GUID) [ BAPI_OBJCL_CHANGE_KEY ]
  • ConcatenateKey : Concatenate Key [ BAPI_OBJCL_CONCATENATEKEY_KEY ]
  • Create : Classification BAPI: Create Assignment (GUID) [ BAPI_OBJCL_CREATE_KEY ]
  • Delete : Classification BAPI: Delete Assignment (GUID) [ BAPI_OBJCL_DELETE_KEY ]
  • ExistenceCheck : Check Existence of Object [ BAPI_OBJCL_EXISTENCECHECK_KEY ]
  • GetClasses : Classes for Object (Key) [ BAPI_OBJCL_GETCLASSES_KEY ]
  • GetDetail : Classification BAPI: Read Classification Information (GUID) [ BAPI_OBJCL_GETDETAIL_KEY ]
  • GetKeyOfObject : Key for Object [ BAPI_OBJCL_GET_KEY_OF_OBJECT ]
  • GetObjectOfKey : Object for Key [ BAPI_OBJCL_GET_OBJECT_OF_KEY ]
  • GetObjects : Find by Assignments (Key) [ BAPI_OBJCL_GETOBJECTS_KEY ]
  • GetStatus : Classification Status for Object (Key) [ BAPI_OBJCL_GETSTATUS_KEY ]
  • SplitKey : Decomposition of Concatenated Key [ BAPI_OBJCL_SPLITKEY_KEY ]

11-Dec-2005


Change

Change


This BAPI changes an existing classification, or creates it if it doesnot yet exist. The classification is defined by the required inputfields object key (ObjectKey) and class name (AllocDetail-ClassNum).The default value for optional parameter date (KeyDate) is the system
date, on which all classifications are valid. The new characteristicsand/or values are transferred in different tables according to type.Numeric, time, and date characteristics are transferred in table AllocValuesNumNew, character and boolean characteristics in table
AllocValuesCharNew, and currency characteristics in table AllocValuesCurrNew.

Notes

The object key ObjctKey can be generated from key fields object, object table, and class type, by using BAPIObjectClassification.GetKeyOfObject

If these fields are defined and only one function module is to be used,
used function module BAPI_OBJCL_CHANGE. This skips conversion to the object key.

Results

If the BAPI runs successfully, table Return contains no messages of type 'E'.

Assignment was created: Message CL735

Assignment was changed: Message CL737


Assignment was not changed: Message CL738

Caution

This BAPI only changes the parameters of an existing assignment (orcreates a whole new assignment), but does not delete the assignment toa class and replace it with an assignment to another class. If you want to reassign an object, the old assignments must be read by
BAPI_OBJCL_GETCLASSES and deleted by BAPI_OBJCL_DELETE. Then you create the new assignments with BAPI_OBJCL_CREATE.

The information transferred in this BAPI replaces the old informationcompletely. An empty field means "delete entry", not "no change".


This BAPI does not change the database. To do this, BAPI BapiService.TransactionCommit must be called afterward.

You can only use this BAPI for objects that are not classes.

This BAPI only processes assigned values for classification, not for configuration.


11-Dec-2005


ConcatenateKey

ConcatenateKey


This BAPI generates the concatenated object key from the individual key fields and contents of the object table.

If the BAPI runs successfully, table RETURN contains no messages of type 'E', and export field ObjectKey_Conc contains an entry.

Notes


The object key ObjctKey can be decomposed into the key fields object, object table, and class type by BAPIObjectClassification.GetObjectOfKey.

If these fields are relevant and only one function module is to beused, use function module BAPI_OBJCL_CONCATENATEKEY. This skips the conversion from the object key.


11-Dec-2005


Create

Create


This BAPI creates a classification with assigned values, if it does notyet exist. The classification is defined by the required fields object key (ObjectKey) and class name (AllocDetail-Class_Num). Thecharacteristics and their values are transferred in different tables,
according to type. Numeric, time, and date characteristics are transferred in table AllocValuesNum, character and booleancharacteristics in table AllocValuesChar, and currency characteristics in table AllocValuesCurr.

If the BAPI runs successfully, table RETURN contains no messages of type 'E'.


Notes

The object key ObjctKey can be generated from the key fields object, object table, and class type by BAPIObjectClassification.GetKeyOfObject.

If these fields are defined and only one function module is to be used,use function module BAPI_OBJCL_CREATE. This skips the conversion to the object key.


Caution

This BAPI does not change the database. To do this, BAPI BapiService.TransactionCommit must be called afterward.

This BAPI can only be used with objects that are not classes.

The values processed in this BAPI are for classification only, not for configuration.


11-Dec-2005


Delete

Delete


This BAPI deletes a classification and its assigned values. Theclassification is defined by the object key (ObjectKey) and the classname (ClassNum), plus the optional parameters date (KeyDate) and changenumber (ChangeNumber). The default value for the date is the system date, on which all classifications are valid.


If the BAPI runs successfully, table RETURN contains no messages of type 'E'.

Notes

The object key ObjctKey can be generated from the key fields object, object table, and class type by BAPIObjectClassification.GetKeyOfObject.

If these fields are defined and only one function module is to be used,
use function module BAPI_OBJCL_DELETE. This skips the conversion to the object key.

Caution

This BAPI does not change the database. To do this, BAPI BapiService.TransactionCommit must be called afterward.

This BAPI can only be used with objects that are not classes.


11-Dec-2005


ExistenceCheck

ExistenceCheck


This BAPI checks the existence of a classification, on a specific dateif required. The classification must be defined by the class name andthe key of the classified object. The default value for the date is the system date.

Table RETURN can contain the following message types:


Type 'E': Object is a class

Type 'S' : Classification exists and is valid

Type 'I' : Classification does not exist or is not valid

Notes

The object key ObjctKey can be generated from the key fields object, object table, and class type by BAPI
ObjectClassification.GetKeyOfObject.

If this fields are defined and only one function module is to be used,use function module BAPI_OBJCL_EXISTENCECHECK. This skips the converstion to the object key.

Caution

This BAPI can only be used with objects that are not classes.


11-Dec-2005


GetClasses

GetClasses


This BAPI returns all classes where an object (such as a material) isclassified. This is usually exactly one class, or several classes in the case of multiple classification.

The object is defined by the object key (ObjectKey).

Table AllocList contains the result with class (ClassNum), class type
(ClassType), classification status (Status), and object information. Error messages are logged in table Return. If the BAPI runssuccessfully, this table contains no messages of type 'E'.

Notes

The object key ObjctKey can be generated from the key fields object, object table, and class type by BAPI
ObjectClassification.GetKeyOfObject.

If these fields are defined and only one function module is to be used,use function module BAPI_OBJCL_GETCLASSES. This skips the conversion to the object key.


11-Dec-2005


GetDetail

GetDetail


This BAPI returns detailed information on a classification. The objectkey (Objectey), class name (ClassNum), and a date, if required, are imported. The default value for the date is the system date.

Information on the class is output in structure AllocDetail. The other
export tables contain the assigned values for the classification, according to the data type of the characteristics. The values fornumeric, time, and date characteristics are in table AllocValuesNum, values for character and boolean characteristics are in table
AllocValuesChar, and values for currency characteristics are in table AllocValuesCurr.

If the BAPI runs successfully, table RETURN contains no messages of type 'E'.

Notes

The object key ObjctKey can be generated from the key fields object, object table, and class type by BAPI
ObjectClassification.GetKeyOfObject.

If these fields are defined and only one function module is to be used,use function module BAPI_OBJCL_GETDETAIL. This skips the conversion to the object key.

Caution

This BAPI can only be used with objects that are not classes.


This BAPI only returns the assigned values for classification, not for configuration.


11-Dec-2005


GetKeyOfObject

GetKeyOfObject


This BAPI returns the key of an object (ObjectKey). To do this, theobject (Object), object table (ObjectTable), and class type (ClassType)must be transferred. This key is needed to address objects when using business object ObjectClassification.

If an object is to be classified in a class type for the first time,
the object does not yet have a key. Before you can classify it, you must use this BAPI to generate a key. To do this, set parameter'CreateMissingKey' to 'X'. The result table then contains a messagetelling you whether an existing key is displayed or a new key has been generated.



11-Dec-2005


GetObjectOfKey

GetObjectOfKey


You can use this BAPI to derive the object (Object), object table(ObjectTable), and class type (ClassType) from the object keys returned by BAPIs for business object ObjectClassification.


11-Dec-2005


GetObjects

GetObjects


No document is available


11-Dec-2005


GetStatus

GetStatus


This BAPI returns the status of a classification, which is defined byobject key (ObjectKey), class name (ClassNum), and a date, if required. The default value for the date is the system date.

If the BAPI runs successfully, table RETURN contains no messages of type 'E'.


Notes

The object key ObjctKey can be generated from the key fields object, object table, and class type by BAPIObjectClassification.GetKeyOfObject.

If these fields are defined and only one function module is to be used,use function module BAPI_OBJCL_GETSTATUS. This skips the conversion to the object key.


Caution

This BAPI can only be used with objects that are not classes.


11-Dec-2005


SplitKey

SplitKey


This BAPI returns the component key field names and key field values of an object for its key (ObjectKey).

If the BAPI runs successfully, table RETURN contains no messages of type 'E'.

Notes

The object key ObjectKey can be generated from the key fields object, object table, and class type by BAPI
ObjectClassification.GetKeyOfObject.

If these fields are defined and only one function module is to be used,use function module BAPI_OBJCL_SPLITKEY. This skips the conversion to the object key.


11-Dec-2005