Logic of SAVE_EC function module in One Order
In previous blogs the READ and UPDATE logic of Opportunity header field Closing Date are explained:
In this blog we will research what happens when end user clicks save button after Closing Date is changed in WebClient UI.
This time we use naming convention CRM*SAVE_EC* to list the function modules which will be responsible to trigger the persistence of the change into corresponding database table.
The corresponding function module for Opportunity header is: CRM_OPPORT_H_SAVE_EC
The research could be done from below report:
REPORT zoneorder_modify. CONSTANTS: gv_guid TYPE crmt_object_guid VALUE '6C0B84B759DF1ED6BDF05763B3DC8841'. DATA: lt_opport_h TYPE crmt_opport_h_comt, ls_opport_h LIKE LINE OF lt_opport_h, lt_change TYPE crmt_input_field_tab, ls_change LIKE LINE OF lt_change, lt_saved TYPE crmt_return_objects, lt_exception TYPE crmt_exception_t, lt_to_save TYPE crmt_object_guid_tab, lt_not_to_save TYPE crmt_object_guid_tab. ls_opport_h-ref_guid = gv_guid. ls_opport_h-expect_end = '20170217'. ls_change = VALUE #( ref_guid = gv_guid ref_kind = 'A' objectname = 'OPPORT_H' ). APPEND 'EXPECT_END' TO ls_change-field_names. APPEND ls_change TO lt_change. APPEND ls_opport_h TO lt_opport_h. CALL FUNCTION 'CRM_ORDER_MAINTAIN' EXPORTING it_opport_h = lt_opport_h CHANGING ct_input_fields = lt_change EXCEPTIONS error_occurred = 1 document_locked = 2 no_change_allowed = 3 no_authority = 4. APPEND gv_guid TO lt_to_save. CALL FUNCTION 'CRM_ORDER_SAVE' EXPORTING it_objects_to_save = lt_to_save iv_update_task_local = abap_true IMPORTING et_saved_objects = lt_saved et_exception = lt_exception et_objects_not_saved = lt_not_to_save EXCEPTIONS document_not_saved = 1. WRITE: / sy-subrc. COMMIT WORK AND WAIT.
Execute the report via tcode SAT, and we can find out that the persistence of Opportunity header field consists of two steps:
2. Update function module CRM_OPPORT_H_UPDATE_DU
The left part of this blog will explain these two steps in more detail.
The reason why CRM_OPPORT_H_SAVE_EC is called during save is because it is registered as callback for event SAVE in order CRMV_EVENT:
Update on 2017-04-24 4:27PM in Walldorf
How this registration information is loaded in the runtime could be found from this wiki page.
This callback function module does not have any logic but directly delegates the call to CRM_OPPORT_H_SAVE_OB, which calls a generic function module CRM_ORDER_TABLE_SAVE to determine the kind of current change ( Insert, Update or Delete ) and call update function module CRM_OPPORT_H_UPDATE_DU to perform database change.
CRM_ORDER_TABLE_SAVE consists of the following steps:
(1) call CRM_OBJECT_NAMES_DETERMINE to get corresponding DDIC object names and update function module name for OPPORT_H.
(2) call CRM_ORDER_UPDATE_TABLES_DETERM to extract the detail changed data. In my example, 1 update operation is detected for OPPORT_H.
The change of closing date specified by code is already included in <RECORDS_TO_UPDATE>:
How this change detection is done?
First Opportunity header object buffer( latest data) is retrieved via CRM_OPPORT_H_GET_MULTI_OB:
Then database buffer is read via CRM_OPPORT_H_GET_MULTI_DB:
By comparison on these two buffer we can know the given opportunity has a change on Closing Date field in header level.
It simply inserts the guid of changed opportunity to be saved into a global internal table gt_guids_to_save.
(4) call update function module CRM_OPPORT_H_UPDATE_DU
In my example report, the execution of this update function module is triggered by COMMIT WORK AND WAIT.
The corresponding OPEN SQL statement is executed according to changed data in INSERT, UPDATE or DELETE mode.
I have written a series of blogs to explain how One Order API works. The blogs are written based on a simple scenario: read, change and save field “Closing Date” in Opportunity header level.