CL_EHCSM_SPC_ACCESS - API: Providing Full Access to EHS Specification Mgmt Data

Fill RESBD Structure from EBP Component Structure   ABAP Short Reference  
This documentation is copyright by SAP AG.

Functionality

This class provides full access to data used in specification management. It is the main class supportingthe specification management API and enables application development based on a Web UI. This class is located in package CBUI_BO.

You can use this class whenever you want to access the following data stored in the specification database:

• Specification header

• Specification usage

• Restrictions

• Identifier usage

• Value assignment usage

• Specification identifier

• Specification identifier long text

• Specification identifier-based regulatory list

• Specification reference

• Specification status

• Specification material assignment

• Specification relationship

• Value assignment

• Value assignment header

• Value assignment instance

• Assessment

• Composition / substance listing

• Source

• Text

• Long text

Corresponding methods exist for accessing this data. The following sections describe the methods in more detail.

Use Cases the CBUI_BO API Supports:

The CBUI_BO API supports the following use cases:

• Retrieve of specification related data. This related data is mentioned in the section above

• Creation of a specification

• Deletion of one or many specification with all related data

• Maintenance of one specification in order to create, retrieve, update and delete related data records

• Temporary or permanent overwriting of inherited valuation instances

• Editing of status entries, reference entries, relationship entries or overwriting of inherited valuation instances of a specification forces the saving of data

• Switch from display mode (read-only) into edit mode of one specification and all its related data

• Copy of an existing specification related data into either another existing target specification or a new one

• Parallel processing of valuation instance data related to one specification:
  One user is editing properties of value assignment type A whereas another user is editing properties of value assignment type B

• Saving of changes either in transaction master or slave mode; in master mode does the CBUI_BO APItakes care about committing of changes, whereas in slave mode the consuming application must take care about the commit

• UI property and UI action handling related to the retrieved specification data

Out of Scope:

• Parallel editing of multiple specifications

• Overwriting of referenced valuation instance

• Reports

General Aspects

Each consumer of this class gets access to the singleton instance through the method GET_INSTANCE.

Within this GET_INSTANCE method can a consumer set the key date or the change number that will be laterin order to access EH&S specification data. As long as no changes were made in a user transaction, those access settings can be changed by calling the CHANGE_SETTINGS method.

Usage of Engineering Change Management for Specifications

If you make changes without using a change number, the standard validity period used goes from 01/01/0001to 12/31/9999. The system enters the current date as the key date. When you use a change number to changea data record for the first time, the SAP system divides the overall validity period into two adjoiningvalidity periods. When CL_EHCSM_SPC_ACCESS is accessed to work with a change number, only specifications can be retrieved that are assigned to that change number.

If you want to make changes with using a change number, you need to call this class in the following way:

• Set the access parameters with the correct key date / change number what the specification can be retrieved

• Once you have retrieved it, change the change number settings of this class via the CHANGE_SETTINGS method

• Now change a data record and save your changes

Saving Required

Changing specification data might force the saving of data changed in order to avoid data inconsistency.Therefore does CBUI_BO abort any insert, update and delete attempt once saving is required. The usermust save or cleanup the changes in order to continue. The class CL_EHCSM_SPC_ACCESS provides the method IS_SAVING_REQUIRED determining if saving is required.

LINEMOD Component in DDIC Structures

CBUI_BO is providing own DDIC structures and table types. Nevertheless do they internally include existingDDIC structures that are used in EHS specification management. Such structures often contain a component LINEMOD that is internally used to differentiate between insert, update and deletes.

When you are consuming CBUI_BO, you don't have to care about that component at all. CBUI_BO set theLINEMOD correctly. It will set this line mode depending of the method called, i.e. calling any insert/createmethod will set the line mode to insert. But the line mode is set only for those data records where the line mode is initial.

Usage of Keys - DDIC Structure EHCSMS_SPC_KEY

CBUI_BO is providing that DDIC structure in order easily address EHS specification related data records. The structure consists of the following components:

• RECN
  The sequential number of a data record.

• ACTN
  The sequential number of the change state.

