SAP Workflow: A Comprehensive Guide to Troubleshooting and Debugging

by Thomas Nittmann, Dataxstream, LLC Table of Contents Introduction .......................................................................................................................................2 Primary Components........................................................................................................................2 Base Line Configuration ...................................................................................................................3 Event Debugging ............................................................................................................................13 Problem1 Event Linkage:............................................................................................................14 Resolution to Problem 1:.............................................................................................................14 Problem 2 Event Parameters:.....................................................................................................15 Resolution A to Problem 2: .........................................................................................................16 Resolution B to Problem 2: .........................................................................................................24 Additional Event Information: ......................................................................................................29 Agent Resolution Debugging..........................................................................................................35 Problem 3 Agent Resolution: ......................................................................................................35 Resolution to Problem 3:.............................................................................................................35 Workflow Task (Method) Debugging ..............................................................................................50 Foreground (Dialog) Tasks .........................................................................................................50 Background (Synchronous) Tasks..............................................................................................55 Summary of Trouble Shooting Transactions ..................................................................................70

Copyright 2003 by Klee Associates, Inc. www.SAPtips.com

Page 1

SAP Workflow: A Comprehensive Guide to Troubleshooting and Debugging Introduction

This article focuses on practical techniques to assist in the debugging and resolving of workflow issues during the development and production support phases of SAP implementations. The SAP workflow application incorporates the use of several components: a graphical editing tool (Workflow Builder), some object-oriented concepts (using the Business Object Repository), ABAP, and a hook/trigger mechanism into the SAP application modules (FI, CO, MM, etc). As business requirements are mapped into a workflow process definition and prototyping starts, debugging becomes an essential tool to expedite the implementation of workflow processes. In this white paper, we will concentrate on the use of debugging techniques to resolve real-world workflow implementation and production support issues. Before we begin, lets list some preliminary assumptions and guidelines: The workflow engine has already been enabled. We are working with SAP Release 4.6C. There are significant changes and enhancement in release 6.1/6.2 SAP workflow technology. SAP Workflow is part of the Basis system, and future enhancements are incorporated into the Web Application Server (WAS). The next version of R/3 functional applications is called R/3 4.7, and is based on the 6.x version of the WAS. The user should be familiar with basic workflow configuration and development, e.g., that workflow type TS is a single step task and type WS is a multi-step task.

Since workflow has many different elements, starting the debugger is not as straight forward as with a stand-alone ABAP program. To illustrate the best way to step in and resolve issues by debugging, we will start by looking at a copy of the standard SAP workflow template for the overall release of MM purchase requisitions. The debugging principles applied may be used with any workflow templates (customer defined or standard). A custom workflow template (WS) is being used to illustrate the use of debugging concepts on background tasks. A new custom single step task (TS) has been created for notifying the creator of the purchase requisition release, and replaces the Dialog Foreground Task that requests the creator to manually confirm a work item.

Primary Components
Each workflow consists of several components that are best described by answering the following questions: When should the workflow start? The answer to this question assists in determining the event triggering mechanism that starts the workflow. What steps need to occur, i.e., what tasks (transactions and/or background items need to be performed) need to occur? Who performs the tasks, i.e., the agent resolution?

As we proceed, we will review problem solving and debugging techniques used in each of these components. Copyright 2003 by Klee Associates, Inc. www.SAPtips.com Page 2

SAP Workflow: A Comprehensive Guide to Troubleshooting and Debugging Base Line Configuration
First, lets break down the CUSTOM release workflow into its primary multi-step and single-step tasks. Custom Workflow Template WS99500034 (zwf_req_rel) is the multi-step task for the overall purchase requisition and is a copy of the standard template WS20000077. It contains several single-step (TS) tasks. Single-step task TS20000159 (mm_req_rel_c) is a dialog foreground task for the overall release of the workflow. Method BUS2105-SINGLERELEASE. Single-step task TS20000163 (mm_req_res_c) is a dialog foreground task that requests the creator of the requisition to confirm that the Requisition Release was cancelled. Method BUS2105- INFORELEASERESET. Single-step task TS20000161 (mm_req_rej_c) is a dialog foreground task that requests the creator of the requisition to confirm that the Requisition Release was refused. Method BUS2105-INFORELEASEREJECTED. Single-step task TS99500020 (zmm_req_ok) is a custom background task that replaces the standard task TS20000162 (Requisition Released). The purpose of having a background task is to eliminate the additional work that would be required by confirming a foreground dialog work item, i.e., we only want to send a notification and not a work item to the creator of the requisition. We enable a notification with the custom background task and method ZBUS2105-ZNOTIFYREQRELEASE.

Next, review the requisition release Workflow Builder Process Flow: Note: to display the delivered SAP Workflow, use transaction PFTC > enter Workflow Template for Task Type > enter 20000077 for task > click on display > click on workflow builder.

Copyright 2003 by Klee Associates, Inc. www.SAPtips.com

Page 3

SAP Workflow: A Comprehensive Guide to Troubleshooting and Debugging

Figure 1: Workflow Builder Process Flow (Don't worry if you can't read the smallest print on this screen shot - it's hard to read the smallest print on the process flow even inside SAP. What's important is the overall process flow). The Requisition Overall Release Workflow is pre-delivered by SAP, and even though we created a custom version of the workflow, there is some baseline configuration required to activate it. Many (but not all) pre-defined workflows require some sort of IMG configuration. Lets review the application configuration: Note: to find the on-line R/3 documentation for workflow, navigate to: Basis Components > Business Management (BC-BMT) > SAP Business Workflow (BC-BMT-WFM) > Reference Documentation > BC Workflow Scenarios in Applications (BC-BMT-WFM) > MM Materials Management: Workflow Scenarios Use transaction OMEB to activate the Overall Release for the Purchase Requisition document type. Note: SAP initially delivered line item release strategies and later enhanced the application with an overall release. The Purchase Copyright 2003 by Klee Associates, Inc. www.SAPtips.com Page 4

SAP Workflow: A Comprehensive Guide to Troubleshooting and Debugging

Requisition application is built on one table (EBAN) and is not separated into header and line item tables like most other applications.

Figure 2: Requisition Workflow Types Classification (area menu transaction CL00) is required to set up class and characteristic values used to determine the release strategy. Create Characteristic Values (CT01)

