Kontakt

Ansicht
Dokumentation

CFG_API_GET_LONG_DESCRIPTIONS - Get Object Type for Longtext Descriptions

CFG_API_GET_LONG_DESCRIPTIONS - Get Object Type for Longtext Descriptions

BAL Application Log Documentation   General Material Data  
This documentation is copyright by SAP AG.
SAP E-Book

Functionality

The function module for retrieving the long descriptions works similar as the one for the short descriptions. It is also implmented in Abap.

*"----------------------------------------------------------------------

*"*"Local Interface:

*"  IMPORTING

*"     VALUE(KB_LOGSYS) TYPE  COMT_CFGD_KBLOGSYS

*"     VALUE(KB_NAME) TYPE  COMT_CFGD_KBNAME

*"     VALUE(KB_VERSION) TYPE  COMT_CFGD_KBVERSION

*"     VALUE(KB_ACTIVE) TYPE  COMT_CFGD_BOOLEAN

*"     VALUE(LANGUAGE) TYPE  LANG OPTIONAL

*"     VALUE(BUILD_NUMBER) TYPE  COMT_CFGD_KBBUILD

*"     VALUE(INCLUDE_ALL_CSTIC_VALUES) TYPE  COMT_CFGM_BOOLEAN DEFAULT

*"       'F'

*"  CHANGING

*"     VALUE(OBJECT_LONGTEXT) TYPE  COMT_CFGM_OBJECT_LNGTX_I

*"     VALUE(CSTIC_LONGTEXT) TYPE  COMT_CFGM_CSTIC_LNGTX_I

*"     VALUE(CSTIC_VALUE_LONGTEXT) TYPE  COMT_CFGM_CSTIC_VAL_LNGTX_I

*"  EXCEPTIONS

*"      BUILD_NOT_UP_TO_DATE

*"      KNOWLEDGEBASE_NOT_FOUND

*"      INVALID_PRODUCT_TYPE

*"      INVALID_INPUTPARAM_COMBINATION

*"----------------------------------------------------------------------

The main difference to the retrieval of short descriptions is for the longtexts (explanations with several lines) no use of the TABLES syntax is made although this is processed faster within jRFCs (RFC function modules with the Java Connector). As the longtexts have multiple lines we need a structured return type that is not supported in the TABELS syntax.

The imports match exactly those for CFG_API_GET_LONG_DESCRIPTIONS and are not explained here again. Characteristic groups are not supported. They do not have longtexts.

Objects, characteristics and values are identified as before.

A longtext comprises of :

  • TEXT_FORMAT format characters as defined in SAPScript
  • TEXT_LINE a text line
  • TEXT_LINE_ID the line id, if the text comes unsorted, you can resort with respect to the line id.

Exceptions:

  • BUILD_NOT_UP_TO_DATE if the specified build of the knowledgebase version is not up to date any more. A newer build with possibly changed content is known.
  • KNOWLEDGEBASE_NOT_FOUND
  • INVALID_PRODUCT_TYPE if the product type is not one of the above specified types
  • INVALID_INPUTPARAM_COMBINATION if characteristic values are imported and the flag INCLUDE_ALL_CSTIC_VALUES is set to 'T'.





Parameters

BUILD_NUMBER
CSTIC_LONGTEXT
CSTIC_VALUE_LONGTEXT
DEPENDENCY_LONGTEXT
INCLUDE_ALL_CSTIC_VALUES
KB_ACTIVE
KB_LOGSYS
KB_NAME
KB_VERSION
LANGUAGE
OBJECT_LONGTEXT

Exceptions

BUILD_NOT_UP_TO_DATE
INVALID_INPUTPARAM_COMBINATION
INVALID_PRODUCT_TYPE
KNOWLEDGEBASE_NOT_FOUND

Function Group

COM_CFG_API_MASTERDATA

Vendor Master (General Section)   BAL Application Log Documentation  
This documentation is copyright by SAP AG.

Length: 5162 Date: 20240523 Time: 112404     sap01-206 ( 51 ms )