• RECNROOT
  The sequential number of the specification header data record the data record (RECN)belongs to. In general should RECNROOT always be filled. Specification header related structures mustnot fill RECNROOT, a correct filled RECN is enough. Whenever you insert, update, delete or retrievespecification related data you should fill the RECNROOT component accordingly. If RECNROOT is not setat all does the EHS backend API just returning the data without doing anything without any message.
  Only the insert methods which names are ending with SINGLE or SAMPLE has a mandatory import parameterfor specification header. When you call these methods you don't need to fill RECNROOT since the methodtakes care about that. You only need to ensure that RECN is correctly filled in the specification header parameter.

• RECNPARENT
  Within CBUI_BO API the DDIC structure EHCSMS_SPC_KEY has been enhanced with an additional component RECNPARENT containing the sequential number of the parent data record.
  
  This new component must be filled when some specific specification data is requested or inserted.This section provides all necessary details. Please note that in all other cases RECNPARENT is ignored.
  
  Retrieve of Specification Data:
  ---------------------------------------
  Whenever retrieving the following data that new component RECNPARENT should be filled accordingly:

• For identifier based regulatory lists (method RETRIEVE_IDENT_REG_LIST of class CL_EHCSM_SPC_ACCESS)is RECNPARENT of IT_SPC_IDN_REG_LIST_KEY interpreted to determine the identifier for which regulatory lists are requested in case the import parameter IT_SPC_IDN_KEY is initial.

• Some valuation instance related retrieve methods have amongst others two optional import parametersIT_SPC_VAL_INST_KEY and IT_SPC_VAL_HDR_KEY. RECNPARENT of import parameter IT_SPC_VAL_INST_KEY containsthe RECN of the valuation header the valuation instance belongs to. If the import parameter IT_SPC_VAL_HDR_KEYis initial the import parameter IT_SPC_VAL_INST_KEY must be filled to prevent unnecessary data record locks for the following valuation related data:
  
  - Valuation Instance
  - Valuation Assessment
  - Valuation Composition
  - Valuation User Defined Texts and Documents
  - Valuation Long Text
  - Valuation Source
  
  Creation of Specification Data:
  ----------------------------------------
  The creation of valuation instance related specification data requires RECNPARENT as well in order toavoid such unnecessary data record locks. In a consequence should RECNPARENT (with the RECN of the valuationheader the valuation instance belongs to) of the import parameters IT_SPC_VAL_INST_KEY and IS_SPC_VAL_INST_KEY be filled whenever the following specification data is created:
  - Valuation Characteristics Data
  - Valuation Composition
  - Valuation User Defined Texts and Documents
  - Valuation Long Text
  - Valuation Source
  

Specification Category (OBJTYPE) and Specification Type (SUBCAT)

The topic specification category and type is quite complicated and hard to understand. A specificationonly knows its specification type (SUBCAT) but not its category (OBJTYPE). The specification categoryis given by the workbench the specification is opened in. For instance if you open a specification intransaction CG02 the OBJTYPE internally used is automatically set to SUBSTANCE. Whereas in other workbenches an other OBJTYPE is set.

With CBUI_BO API you need to set the correct specification category to use when you initialize thisaccess class (GET_INSTANCE method) or via CHANGE_SETTINGS method. That OBJTYPE is necessary when it comes to DDIC search helps assigned to EH&S specification / CBUI_BO related DDIC structures.

EH&S Specification is highly customizable and unfortunately is it possible to assign more than one OBJTYPE for one SUBCAT. Therefore is it not possible to determine the correct OBJTYPE for a given SUBCAT.

Nevertheless ford the CL_EHCSM_SPC_ACCESS=>RETRIEVE_HEADER try to determine the OBJTYPE if the optionalparameter IV_FILL_DATA_IND is set. In case exactly one OBJTYPE is assigned to a SUBCAT that method returns that OBJTYPE.

General Methods

The following general methods are provided in order to access this class:

• GET_INSTANCE
  This method returns the singleton instance of this access class. You can use its import parameters to influence the following:

• IV_CHANGE_NR: The change number that is used for data access.

• IV_KEY_DATE: The key date data that you want to retrieve.

• IV_SPC_CAT: The specification category of the specification that you want to access.

• IV_LANGU: The language key specifies the language that is used when language-dependent data is retrieved.

• This method only interprets the import parameter values and change the settings in case no instanceexists so far. As soon as an instance exists, the import parameters are ignored. Consumers shall call CHANGE_SETTINGS method in order to change access settings.