Figure 3: Create Characteristic screen displaying Basic data tab

Copyright 2003 by Klee Associates, Inc. www.SAPtips.com

Page 5

SAP Workflow: A Comprehensive Guide to Troubleshooting and Debugging

Figure 4: Create Characteristic screen displaying Addnl Data tab

Figure 5: Create Characteristic screen displaying Values tab Set up an overall release class (CL01), assign it to class type 032, and assign a Characteristic Value to it.

Copyright 2003 by Klee Associates, Inc. www.SAPtips.com

Page 6

SAP Workflow: A Comprehensive Guide to Troubleshooting and Debugging

Class Basic Data

Figure 6: Change Class screen displaying Basic data tab Class Assignment to Characteristic Values

Figure 7: Change Class screen displaying Characteristic tab Copyright 2003 by Klee Associates, Inc. www.SAPtips.com Page 7

SAP Workflow: A Comprehensive Guide to Troubleshooting and Debugging

3. Transaction OMGQ is required to activate the event trigger mechanism from the MM requisition application. Release Group:

Figure 8: Change View Release Groups: Overview screen Release code:

Figure 9: Change View Release Codes: Overview screen Release Indicators:

Figure 10: Change View Release Indicator: Overview screen

Copyright 2003 by Klee Associates, Inc. www.SAPtips.com

Page 8

SAP Workflow: A Comprehensive Guide to Troubleshooting and Debugging

Release Strategy

Figure 11: Change View Release Strategies: Overview screen

Figure 12: Change View Release Strategies: Details screen

Copyright 2003 by Klee Associates, Inc. www.SAPtips.com

Page 9

SAP Workflow: A Comprehensive Guide to Troubleshooting and Debugging

Figure 13: Release Statuses dialog box

Figure 14: Change View Release Strategies: Classification screen

Copyright 2003 by Klee Associates, Inc. www.SAPtips.com

Page 10

SAP Workflow: A Comprehensive Guide to Troubleshooting and Debugging

Workflow

Figure 15: Change View Assignment of Role to Release Code: Overview screen Note: we are currently using the default agent resolution provided by SAP release strategy configuration (OMGQ). We will discuss the use of plant in the agent resolution process below. 4. Generate Class Statistics via transaction CLST (class type 032). This optimizes the SAP search process for all characteristics created for the classification. 5. Any user that releases requisitions must be assigned M_EINK_FRGAL authorization (PFCG/SU01).

Copyright 2003 by Klee Associates, Inc. www.SAPtips.com

Page 11

SAP Workflow: A Comprehensive Guide to Troubleshooting and Debugging

Figure 16: Change role: Authorizations screen 6. Lastly, make sure the event linkage is set up via SWE2.

Figure 17: New Entries: Details of Added Entries screen Copyright 2003 by Klee Associates, Inc. www.SAPtips.com Page 12

SAP Workflow: A Comprehensive Guide to Troubleshooting and Debugging Event Debugging

As you can see, there was a significant amount of work required to set up a very simple example of the release workflow for purchase requisitions, however, we are now ready to go! Workflows are primarily triggered based on events generated by applications. Once the baseline configuration is complete, we would expect the purchase requisition application to trigger events that will start workflow when we create purchase requisitions that meet our criteria, e.g., any purchase requisition w/ document type NB and a total value over USD1000.00 (based on our OMGQ configuration). Lets create the requisition. The requisition release workflow uses trigger events coded in the original main MM purchasing program SAPMM06B. Most often, issues arise with the parameters that the developer expects to be passed into the workflow container from the event (i.e., the event/workflow template binding condition). To expedite resolution to event/workflow binding issues, we will review some helpful debugging and troubleshooting tips:

Figure 18: Performance Assistant screen The total value of requisition 10008488 is USD12,600.00, so it requires the release strategy we setup in OMGQ. So, in theory, we should have a workflow.

Figure 19: Display: Purchase Requisition Statistics screen displaying details on selected item Copyright 2003 by Klee Associates, Inc. www.SAPtips.com Page 13

SAP Workflow: A Comprehensive Guide to Troubleshooting and Debugging

Figure 20: Release Strategy Overall rel.: screen Problem1: Event Linkage: But when we go to transaction SWI1, we notice that no workflows exist at all! Before we start going through the purchase requisition program in debug mode, we should start by utilizing some standard SAP utility transactions: a. Turn on the event log with transaction SWELS. b. Re-create another purchase requisition by copying the one we just created. c. Display the event trace w/ transaction SWEL.

Figure 21: Display Event Trace screen Hint: In previous SAP releases, a workflow development area menu was available to easily access the most common WF transactions. If you are more comfortable with the older area menu, you can escape from the Easy Menu by entering /n in the transaction window and then entering transaction SWLD to get to the old area menu. Resolution to Problem 1: The event trace shows no event receiver was found. This error is typical if the event linkage is not set up or not active in transaction SWE2. By reviewing SWE2, we notice that the type linkage was not set to 'active.' To resolve the issue, activate the event linkage and be sure to save the entries. To continue the exercise, we can either create a new requisition to ensure workflow starts, or manually start workflow for the existing requisitions.

Copyright 2003 by Klee Associates, Inc. www.SAPtips.com

Page 14

SAP Workflow: A Comprehensive Guide to Troubleshooting and Debugging

Tip: Ideally, in a production environment, if workflow didnt start when it should have, we would want to manually start it. You can manually create the workflow by using either transaction SWUE (create event) or SWUS (start workflow). However, its best to use transaction SWI1 and find a similar workflow that has been generated to get the correct syntax and values for the container elements.

Figure 22: New Entries: Details of Added Entries screen Other items to review if the issue was not resolved: SWU3: Check the Workflow Engine make sure all items are configured properly (all lights are green). SWUB (part of SWU3): Validate that the workflow RFC destination is configured completely. First synchronize the passwords and then test the RFC connection with the caliper icon (function key F5). SM58: workflow is based on tRFCs. The tRFC errors are logged and can be reviewed using transaction SM58. SM21: Check the system log for workflow specific errors. ST22: Check for workflow specific short dumps.

Problem 2: Event Parameters: Often, customers identify additional event parameters that are required in the workflow but are not being passed from the event trigger. In addition, you may expect values that you are not

