Action Sequences: To Define an Action Sequence

The following activity will walk you through the process of defining an action sequence.

Story

Suppose that when a user clicks the Close command on the Cases (CR306000) form, you need to execute the actions that correspond to the following commands on the form:

Release to release the case
View Invoice if the case is billable (that is, if the Billable check box is selected on the CRM Info tab of the Cases form)

Process Overview

First, you will learn the internal names of the entities used in the workflow: the actions and fields, workflow class, graph, and DAC.

Then you will extend the default workflow for the Cases (CR306000) form and define the action sequences in the extension. In order to define an action sequence for more than two actions, you need to define an action sequence for each pair. Thus, you will first define an action sequence for the Close and Release actions, and then an action sequence for the Release and View Invoice actions.

System Preparation

Before you begin, you should make sure that you have configured your instance of MYOB Acumatica, as described in the Preparing an Instance for Workflow Customization chapter.

You also need to create an extension library for the instance. For details, see To Create an Extension Library.

Step 1: Investigate the Internal Names of Elements on the Cases Form

To define a sequence of existing actions, you need to learn the internal names of these actions in the graph of the Cases (CR306000) form, as well as other relevant internal names. Do the following:

Open the Cases form.
By using the Element Inspector, learn the name of the graph and the DAC for the form: CRCaseMaint and CRCase
By using the Element Inspector, learn the action names of the following commands on the More menu:
- Release: release
- Close: Close
- View Invoice: viewInvoice
By using the Element Inspector, learn the internal name for the Billable check box on the CRM Info tab: CRCase.IsBillable.
In the website project of the Visual Studio solution, find the source code of the PX.Objects.CR namespace, and find the class that defines the code of the workflow for the Cases form: The CaseWorkflow class is located in App_Data/CodeRepository/PX.Objects/CR/Workflows/CaseWorkflow.cs.

Step 2: Implement the First Action Sequence

To implement the first action sequence to be executed, do the following:

In the extension library, create a C# file named CaseWorkflow_Extension.cs.

In the file, extend the class that implements the workflow for the Cases (CR306000) form, as shown in the following code.

public class CaseWorkflow_Extension : PXGraphExtension<CaseWorkflow, CRCaseMaint>
{
    public sealed override void Configure(PXScreenConfiguration config) =>
        Configure(config.GetScreenConfigurationContext<CRCaseMaint, CRCase>());

    protected static void Configure(WorkflowContext<CRCaseMaint, CRCase> context)
    {
    }
}

In the Configure(WorkflowContext<CRCaseMaint, CRCase> context) method, implement the action sequence as shown in the following code.
```
context.UpdateScreenConfigurationFor(screen =>
{
  return screen
    .WithActionSequences(sequences =>
    {
      sequences.Add(s => s
        .AfterAction("Close")
        .RunAction("release")
        .StopOnError(true));
    });
});
```
In the code above, you have defined a sequence by calling the Add method in the WithActionSequences method. In the lambda expression for the Add method, you have specified the first action of the sequence (the triggering action) in the AfterAction method and the second action of the sequence in the RunAction method. In the StopOnError method, you have also specified that the second action should not be performed if an error occurs during the execution of the first action of the sequence.

Add the necessary using directives.

using PX.Data;
using PX.Data.WorkflowAPI;
using PX.Objects.CR;
using PX.Objects.CR.Workflows;

Build the project.

Step 3: Implement the Second Action Sequence

To implement an action sequence containing the release and viewInvoice actions, you need to add a separate sequence after the first one. Because the viewInvoice action should be executed only if the case is billable, you need to define a condition and specify it in the action sequence. Do the following:

Define a condition that is true when the case is billable.
1. In the CaseWorkflow_Extension class, define the Conditions class with the condition.
```
public class Conditions : Condition.Pack
{
    public Condition IsBillable =>
      GetOrCreate(b => b.FromBql<CRCase.isBillable.IsEqual<True>>());
}
```
2. Add the necessary using directive.
```
using static PX.Data.WorkflowAPI.BoundedTo<PX.Objects.CR.CRCaseMaint, PX.Objects.CR.CRCase>;
```
3. In the Configure(WorkflowContext<CRCaseMaint, CRCase> context) method, create an instance of the Conditions class.
```
var conditions = context.Conditions.GetPack<Conditions>();
```
In the WithActionSequences method, add the second sequence after the sequence defined in the previous step. Specify the IsBillable condition in the AppliesWhen method.
```
sequences.Add(s => s
  .AfterAction("release")
  .RunAction("viewInvoice")
  .AppliesWhen(conditions.IsBillable)
  .StopOnError(true));
```
Build the project.

Step 3: Test the Modified Workflow

To test the implemented sequence, do the following:

Open the Cases (CR306000) form.
Note:
To make sure that the workflow has been modified correctly, note that the More button is displayed and the toolbar buttons have connotations. If you suspect an error, you can check the workflow output on the System Events tab of the System Monitor form. For details, see Test Instance for Workflow Customization: To Enable Workflow Validation.
Create a new case with the following settings:
- Case Class: PRODSUPINC
  You need to specify this class because it is billable; this causes the Billable check box to be selected on the CRM Info tab of the form.
- Business Account: C000000001
- Subject: Test Sequence
On the form toolbar, click Open.
In the Open dialog box which opens, click OK.
On the form toolbar, click Close.
In the Close dialog box which opens, click OK.
Note that the form shows the Processing Results dialog box and the timer indicating a long-running operation. The Processing Results dialog box indicates that the action sequence is being performed. The timer indicates that the release action which contains the long-running operation is being performed.
Figure 1. The system performing a long-running operation

After the sequence is completed, in the Processing Results dialog box, note the list of actions that have been performed: Close, Release, and View Invoice, as shown in the following screenshot. The Invoices and Memos (AR301000) form is opened in a new tab with the invoice created for the case.
Figure 2. The list of performed actions
In the Processing Results dialog box, click OK.