Workflows

Page ID: (AU201020)

This page contains the list of all workflows defined for a particular screen (that is, a form in MYOB Acumatica) as well as the general settings of each workflow. The page lists predefined workflows, as well as customized and custom workflows. You can use the page to add customized and custom workflows for the form.

Tip: You open the Workflows page by clicking Workflows under the [1]Tatiana.Davydovaform?2024/03/2618:38:23+01:00screen ID (of the form for which you are adding or modifying workflows) in the navigation pane of the Customization Project Editor. In the name that appears on the page, Workflows is preceded by the form ID and then the form name in parentheses.

Page Toolbar and More Menu

The page toolbar includes standard buttons and page-specific buttons and commands. For the list of standard buttons, see Page Toolbar. The page-specific commands can be shown as buttons on the page toolbar, as commands on the More menu, or in both places. These commands are listed in the following table in alphabetical order.

Command Description
Add Workflow

Opens the Add Workflow dialog box, which you use to add a new custom workflow or a new inherited workflow—that is, a workflow based on a predefined workflow.
Disinherit

Breaks the relationship between the predefined workflow and the selected customized workflow that was based on it. (You first click the row with the customized workflow in the table and then click this command.) The selected workflow will no longer [2]janice.paganiniPhrase more precisely? I'm not sure what we mean.qw4_qtt_jyb2022/09/1621:19:15-04:00Tatiana.DavydovaThat is, the system does not check whether the version of the predefined workflow on which the customized workflow is based differs from the version if the predefined workflow in the system.1qw4_qtt_jyb12023/08/0815:24:30+03:00get updates from the system, and the Upgrade Predefined Workflow command will not be available for it.

Attention: You cannot reverse the changes induced by the Disinherit command. That is, you cannot link the selected workflow to a predefined workflow once you have selected the workflow and clicked Disinherit.
Upgrade Predefined [3]janice.paganiniImportant and global: For ALL commands that are not universally available, no matter what (even when a brand-new customization project has been created), we must document the dependencies. That is, there must be a paragraph after the descriptive one to say "This command is available only if ..." Similarly, if a command or button only appears on the page in certain circumstances, we must say "This command appears on the page only if ..."sm1_51m_zvb2022/08/0518:17:10-04:00Tatiana.DavydovaTBD3sm1_51m_zvb32022/12/2821:41:41+03:00Workflow

Starts the process of upgrading the selected customized workflow (which is based on a predefined workflow) with the latest changes from the system. (You first click the row with the customized workflow in the table and then click this command.)

If there are any conflicts, the Upgrade Conflicts dialog box opens, in which you can resolve these conflicts.

[4]Tatiana.DavydovaFor review2023/08/1620:35:44+03:00

This command is available only if the version of the predefined workflow in the system and the version of the predefined workflow in the customization project differ.
View Changes

Opens the Changes dialog box, which you use to view the description of a workflow in internal format. If you have made changes to this workflow, they are highlighted in the dialog box. You can return the workflow to the predefined state by clicking [5]Tatiana.DavydovaChange to "Reverse Changes" after AC-300669 is merged (2024R1 RC)2024/01/2215:16:52+01:00Revert Changes in the dialog box.

Tip: The View Changes button and command are available only if the workflow is inherited—that is, based on a predefined workflow.
[8]Tatiana.DavydovaFor editorial review2023/06/1319:56:12+03:00
Table 1. Add Workflow Dialog BoxThis dialog box opens when you click Add Workflow on the page toolbar. The dialog box contains the following elements.
Element Description
Operation

The operation that the system will perform when you specify all the needed values and click OK. You can select one of the following options: Create New Workflow, Extend System Workflow, and Copy Workflow.

[6]Tatiana.DavydovaFor editorial review2023/06/1319:55:28+03:00

You can select one of the following options:

  • Create New Workflow: Creates custom workflow
  • Extend System Workflow: Creates a customized workflow
  • Copy Workflow: Creates a copy of a predefined workflow
Base Workflow

Required. The name of the predefined workflow on which the current workflow is based.

[7]Tatiana.DavydovaFor editorial review2023/06/1319:55:37+03:00

This box is displayed only if you select Extend System Workflow in the Operation box.
Workflow to Copy

Required. The predefined workflow that you want to copy.

This box is displayed only if you select Copy Workflow in the Operation box.
Workflow Type

Required. The type of the entities to which the workflow is applied. The applicable entities depends on the particular form for which the workflow is defined.

[9]Tatiana.DavydovaFor editorial review2023/06/1319:57:20+03:00

If only one default workflow is available for the form, this box contains one value (Default). If the form has multiple workflows, this box contains all of these workflow types, and the Default type.
Workflow Name