Copyright 2003 by Klee Associates, Inc. www.SAPtips.com

Page 15

SAP Workflow: A Comprehensive Guide to Troubleshooting and Debugging

seeing in the workflow, so you want to review the code to determine what parameters are actually getting passed from the application to the workflow. In this specific example, SAP provided the hooks (trigger mechanism) to start the workflow directly in the MM Purchase Requisition application. Workflow starts because we configured the OMGQ transaction to activate workflow the MM Purchase Requisition program checks the OMGQ to determine if WF should be started. Several options exist to view the event parameters being passed: Resolution A to Problem 2: Debug the MM Purchase Requisition application and look for the Event Create function modules. Events are created using several possible function modules: SWE_EVENT_CREATE, SWE_EVENT_CREATE_IN_UPD_TASK, and SWE_EVENT_CREATE_FOR_UPDATE_TASK. Note: Before we begin with this approach, it is important to mention that this particular application calls the workflow routines from a function module in update task, so we cannot simply start debugging and force a break-point at SWE_EVENT_CREATE. This option is the most work intensive, but we will review it to illustrate the process. We will proceed by using transaction ME51 to create a new purchase requisition (w/ similar characteristics as before so the release strategy is evoked). Before saving the requisition, we switch the debug mode on by entering /h in the transaction window.

Figure 23: Create: Purchase Requisition screen Copyright 2003 by Klee Associates, Inc. www.SAPtips.com Page 16

SAP Workflow: A Comprehensive Guide to Troubleshooting and Debugging

Now we can save the requisition and enter the primary MM program for purchase requisitions.

Figure 24: ABAP_Debugger screen Next, the fun part begins. Initially, I would suggest to try setting a break point at SWE_EVENT_CREATE and/or go to transaction SE38 or SE80, and enter program SAPMM06B and search for SWE_EVENT_CREATE, EVENT, RELEASE, and/or Workflow to determine where the workflow event is triggered. Searching by function module Breakpoint.

Figure 25: ABAP_Debugger screen with Breakpoint pull down menu

Copyright 2003 by Klee Associates, Inc. www.SAPtips.com

Page 17

SAP Workflow: A Comprehensive Guide to Troubleshooting and Debugging

Figure 26: BREAKPOINT dialog box By performing this once, we notice that the breakpoint is not reached. Another purchase requisition must be created and we enter the debug mode again by entering /h in the transaction window. Hint: Most of the SAP code has its roots from the German language. The abbreviation FRG seen throughout the code (and class system) is short for Freigabe Strategie or Release Strategy. To find out where workflow is triggered, search the main program SAPMM06B for the module that begins with FRG. In debug mode, we page down and review all the modules and pinpoint MODULE FRGST. Place a breakpoint here and then continue to the breakpoint and step into the module.

Figure 27: ABAP_DEGUGGER screen The FRGST module is only used to determine the release strategy. Workflow is not started in this module so we must continue. Note: the function modules ME_REL_STRATEGY_REQUISITION and ME_REL_GENERAL_STRATEGY_EBAN used in module FRGST can be used to troubleshoot potential issues with the release strategy determination for Purchase Requisitions.

Copyright 2003 by Klee Associates, Inc. www.SAPtips.com

Page 18

SAP Workflow: A Comprehensive Guide to Troubleshooting and Debugging

Page through the code and try to determine where the workflow is triggered. Lets search the primary purchase requisition program SAPMM06B using search criteria event.

Figure 28: ABAPEditor: Display screen

Figure 29: Find/replace dialog box

Copyright 2003 by Klee Associates, Inc. www.SAPtips.com

Page 19

SAP Workflow: A Comprehensive Guide to Troubleshooting and Debugging

Figure 30: Global Search in Programs screen Page through the search criteria and try to select possible areas (and set breakpoints) where the event may be called. After a few attempts, you should be able to determine function module ME_REL_EVENT_GENERAL_EBAN calls the event trigger SWE_EVENT_CREATE. Note: In this example, function module ME_REL_EVENT_EBAN is used for individual line item release. We are using overall line item release, i.e., we want approval based on the total value of all line items. Copyright 2003 by Klee Associates, Inc. www.SAPtips.com Page 20

SAP Workflow: A Comprehensive Guide to Troubleshooting and Debugging

Notice that 'ME_REL_EVENT_GENERAL_EBAN' is called in update task. The in update task is used to bundle many database changes into a single logical unit of work. All function modules belonging to the purchase requisition transaction are assigned an update key. When a commit work is performed, the update task reads the queue and processes all requests with the update key. We can set a breakpoint here but wont be able to debug unless we activate UPDATE DEBUGGING.

Figure 31: ABAP_DEBUGGER screen Since the ME_REL_EVENT_GENERAL_EBAN function module is being called in update task, we must activate update debugging. Note: for documentation on UPDATE DEBUGGING, see the R/3 online documentation: ABAP Run time Tools > Settings and Warnings (search for update debug) Settings > Update Mode (Use update debugging in debug mode)

Copyright 2003 by Klee Associates, Inc. www.SAPtips.com

Page 21

SAP Workflow: A Comprehensive Guide to Troubleshooting and Debugging

Figure 32: Settings pull down menu After the purchase requisition passes all pre-processing, the update task function modules are executed. Since we enabled Update Debugging, a new session will open with the Update Task function modules. In the next print screen we finally get to the SWE_EVENT_CREATE function module, which is called from ME_REL_EVENT_GENERAL_EBAN.

Copyright 2003 by Klee Associates, Inc. www.SAPtips.com

Page 22

SAP Workflow: A Comprehensive Guide to Troubleshooting and Debugging

Figure 33: ABAP_DEBUGGER screen Copyright 2003 by Klee Associates, Inc. www.SAPtips.com Page 23

SAP Workflow: A Comprehensive Guide to Troubleshooting and Debugging

Figure 34: BANF_CONTAINER - RELEASE CODE At this point, we see that the container element RELEASECODE with a value of EX is being passed. Resolution B to Problem 2: Review the event binding in the work item. The debug option required significant work to determine exactly where the event was being triggered for the purchase requisition release strategy. Sometimes you dont need to find the exact portion of the code that calls the event and you simply want to review the event container parameters. To do so, use the work item display transaction SWI1. Note: since we are in a relatively technical mode as we analyze workflow issues, it is recommended to switch your default workflow settings from a graphical view to a technical view. Go to the business workplace (transaction SBWP) > settings > workflow settings > personal settings > select Technical view for Work item display and Workflow log