• CHANGE_SETTINGS
  You can use this method to change the access settings. Note, that changing thesettings during a transaction will force you to save data changes. You can call the method IS_SAVING_REQUIRED to ask the API if saving of data changes is required.

• GET_SETTINGS
  This method returns the current settings of this access API.

Transactional Behavior Methods

You can influence transactions using the following methods:

• CLEANUP
  Informs the EHS specification buffer to rollback all changes made in the transaction and remove all locks. The optional import parameter IV_CLEANUP_REASON specifies why data changes are cleaned up:

• If a COMMIT WORK was the reason, this method calls internally the commit function module relevant to the EHS specification

• If BUFFER REFRESH was the reason, all unsaved changes are reverted but existing locks are not released

• If ROLLBACK WORK was the reason, all unsaved changes are reverted and existing locks are released

• GET_CHANGED_SPECIFICATIONS
  You can use this method to get a list of all specification changed in a transaction.

• HAS_DATA_CHANGES
  This method indicates if unsaved data changes were made.

• SAVE
  This method informs the EHS specification buffer to save all data changes in the transaction. This method must be called twice, once before the actual commit and then also after the COMMIT WORK.

• The import parameter IV_SAVE_MODE is used to distinguish if the call is before or after commit.
  
  If the save mode is set to COMPLETE, this method does the complete COMMIT WORK and wait until all necessary internal calls are executed.
  If caller of the SAVE method needs to trigger the COMMIT WORK, this save method must called twice:
  1.) Call SAVE with mode BEFORE
  2.) External call of COMMIT WORK
  3.) Call SAVE with mode AFTER

• The export table ET_CHANGED_SPECS returns a list of changed specifications. This list is filled when data was successfully saved before the commit.

• IS_SAVING_REQUIRED
  This method returns an indicator when specification management requires data changes to be saved.
  The changes are saved when one of the following conditions is true:

• A new specification header is created.

• Changes to specification data were made and now the consumer wants to retrieve or change status data.

• Changes to specification data were made and now the consumer wants to retrieve or change relationship data.

• Changes to specification status data were made and now the consumer wants to retrieve or change any other specification data.

• Changes to relationship data for the specification were made and now the consumer wants to retrieve or change any other specification data.

• Changes to reference data for the specification were made and now the consumer wants to retrieve or change any other specification data.

• Inherited valuation instance are overwritten.

• The key date and change number for accessing specification data has changed and unsaved data does exist.

Utility Methods

The following auxiliary methods are provided:

• COPY_SPECIFICATION
  This method copies data from a given source specification into a given target specification. The following parameters exist:

• IS_SOURCE_HDR_KEY
  Specifies the key of the specification that is the data source for copying.

• IV_CREATE_TARGET_IND
  Indicates with the value ABAP_TRUE that the target specification header instance is created. The data of the source target specification is then copied to the newly created target one.

• IS_TARGET_HDR_KEY
  Specifies the optional key of the target specification.

• IV_COPY_TEMPLATE
  Specifies the ID of the copy template to use.

• IV_COPY_REF_IND
  Indicates with the value ABAP_TRUE that references are copied.

• IV_COPY_MAT_ADMNT_IND
  Indicates with the value ABAP_TRUE that material assignments are copied.

• IV_COPY_RESTR_IND
  Indicates with the value ABAP_TRUE that restrictions are copied.

• IV_SOURCE_ADDINF
  Specifies the change number and key data for retrieving the source specification data.

• IV_TARGET_ADDINF
  Specifies the optional change number and key data for the target specification data.

• ES_TARGET_HDR
  Specifies the target specification header.

• GET_IDENTS_BY_LISTING
  This method returns identifiers belonging to a identification list. The following are method parameters:

• IV_ID_LISTING
  Specifies the name of the listing to use.

• IV_NO_POSITIONS_WANTED
  Specifies the maximum number of identifiers.

• IV_FILL_IDTITLE
  Indicates with the value ABAP_TRUE that the titles and classification names of the identifiers are determined in ET_IT_TITLE.

• IV_FILL_IDSUFFIX
  Indicates with the value ABAP_TRUE that for each identifier suffix information is added, such as identification category and identification type.

• IV_IDENT_IND
  Indicates with the value ABAP_TRUE that the identifiers for the UI view containing all identifiers are determined.

• IV_IDN_REG_LIST_IND
  Indicates with the value ABAP_TRUE that the identifiers for the UI view containing all identifier regulatory list are determined.

