Kontakt

Ansicht
Dokumentation

CFG_API_GET_SHORT_DESCRIPTIONS - Get Object Type for Short Descriptions

CFG_API_GET_SHORT_DESCRIPTIONS - Get Object Type for Short Descriptions

rdisp/max_wprun_time - Maximum work process run time   ABAP Short Reference  
This documentation is copyright by SAP AG.
SAP E-Book

Functionality

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

*"*"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'

*"  TABLES

*"      OBJECT_DESCRIPTIONS TYPE  COMT_CFGM_OBJECT_DESCR_I

*"      CSTIC_GROUP_DESCRIPTIONS TYPE  COMT_CFGM_CSTIC_GR_DESCR_I

*"      CSTIC_DESCRIPTIONS TYPE  COMT_CFGM_CSTIC_DESCR_I

*"      CSTIC_VALUE_DESCRIPTIONS TYPE  COMT_CFGM_CSTIC_VAL_DESCR_I

*"  EXCEPTIONS

*"      BUILD_NOT_UP_TO_DATE

*"      KNOWLEDGEBASE_NOT_FOUND

*"      INVALID_PRODUCT_TYPE

*"      INVALID_INPUTPARAM_COMBINATION

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

This function module is implemented in ABAP and reads the language dependent description for classes and products (OBJECT_DESCRIPTIONS), for characteristic groups (CSTIC_GROUP_DESCRIPTIONS), for characteristics (CSTIC_DESCRIPTIONS) and for characteristic values (CSTIC_VALUE_DESCRIPTIONS) of a specified knowledgebase version.

The knowledgebase version is specified by KB_LOGSYS, KB_NAME, KB_VERSION, the active flag (KB_ACTIVE) and the build number of the KB. This information can be retrieved from a configuration by calling CFG_API_GET_CONFIG_INFO.

The language can be specified explicitly. Otherwise the logon language is used.

The function module returns the descriptions for the objects you specify in the below showed tables.

Characteristic values are returned for all characteristics that are imported.

If the flag INCLUDE_ALL_CSTIC_VALUES is set to true all characteristic value descriptions for characteristics listed in CSTIC_DESCRIPTIONS are retrieved as well.

All four tables serve as Import and Export table at the same time. The first column(s) must be filled, the descriptions are then retrieved and completed.

For objects the following structure defines the table line:

  • OBJECT_NAME to be provided by the caller (from CFG_API_GET_INSTANCES)
  • OBJECT_TYPE to be provided by the caller (from CFG_API_GET_INSTANCES)
  • CLASS_TYPE to be provided by the caller (from CFG_API_GET_INSTANCES)
  • DESCRIPTION added by the function module

For characteristic groups the following structure defines the table line:

  • OBJECT_NAME to be provided by the caller (from CFG_API_GET_INSTANCES)
  • OBJECT_TYPE to be provided by the caller (from CFG_API_GET_INSTANCES)
  • CLASS_TYPE to be provided by the caller (from CFG_API_GET_INSTANCES)
  • CSTIC_GROUP_NAME to be provided by the caller (from CFG_API_GET_CSTIC_GROUPS)
  • DESCRIPTION added by the function module

For characteristics:

  • CSTIC_NAME to be provided by the caller (from CFG_API_GET_CSTIC_TYPES)
  • DESCRIPTION added by the function module

For characteristic values the function module works in two possible modes:

  1. All values to the above specified characteristic are added implicitly with the respective description if the flag INCLUDE_ALL_CSTIC_VALUES is set to 'T',
  2. the values are specified one by one as for the other entities.

The provided data is shown below:

  • CSTIC_NAME
  • CSTIC_VAL
  • DESCRIPTION

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_DESCRIPTIONS
CSTIC_GROUP_DESCRIPTIONS
CSTIC_VALUE_DESCRIPTIONS
DEPENDENCY_DESCRIPTIONS
INCLUDE_ALL_CSTIC_VALUES
KB_ACTIVE
KB_LOGSYS
KB_NAME
KB_VERSION
LANGUAGE
OBJECT_DESCRIPTIONS

Exceptions

BUILD_NOT_UP_TO_DATE
INVALID_INPUTPARAM_COMBINATION
INVALID_PRODUCT_TYPE
KNOWLEDGEBASE_NOT_FOUND

Function Group

COM_CFG_API_MASTERDATA

Fill RESBD Structure from EBP Component Structure   BAL Application Log Documentation  
This documentation is copyright by SAP AG.

Length: 7365 Date: 20240523 Time: 091513     sap01-206 ( 66 ms )