Copyright 2003 by Klee Associates, Inc. www.SAPtips.com

Page 24

SAP Workflow: A Comprehensive Guide to Troubleshooting and Debugging

Figure 35: Personal workflow settings for (User Name) screen Transaction SWI1 Selection Screen (Simply Execute). Consider entering date/time to reduce selection to specific workflow created for the application (purchase requisition) document. Also select Additional data to display the workflow number, agent, and other additional data.

Copyright 2003 by Klee Associates, Inc. www.SAPtips.com

Page 25

SAP Workflow: A Comprehensive Guide to Troubleshooting and Debugging

Figure 36: Selection Report for Work Items screen Transaction SWI1 Output.

Figure 37: Work item selection screen with Workflow Log Icon highlighted Display the workflow log for this item by clicking on the Scroll icon (fourth icon from the left). Be sure to place the cursor on the item you want to display.

Figure 38: Workflow Log (View With Technical Details) screen We see that our workflow has still errored. The log shows you that the workflow (WS template) started but no single step tasks (TS) have been evoked, so we have an issue before we even get

Copyright 2003 by Klee Associates, Inc. www.SAPtips.com

Page 26

SAP Workflow: A Comprehensive Guide to Troubleshooting and Debugging

to the first single step task. We will resolve the error in the next couple of sessions, but first lets review the event parameters. Click on the WS container icon (displayed above).

Figure 39: Display Work Item - Container screen The container displays the event parameters passed by the purchase requisition application to the workflow. Note: if you expect additional event parameters to be passed, check the workflow definition via transaction PFTC (enter the workflow template > select Triggering events tab > select binding definition button) to make sure the binding has been set-up correctly. Most often, custom workflow event parameter binding issues are a result of incorrect binding from the event to the workflow task.

Figure 40: Workflow Template: Display screen displaying Triggering events tab. Copyright 2003 by Klee Associates, Inc. www.SAPtips.com Page 27

SAP Workflow: A Comprehensive Guide to Troubleshooting and Debugging

Figure 41: Task Binding Triggering Events screen By clicking on the Event container, we see all the element parameters that the standard SAP Purchase Requisition application intended to pass to the workflow. After debugging the code where the event is triggered and reviewing the event container, we see that it would be nearly impossible to add other event parameters to the workflow without modifying SAP source code OR perhaps looking for a user exit. Note: At this point, we have analyzed the triggering mechanism of the purchase requisition release workflow. Since the trigger mechanism in this example is provided by SAP in the primary Purchase Requisition application, there is no ideal way to add additional event parameters. However, this does not mean we do not have other options. We can create additional (custom) object attributes or methods to pull data into the workflow.

Copyright 2003 by Klee Associates, Inc. www.SAPtips.com

Page 28

SAP Workflow: A Comprehensive Guide to Troubleshooting and Debugging

Figure 42: Release step created: Display Container screen Additional Event Information: The initial part of any workflow is some sort of triggering mechanism (Event) to start the entire process in motion. Several standard and custom event-triggering options are available to start the workflow: The application (original SAP code) triggers workflow based on configuration settings. This is how the purchase requisition release workflow that we have been reviewing is enabled. Status Management, primarily used in the PP, PM, and SM modules, triggers the workflow based on either a system status or user status change. Why isnt status management available in other modules? Because the original developers of the other modules didnt incorporate status management into the applications. A custom ABAP report (and/or function module) can be written that calls the standard workflow event creation function modules. A user exit (and/or field exit) may be activated and coded to trigger workflow. A stand alone Start Transaction can be generated via a standard tool provided by SAP. To start workflow, the end user calls the transaction, fills in the selection screen, and then executes the transaction to trigger the workflow. Business Transaction Events (BTEs) are available for FI/CO, SD, MM and other modules. BTEs must be activated via configuration (linking the BTE with the event function module) and/or development, and are standard hooks into the application that SAP provides. When the event is triggered from the application, a function module calls a BOR (Business Object Repository) event. SAP provides a function module for all BTEs that can be linked to an event. Change documents. If a change document object is created for the application, you can link any create/change/delete change document objects to a workflow event. Page 29

Copyright 2003 by Klee Associates, Inc. www.SAPtips.com

SAP Workflow: A Comprehensive Guide to Troubleshooting and Debugging

Message control (output determination) may be used for workflows in a similar fashion to how it's used for printouts, faxes, etc. Message control is used in the MM and SD modules. Since message control is run in the background, it is often difficult to debug the event creation process. We sill show an example of message control in the Purchase Order application, because the Purchase Requisition application does not use message control. Heres a solution to assist in debugging message control (this works for fax, print, workflow, and all output types available in message control): Note: Message Control, Output Determination, Output Control are different names that are generically called Condition Technique, i.e., dont let SAP confuse you - they all refer to the same process. a. Message control (aka output determination) uses function module RV_MESSAGES_UPDATE to generate output if the configuration is set up properly. b. Set a break point at: 'IF MSG_NO_UPDATE_TASK = SPACE.' statement in the function module RV_MESSAGE_UPDATE (line 95 in R/3 46C).

Copyright 2003 by Klee Associates, Inc. www.SAPtips.com

Page 30

SAP Workflow: A Comprehensive Guide to Troubleshooting and Debugging

Figure 43: Function Builder: Display RV_MESSAGES_UPDATE screen displaying Source code tab.

Copyright 2003 by Klee Associates, Inc. www.SAPtips.com

Page 31

SAP Workflow: A Comprehensive Guide to Troubleshooting and Debugging

Note: Several steps are required to set up message control for workflow. In this example, Output Medium 9 (Events SAP Business Workflow) was set up for output type NEU (Purchase Orders) via transaction M/34. Output type 9 is used to create an event; the other option is to set up output medium T and trigger a task directly. Program RVNSWE01 and form routine CREATE_EVENT are used to generate the event. Custom sub-type ZBUS2012 was created, delegated to ZBUS2012, and custom event zMessageWFEvent was created. Template workflow (WS99500035) was created with a simple task (TS99500021), with a method that has break-point in it. Lastly, a condition record (MN04) was created for document type NB to automatically generate the workflow output when the purchase order is saved. c. Determine the form routine used by message control to create the workflow event. Message control (output determination) for purchase orders is set up in the IMG under MM > Purchasing > Messages > Output Control. We simply need to review the message type NEU for purchase order output to find the form-driving program and form routine.