• IV_HITLIST_ID_IND
  Indicates with the value ABAP_TRUE that the identifiers for a result list view are determined.

• ET_ID
  Specifies the list with determined identifiers.

• ET_ID_TITLE
  Specifies the list with identifier titles and classification names belonging to the request listing.

• EV_HITLIST_IDENT
  Specifies the concatenated identifier of a specification prepared for result list representation.

• GET_VAT_DEFINITION
  This method returns the description for a specific value assignment type.

• SIMULATE_FOREIGN_LOCK
  This method is for testing and you can use it to simulate foreign lockdetection. For more information, see also the SAP user parameter EHCSM_SIM_FORGN_LOCK that a user can set in its own parameter settings in order to enable or disable the lock detection simulation.

EHS Specification Management Access Methods

Common

Each method has the following export parameters in common:

• ET_MESSAGE
  Specifies the list of messages that have emerged during method processing.

• ET_FAILED_KEY
  Specifies the list of keys that identify specification-related data that is unknown in the specification database.

• EV_FOREIGN_LOCK
  If set, indicates when a foreign lock is detected.

• EV_SEVERITY
  Specifies the calculated value of the overall severity of all messages that are part of ET_MESSAGE.

About Retrieve Methods

Each retrieve method has the following parameters in common:

• IV_LOCK_MODE
  Specifies the lock mode for the retrieve: no lock, shared, or exclusive lock (for more information, see attribute GC_LOCKMODE of interface IF_EHCSM_SPC_CONST_C).

• IV_FILL_DATA_IND
  Indicates when the value is true that related transient data is determined also. For more details see the inline comment of each retrieve method.

List of Access Methods

Accessing data from EHS specification management is possible using the following methods:

Specification Header

The specification header defines the root entry for every data record in EHS specification management. The following methods exist for the specification header:

• INSERT_HEADER
  You can use this method to create one or more than one new instance of a specification header.

• UPDATE_HEADER
  You can use this method to update one or more than one instance of a specification header.

• DELETE_HEADER
  You can use this method to delete one or more than one instance of a specification header.

• RETRIEVE_HEADER
  This method retrieves one or more than one instance of a specification identifier.Therefore, the following two import parameters are available and are taken into account when corresponding header data is retrieved:

• IT_SPC_HEADER
  If the SUBID of the specifications to retrieve is known, this parameter is used.

• IT_SPC_HEADER_KEY
  If RECN and ACTN of the specifications to retrieve is known, this parameter is used.

Specification Identification

The following methods enable you to identify a specification using various identifiers:

• INSERT_IDENT
  You can use this method to create one or more than one new instance of a specification identifier.

• UPDATE_IDENT
  You can use this method to update one or more than one instance of a specification identifier.

• DELETE_IDENT
  You can use this method to delete one or more than one instance of a specification identifier.

• RETRIEVE_IDENT
  You can use this method to retrieve one or more than one instance of a specification identifier.

• The import parameter IT_LANGU specifies the language(s) for the specifications whose identifiers you want to retrieve.

• The optional import parameter IT_SPC_IDN_KEY can be used to filter the retrieve for specific identifiers instances.

Specification Identifier Long Text

• INSERT_IDENT_LTX
  This method creates long text records for exactly one identifier instance.

• INSERT_IDENT_LTX_SINGLE
  This method creates one or more than one new long text instance of a specification identifier.

• UPDATE_IDENT_LTX
  This method updates one or more than one long text instance of a specification identifier.

• DELETE_IDENT_LTX
  This method deletes one or more than one long text instance of a specification identifier.

• RETRIEVE_IDENT_LTX
  This method retrieves one or more than one long text instance of a specification identifier.

• The import parameter IT_LANGU defines the language(s) for those specifications for which the identifiers are retrieved.

• You can use the optional import parameter IT_SPC_IDN_KEY to filter the retrieve for specific identifiers instances.

• You can use the optional parameter IT_SPC_IDN_LTX_KEY to filter for specific identifier long text instances.

Specification Identifier Based Regulatory List

• INSERT_IDENT_REG_LIST_SINGLE
  This method creates regulatory list records for exactly one identifier instance.

• INSERT_IDENT_REG_LIST
  This method creates one or more than one new regulatory list instance of a specification identifier.

