Submit Attribute Set

Overview

The main document (Transaction) Submit Attribute Set is provided with the Standard Process and reference application. This attribute set and associated attributes cannot be deleted from a Commerce process. Attribute Sets and Array Sets are listed at the bottom of the Attribute Lists page

  Name

  Variable Name

  Type

  Description

My Approval [Submit]

approve_reject_icon_submit_t

Text

This attribute lists all approval currently pending for current logged in user. This is not available as rule input.

Approval Status [Submit]

approval_status_submit_t

Text Area

This attribute lists all currently pending active approvals for a transaction.

Approval History [Submit]

approval_history_submit_t

Text Area

This attribute records approval history of a transaction. If a reason is reset, it is erased from the approval history.

Approval Revision [Submit]

approval_revision_submit_t

Integer

This attribute tracks the number of times a quote has been revised

Remote Approval Process Id [Submit]

_remote_approval_id_submit_t

Text

This attribute stores the corresponding process id in the remote approval system

 

Administration

ClosedEdit Submit Attribute Set Attributes

Complete the following steps to edit a Submit Attribute Set attribute.

  1. Navigate to Admin > Process Definition.
  2. Select Attributes from the main document Navigation drop-down, and then click List.
  3. Click on the applicable Submit Attribute Set name.
  4. Click on the applicable attribute name.
  5. Refer to Commerce Attributes & Array Sets for information about different attribute types and editing attributes.
  6. After you have finished your edits, click Apply or Update.

When you click the attribute set name, you can view the details of the individual attributes:

ClosedMy Approval

A special attribute for the Reject/Approve icons is created automatically when a standard Submit Action is created.

The Reject/Approve icon attributes includes a set of approve and reject icons for each reason that has been defined. If reasons are added or modified, the attribute automatically updates. The admin user does not have the ability to modify other properties of the individual icons. The attribute value gets saved to the database when the Approve or Reject button is clicked on the commerce document. When the user clicks the Approve or Reject icon, it updates the value of the reason the user approved or rejected the quote and also the comments that the approver enters. This is done to ensure that two different approvers are not over-riding each other's approvals.

My Approval comments

The My Approval attribute is uneffected by a read-only document view.

ClosedApproval Status

This attribute is created automatically when a standard Submit action is created.

The Approval Status attribute lists all of the approvals that are currently pending for a quote. If the quote is not waiting for approvals, the Approval Status section will read "No Approvals Pending".

Approved Status

ClosedApproval History

The Approval History attribute is automatically created when a standard Submit action is created by the FullAccess user.

The Approval History attribute keeps a record of everything that is happening with the approvals. It shows the person who created the quote, when the quote was submitted for approval, and a history of who has approved the quote and on what date.

Approval History

Note that the Approval History is cleared when the Revise action is triggered. To prevent clearing of the approval history records, select the Retain Past History checkbox from the General tab of the Approval History attribute. Refer to Editing a Document Attribute for information about the Attribute Editor.

Approval History Submit Attribute

ClosedApproval Revision

The Approval Revision history attribute is an Integer attribute that will count the number of times the quote has been revised.

ClosedRule Inputs

ClosedApproval History

ClosedApproval Status

ClosedAdditional Rule Inputs

ClosedFunctions

The getreasonstatus() function evaluates whether a reason has been completely approved or not. The syntax for this function is:

Integer getreasonstatus(String Curr_reason_variable_name)

Return Value Format: Integer Constraints.

Attribute Description
BM_REASON_STATUS_INVALID No reason exists in reason tree with given variable name
BM_REASON_STATUS_INACTIVE Reason exists in reason tree, but the condition for the reason is not met.
BM_REASON_STATUS_PENDING Active reason has not been completely approved.
BM_REASON_STATUS_APPROVED Reason that has been completely approved.
BM_REASON_STATUS_REJECTED Reason that has been completely rejected.

 

Notes

As with any change to a Commerce layout, you must replicate this change in any corresponding Mobile layouts. For more information, see Mobile Layouts for Commerce.

Order of Operations:
1. Sub-Document Modify tab of Update Line Item Action is evaluated
2. Update Line Item Validation is performed
3. Modify Tab of Standard Approval Action is evaluated
4. Advanced Modification of Standard Approval Action is evaluated
5. Advanced Validation of Standard Approval Action is performed
6. Recalculation of user side Reason approval tree is performed
7. Step Transition is performed
8. Save Reason Tree Info/Update Approval History/Updated Approval Status

  • The first two operations are run only when the line item data has changed.
  • The Modify Tab/Advanced Modification of the Submit action provide the values on which the tree calculation is based for the first time. If there are reasons to approve at the end of the Submit action, the Request for Approval action is automatically run and the tree is calculated based on the values derived from the modify tab/advanced modification of the Request for Approval action. Therefore, modify tab/advanced modification of Submit Actions should be the same as the modify tab/advanced modification of the Request for Approval action, especially for attributes that are used in the tree calculation (that is, attributes that are used in the reason condition or the next approver condition).
  • Getreasonstatus() is updated (in most cases) at the end of all the operations, so it will not return the statues of a reason in the same pass. In general, getreasonstatus(except for reject)/approval history are updated at the end of the action so the updated history/status is not available in the same action that changes the status/history.
  • Reset reasons are removed from approval history. However, approval history for a rejected reason is not reset before the Reset Reason tab is run. So, check Approval History for the status of a recently rejected reason in the Reset Reason tab, but remember that the rejected reason will be removed from the history right after Reset Reason

  • Approval attributes (e.g. submit comments, approve/reject comment, document link, current approver, next approver, current reason name, and current reason description) are updated after normal modifications occur in the Commerce action flow, therefore the updated values are not available to populate text or text area type attributes.

  • Approval attributes are intended for use in approval notifications only and are populated dynamically when used in the advanced notifications.
The Submit attributes must be added to the Commerce document by using the Layout Editor.

 

Related Topics

Related Topics Link IconSee Also