Figure 44: Display View Processing routines: Overview screen Hint: SAP uses the condition technique for pricing, output, account determination, and many other functions. Each application has a different transaction to configure the condition technique. However, you can use transaction VK01 to select any condition technique you would like to maintain. d. Set a breakpoint in the form routine CREATE_EVENT.

Copyright 2003 by Klee Associates, Inc. www.SAPtips.com

Page 32

SAP Workflow: A Comprehensive Guide to Troubleshooting and Debugging

Figure 45: ABAP Editor: Display Report screen e. Go to the application that uses message control and create an application document, e.g., transaction ME21 for purchase orders (the purchase requisition application does not use message control). You need to make certain a condition record (MN04) is set up to automatically propose the workflow output.

Figure 46: Create Purchase Order: Item Overview screen f. When you save the purchase order, a debug session starts for function module RV_MESSAGES_UPDATE.

Note: The debug session will start only if message control automatically proposed output. If a debug session did not open, then manually add the output type (Headers > Messages) and save.

Copyright 2003 by Klee Associates, Inc. www.SAPtips.com

Page 33

SAP Workflow: A Comprehensive Guide to Troubleshooting and Debugging

Figure 47: ABAP_DEBUGGER screen g. Set variable MSG_NO_UPDATE_TASK = X and continue (be sure to change it by clicking on the pencil).

Figure 48: Field names screen h. When you continue, SAP will break at the form routine for the creation of the event.

Copyright 2003 by Klee Associates, Inc. www.SAPtips.com

Page 34

SAP Workflow: A Comprehensive Guide to Troubleshooting and Debugging

Figure 49: ABAP_DEBUGGER screen i. Later we will review how to continue debugging at the workflow task level.

Agent Resolution Debugging

All workflow tasks that generate work items (foreground tasks) need to be assigned to an individual or group of agents. Problem 3: Agent Resolution: A workflow work item is created but it is not assigned to an agent. Resolution to Problem 3: First, review the work item workflow log via transaction SWI1 (click on workflow log Scroll Icon).

Figure 50: Work item selection screen

Copyright 2003 by Klee Associates, Inc. www.SAPtips.com

Page 35

SAP Workflow: A Comprehensive Guide to Troubleshooting and Debugging

Figure 51: Workflow Log (View With Technical Details) screen Review the log and pinpoint where the error occurs. Double click where you see the first Message occur.

Figure 52: Workflow Log (View With Technical Details) screen indicating where to click Click the long text (? icon)

Figure 53: Information dialog box The long text of the issues describes that an agent could not be determined.

Copyright 2003 by Klee Associates, Inc. www.SAPtips.com

Page 36

SAP Workflow: A Comprehensive Guide to Troubleshooting and Debugging

Figure 54: Performance Assistance screen We need to review the standard SAP workflow agent resolutions before we continue. The first single step task (TS) step of the purchase requisition workflow (WS) release strategy is 000004 (TS20000159).

Copyright 2003 by Klee Associates, Inc. www.SAPtips.com

Page 37

SAP Workflow: A Comprehensive Guide to Troubleshooting and Debugging

Figure 55: Workflow Builder - Display screen You can define agent resolution at the step (000004) level. Any agent resolution defined at this level will be superceded if agent resolution is at the single step (TS) task level.

Figure 56: Workflow Builder - Display screen showing no agent resolution is defined. Double click on task TS20000159 and select the default role tab. A standard role (AC20000026) is defined. This is used to determine the agent for the overall release. Here's where our problem occurs. We need to figure out why an error is recurring here.

Copyright 2003 by Klee Associates, Inc. www.SAPtips.com

Page 38

SAP Workflow: A Comprehensive Guide to Troubleshooting and Debugging

Note: All of the workflow objects usually have prefixes that are most often NOT displayed on screen. Workflow objects are stored in the SAP HR-PD tables with the prefixes. Heres an overview of the most common prefixes: TG Task Group WF Custom multi-step task (obsolete) WS Multi-step workflow task TS Single-step workflow task T Customer Single-step task (obsolete) AC Role C Job O Organizational Unit S - Position

Figure 57: Standard Task: Display screen displaying Default roles tab You can double click on the standard role (AC20000026) to launch the PFAC transaction and review the function module that determines the agent.

Copyright 2003 by Klee Associates, Inc. www.SAPtips.com

Page 39

SAP Workflow: A Comprehensive Guide to Troubleshooting and Debugging

Figure 58: Standard Role: Display screen displaying Role definition tab Set a SOFT breakpoint in ME_REL_GET_RESPONSIBLE (use transaction SE37).

Copyright 2003 by Klee Associates, Inc. www.SAPtips.com

Page 40

SAP Workflow: A Comprehensive Guide to Troubleshooting and Debugging

Figure 59: Function Builder: Display screen displaying Source code tab Now, well use the workflow test transaction SWUS to execute requisition release workflow WS99500034. We will need the container elements so we should go to SWI1 (and then workflow log > container elements) first and display the errored workflow event parameters.

Figure 60: Workflow Log (View With Technical Details) screen Copyright 2003 by Klee Associates, Inc. www.SAPtips.com Page 41

SAP Workflow: A Comprehensive Guide to Troubleshooting and Debugging

Figure 61: Display Work Item - Container screen Go to SWUS and execute the workflow with the above container elements.

Figure 62: Start Workflow (Test Environment) screen Select Input Data and enter the container elements

Figure 63: Initialize Container screen Execute the test workflow. The debug point set up in function module ME_REL_GET_RESPONSIBLE will be evoked and you can start debugging the issue. Copyright 2003 by Klee Associates, Inc. www.SAPtips.com Page 42

SAP Workflow: A Comprehensive Guide to Troubleshooting and Debugging

Figure 64: ABAP_DEBUGGER screen Run through the debugger and you will eventually get to a function module where SYST-SUBRC = 1.

Copyright 2003 by Klee Associates, Inc. www.SAPtips.com

Page 43

