Program Exits in Work Item for Workflow.docx
- 文档编号:13733896
- 上传时间:2023-06-16
- 格式:DOCX
- 页数:16
- 大小:787.69KB
Program Exits in Work Item for Workflow.docx
《Program Exits in Work Item for Workflow.docx》由会员分享,可在线阅读,更多相关《Program Exits in Work Item for Workflow.docx(16页珍藏版)》请在冰点文库上搜索。
ProgramExitsinWorkItemforWorkflow
ProgramExitsinWorkItemforWorkflow
ByAnirbanBhattacharjee,KPITCumminsandInfosystemsfrom Link
Purpose:
ThepurposeofthisdocumentistodemonstratehowtouseProgramExitsinaWorkItemforWorkflow.
BusinessScenario:
Manytimeswehavescenarioswherewewanttodosomeadditionalcustomprocessingwhenaworkitemiscreatedorexecuted.
SAPhasgivenusawaybywhichwecandesignProgramExitsinaworkitem.Theeventsonwhichwecanprogramthisarementionedbelow
∙BeforeWorkItemCreation
∙AfterWorkItemCreation
∙BeforeWorkItemExecution
∙ AfterWorkItemExecution
∙AftertheexecutionofaSynchronousObjectMethodintheworkitem
∙BeforePhysicalDeletionoftheWorkItem
∙OntheStatusChangeofaWorkItem
∙OnaRuleexecutionintheWorkItem
∙AfteranactionexecutionintheWorkItem
∙BeforeandactionexecutionintheWorkItem
Wewillseethattheclasswewillmodellateroninthistutorialwillcontainthemethodsthatcanbeimplementedforhandlingtheaboveevents.
Herewewillsende-mailviathisProgramExitoncewhenaworkitemiscreatedandoncewhenitisexecuted.
Therewillbenoe-mailstepsmodeledintheworkflow.Theywillhappensolelyfromtheprogramexit.
ProcesstodesigntheProgramExitinaWorkItem
Letuslookatthetabinaworkitemwherethisexitisdesigned
NotethattheSAPDocumentationstatesthattheclassthatwillbemodeledheremustsupporttheIF_SWF_IFS_WORKITEM_EXIT interface.PleaseensurethatinsidethisclasswewillnotbeusinganyABAPInstructionthatcanreleasethecurrentLUWlikeCOMMITWORK,ROLLBACKWORKorusingRFCFunctionCalls.
NowwewilldesignaclassviathetransactionSE24.Wewillcallthisclass ZZCL_WORK_ITEM_EXIT.
The Properties taboftheclasswilllookasshown.Wewilladdthetypegroup SWRCO
Wewillnowdeclaretheinterface IF_SWF_IFS_WORKITEM_EXIT intheinterfacetab
Oncewedeclaretheinterface,theattributesrelatedtothisinterfacewillappearinthe Attributes Tab.
Noticetheeventsthatcanhappenwithaworkiteminthe Description column. Thisiswhatwasmentionedatthestartofthetutorial.
Wewillnowaddacoupleofcustomattributesasmentionedbelow:
WI_CONTEXT asatypereferenceto IF_WAPI_WORKITEM_CONTEXT;thisinterfacereturnsthevariousattributesofaworkitem.
Displayingthisinterfacevia SE24 andshowingyouthemethods
Toseehowtoimplementthesemethodsinaclass,pleaserefer CL_SWF_RUN_WORKITEM_CONTEXT.
Thisclassisveryhelpfultounderstandhowtodovariousoperationsonaworkitem.
Theothercustomattributewillbenamed PROCESS_STATUS.Thiswillcontainadefaultvalue‘sap.bc.bmt.wfm.process.status’.
Theattributestabnowlookslikeasshownbelow
Boththeattributesare InstanceAttribute and Private visibility.
Nowletusnavigatetothe Methods Tabofthisclass.
Theonlymethodcreatedbydefaultis EVENT_RAISED.ThiswillbecalledwhenevertheWorkItemEvents(mentionedatthestartofthetutorial)aretriggered.
Theparametersthatappearinthismethodare
(Notethatthereisaparameter IM_WORKITEM_CONTEXT whichrefersinterface IF_WAPI_WORKITEM_CONTEXT)
Nowwewillcreatetwomoremethodscalled AFTER_WI_CREATION and AFTER_WI_EXECUTION asshown.
Boththemethodsare InstanceMethod with Private Visibility.
Writethefollowingcodeinthe AFTER_WI_CREATION method
(Thiscodewillsendane-mailtoadummye-mailIDwiththeWorkItemIDstatingthatitwas Created. Willtriggerafterworkitemiscreated)
METHOD after_wi_creation.
DATA:
lcl_v_wi_id TYPE sww_wiid, "Work Item ID
lv_wid_text TYPE char12,
send_request TYPE REF TO cl_bcs,
text TYPE bcsy_text,
body_text TYPE so_text255,
document TYPE REF TO cl_document_bcs,
sender TYPE REF TO cl_sapuser_bcs,
recipient TYPE REF TO if_recipient_bcs,
bcs_exception TYPE REF TO cx_bcs,
sent_to_all TYPE os_boolean.
* For simplicity of the demo, we are only fetching the work item ID
* You can get the complete work item and workflow details as well
* Please refer class CL_SWF_RUN_WORKITEM_CONTEXT and interface IF_WAPI_WORKITEM_CONTEXT
* Get the Work Item ID
CALL METHOD wi_context->get_workitem_id
RECEIVING
re_workitem = lcl_v_wi_id.
* Pass WID to text field
CLEAR:
lv_wid_text.
lv_wid_text = lcl_v_wi_id.
*----------------------------------------------------------------------------------------*
* Send an e-mail to a dummy e-mail ID stating that the above Work Item has been created
*----------------------------------------------------------------------------------------*
TRY.
* -------- create persistent send request ------------------------
send_request = cl_bcs=>create_persistent( ).
* -------- create and set document -------------------------------
* Build the e-mail Body
CLEAR:
body_text.
CONCATENATE 'Work Item Created. WID:
'
lv_wid_text INTO body_text SEPARATED BY space.
APPEND body_text TO text.
document = cl_document_bcs=>create_document(
i_type = 'RAW'
i_text = text
i_length = '12'
i_subject = 'E-Mail sent AFTER Work Item Creation' ).
* Add document to send request
CALL METHOD send_request->set_document( document ).
* --------- set sender -------------------------------------------
* note:
this is necessary only if you want to set the sender
* different from actual user (SY-UNAME). Otherwise sender is
* set automatically with actual user.
sender = cl_sapuser_bcs=>create( sy-uname ).
CALL METHOD send_request->set_sender
EXPORTING
i_sender = sender.
* --------- Add recipient (e-mail address) -----------------------
* Create recipient - passing a dummy e-mail ID here
recipient = cl_cam_address_bcs=>create_internet_address('anirban@' ).
* Add recipient with its respective attributes to send request
CALL METHOD send_request->add_recipient
EXPORTING
i_recipient = recipient
i_express = 'X'.
* ---------- Send document ---------------------------------------
CALL METHOD send_request->send(
EXPORTING
i_with_error_screen = 'X'
RECEIVING
result = sent_to_all ).
COMMIT WORK.
* -----------------------------------------------------------
* * exception handling
* -----------------------------------------------------------
CATCH cx_bcs INTO bcs_exception.
* Writeowncodetocatchexception
ENDTRY.
ENDMETHOD.
Writethefollowingcodeinthe AFTER_WI_EXECUTION method
(Thiscodewillsendane-mailtoadummye-mailIDwiththeWorkItemIDstatingthatitwas Executed. Willtriggerafterworkitemisexecuted)
METHOD after_wi_creation.
DATA:
lcl_v_wi_id TYPE sww_wiid, "Work Item ID
lv_wid_text TYPE char12,
send_request TYPE REF TO cl_bcs,
text TYPE bcsy_text,
body_text TYPE so_text255,
document TYPE REF TO cl_document_bcs,
sender TYPE REF TO cl_sapuser_bcs,
recipient TYPE REF TO if_recipient_bcs,
bcs_exception TYPE REF TO cx_bcs,
sent_to_all TYPE os_boolean.
* For simplicity of the demo, we are only fetching the work item ID
* You can get the complete work item and workflow details as well
* Please refer class CL_SWF_RUN_WORKITEM_CONTEXT and interface IF_WAPI_WORKITEM_CONTEXT
* Get the Work Item ID
CALL METHOD wi_context->get_workitem_id
RECEIVING
re_workitem = lcl_v_wi_id.
* Pass WID to text field
CLEAR:
lv_wid_text.
lv_wid_text = lcl_v_wi_id.
*----------------------------------------------------------------------------------------*
* Send an e-mail to a dummy e-mail ID stating that the above Work Item has been created
*----------------------------------------------------------------------------------------*
TRY.
* -------- create persistent send request ------------------------
send_request = cl_bcs=>create_persistent( ).
* -------- create and set document -------------------------------
* Build the e-mail Body
CLEAR:
body_text.
CONCATENATE 'Work Item EXECUTED. WID:
'
lv_wid_text INTO body_text SEPARATED BY space.
APPEND body_text TO text.
document = cl_document_bcs=>create_document(
i_type = 'RAW'
i_text = text
i_length = '12'
i_subject = 'E-Mail sent AFTER Work Item EXECUTION' ).
* Add document to send request
CALL METHOD send_request->set_document( document ).
* --------- set sender -------------------------------------------
* note:
this is necessary only if you want to set the sender
* different from actual user (SY-UNAME). Otherwise sender is
* set automatically with actual user.
sender = cl_sapuser_bcs=>create( sy-uname ).
CALL METHOD send_request->set_sender
EXPORTING
i_sender = sender.
* --------- Add recipient (e-mail address) -----------------------
* Create recipient - passing a dummy e-mail ID here
recipient = cl_cam_address_bcs=>create_internet_address('anirban@' ).
* Add recipient with its respective attributes to send request
CALL METHOD send_request->add_recipient
EXPORTING
i_recipient = recipient
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- Program Exits in Work Item for Workflow