{"type":"doc","content":[{"type":"paragraph","content":[{"text":"This method is executed in the implementation class whenever an action is triggered by a decision task by the user in OneList.","type":"text"}]},{"type":"paragraph","content":[{"text":"The actions are configured in OneList and can be used to represent approval decisions made by the user for a specific task for example Approve, Reject, Return, etc. ","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Method Parameters","type":"text"}]},{"type":"table","attrs":{"layout":"full-width"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[124.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[271.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[1405.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[124.0]},"content":[{"type":"paragraph","content":[{"text":"Importing","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[271.0]},"content":[{"type":"paragraph","content":[{"text":"ID_TASK_ID","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1405.0]},"content":[{"type":"paragraph","content":[{"text":"OneList Task ID being actioned (","type":"text"},{"text":"SAP workflow work item ID","type":"text","marks":[{"type":"em"}]},{"text":")","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[124.0]},"content":[{"type":"paragraph","content":[{"text":"Importing","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[271.0]},"content":[{"type":"paragraph","content":[{"text":"ID_ACTION_BY","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1405.0]},"content":[{"type":"paragraph","content":[{"text":"User Name that triggered the action","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[124.0]},"content":[{"type":"paragraph","content":[{"text":"Importing","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[271.0]},"content":[{"type":"paragraph","content":[{"text":"ID_ACTION_ID","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1405.0]},"content":[{"type":"paragraph","content":[{"text":"OneList Action ID","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[124.0]},"content":[{"type":"paragraph","content":[{"text":"Importing","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[271.0]},"content":[{"type":"paragraph","content":[{"text":"ID_ACTION_COMMENT","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1405.0]},"content":[{"type":"paragraph","content":[{"text":"Action comment entered by the user in OneList","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[124.0]},"content":[{"type":"paragraph","content":[{"text":"Importing","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[271.0]},"content":[{"type":"paragraph","content":[{"text":"ID_OBJECT_ID","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1405.0]},"content":[{"type":"paragraph","content":[{"text":"The object ID of the workflow task (","type":"text"},{"text":"generally, the SAP document number being actioned","type":"text","marks":[{"type":"em"}]},{"text":")","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[124.0]},"content":[{"type":"paragraph","content":[{"text":"Exception","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[271.0]},"content":[{"type":"paragraph","content":[{"text":"FAILED_TO_ACTION","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1405.0]},"content":[{"type":"paragraph","content":[{"text":"Raised exception when the action could not be executed","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Method Implementation","type":"text"}]},{"type":"paragraph","content":[{"text":"Custom ABAP logic can be implemented using the import parameters sent by OneList to execute the desired action outcome in SAP. ","type":"text"}]},{"type":"paragraph","content":[{"text":"As an example, the Release and Reject actions for a Purchase Order approval can be implemented as follows:","type":"text"}]},{"type":"codeBlock","content":[{"text":"METHOD execute_action.\n\n DATA: lo_api TYPE REF TO cl_gbapp_apv_po_api.\n\n DATA: lt_approval_decision TYPE gbappt_po_approval_decision,\n ls_approval_decision TYPE LINE OF gbappt_po_approval_decision,\n ls_parameter TYPE LINE OF /iwbep/t_mgw_name_value_pair,\n lt_parameter TYPE /iwbep/t_mgw_name_value_pair,\n ls_action_result TYPE gbapps_action_result.\n\n DATA: ld_po_number TYPE bapimmpara-po_number,\n ld_rel_code TYPE bapimmpara-po_rel_cod.\n\n ld_po_number = id_object_id.\n ld_rel_code = me->get_po_rel_code( id_po_number = ld_po_number ).\n\n lo_api = cl_gbapp_apv_po_api=>get_instance( ).\n\n CHECK ld_rel_code IS NOT INITIAL.\n\n CLEAR ls_approval_decision.\n CLEAR lt_approval_decision.\n ls_approval_decision-workitem_id = id_task_id.\n\n CASE id_action_id.\n WHEN 'RELEASE'.\n ls_approval_decision-decision = '0001'.\n ls_approval_decision-approval_text = id_action_comment.\n\n WHEN 'REJECT'.\n ls_approval_decision-decision = '0002'.\n ls_approval_decision-rejection_text = id_action_comment.\n\n ENDCASE.\n APPEND ls_approval_decision TO lt_approval_decision.\n\n TRY.\n lo_api->set_decision( EXPORTING it_approval_decision = lt_approval_decision\n IMPORTING es_action_result = ls_action_result ).\n CATCH /iwbep/cx_mgw_busi_exception .\n RAISE failed_to_action.\n ENDTRY.\n\n ENDMETHOD.","type":"text"}]},{"type":"paragraph","content":[{"text":"Below are other sample implementations that cater to various OneList decision workflows.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Standard Decision Task","type":"text"}]},{"type":"codeBlock","content":[{"text":" METHOD execute_action.\n\n* Call default OneList action via Decision Task\n\n DATA: lv_wi_id TYPE swr_struct-workitemid,\n lv_new_wi_status TYPE sww_wistat,\n lv_return_code LIKE sy-subrc,\n lt_message_lines TYPE TABLE OF swr_messag,\n lt_message_struct TYPE TABLE OF swr_mstruc,\n ls_container_simple TYPE swr_cont,\n lt_container_simple TYPE swrtcont,\n lv_status TYPE tim_req_status,\n\n lv_decision_key TYPE swr_decikey,\n lv_decision_note TYPE swrsobjid,\n lv_rc TYPE sy-subrc,\n lv_comment_str TYPE string,\n lv_comnam TYPE text255 VALUE gc_comnam,\n lwa_return TYPE bapiret2,\n lv_newstat TYPE sww_wistat,\n\n lt_msglines TYPE STANDARD TABLE OF swr_messag,\n lt_msgstruct TYPE STANDARD TABLE OF swr_mstruc,\n\n lv_new_date_char(10),\n lv_new_date TYPE datum,\n lv_escalated TYPE flag,\n lv_must_be_after TYPE dats.\n\n FIELD-SYMBOLS: TYPE swr_messag,\n TYPE swr_mstruc.\n\n CLEAR: lv_new_date, lv_new_date_char.\n\n lv_wi_id = id_task_id.\n lv_decision_key = id_action_id.\n lv_decision_note = id_action_comment.\n\n CALL FUNCTION 'SAP_WAPI_DECISION_COMPLETE'\n EXPORTING\n workitem_id = lv_wi_id\n user = id_action_by\n decision_key = lv_decision_key\n decision_note = lv_decision_note\n IMPORTING\n return_code = lv_rc\n new_status = lv_newstat\n TABLES\n message_lines = lt_message_lines\n message_struct = lt_message_struct.\n\n IF lv_rc IS NOT INITIAL.\n READ TABLE lt_message_lines INDEX 1 ASSIGNING FIELD-SYMBOL().\n MESSAGE ID zcacl_ol_scenario_adpt=>gc_message_id_error\n TYPE -msg_type\n NUMBER zcacl_ol_scenario_adpt=>gc_message_no_error\n WITH -line RAISING failed_to_action.\n ENDIF.\n\n ENDMETHOD.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"HCM Task","type":"text"}]},{"type":"codeBlock","content":[{"text":" METHOD execute_action.\n DATA: lt_messages TYPE hrasr_return_tab,\n lt_attachments TYPE hrasr00attachment_tab,\n lt_form_field_values TYPE hrasr_special_param_tab,\n lt_input_help_values TYPE hrasr_special_param_tab,\n lt_field_ui_attributes TYPE hrasr_uiattribute_param_tab,\n lt_events TYPE hrasr00form_events_tab,\n lt_link_lists TYPE hrasr00link_tab,\n lt_history_details TYPE hrasr00step_attributes_ui_tab.\n\n DATA: lv_event TYPE syucomm,\n lv_ok TYPE abap_bool,\n lv_wi_id TYPE swr_struct-workitemid,\n lv_notes TYPE hrasr_s_special_param-fieldvalue.\n\n lv_wi_id = iv_task_id.\n\n lv_notes = iv_action_comment.\n\n lv_event = if_hrasr00_ui_constants=>c_event_initialize.\n\n \" First, initialize\n CALL FUNCTION 'HRASR_PROCESS_EXECUTE'\n EXPORTING\n iv_wi_id = lv_wi_id\n iv_event = lv_event\n IMPORTING\n ev_is_ok = lv_ok\n et_messages = et_messages\n CHANGING\n ct_attachments = lt_attachments\n ct_form_field_values = lt_form_field_values\n ct_input_help_values = lt_input_help_values\n ct_field_ui_attributes = lt_field_ui_attributes\n ct_events = lt_events\n ct_link_lists = lt_link_lists\n ct_history_details = lt_history_details.\n IF lv_ok EQ abap_false.\n RAISE failed_to_action.\n ENDIF.\n\n* Prepare notes\n IF lv_notes IS NOT INITIAL.\n TRY.\n lt_form_field_values[ fieldname = gc_hrasr_current_note ]-fieldvalue = lv_notes.\n CATCH cx_sy_itab_line_not_found.\n INSERT VALUE #( fieldname = gc_hrasr_current_note\n fieldvalue = lv_notes )\n INTO TABLE lt_form_field_values.\n ENDTRY.\n ENDIF.\n\n CLEAR lv_ok.\n\n CASE iv_action_id.\n WHEN gc_ol_action_id_approve. \"APPROVE\n lv_event = if_hrasr00_fpm_constants=>c_event_approve.\n WHEN gc_ol_action_id_reject. \"REJECT\n lv_event = if_hrasr00_fpm_constants=>c_event_reject.\n WHEN gc_ol_action_id_back. \"BACK\n lv_event = if_hrasr00_fpm_constants=>c_event_backto.\n WHEN OTHERS.\n ENDCASE.\n\n CALL FUNCTION 'HRASR_PROCESS_EXECUTE'\n EXPORTING\n iv_wi_id = lv_wi_id\n iv_event = lv_event\n IMPORTING\n ev_is_ok = lv_ok\n et_messages = et_messages\n CHANGING\n ct_attachments = lt_attachments\n ct_form_field_values = lt_form_field_values\n ct_input_help_values = lt_input_help_values\n ct_field_ui_attributes = lt_field_ui_attributes\n ct_events = lt_events\n ct_link_lists = lt_link_lists\n ct_history_details = lt_history_details.\n IF lv_ok EQ abap_false.\n TRY.\n zhrcl_hrasr_ui5_connector=>wait_for_workitem_status( iv_wi_id = lv_wi_id\n iv_wi_stat = gc_wi_stat_completed ). \"COMPLETED\n CATCH zcx_hrasr_ui5_exception.\n RAISE failed_to_action.\n ENDTRY.\n ENDIF.\n ENDMETHOD.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"SRM Task","type":"text"}]},{"type":"codeBlock","content":[{"text":" METHOD execute_action.\n\n CONSTANTS: lc_return_success TYPE bapi_mtype VALUE 'S',\n lc_return_error TYPE bapi_mtype VALUE 'E'.\n\n DATA: lv_wi_id TYPE swr_struct-workitemid,\n lv_decision TYPE bbp_following_action,\n lo_bbp_obj TYPE REF TO cl_bbp_smtp_inbound_offapp.\n\n DATA: lv_new_wi_status TYPE sww_wistat,\n lv_return_code LIKE sy-subrc,\n lt_message_lines TYPE TABLE OF swr_messag,\n lt_message_struct TYPE TABLE OF swr_mstruc,\n ls_container_simple TYPE swr_cont,\n lt_container_simple TYPE swrtcont,\n lv_new_date_char(10),\n lv_new_date TYPE datum,\n lv_escalated TYPE flag,\n lv_objid TYPE crmt_object_id_db,\n lv_objtype TYPE crmt_subobject_category_db,\n lv_objguid TYPE bbp_guid,\n lv_objguid2 TYPE bbp_guid_32,\n lv_action TYPE bbp_wfl_action,\n lv_objchanged TYPE xfeld,\n lv_must_be_after TYPE dats,\n\n lv_comment_str TYPE string,\n lv_comnam TYPE text255 VALUE 'Approver Comments',\n lwa_return TYPE bapiret2,\n\n lv_wfelem TYPE swc_elem,\n lv_sc_guid TYPE /sapsrm/wf_document_guid,\n lv_sc_wiid TYPE /sapsrm/wf_workitem_id,\n lv_sc_agent TYPE /sapsrm/wf_agent_id,\n lv_sc_decision TYPE /sapsrm/wf_decision,\n lv_return TYPE syst_subrc.\n\n DATA: lt_simpcont TYPE STANDARD TABLE OF swr_cont.\n\n FIELD-SYMBOLS: TYPE swr_object,\n TYPE bapiret2,\n TYPE swr_cont,\n TYPE /IQX/OL_WF_CONTAINER_SINGLE_ST.\n\n WRITE: / 'id_task_id:', id_task_id.\n WRITE: / 'id_action_id:', id_action_id.\n\n lv_wi_id = id_task_id.\n lv_decision = id_action_id.\n\n* Add approver comments, if there's any\n IF id_action_comment IS NOT INITIAL.\n CLEAR: lwa_return.\n CALL METHOD zprcl_onelist_scart_adapter=>add_approval_notes\n EXPORTING\n im_wiid = lv_wi_id\n im_comment = lv_comment_str\n IMPORTING\n ex_return = lwa_return.\n IF lwa_return-type EQ lc_return_success.\n* Successfully added, do nothing.\n ENDIF.\n\n ENDIF.\n\n* Read details of WI\n* Get workflow container data\n CALL FUNCTION 'SAP_WAPI_READ_CONTAINER'\n EXPORTING\n workitem_id = lv_wi_id\n IMPORTING\n return_code = lv_return\n TABLES\n simple_container = lt_simpcont.\n\n lv_wfelem = 'BOID'.\n READ TABLE lt_simpcont ASSIGNING \n WITH KEY element = lv_wfelem.\n IF sy-subrc EQ 0.\n\n lv_sc_guid = -value.\n lv_sc_wiid = id_task_id.\n lv_sc_agent = id_action_by.\n lv_sc_decision = id_action_id.\n\n WRITE: / 'lv_sc_guid:', lv_sc_guid.\n WRITE: / 'lv_sc_wiid:', lv_sc_wiid.\n WRITE: / 'lv_sc_agent:', lv_sc_agent.\n WRITE: / 'lv_sc_decision:', lv_sc_decision.\n\n CALL METHOD /sapsrm/cl_wf_process_mgr_sbwf=>system_decision\n EXPORTING\n iv_document_guid = lv_sc_guid\n iv_workitem_id = lv_sc_wiid\n iv_agent_id = lv_sc_agent\n iv_decision = lv_sc_decision.\n IF sy-subrc EQ 0.\n WRITE: / 'system_decision successful.'.\n ENDIF.\n ELSE.\n MESSAGE ID '00' TYPE 'E' NUMBER 398\n WITH 'Unable to find document.' RAISING failed_to_action.\n ENDIF.\n\n ENDMETHOD.","type":"text"}]}],"version":1}

Browser not supported