SAP Workflow: A Comprehensive Guide to Troubleshooting and Debugging

Figure 65: ABAP_DEBUGGER screen Copyright 2003 by Klee Associates, Inc. www.SAPtips.com Page 44

SAP Workflow: A Comprehensive Guide to Troubleshooting and Debugging

The function module RH_TASK_AGENT_CHECK determines if the task is assigned to a user id. It isnt, so we receive the error. Lets briefly discuss task attributes. A task w/ attribute General task indicates any SAP user can execute the task. A task w/ attribute General forwarding allowed indicates that the original agent may forward the task to any user (even if they are not assigned to the task). A task w/ attribute General forwarding not allowed indicates that the work item can only be forwarded to agents assigned to the task.

To determine the task attributes, go to transaction PFTC > enter the Workflow template > go to display > select Workflow Builder >

Figure 66: Task: Maintain screen

Copyright 2003 by Klee Associates, Inc. www.SAPtips.com

Page 45

SAP Workflow: A Comprehensive Guide to Troubleshooting and Debugging

Figure 67: Workflow Template: Display screen showing Basic data tab Navigate to the step in question (here step 000004) > double click on the step >

Figure 68: Workflow Builder Process Flow Double click on TS20000159 >

Figure 69: Control tab From the menu, select Additional Data > Agent Assignment > Maintain >

Copyright 2003 by Klee Associates, Inc. www.SAPtips.com

Page 46

SAP Workflow: A Comprehensive Guide to Troubleshooting and Debugging

Figure 70: Standard task: Maintain Agent Assignment screen Select the line item and then click attributes >

Figure 71: Task Overall release of requisition screen This is our issue. The task is not classified as general. Option one is to create an org. structure, assign a position, assign a user (or person), and then assign the task to the position. Or we can make the task general so it can be executed by anybody (with the expectation that the OMGQ configuration role resolution will be used). Lets change the assignment to General task and save.

Figure 72: Standard task: Maintain Agent Assignment screen Re-execute the SWUS test transaction. Notice we no longer have an issue w/ RH_TASK_AGENT_CHECK Copyright 2003 by Klee Associates, Inc. www.SAPtips.com Page 47

SAP Workflow: A Comprehensive Guide to Troubleshooting and Debugging

Copyright 2003 by Klee Associates, Inc. www.SAPtips.com

Page 48

SAP Workflow: A Comprehensive Guide to Troubleshooting and Debugging

Figure 73: ABAP_DEBUGGER screen Create another purchase requisition from scratch and validate that the workflow is correctly created (SWI1).

Figure 74: Work item selection screen By clicking on the agent icon, you will notice that an agent is now correctly assigned and the workflow is no longer in error.

Figure 75: Workflow Log (View With Technical Details) screen Note: a common migration issue specific to purchase requisition releases occurs when clients transition from individual line item release to overall release. If OMGQ workflow configuration is maintained at the plant level (based on single line item release), the workflow will error for overall release because there is no plant at the header level of the purchase requisition, i.e., you must remove the plant from OMGQ > Workflow. By using the

Copyright 2003 by Klee Associates, Inc. www.SAPtips.com

Page 49

SAP Workflow: A Comprehensive Guide to Troubleshooting and Debugging

same debugging principles just described, you would be able to determine the error.

Figure 76: Change View Assignment of Role to Release Code: Overview screen

Workflow Task (Method) Debugging

The code for a single step task (TS) is written in methods assigned to objects in the Business Object Repository (BOR). It is often necessary to debug the method code to resolve workflow issues. Ideally, you want to start the debugger for the entire workflow but break at some point in the custom method code. Lets review the process for debugging both foreground (dialog) and background (synchronous) single step tasks. Foreground (Dialog) Tasks We will start by dissecting the first foreground task in the custom purchase requisition workflow (WS99500034) we created. The first task is the overall release of the requisition (TS20000159). Use the workflow builder (transaction PFTC > enter Workflow template for task type > enter task number 99500034 for Name >select display > click on the Workflow builder button) to call up the workflow and double click on the first task (step 000004) in the process flow diagram to launch the workflow template task detail screen. The goal is to set a break-point in the first dialog task to aid in debugging any issues.

Copyright 2003 by Klee Associates, Inc. www.SAPtips.com

Page 50

SAP Workflow: A Comprehensive Guide to Troubleshooting and Debugging

Figure 77: Workflow Builder - Display screen Next, double click on the task to launch the task details.

Copyright 2003 by Klee Associates, Inc. www.SAPtips.com

Page 51

SAP Workflow: A Comprehensive Guide to Troubleshooting and Debugging

Figure 78: Standard Task: Display screen displaying Basic data tab Double click on method SINGLERELEASE to launch the BOR definition of the method.

Copyright 2003 by Klee Associates, Inc. www.SAPtips.com

Page 52

SAP Workflow: A Comprehensive Guide to Troubleshooting and Debugging

Figure 79: Display Object Type screen Notice that object ZBUS2105 was called - this is fine. Custom sub-type ZBUS2105 was created and delegated to super type BUS2105. Place the cursor on the method zPurchaseRequisiton.SingleRelease, and then click the Program button to launch the code for this method. We will set a soft breakpoint.

Copyright 2003 by Klee Associates, Inc. www.SAPtips.com

Page 53

SAP Workflow: A Comprehensive Guide to Troubleshooting and Debugging

Figure 80: Object Type: Editor Display Program screen We cannot simply create a new purchase requisition (ME51) and expect the breakpoint to hit, because workflow is based on the tRFC (transactional RFC) engine; its an asynchronous RFC (which ensures unique execution). To test, we will use the workflow test transaction SWUS and a former purchase requisition (00100008529) that was already created and has a release strategy.

Figure 81: Start Workflow (Test Environment) screen When we execute the data (after adding the input data), the method code is available for debugging.

Copyright 2003 by Klee Associates, Inc. www.SAPtips.com

Page 54

SAP Workflow: A Comprehensive Guide to Troubleshooting and Debugging