• UPDATE_IDENT_ REG_LIST
  This method updates one or more than one regulatory list instance of a specification identifier.

• DELETE_IDENT_ REG_LIST
  This method deletes one or more than one regulatory list instance of a specification identifier.

• RETRIEVE_IDENT_ REG_LIST
  This method retrieves one or more than one regulatory list instance of a specification identifier.

• You can use the optional import parameter IT_SPC_IDN_ REG_LIST_KEY to filter for specific long text instances of an identifier.

Specification Usage

Usages are used at three different places with EHS specification management: restrictions, identifierusage, and valuation usage. Within usages, the rating and the validity area of data are specified. The supported usage types are defined in the constant interface as well:

• INSERT_USAGE_SINGLE
  Can be used to create usages for a specific parent, that is for a specific instance the usages shall be assigned to:

• IS_PARENT_KEY
  This structure identifies the parent instance (specification header instance forrestrictions, specification identifier instance for identifier usage, and valuation instance for valuation instance).

• IT_SPC_USG
  Specifies a list with new usage instances. It is not necessary to fill RECN and ACTN. However, it is mandatory to set VACLID and RVLID.

• IV_USAGE_TYPE
  Specifies the usage type. See IF_EHCSM_SPC_CONST_C and its attribute GC_USAGE_TYPE.

• ET_SPC_USG
  Specifies the export table that contains all created usage instances.

• INSERT_USAGE
  Inserts usage instances. A usage instance belonging to exactly one parent, three parent types must be distinguished:

• IT_PARENT_KEY
  In case of restrictions represents a SPC header instance the parent.
  In case of identifier usages represent an identifier instance the parent.
  In case of valuation usages represent a valuation instance the parent.

• UPDATE_USAGE
  Updates usage instances.

• DELETE_USAGE
  Deletes one or more than one usage instance.

• RETRIEVE_USAGE
  This method returns usage-related data.

Specification Usage Profile

In usage profiles, you can specify frequently used combinations of ratings and validity areas. The systemproposes ratings and validity areas automatically under the conditions described in, see section Features when you edit the value assignments and header data (identifiers, restrictions, and specification statuses) of a specification. For such usage profiles, the following methods exist:

• REMOVE_USG_PROFILE_FOR_USER
  This method remove the default usage profile for a user.

• RETRIEVE_USG_PROFILE_FOR_USER
  This method gets default usage profile for a user.

• SET_USG_PROFILE_FOR_USER
  This method sets default usage profile for a user.

Specification Reference

You can use these methods to assign one or more than one reference specification to a specification:

• INSERT_REFERENCE
  You can use this method to create one or many references that belong to one specification.

• UPDATE_REFERENCE
  You can use this method to update references.

• DELETE_REFERENCE
  You can use this method to delete references for one or more than one specification.

• RETRIEVE_REFERENCE
  You can use this method to retrieve reference-related data for one or more than one specification.

• You can use this optional import parameter IT_SPC_REF_KEY to filter for specific reference instances.

Specification Status

Specification status specifies for a specification for which usages its identifiers and value assignment instances should be protected. For the status, the following methods are provided:

• INSERT_STATUS
  This method creates one or more than one new specification status instance.

• UPDATE_STATUS
  This method updates one or more than one specification status instance.

• DELETE_STATUS
  This method deletes one or more than one specification status instance.

• RETRIEVE_STATUS
  This method retrieves one or more than one specification status instance.

• You can use the optional import parameter IT_SPC_STATUS_KEY to filter for specific status instances.

Specification Material Assignment

The following methods maintain and access object links specifications and materials in the SAP Material Master(LO-MD-MM) component:

• INSERT_MAT_ASSIGNMENT
  You can use this method to create material assignments for one or more than one specification.

• UPDATE_MAT_ASSIGNMENT
  You can use this method to update material assignments for one or more than one specification.

• DELETE_MAT_ASSIGNMENT
  You can use this method to delete material assignments for one or more than one specification.

• RETRIEVE_MAT_ASSIGNMENT
  You can use this method to retrieve material assignments for one or more than one specification.

• You can use the optional import IT_SPC_MAT_ASSIGNMENT_KEY to filter for specific material assignment instance.

Specification Inheritance or Relationship

Methods belonging to inheritance enable you to pass value assignments and identifiers from one specification (source specification) to another (target specification).