Required. The name of the workflow you are adding.
This dialog box has the following buttons.
OK

Adds the workflow to the table on the page and closes the dialog box.
Cancel

Closes the dialog box without adding a workflow to the page.
[10]Tatiana.DavydovaFor editorial review For SME review2023/02/0618:39:20+03:00
Table 2. Upgrade Conflicts Dialog BoxThis dialog box opens when you click Upgrade Predefined Workflow on the page toolbar. The dialog box contains the following elements.
Element Description
Workflow Element

The workflow element in which the conflict has occurred.
Property

The property of the workflow element in which the conflict has occurred.
System Value

The value that the element has in the system workflow,
Customization Value

The value that the element has in the customized workflow.
System Action

The action that the system has performed to modify the element.
Customization Action

The customization action that has been performed to modify the element.
[11]Tatiana.DavydovaCreated a change request to rename the column.2023/02/0618:41:27+03:00Resolve Conflict in Action

The action that the system will perform to resolve the conflict.
This dialog box has the following buttons.
OK

Resolves the conflicts, merges the changes, and closes the dialog box.
Cancel

Closes the dialog box without resolving the conflicts.
Table 3. Changes Dialog BoxYou use this dialog box to view the source code of the workflow; the changes to the currently selected element are highlighted in red. The dialog box also contains the following buttons.
Button Description
[12]Tatiana.DavydovaChange to "Reverse Changes" after AC-300669 is merged (2024R1 RC)2024/01/2215:17:02+01:00Revert Changes

Returns the workflow to the predefined state.
Close

Closes the dialog box.

Summary Area

In this area, you can specify the basic settings for the new workflow.

[16]Tatiana.DavydovaFor review2023/08/1620:09:28+03:00[17]Tatiana.DavydovaFor review2023/08/1620:09:35+03:00
Element Description
State Identifier

The name of the field on this form that indicates the state.
Type Identifier

The field whose value determines which workflow is used if multiple workflows are defined for the form.

If you do not select any value in the this box, an entity that has been created on the form can have only one workflow. If you want the entity to have multiple workflows, select the field that defines the change of the workflow in this box.

[13]Tatiana.DavydovaFor review2023/08/1620:35:02+03:00

This field is read-only if its value has been specified in the code (by using Workflow API).
Allow Users to Modify Type

A check box that you select if you want users to be able to change the workflow type for an existing [14]Tatiana.DavydovaIf this check box is selected, the user can change the value of this field for the already created entities.2022/02/0715:56:43+03:00entity[15]Tatiana.DavydovaIn this case, another workflow is used for the entity (the one with the new field value).2022/02/0715:56:33+03:00.
Subtype Identifier

The field whose value determines which workflow is used if multiple workflows are defined for the form (that is, the workflow-identifying field of the second level).

This box is available only if the type identifier for this workflow is specified in the code (by using Workflow API). By default, it is supported for the following forms:
Allow Users to Modify Subtype

A check box that you select if you want users to be able to change the workflow subtype for an existing entity.

Table

This table lists all workflows defined for the form. If you click the name of a workflow in the table, you open the Workflow page with the workflow. This page has the name <Form Number (Form Name)> State Diagram: <Workflow Name> for the customized, custom, or predefined workflow. The columns of the table are described below.

The table toolbar includes only standard buttons. For the list of standard buttons, see Table Toolbar.

[19]Tatiana.DavydovaFor review2023/09/0723:00:34+03:00
Column Description
Active

A check box that indicates (if selected) that the current workflow is active.
Workflow Type [18]janice.paganiniHere, too, can we be more precise about how this works? What we are saying is not wrong, of course; it's just rather vague. The second sentence is more conceptual. When you are planning your workflow types, it helps to know that. But we should be talking about what the setting in the column indicates--so the perspective should be flipped. We should expand on the first sentence by telling how the value is used.icd_wbm_zvb2022/09/2415:13:06-04:00Tatiana.DavydovaTBD The type of workflow that you selected in the Add Workflow dialog box.17icd_wbm_zvb172022/12/2821:49:54+03:00

The type of the entities to which the workflow is applied. The applicable entities depends on the particular form for which the workflow is defined.
Workflow Subtype

The subtype of the entities to which the workflow is applied.

This box is available only if the type identifier for this workflow is specified in the code (by using Workflow API).
Workflow Name

The name of the workflow, which is also a link that you can click to switch to the Workflow page for the selected workflow.
Base System Workflow

The name of the predefined workflow on which the current workflow is based.
Status

The status of the workflow, which can be one of the following: System Read-Only, Inherited, or New.