Figure 82: ABAP_DEBUGGER screen Background (Synchronous) Tasks Special consideration is required for background tasks, because any breakpoints in the code do not cause the task to stop and wait for the user to debug. To illustrate the process of debugging, we will use background task TS99500020 (ZBUS2105-ZNOTIFYREQRELEASE), which sends a notification (not a work item) to a recipient when the requisition is released and has been added to the sample workflow template. Hint: Several options are available for creating notifications via workflow: the SAP-delivered SendMail task a custom method (as illustrated in this example with TS99500020/zmm_req_ok Copyright 2003 by Klee Associates, Inc. www.SAPtips.com Page 55

SAP Workflow: A Comprehensive Guide to Troubleshooting and Debugging

standard task), or a simple method w/ begin_method and end_method (adding text to task description and using report RSWUWFML to generate notifications for the work item). To incorporate several different notifications into a workflow process, it is sometimes simpler not to use the standard SAP SendMail task and create your own method for the process. Sometimes its easier to dynamically create your agents for notification from a custom method rather than using the standard SendMail.

Copyright 2003 by Klee Associates, Inc. www.SAPtips.com

Page 56

SAP Workflow: A Comprehensive Guide to Troubleshooting and Debugging

Figure 83: Workflow Builder Process Flow Copyright 2003 by Klee Associates, Inc. www.SAPtips.com Page 57

SAP Workflow: A Comprehensive Guide to Troubleshooting and Debugging

To debug, use the workflow builder (transaction PFTC > enter Workflow template for task type > enter task number 99500034 for Name >select display > click on the Workflow builder button) to call up the workflow, and double click on the background task TS99500020 (step 00031) in the process flow diagram to launch the workflow template task detail screen.

Figure 84: Workflow Builder Display screen Next, double click on the task to launch the task details.

Copyright 2003 by Klee Associates, Inc. www.SAPtips.com

Page 58

SAP Workflow: A Comprehensive Guide to Troubleshooting and Debugging

Figure 85: Standard Task: Display screen displaying Basic data tab Double click on method ZNOTIFYREQRELEASE to launch the BOR definition of the method and then place the cursor on the ZNOTIFYREQRELEASE method.

Copyright 2003 by Klee Associates, Inc. www.SAPtips.com

Page 59

SAP Workflow: A Comprehensive Guide to Troubleshooting and Debugging

Figure 86: Display Object Type screen Make sure the cursor is on the zNotifyReqRelease method and click program. Insert a soft breakpoint in the code.

Copyright 2003 by Klee Associates, Inc. www.SAPtips.com

Page 60

SAP Workflow: A Comprehensive Guide to Troubleshooting and Debugging

Figure 87: Object Type: Editor Display Program screen Green arrow out back to the BOR definitions and (while in CHANGE mode) double click on zPurchaseRequisition.zNotifyReqRelease to pull up the method attributes. We want to set the Copyright 2003 by Klee Associates, Inc. www.SAPtips.com Page 61

SAP Workflow: A Comprehensive Guide to Troubleshooting and Debugging

dialog button so workflow does not automatically process the task. (Later we will change this back, after we have identified any issues from the debug analysis.)

Figure 88: Method screen displaying General tab Save, generate, and then green arrow back to the task description. You will notice that the attributes of the task have changed. The Object method with dialog flag has been set.

Copyright 2003 by Klee Associates, Inc. www.SAPtips.com

Page 62

SAP Workflow: A Comprehensive Guide to Troubleshooting and Debugging

Figure 89: Standard Task: Display screen displaying Basic data tab Green arrow twice back to the workflow builder and regenerate your workflow. Now, we'll create a new purchase requisition (subject to the release strategy). Workflow will now stop at this task, and we will be able to execute it from the work item overview.

Figure 90: Performance Assistant screen Copyright 2003 by Klee Associates, Inc. www.SAPtips.com Page 63

SAP Workflow: A Comprehensive Guide to Troubleshooting and Debugging

Lets use a helpful tool from SAP called Generic Object Services (GOS available from release 4.0 onwards) to identify the workflow for the requisition we just created. GOS is activated by the application transactions and enhances the SAP functionality by allowing you to send email, add comments, review workflow history, and do many other functions. After the requisition is created, display it using transaction ME53. Note: as an alternative, we can use SWI1 (work item overview to find the work item).

Figure 91: Display: Purchase Requisition: Item Overview screen Use the menu and navigate to System > Services for Object.

Figure 92: Display: Purchase Requisition screen showing System pull down menu A new window appears with services > click on the workflow overview to display all workflows assigned to the purchase requisition.

Copyright 2003 by Klee Associates, Inc. www.SAPtips.com

Page 64

SAP Workflow: A Comprehensive Guide to Troubleshooting and Debugging

Figure 93: Display: Purchase Requisition: Item Overview screen showing Purchase requisition menu bar Data on linked workflows appears > click on the workflow log (scroll icon).

Figure 94: Workflows for Object screen

Copyright 2003 by Klee Associates, Inc. www.SAPtips.com

Page 65

SAP Workflow: A Comprehensive Guide to Troubleshooting and Debugging

The workflow log appears. Since the background task we have created occurs after the first dialog (overall release) task, we must first execute the overall release. Click on work item ID 547778 (overall release task).

Figure 95: Workflow Log (View With Technical Details) By clicking overall release work item 547778, the work item execution window appears. Execute the work item. Note: if you cannot execute the work item from SWI1, then you are most likely not assigned as an agent to the task. The easiest way to resolve this is to change the task attribute to General as described previously in this White Paper.

Copyright 2003 by Klee Associates, Inc. www.SAPtips.com

Page 66

SAP Workflow: A Comprehensive Guide to Troubleshooting and Debugging

Figure 96: Please release purchase requisition screen displaying Basic data tab By executing the work item, the task (method) calls transaction ME54 to release the req. Click Release + save and release the requisition.

Figure 97: Release: Purchase Requisition: Item Overview screen After the requisition is released, you return to the work item > green arrow back to the workflow builder. You will notice that workflow now stopped on our background task (here it is work item 547779) because we set it to a dialog task.

Copyright 2003 by Klee Associates, Inc. www.SAPtips.com

Page 67

SAP Workflow: A Comprehensive Guide to Troubleshooting and Debugging

Figure 98: Workflow Log (View With Technical Details) screen We can click work item id 547779 to launch the work item execution screen.

Figure 99: Work item execution screen displaying Basic data tab

Copyright 2003 by Klee Associates, Inc. www.SAPtips.com

Page 68

