Ansicht
Dokumentation

CFG_API_GET_CSTICS_AND_VALUES - Returns dynamical facets of characteristics and the assigned values

TXBHW - Original Tax Base Amount in Local Currency   PERFORM Short Reference  
This documentation is copyright by SAP AG.

Functionality

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

*"*"Local Interface:

*"  IMPORTING

*"     VALUE(CONFIG_ID) TYPE  COMT_CFGM_CONFIG_ID

*"     VALUE(INST_ID) TYPE  COMT_CFGD_INSTID OPTIONAL

*"     VALUE(FILTER_GROUPS) TYPE  COMT_CFGM_GROUP_ID_I OPTIONAL

*"     VALUE(INCLUDE_UNGROUPED_CSTICS) TYPE  COMT_CFGM_BOOLEAN DEFAULT

*"       'T'

*"     VALUE(VISIBLE_CSTICS_ONLY) TYPE  COMT_CFGM_BOOLEAN DEFAULT 'T'

*"     VALUE(INCLUDE_SURCHARGES) TYPE  COMT_CFGM_BOOLEAN DEFAULT 'F'

*"  TABLES

*"      INST_CSTIC_FACETS TYPE  COMT_CFGM_INST_CSTIC_FACET_I

*"      INST_CSTIC_VALUES TYPE  COMT_CFGM_INST_CSTIC_AVAL_I

*"  EXCEPTIONS

*"      PARAMETER_EXCEPTION

*"      COMMAND_EXCEPTION

*"      EXCEPTION_CONFIG_NULL

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

The dynamical data of characteristics and assigned values is retrieved. This can be retrieved for a single instance of a configuration or for the complete configuration. A UI would typically display one instance only to be changed. For an overview the complete configuration may nevertheless be displayed.

Possible filter to reduce the data amount:

• FILTER_GROUPS ,,a list of characteristic groups that serves as filter. No group means all characteristics are returned,

• INCLUDE_UNGROUPED_CSTICS include or exclude the ungrouped characteristics, default is true,

• VISIBLE_CSTICS_ONLY limits the returned data to visible characteristics, default is true,

• INCLUDE_SURCHARGES determines the retrieval of the surcharges for characteristic values, default is false.

The returned data is the following:

CSTIC_FACETSreturn the dynamically changeable facets of a characteristic

• INST_ID ,,,,instance id is needed to identify entries for different instances if the function module is called for the complete configuration,

• CSTIC_NAME ,,the characteristic name to identify the characteristic

• NIL ,,,,,,if the list of allowed values is the empty domain

• READONLY ,,,,the characteristic is read-only

• REQUIRED ,,,,the characteristic is marked as required

• VISIBLE ,,,,the characteristic is marked as visible

• COMPLETE ,,,,the characteristic is complete. If it is marked as required a value is assigned.

• CONSISTENT ,,the characteristic is not part of a conflict.

CSTIC_VALUESreturn the value assignments for characteristics. Only if one or more values are assigned, the characteristic is listed here.

• INST_ID ,,,,instance id is needed to identify entries for different instances if the function module is called for the complete configuration,

• CSTIC_NAME ,,the characteristic name to identify the characteristic,

• VALUE ,,,,the assigned value as a char40 ,

• VCOND_KEY ,,variant condition key that is assigned directly to the characteristic value,

• AMOUNT ,,,,the amount of the variant condition that is determined for the given key,

• CURRENCY ,,,,the currency of the variant condition that is determined for the given key,

• AUTHOR ,,,,the simplified author of the value: S for system, D for Default, U for User.

Note: called without INST_ID the function module returns the value assignments and facets for all instances of the configuration.

Further information

Parameters

CONFIG_ID
FILTER_GROUPS
INCLUDE_SURCHARGES
INCLUDE_UNGROUPED_CSTICS
INST_CSTIC_FACETS
INST_CSTIC_VALUES
INST_ID
VISIBLE_CSTICS_ONLY

Exceptions

COMMAND_EXCEPTION
EXCEPTION_CONFIG_NULL
PARAMETER_EXCEPTION

Function Group

COM_CFG_API_UI_COMMAND

ABAP Short Reference   Addresses (Business Address Services)  
This documentation is copyright by SAP AG.

Length: 6146 Date: 20240523 Time: 091514     sap01-206 ( 60 ms )