• INSERT_RELATIONSHIP
  This method creates a new relationship between two specifications.

• IV_SPC_SOURCE: This import parameter defines the source of the relationship.

• IV_SPC_TARGET: This import parameter defines the target of the relationship.

• IV_TEMPLATE: You use this ID for the relationship template.

• IV_TEMPLATE_GROUP (optional): The template group

• UPDATE_RELATIONSHIP
  This method updates one or more than one specification relationship instance.

• DELETE_RELATIONSHIP
  This method deletes one or more than one specification relationship instance.

• RETRIEVE_RELATIONSHIP
  This method retrieves one or more than one specification relationship instance.

• IV_DST_VIEW_IND: This import parameter defines if relations are returned where the passed specification acts as destination (ABAP_TRUE) or as source (ABAP_FALSE).

• SET_RELATIONSHIP_STATUS
  This method sets the status of a specification relationship. The possiblestatuses are defined both in the constant interface IF_EHCSM_SPC_CONST_C (GC_REL_STATUS_ACTION) and the DDIC domain EHCSM_SPC_REL_STAT_ACTION_CODE.
  For more information, see the documentation of DDIC data elements ESE_ICON_CONS_STAT and ESE_ICON_ACTIVE_INH.

Valuation Header

The purpose of valuation header information is to link valuation instances to a specific value assignmenttype. The API does not provide any insert method, since this is handled indirectly within the valuation instance insert method INSERT_VAL_INST.

For the valuation header the following methods exist:

• UPDATE_VAL_HDR
  This method updates one or more than one valuation header record.

• DELETE_VAL_HDR
  This method deletes valuation header records.

• RETRIEVE_VAL_HDR
  This method retrieves valuation header records.

Valuation Instance

A valuation or value assignment instance represents a data record for a value assignment type in EHSspecification management that can contain additional information such as source, rating, and usage. For maintaining such valuation instances, the following methods are provided:

• INSERT_VAL_INST
  This method inserts specification valuation instances.

• INSERT_VAL_INST_BY_VAT
  This method inserts specification valuation instances that belong to one specific value assignment type.

• UPDATE_VAL_INST
  This method updates valuation instances.

• DELETE_VAL_INST
  This method deletes valuation instances

• RETRIEVE_VAL_INST
  This method retrieves valuation instances

• You can use the optional import IT_SPC_VAL_HDR_KEY to filter for specific valuation headers.

• You can use the optional import IT_SPC_VAL_INST_KEY to filter for specific valuation instances.

• RETRIEVE_VAL_INST_BY_VAT
  This method retrieves all valuation instances belonging to a specific value assignment type.

• You can use the optional import IT_SPC_VAL_HDR_KEY filter for specific valuation headers.

• OVERWRITE_INHERITED_VAL_INST
  This method overwrites an inherited value assignment instance eithertemporarily or permanently. In both cases, the data of the source value assignment instance is copied to this instance.

Valuation Assessment

In value assignment, each data record, that is each value assignment instance, has an assessment. Therefore,there is no need to provide an insert method. There is also no delete method since resetting of an assessmentis done by calling UPDATE_VAL_ASSESSMENT. You can make Customizing settings for the possible assessment values in table TCG71 and they can be accessed using CL_EHCSM_SPC_METADATA_ACCESS~ GET_VAL_ASSESSMENT_LIST.

• UPDATE_VAL_ASSESSMENT
  This method updates the assignment value for specific valuation instances.

• RETRIEVE_VAL_ASSESSMENT
  This method retrieves assessment details of a valuation instance.

Valuation Characteristics Data and Characteristics Values

Characteristics data are structured data belonging to a valuation instance. This API provides the following methods to access and maintain such data:

• INSERT_VAL_CHAR_DATA_SINGLE
  This method inserts characteristics data that belongs to exactly one valuation instance.

• INSERT_VAL_CHAR_DATA
  This method inserts characteristics data that belongs to arbitrary valuation instances and valuations.

• UPDATE_VAL_CHAR_DATA
  This method updates characteristics data that belongs to arbitrary valuation instances and valuations.

• DELETE_VAL_CHAR_DATA
  This method deletes one or more than one piece of specification characteristics data.

• RETRIEVE_VAL_CHAR_DATA_BY_VAT
  This method returns the characteristics data for a specific valueassignment type. If this retrieve is successful, the corresponding profile CL_EHCSM_SPC_PROFILES=>GC_SPC_VAT_ON_DISPLAY is set accordingly to match the Customizing settings that belong to that value assignment type.

