How to: Associate an Action Menu Item with a Workflow Task or Approval Outcome

Article
05/18/2015

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

After you create a task or approval in a Microsoft Dynamics AX workflow, you must create and add an action menu item. The end-user can start the task or approval by clicking the button for the action menu item. The following procedures describe how to add an action menu item to a task or approval outcome, and then implement a class for the action menu item.

Note

Use the same procedures when you add an action item to a web client task or approval outcome in the Actions node in the Web Menu Items node of the Application Object Tree (AOT).

For more information about how to add a display menu item that displays the form for a task or approval, see How to: Associate a Display Menu item with a Workflow Task or Approval.

Before you begin this procedure, you must create a task or approval outcome that you need to add to an action menu item. For more information, see How to: Create a Workflow Task and How to: Create a Workflow Approval.

In the AOT, expand the Menu Items node.
Right-click the Action node, and then click New Menu Item. An action menu item displays under the Menu Items node.
Right-click the new action menu item and then click Properties.

In the Properties sheet, set the following properties.

Property	Value
Name	The name that is used to reference the menu item action, for example, TaskComplete.
Label	The label used for the action menu item in the user interface. For example, enter Complete to identify that the workflow is activated.
ObjectType	Set to Class. Use this value to implement the class for this action item.
Object	Set to WorkflowWorkItemActionManager (for Enterprise Portal, set to EPWorkflowWorkItemActionManager) to use the default workflow action manager. Optionally, implement a custom class. Note The Resubmit and Submit action menu items will require a custom class as this action affects the state of your document.
ConfigurationKey	The configuration key assigned to this menu item.

In the AOT, expand the Workflow node, expand the Tasks node, and then expand the Outcomes node.
Right-click the task outcome that you want to bind an action menu item to and then click Properties.
In the Properties sheet, set the ActionMenuItem property to the task action menu item that you created in step 4.

After an action menu item for a task or approval outcome is created, you can implement the menu item using the workflow work item action manager or create a customized class that implements the action menu item. For more information, see the WorkflowWorkItemActionManager Class.

In the AOT, right-click the Classes node, and then click New Class. A new class displays under the Classes node.
Right-click the new class, click Rename, and then enter a name.
Right-click the new class and then click New Method. The Editor window opens.
In the Editor window, insert the code for the action to take when the action menu item is selected in the user interface.

The following example shows the submit action when the purchase requisition workflow is submitted. The workflow configuration is activated by calling the Workflow::activateFromWorkflowType Method method on the Workflow Class class.

        void submit()
        {
            NoYes activatingFromWeb;
        
            // If we have a workflow control context, we are being activated from EP.
            activatingFromWeb = this.parmWorkflowControlContext() == null ? NoYes::No : NoYes::Yes;
        
            ttsbegin;
            if (PurchReqWFStatusTransitionHelper::setPurchReqTable2InReview(purchReqTable.RecId))
            {
                Workflow::activateFromWorkflowType(this.parmWorkflowTemplateName(),
                                                   purchReqTable.RecId,
                                                   this.parmWorkflowComment(),
                                                   activatingFromWeb,
                                                   DirPersonUser::worker2UserId(purchReqTable.Originator));
            }
            ttscommit;
        }

In the AOT, expand the Menu Items node.
Expand the Action node, and then select the action menu item that will use the class that you created in step 4.
In the Properties sheet, set the Object property to the name of the class that you implemented. When the user selects the action menu item in the user interface, the method in this class will be run.

After your task or approval outcomes have action menu items associated with them, you are ready to add the task or approval to the workflow type. For more information, see How to: Add a Task, Automated Task, or Approval to a Workflow Type.

Share via

How to: Associate an Action Menu Item with a Workflow Task or Approval Outcome

To bind an action menu item to a task outcome

To implement a class for an action menu item

See also

Additional resources