Creating Custom Workflow from scratch in Dynamics Ax 2012

 Suppose we are working in HR module and client wants that worker will add their expense and send for Approval.

For this requirement, first we create a custom table and create its relation with Worker table. And then develop a custom workflow on it.
So this post contains tasks

• Table creation and relation with worker
• Create a simple entry form and list page.
• Workflow

So first we create a new table and generate its relation with Worker ID.

If we open HCMworker table we will find that its primary key is “PersonnelNumber”.

We add new enum type which has expected values, medical, Certification, Food expense and others. We use Tst as extension for our example’s artifacts.


Now create a new table set its Name as tstWorkerExpenseTable.
Expand table node and right click on relation node. Create a new and set table as HCMWorker.

Rightlick on it new => foreignKey=>Primarykey.

You will find new and new field added, you can rename it, if you check the properties you will the  which will int64 bit.

Now drag and drop enum created in previous step
Rename it to Expense type.


Now add one more field name It Amount of real type and set its label as Amount
Save It. Also create a field group with overview and drag all fields in that group.
Table final structure will be as follow.



Form create simple form with Name tstWorkerExpense and set its data source as
Now create a simple form and set its datasource as TstWorkerExpense. And set data source properties  “Edit” and “insert if empty” to no.

Add grid on form and drag and drop fields from data source to grid. Save it.  Form structure will be look like.


Run the form you will find something like. You can improve from. It is enough for our current example
Also insert command buttons on action table for new, Edit and delete.



You can improve but for current example it is enough.

Now create a new enum  for which will used as approval status for table.

Drag and drop in fields of tstWorkerExpense. Save table, compile and synchronize, so this will be reflect at SQL Server level.

Now Its time to write some code that will work for state change in workflow steps.
Right click on Method node on tstWorkerExpense and click on CanSubmitToWorkFlow





Update it as follow.

publicboolean canSubmitToWorkflow(str _workflowType = ”)
{
boolean ret;

if (this.ExpenseStatus ==tstExpenseStatus::NotSubmit)
{

ret = boolean::true;
}
else
{
ret =boolean::false;
}

return ret;
}

New add a new static method with Name “updateworkFlow” and update it as follow

publicstaticvoid updateWorkFlowState(RefRecId _id, tstExpenseStatus _status)
{
tstWorkerExpense _Expense;

selectforUpdate _Expense where _Expense.RecId ==_id;
if (_Expense !=null)
{
ttsBegin;
_Expense.ExpenseStatus = _status;
_Expense.update();
ttsCommit;
}
}

 

Now create a Query and This query will later used when we build Workflow type on it.

Add TstWorkerExpense table in it and set field  dynamic to yes.


Now expand AOT and expand workflow right click on new Workflow Category

Set its name tstWorkFlowCategory and set Module as HumanResource.

Save it. Now add a new me display menu Item With name “tstExpenseTable” and set its form tstWorkerExpenseTable.




Now expand workflow and then expand workflow Type right click and run the wizard.




From next window set following properties all based on artifacts we create in pervious steps.

Ie.  Query, workflow category and menu item.  AS we test this workflow only on Ax client so check on rich client

Click on next.


In result a new Ax Project is created

• Workflow Type
• Classes
  • Document class which extends WorkflowDocument.
  • EventHandler class which gives implementation to handle different workflow events.
  • SubmitManager class.
• Action menu items:
  • SubmitMenuItem pointing to SubmitManager class.
  • CancelMenuItem pointing to WorkflowCancelManager class.

Now expand the form (We created this in one above step) and expand its design, and set following properties  to it will workflow enable
WorkflowEnabled =yes
WorkflowDataSorce =tstWorkFlowExpense
WorkflowType = tstWorkerEpense (We created this in pervious step).


Now expand submit manager class in workflow type project and update logic as follow.
And Create a new method with following logic.

public void submit(Args _args)
{
tstWorkerExpense        workerExpense;
WorkflowComment         note = “”;
WorkflowSubmitDialog    workflowSubmitDialog;

//Opens the submit to workflow dialog.
workflowSubmitDialog = WorkflowSubmitDialog::construct(
_args.caller().getActiveWorkflowConfiguration());
workflowSubmitDialog.run();

if (workflowSubmitDialog.parmIsClosedOK())
{
workerExpense = _args.record();
// Get comments from the submit to workflow dialog.
note = workflowSubmitDialog.parmWorkflowComment();

try
{
ttsbegin;
workerExpense.ExpenseStatus  = tstExpenseStatus::Submit;
ttscommit;

// Send an Infolog message.
info(“Submitted to workflow.”);
}
catch (Exception::Error)
{
error(“Error on workflow activation.”);
}
}

_args.caller().updateWorkFlowControls();
}

public static void main(Args args)
{
tstWorkerExpenseSubmitManager submitManager = new tstWorkerExpenseSubmitManager();
submitManager.submit(args);

}

Now Create a we create workflow approval.
Expand Workflow node in AOT and then again expand Workflow approval.



Now you have to use the following artifacts we created in previous steps.

Document, which we created through workflow type wizard and tables field group. And



Again new project created.


Now expand TsWorkerExpenseAppEventHandler and update following methods.
public void returned(WorkflowElementEventArgs _workflowElementEventArgs)
{
tstWorkerExpense::updateWorkFlowState(_workflowElementEventArgs.parmWorkflowContext().parmRecId(), tstExpenseStatus::ChangeRequest);
}


public void changeRequested(WorkflowElementEventArgs _workflowElementEventArgs)
{
tstWorkerExpense::updateWorkFlowState(_workflowElementEventArgs.parmWorkflowContext().parmRecId(), tstExpenseStatus::ChangeRequest);
}

public void denied(WorkflowElementEventArgs _workflowElementEventArgs)
{
tstWorkerExpense::updateWorkFlowState(_workflowElementEventArgs.parmWorkflowContext().parmRecId(), tstExpenseStatus::Reject);
}


public void completed(WorkflowElementEventArgs _workflowElementEventArgs)
{
tstWorkerExpense::updateWorkFlowState(_workflowElementEventArgs.parmWorkflowContext().parmRecId(), tstExpenseStatus::Approve);
}

public void canceled(WorkflowElementEventArgs _workflowElementEventArgs)
{
tstWorkerExpense::updateWorkFlowState(_workflowElementEventArgs.parmWorkflowContext().parmRecId(), tstExpenseStatus::Cancel);
}

public void started(WorkflowElementEventArgs _workflowElementEventArgs)
{
tstWorkerExpense::updateWorkFlowState(_workflowElementEventArgs.parmWorkflowContext().parmRecId(), tstExpenseStatus::Submit);
}


Now expand the workflow and in sub node Supported Elements, drag and drop approval artifact.




Drag




Now create a new menu item and set its form and set its following properties.

• Form WorkflowTableListPage
• EnumTypeParameter to ModuleAxapta
• EnumParameter to Basic.

Now generate increment CIL. It is necessary step.


Click on this and open the workflow design.


Navigate to the menu item to open WorkflowTableListPage to design the workflow.
Click on new button.


Drag and drop approval on designer screen and. Link the start to shape and from shape to end .