Sapass

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



Index

Characteristic

Characteristic


The architecture area Characteristic contains features such as,
for example, thread length, quality and so on, with which objects can be described.

For the characteristics, quantitative or qualitative values can be
specified, for example, thread length 100 mm, quality good and so on.

By means of characteristics, features of classes can be described. The
use of a characteristic can be limited to classes of certain class types.


11-Dec-2005


Methods

Available Methods


  • AddLongText : Set Long Text for Characteristic or Value [ BAPI_CHARACT_ADDLONGTEXT ]
  • Change : Change Characteristic [ BAPI_CHARACT_CHANGE ]
  • Create : Create Characteristic [ BAPI_CHARACT_CREATE ]
  • Delete : Delete Characteristic [ BAPI_CHARACT_DELETE ]
  • ExistenceCheck : Check Existence of Object [ BAPI_CHARACT_EXISTENCECHECK ]
  • GetDetail : Read Characteristic Attributes [ BAPI_CHARACT_GETDETAIL ]
  • GetList : Find Name [ BAPI_CHARACT_GETLIST ]
  • GetLongText : Read Long Text for Characteristic of Value [ BAPI_CHARACT_GETLONGTEXT ]
  • GetWhereUsedList : Where-Used List in Classes [ BAPI_CHARACT_GETWHEREUSEDLIST ]
  • RemoveLongText : Delete Long Text for Characteristic or Value [ BAPI_CHARACT_REMOVELONGTEXT ]
  • Rename : Rename characteristics [ BAPI_CHARACT_RENAME ]

11-Dec-2005


AddLongText

AddLongText


This BAPI sets the long text (documentation) for a characteristic or characteristic value.

If only the characteristic name (CharactName) is transferred, the longtext for the characteristic is set. If the parameters for the characteristic value are also filled, the long text for this value is
set.

For characteristics with character format, parameter 'ValueChar' isfilled. For characteristics with numeric, currency, date, and timeformat, parameters 'ValueFrom', 'ValueTo', and 'ValueRelation' arefilled. For a detailed description of these fields, see (for example) table 'CharactValuesNum' of BAPI Characteristic.Create
. Single values are entered in field 'ValueFrom', in which case field 'ValueRelation' contains a '1'.

You can also transfer a date or a change number. The long text is setin the system language, unless you select a different language by using
parameter 'LanguageInt' or 'LanguageISO'. 'LanguageInt' is the langaugein SAP format, whereas 'LanguageISO' is the language in ISO format. Ifboth parameters are filled, the ISO format overrides the SAP format.

The long text is in table 'Longtext'. The first field defines the
format (standard line format is *), and the second field contains a line of text.

The result is logged in table 'Return'. If there are errors in thedata, you see a message of type 'E'. If not, you see a message of type 'S'.

Notes

The long text you transfer overwrites the old long text.


You can use function modules CTBP_CONVERT_VALUE_INT_TO_EXT and CTBP_CONVERT_VALUE_EXT_TO_INT to switch between internal and external value format.


11-Dec-2005


Change

Change


This BAPI changes a characteristic, if the characteristic exists. Ifthe characteristic does not exist, the BAPI creates the characteristic.

