Hierarchy
EA-FIN (Software Component) EA-FIN⤷
RE-FX (Application Component) Flexible Real Estate Management⤷
RE_CA_CU (Package) RE: Customizing (IMG) and Area Menu
IMG Activity
| ID | REFX_REIS_RM | Implement Enhancement for Records Management (BAdI) |
| Transaction Code | S_PLN_62000233 | (empty) |
| Created on | 20040226 | |
| Customizing Attributes | REFX_REIS_RM | Implement Enhancement for Records Management (BAdI) |
| Customizing Activity | REFX_REIS_RM | Implement Enhancement for Records Management (BAdI) |
Document
| Document Class | SIMG | Hypertext: Object Class - Class to which a document belongs. |
| Document Name | REIS_RM |
Use
By implementing this Business Add-In (BAdI) you can replace the standard system procedure for creating a record. You can use this Business Add-In only if you want to use SAP Records Management to manage your documents. For more information about this, and about activating the creation of records, see Customizing under Make Basic Settings for Records Management.
If you do not implement this BAdI, then the default implementation is used (global class CL_DEF_IM_REIS_RM).
The implementation of the Business Add-In is based on the object type (filter value of the BAdI). When you create an implementation, you define for which object types (for example, contract, rental object, or building) your implemented method is to be applied. If you create an implementation for multiple object types, then the filter value (parameter FLT_VAL) that contains the current object type must always be considered in the code. Therefore, for the sake of transparency, it is better to create separate implementations for each object type.
Requirements
Standard settings
Activities
You can use the following methods, which are called automatically by the system and used to create or process a record.
- CREATE_RECORD
An implementation of this method has to create precisely one record for the real estate object. However, the method must not call COMMIT WORK or ROLLBACK WORK, since these controls are the responsibility of the standard program. If an error occurs during the creation process, then trigger the exception ERROR with the statement MESSAGE ...RAISING error.
To create the record, you then use only the BAPI function modules from Records Management. The names of these function modules are prefixed by BAPI_RECORD_*, and the function modules are documented. You can also use the default implementation in class CL_DEF_IM_REIS_RM, method CREATE_RECORD as a guide.
The standard setting is for the record to be created on the basis of the folder model defined in Customizing. This setting is dependent on the object type. The four key fields that are required are populated with values from Customizing and transferred as parameters:
- ID_RMS_ID: ID from the Records Management system
- ID_SPS_ID: Element type of the record that is to be created
- ID_MODEL_SPS_ID: Element type of the record model
- ID_MODEL: ID of the record model
If, however, you want to use multiple record models within one object type, when you create the record, do not use the parameter ID_MODEL according to Customizing. Instead, use the ID of a different record model that is already defined. In this way, you can, for example, have different record structures for customer and vendor contracts.
To read the data of the current real estate object (such as the contract type), in the BAdI implementation, call function module API_RE_xx_GET_DETAIL with the parameter IO_OBJECT = IO_OBJECT . Replace xx with the English abbreviation for the relevant object type, for example API_RE_CN_GET_DETAIL for the real estate contract. For examples relating to this, see the various methods of the default implementation.
If you want to create the new record on the basis of the underlying record model, or if you want to use additional properties for the record, then you need to use an implementation of this method.
- GET_RECORD
The default implementation of this method in class CL_DEF_IM_REIS returns a list of the records found for a real estate object. If you have changed the properties of the records in the method CREATE_RECORD, then you need this method to be able to find the records.
- IS_PROPERTY_SELECTION: Search criteria for records for BOR object key of the real estate object
- CT_RESULTING_LIST: List of the records found
- CF_PROCESSED: Indicator that BAdI was executed. Set the indicator when you have implemented the method.
- DISPLAY_RECORD
The default implementation of this method in class CL_DEF_IM_REIS shows the record found for a real estate object using GET_RECORD. If you want to use a display different from the standard display, you need this method.
- IS_RECORD: Record to be displayed
- IF_MODIFY: Change mode indicator
- CF_PROCESSED: Indicator that BAdI was executed. Set the indicator when you have implemented the method.
Note that when implementing the BAdI you are not allowed to use statements that affect the interface, such as direct output of messages using MESSAGE without the addition RAISING.
Example
Business Attributes
| ASAP Roadmap ID | 153 | Design enhancements |
| Mandatory / Optional | 2 | Optional activity |
| Critical / Non-Critical | 2 | Non-critical |
| Country-Dependency | A | Valid for all countries |
Maintenance Objects
| Maintenance object type | E | Business Add-In - Definition |
History
| Last changed by/on | SAP | 20040226 |
| SAP Release Created in | 500 |