SAP Workflow: A Comprehensive Guide to Troubleshooting and Debugging

Execute the work item. You will now be able to debug the background method associated with the task. Technically, we have made the method dialog to debug it. After you have finished debugging the method, be sure to change the attributes back to background (switch off the dialog indicator in SWO1) and then regenerate the workflow via transaction PFTC.

Figure 100: ABAP_DEBUGGER screen

Copyright 2003 by Klee Associates, Inc. www.SAPtips.com

Page 69

SAP Workflow: A Comprehensive Guide to Troubleshooting and Debugging Summary of Trouble Shooting Transactions
Once you are able to initiate the debugging sessions, all the standard ABAP debugging principles apply. Heres a review of some important transactions to assist in troubleshooting your workflows. # 1. Transaction SWI1 Description Work item overview Relevant Notes This is the most used transaction to display workflows created in the SAP systems. Use the technical workflow log to analyze single-step tasks in a multistep workflow. Review the container element parameter values passed in to each task, change container element parameters to test different variations of the workflow, and determine to whom the work items are assigned (agent resolution). Later versions of SAP use the following transactions: PFTC_CHG PFTC_COP PFTC_DEL PFTC_DIS PFTC_INS PFTC_STR Change Tasks Copy Tasks Delete Tasks Display Tasks Create Tasks Task Maintenance ->

2.

PFTC

This is the general task maintenance transaction used to develop multi-step and singlestep tasks. This is the entrance point to the workflow builder process diagram.

Be sure to request authorization to PFTC since it is less cumbersome to use than the individual transactions. In single-step tasks, use the menu and go to Additional Data > Agent Assignment to check the task attributes. Remember General tasks can be executed by anybody. 3. SWU3 The area menu IMG for setting up the workflow engine. Several steps are required to set up the engine. Errors usually occur w/ the RFC destination (see transaction SWUB) below. Use the Start verification workflow to validate that the workflow engine is set up correctly. 4. SWUB Workflow RFC destination Synchronize the password and use the test button to make sure the RFC destination is working correctly. Often errors exist because someone Copyright 2003 by Klee Associates, Inc. www.SAPtips.com Page 70

SAP Workflow: A Comprehensive Guide to Troubleshooting and Debugging

# Transaction Description Relevant Notes changed the WF-BATCH user id password. If you cannot figure out why a particular workflow is not working, always check the system log. If you cannot figure out why a particular workflow is not working, always check for short dumps. If you are expecting workflows and not receiving any, make sure the event is linked to a workflow receiver. This can help resolving event issues. Validate, at minimum, that an event is being created and then check SWE2 for the event linkage. If no event is being created, then theres most likely a problem with the activation of events in the application configuration or other areas. IMPORTANT: in production, you should turn off the event log for daily use and only turn it on when troubleshooting. If the log is on, it has a tendency to fill up the log tables and cause errors if the system is not properly maintained. 9. SWEL Display Event Trace Synchronize run time buffer Display any events you expected to be triggered. As of 4,6, SAP includes a task and org assignment buffer for increased performance. Any time org assignments to tasks have been made, be sure to sync the buffers. Otherwise, new agent assignment rules may not be taken into consideration, i.e., you may have fixed an issue but the buffer is using the old data!

5.

SM21

System Log

6.

ST22

Short Dump Log

7.

SWE2

Event Linkage Table

8.

SWELS

Turn on/off the event trace log

10. SWU_OBUF

Copyright 2003 by Klee Associates, Inc. www.SAPtips.com

Page 71

SAP Workflow: A Comprehensive Guide to Troubleshooting and Debugging

# Transaction 11. SWUS Description The workflow test tool. Relevant Notes This is very helpful to start workflows for transactions where no workflows were created but were supposed to have been. Its also a GREAT tool to start debugging tasks after you inserted a breakpoint. Review other work items for similar tasks via transaction SWI1 (display the container elements) if you need help identifying values for the Input Data. 12. SWUE Workflow event test tool. Similar to the SWUS, but this creates the event. Again, use SWI1 to identify container elements (event > ws). If any workflow engine issues exist, the workflow will log errors in the tRFC event tables. The use of SM21, ST22, and SM58 are essential in identifying workflow issues. 14. SCOT SAP Connect Configuration Any notifications (not work items) will be logged here. If there are issues with end users receiving notifications review SCOT. Most often, the issue is that program RSCONN01 is not running to send notification out to the SENDMAIL or exchange server. 15. SWLD Old area menu for workflow development Re-start workflows after system crash Execute work item w/o agent check Re-start workflow after error. This is a great transaction to bypass agent resolution issues and focus on other problems. Exit out of the easy menu (/n), then enter /nSWLD to get to the old area menu.

13. SM58

tRFC buffer errors

16. SWPC 17. SWIA

18. SWPR

Copyright 2003 by Klee Associates, Inc. www.SAPtips.com

Page 72

SAP Workflow: A Comprehensive Guide to Troubleshooting and Debugging

Thomas Nittmann, Dataxstream, LLC. Thomas is a principal at Dataxstream, LLC, and has over nine years of SAP experience. After implementing SAP Plant Maintenance and Materials Management in Germany, he joined Ernst and Youngs Management Consulting practice in 1995, and later co-founded Dataxstream. He focuses on SAP Cross Application integration with Logistics modules, and specializes in workflow automation for both R/3 and mySAP products. Thomas can be reached at [email protected] or visit www.dataxstream.com

The information in our publications and on our Website is the copyrighted work of Klee Associates, Inc. and is owned by Klee Associates, Inc. NO WARRANTY: This documentation is delivered as is, and Klee Associates, Inc. makes no warranty as to its accuracy or use. Any use of this documentation is at the risk of the user. Although we make every good faith effort to ensure accuracy, this document may include technical or other inaccuracies or typographical errors. Klee Associates, Inc. reserves the right to make changes without prior notice. NO AFFILIATION: Klee Associates, Inc. and this publication are not affiliated with or endorsed by SAP AG. SAP AG software referenced on this site is furnished under license agreements between SAP AG and its customers and can be used only within the terms of such agreements. SAP AG and mySAP are registered trademarks of SAP AG. All other company and product names used herein may be trademarks or registered trademarks of their respective owners.

Copyright 2003 by Klee Associates, Inc. www.SAPtips.com

Page 73