Submit Action Set
Overview
The Submit action set is a series of Modify actions in Commerce that are essentially sub-actions of Submit. The Submit action set is comprised of Submit, Request Approval, Approve, Reject, and Revise.
When does the Submit action run?
After Submit is clicked:
- The quote passes through the approval tree defined on the Submit action. If any of them return true, the Request Approval action will be performed first.
- Approvers receive notifications and the Approve and Reject actions are available to them until they have performed either action, at which time the actions will no longer be visible to them.
- When the quote has received its final approval, or if no approvals are required, the Submit action and its associated modifications run.
Plan your status modifications, step transitions, and integrations accordingly!
Action or Sub-Action | What Does it Do? | Notes |
---|---|---|
Submit | The Submit action decides if the quote needs to enter the approval sequence or can be automatically approved. Other times it runs each Modify action. |
|
Request Approval | The Request for Approval action moves the quote into an approval pathway. It is automatically performed when the user clicks a Submit action and there is a Reason to approve the quote. |
|
Approve | This action is performed when the user clicks the Approve button. |
|
Reject | This action is performed when any Reason for an approval sequence is rejected by an approver. |
|
Revise | The Revise action allows the user to revise a Transaction document that has been submitted for approval. |
|
Administration
Creating the Submit Action Set
-
Navigate to the Action List page.
The Variable Name field populates automatically. Variable names can only contain alpha-numeric characters and underscores. The entry can be changed before saving, but after saving the value is read-only.
-
Click Add.
The Admin Action page opens.
-
Enter a Label and Variable Name.
The Variable Name field populates automatically. Variable names can only contain alpha-numeric characters and underscores. The entry can be changed before saving, but after saving the value is read-only.
- In the Action Type drop-down, select Submit.
-
Click Add.
The Admin Action page reappears.
- When you have returned to the Actions List page, the new Submit action appears with 4 sub-actions: Request Approval, Reject, Revise and Approve.
- These sub-actions can each be edited.
- When you have returned to the Actions List page, the new Submit action appears with 4 sub-actions: Request Approval, Reject, Revise and Approve.
- Edit the Submit action as you would any type of Modify action.
-
Click Edit Approvals to create reasons and approvers within the Approval Sequence.
If the Submit action is deleted, all associated actions and attributes are also deleted.
Revising a Sub-Action (Reset Reasons)
Resetting of reasons is typically used when a quote is required to step through the entire Approval Sequence, or portions of the sequence, even if some of the Approvals have already been received. An approval reason has 4 statuses: Approved, Rejected, Pending or Ignored.
- Resetting a Reason that is in Approved or Rejected: The reason was triggered and already received an approval (or rejection). Resetting the reason means it will be re-evaluated upon a Submit action and if the condition is met, an email notification will be sent and a new approval/rejection will be required.
- Resetting a Reason that is in Pending: The reason was triggered but was neither approved nor rejected. Resetting the reason means that it will be re-evaluated upon a Submit action and if the condition is met, an email notification will be sent and a new approval/rejection will be required.
- Resetting a Reason that is in Ignored: The reason was not triggered in the initial request, so resetting it has no affect.
-
Navigate to the Action List page.
The Variable Name field populates automatically. Variable names can only contain alpha-numeric characters and underscores. The entry can be changed before saving, but after saving the value is read-only.
- Open a Revise sub-action.
- Click the Reset Reasons tab.
- Select one of the following:
Simple Reset (All Reasons): If this option is selected, the reason will be reset.
The default setting is for no reasons to be reset.
Define Advanced Reset: Select this option and click Define Function. Write an advanced function that will return the reasons that should be reset. The return format can be an array or delimited string of the reason variable names.
If the desired outcome is that the quote only needs an Approval once, regardless of changes or revisions, then the Reason or Reasons should not reset.- The Revise sub-action cannot activate reasons or submit the Transaction. Revise will always perform only its own Step transition and all active approval nodes will always be deactivated.
- Approval workflow cannot be resumed until the request for approval action is performed again.
Notes
- When setting transitions, try to use just one pending approval Step. Adding multiple Steps increases complexity. Instead, use a variety of participant profiles.
- Keep both the parent Submit action advanced modification and the sub-action "Submit for approval" advanced modification equivalent.