Valuation Composition and Substance Listing

Compositions and listings are used to enter the individual components of a specification. The same accessmethods exist for both composition and substance listing. Within Customizing can be distinguished per value assignment type if it supports composition or substance listing.

• INSERT_VAL_COMP
  This method inserts new composition or substance listing data.

• INSERT_VAL_COMP_SIMPLE
  This method creates one new composition or substance listing data for a specific valuation instance.

• INSERT_VAL_COMP_SINGLE
  This method creates one or more than one piece of composition or substance listing data for a specific valuation instance.

• UPDATE_VAL_COMP
  This method updates composition or substance listing data.

• DELETE_VAL_COMP
  This method deletes composition or substance listing entries.

• RETRIEVE_VAL_COMP
  This method retrieves composition or substance listing data.

• You can use the optional import IT_SPC_VAL_HDR_KEY to filter for specific valuation headers.

• You can use the optional import IT_SPC_VAL_INST_KEY to filter for specific valuation instances.

• You can use the optional import IT_SPC_VAL_COMP_KEY to filter for specific valuation composition or substance listing instances.

Valuation Source

You can record a source and an additional note for valuation instances using the following methods:

• INSERT_VAL_SOURCE
  This method inserts new source data for more than one valuation instance.

• INSERT_VAL_SOURCE_SINGLE
  This method inserts new source data for one instance.

• UPDATE_VAL_SOURCE
  This method updates source data.

• DELETE_VAL_SOURCE
  This method deletes source data.

• RETRIEVE_VAL_SOURCE
  This method retrieves source data.

• You can use the optional import IT_SPC_VAL_HDR_KEY to filter for specific valuation headers.

• You can use the optional import IT_SPC_VAL_INST_KEY to filter for specific valuation instances.

• You can use the optional import IT_SPC_VAL_SRC_KEY to filter for specific source instances.

Valuation Text, User Defined Texts, and Documents

To describe a value assignment instance in more detail, you can enter any user defined text and assign documents to it. Such text and documents are accessed through the following methods:

• INSERT_VAL_TXT
  This method inserts user-defined text and documents based on the valuation.

• INSERT_VAL_TXT_SINGLE
  This method inserts user-defined text and documents based on the valuation for a specific valuation instance.

• UPDATE_VAL_TXT
  This method updates user-defined text and documents based on the valuation.

• DELETE_VAL_TXT
  This method deletes user-defined text and documents based on the valuation.

• RETRIEVE_VAL_TXT
  This method retrieves user-defined text and documents based on the valuation.

• You can use the optional import IT_SPC_VAL_HDR_KEY to filter for specific valuation headers.

• You can use the optional import IT_SPC_VAL_INST_KEY to filter for specific valuation instances.

• You can use the optional import IT_SPC_VAL_TXT_KEY to filter for specific source instances.

Valuation Long Text

• INSERT_VAL_LTX
  This method inserts valuation long text.

• INSERT_VAL_LTX_SINGLE
  This method inserts valuation long text that belongs to a specific valuation text and valuation instance.

• UPDATE_VAL_LTX
  This method updates valuation long text.

• DELETE_VAL_LTX
  This method deletes valuation long text.

• RETRIEVE_VAL_LTX
  This method retrieves valuation long text.

• You can use the optional import IT_SPC_VAL_HDR_KEY to filter for specific valuation headers.

• You can use the optional import IT_SPC_VAL_INST_KEY to filter for specific valuation instances.

• You can use the optional import IT_SPC_VAL_TXT_KEY to filter for specific source instances.

Relationships

For more information, see interface IF_EHCSM_SPC_ACCESS_BA.

Example

ABAP Unit Tests and demo reports demonstrate the usage of the CBUI_BO. Most of the CBUI_BO classes consists of local ABAP Unit Test classes. The demo reports are located within the programs folder of package CBUI_BO.

Notes

This class is implemented following the singleton pattern. In consequence, no public constructor exists and you must call the GET_INSTANCE method in order to get an instance of this class.

Further information

CPI1466 during Backup   General Data in Customer Master  
This documentation is copyright by SAP AG.


Length: 43335 Date: 20120526 Time: 115241     triton ( 1021 ms )