Export (0) Print
Expand All

How to: Create a Workflow Event Handler [AX 2012]

Updated: October 11, 2011

Applies To: Microsoft Dynamics AX 2012 R3, Microsoft Dynamics AX 2012 R2, Microsoft Dynamics AX 2012 Feature Pack, Microsoft Dynamics AX 2012

The event handlers for a Microsoft Dynamics AX workflow are provided on a workflow and workflow element level. Workflow event handlers process events that occur during execution of the workflow, for example, when a workflow is canceled.

This topic describes how to create and implement event handlers on the workflow level. For more information about event handlers for workflow elements such as tasks and approvals, see How to: Create a Workflow Task or Approval Event Handler.

Typically, the class and methods for a workflow event handler are created by the Workflow wizard when you create a new workflow type. You just need to supply the code for each event. Use the following procedure if you need to create the workflow event handler manually.

To create a workflow started event handler

  1. In the AOT, expand the Classes node.

  2. Right-click the Classes node, and then select New Class. A class group displays under the Classes node.

  3. Right-click the new class, click Rename, and enter a name for the class.

  4. Expand the new class, select classDeclaration, right-click the class declaration, and then click Edit.

  5. Enter the following code in the class declaration.

    
    public class <event handler class name> implements
        WorkflowStartedEventHandler,
        WorkflowCanceledEventHandler,
        WorkflowCompletedEventHandler
    {
    }
    
  6. Right-click the new class and then click New Method. A new method node displays under the Classes node.

  7. Right-click the new method and then click Edit. Enter the following code for the started event method.

    
    public void started(WorkflowEventArgs _workflowEventArgs)
    {;
        <insert method here>
    }
    
  8. Repeat steps 6 and 7 for the remaining events.

  9. Right-click the node for the new class and select Save.

  10. To compile your application, in the AOT, right-click AOT, select Add-Ins, and then select Incremental CIL generation from X++.

The following code example shows a basic implementation of a workflow event handler for the started event of a workflow that tracks issues. The class declaration is shown first, followed by the implementation of the started method. The IssueStateChangeManager.start method updates the workflow state to Started based on the RecId parameter passed in by the workflowContext variable. For more information, see WorkflowEventArgs Class and WorkflowContext Class.

// Class Declaration
public class IssueWorkflowEventHandler implements
    WorkflowStartedEventHandler,
    WorkflowCanceledEventHandler,
    WorkflowCompletedEventHandler
{
}
 
// WorkflowStarted method
public void started(WorkflowEventArgs _workflowEventArgs)
{
    // This is the variable declaration.
    WorkflowContext workflowContext;
    
 
    // Gets the workflow context from _workflowEventArgs.
    workflowContext = _workflowEventArgs.parmWorkflowContext();
 
    // Sets the workflow state to Started.
    IssueStateChangeManager::start(workflowContext.parmRecId());
}

You can implement the workflow canceled and completed event handler using the same code syntax shown earlier.


Announcements: To see known issues and recent fixes, use Issue search in Microsoft Dynamics Lifecycle Services (LCS).

Community Additions

ADD
Show:
© 2014 Microsoft