The following fields must contain data:

  • Charact_name (characteristic name)
  • Data_type (data type)

  • Length (number of characters)
  • Decimals (number of decimal places)
  • Status (status) in structure CharactDetail
  • Description (description) in structure CharactDescription
  • Either field Language_Int (internal language format, 1 character) or Language_ISO (external language format, 2 characters)

  • ISO format overrides internal format. If there is more than one entry for the same language, the last is relevant.

  • According to data type, the values must be entered in the relevant values table: numeric, time, and date values in CharactValuesNum, character and boolean values in CharactValuesChar, and currency values in
    CharactValuesCurr
    .
  • The value descriptions are in table CharactValuesDescr,regardless of data type. Check tables are entered in table CharactReferences and restrictions to class types are in table CharactRestrictions.


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

    Caution

    The BAPI transfers all information as new, replacing the old information completely. This means that a blank field means "deleteentry", not "no change".


    This BAPI does not change the database. To change the database, call BAPI BapiService.TransactionCommit afterwards.


    11-Dec-2005


    Create

    Create


    This BAPI creates a characteristic that does not yet exist.

    The following fields must contain data:

  • Charact_Name (characteristic name)
  • Data_Type (data type)
  • Length (number of characters)
  • Decimals (number of decimal places)

  • Status (status) in structure CharactDetail
  • Description (description) in structure CharactDescription
  • Either Language_Int (internal language format, 1 character) or Language_ISO (external language format, 2 characters)

  • ISO format overrides internal format. If there is more than one entry for the same language, the last is relevant.

  • The values must be entered in the following values tables, according to data type: numeric, time, and date values in CharactValuesNum, character and boolean values in CharactValuesChar, and currency values in
    CharactValuesCurr
    . The value descriptions are in table CharactValuesDescr, regardless of data type.
  • Check tables are entered in table CharactReferences and restrictions to class types are in table CharactRestrictions.


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

    Caution

    This BAPI does not change the database. To change the database, call BAPI BapiService.TransactionCommit afterwards.


    11-Dec-2005


    Delete

    Delete


    This BAPI deletes a characteristic, which is identified by its name andoptionally a date and/or change number. The default value for the date is the system date, on which all characteristics are valid.

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


    Caution

    This BAPI does not change the database. To change the database, call BAPI BapiService.TransactionCommit afterwards.


    11-Dec-2005


    ExistenceCheck

    ExistenceCheck


    Funktionalit舩

    This BAPI checks whether a characteristic exists on a specific date.The default value for the date is the system date, on which all characteristics are valid.

    The result is shown as follows in table RETURN:

    E00 172 No authorization to display characteristics


    IC1 003 Characteristic does not exist or is not valid

    SC1 002 Characteristic exists


    11-Dec-2005


    GetDetail

    GetDetail


    This BAPI returns detail information on a characteristic, which isidentified by its name and optionally by a date (default value is the system date).

    Transfer Structures

    CharactDetail contains the basic data of the characteristic. CharactDescr
    contains the descriptions. According to the characteristic format, one of the export tables is filled: CharactValuesNum, CharactValuesChar, or CharactValuesCurr. Numeric, time, and date characteristics are
    in CharactValuesNum, character and boolean characteristics are in CharactValuesChar and currency characteristics are in CharactValuesCurr.

    Value descriptions are all in table CHARACTVALUESDESCR, regardless of the characteristic format.


    Check tables are in CharactReferences.

    CharactRestrictions contains the restrictions to class types.

    Note

    Messages are logged in table RETURN. If the BAPI runs successfully, there are no messages of type 'E'.


    11-Dec-2005


    GetList

    GetList


    Funktionalit舩

    This BAPI returns the result of a search for characteristics. Thesearch criteria are the characteristic name, characteristics group,data type, check table, and date. The characteristic name and the groupare transferred in a range table, allowing you to run complex queries.


    The characteristics that match the search criteria are returned in table CharactList. This table contains the name, group, data type, number of characters, and number of decimal places of each characteristic.

    Note

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


    This BAPI reads the database. This means that it finds the data from the last call of BAPI BAPIService.TransactionCommit or the COMMIT-WORK statement. Any changes made since are ignored.


    11-Dec-2005


    GetLongText

    GetLongText


    This BAPI reads the long text (documentation) for a characteristic or characteristic value.

    If only the characteristic name (CharactName) is transferred, the longtext for the characteristic is read. If the parameters of a characteristic value are also filled, the long text for the value is
    read.

    For characteristics with character format, parameter 'ValueChar' isfilled. For numeric, currency, date, and time characteristics, theparameters 'ValueFrom', 'ValueTo', and 'ValueRelation' are filled. Youwill find a detailed description of these fields in, for example, table 'CharactValuesNum' of BAPI Characteristic.Create
    . If a single value is entered in field 'ValueFrom', 'ValueRelation' contains a '1'.

    In addition, you can transfer a date or a change number. Usually, thelong text is read in the system language, by parameter 'LanguageInt' or'LanguageISO', but you can select a different language. 'LanguageInt'
    contains the language in SAP format. 'LanguageISO' contains thelanguage in ISO format. If both parameters are filled, ISO format has priority.

    The long text is in table 'Longtext'. The first field contains formatdata (standard line: *), and the second field contains a text line.


    The result is logged in table 'Return'. If there are errors in thedata, this table contains a message of type 'E', if there is no longtext, it contains a message of type 'I', and if a long text is found successfully, there is no message.

    Notes


    Function modules CTBP_CONVERT_VALUE_INT_TO_EXT and CTBP_CONVERT_VALUE_EXT_TO_INT can be used to switch between internal and external value format.


    11-Dec-2005


    GetWhereUsedList

    GetWhereUsedList


    This BAPI returns a list of all classes that contain characteristic 'CharactName' on date 'KeyDate'.

    If the characteristic is not assigned to a class, table 'Return'contains a message of type 'I'. If an error occurs, the table contains a message of type 'E'.



    11-Dec-2005


    RemoveLongText

    RemoveLongText


    This BAPI deletes the long text (documentation) for a characteristic or characteristic value.

    If only the characteristic name (CharactName) is transferred, the longtext for the characteristic is deleted. If the parameters for thecharacteristic value are also filled, the long text for this value is deleted.


    For characteristics with character format, parameter 'ValueChar' isfilled. For characteristics with numeric, currency, date, and timeformat, parameters 'ValueFrom', 'ValueTo', and 'ValueRelation' arefilled. For a detailed description of these fields, see (for example) table 'CharactValuesNum' of BAPI Characteristic.Create
    . Single values are entered in field 'ValueFrom', in which case field 'ValueRelation' contains a '1'.

    You can also transfer a date or a change number. The long text isdeleted in the system language, unless you select a different languageby using parameter 'LanguageInt' or 'LanguageISO'. 'LanguageInt' is the
    langauge in SAP format, whereas 'LanguageISO' is the language in ISOformat. If both parameters are filled, the ISO format overrides the SAP format.

    The long text is in table 'Longtext'. The first field defines theformat (standard line format is *), and the second field contains a line of text.


    The result is logged in table 'Return'. If there are errors in thedata, you see a message of type 'E'. If not, you see a message of type 'S'.

    Notes

    You can use function modules TBP_CONVERT_VALUE_INT_TO_EXT and CTBP_CONVERT_VALUE_EXT_TO_INT
    to switch between internal and external value format.


    11-Dec-2005


    Rename

    Rename


    No document is available


    11-Dec-2005