Commerce Actions
Overview
Commerce processes contain two categories of actions:
-
Process Actions trigger events within a Commerce Process. CPQ provides a standard set of process action with predefined functional logic for each Commerce Process. Process actions cannot be deleted, but some action settings can be modified. For more information, refer to Commerce Process Actions.
-
Commerce Document Actions trigger events within their respective main document or sub document to occur. Users usually perform Commerce actions, but timers can be set up so the system can automatically perform Commerce actions after specified periods of time. The Commerce system creates a default set of actions for use in each process and document. For more information, refer to Commerce Document Actions.
Standard Process Actions
CPQ provides a Standard Process that includes several actions that come with predefined functional logic that is ready for customers' use. Standard process actions cannot be deleted. If required, seeded logic can be overridden by administrators to incorporate their customization logic. Select the following options to view a list of respective actions.
Action Types
CPQ has several types of actions. Administrators can create custom document actions for some of the action types.
Add from Catalog (Main Document and Sub-Document)
Add from Catalog actions allow the user to add line items to a transaction. Destinations can be set for Add from Catalog type actions. Multiple Add from Catalog type actions can be added to the same document to offer users different catalog destinations within the application.
This action has different options for the main document (Transaction) and sub-document (Transaction Line):
-
Main Document: Here the tab contains a simple URL field. The valid value for the URL field is the relative path to any page on the Oracle CPQ application.
For example: On the main document, you can use an Add from Catalog action as a quick link that always goes back to the same page, either a page in the catalog or a Favorites List page.
-
Sub-Document: Here the tab contains a simple URL field as well as an advanced function option. On sub-documents, you can set up advanced destination rules for Add to Catalog type actions. This has the added benefit of enabling you to link the Add from Catalog action to different catalog pages depending on the subsystem components that still need to be added to the document.
The valid value for the URL field is the relative path to any page on your application.
The advanced function is usually used to display the action in the line item section of the main document.
Add from Catalog type actions created for sub-documents should be added to the line item group for the main document only. They should not be added to the sub-document view.
Auto Fill (Main Document)
Regardless of where you are mastering your customer data, Oracle CPQ makes it easy to find and retrieve account data during your quoting process by using a collection of main document action types such as Auto Fill, Browse, View, and Select Alternate Address.
When an Account is selected during the quoting process, the Auto Fill action populates the Account attribute and address values to the mapped main document attributes.
Back (Main Document and Sub-Document)
Back actions are used to take the user back to the previous page, depending on which document they are on.
-
If the user is on the main document, clicking Back will take the user to the transactions / quotes list page.
-
If the user is on the sub-document, clicking Back will take the user to the main document.
Browse (Main Document)
Regardless of where you are mastering your customer data, Oracle CPQ makes it easy to find and retrieve account data during your quoting process by using a collection of main document action types such as Auto Fill, Browse, View, and Select Alternate Address.
Once created, an Account can be selected during the quoting process using the Browse action.
Note: Read/Write access for the _customer_id attribute must be enabled in the workflow participant profiles on the transaction step from where the Browse action is triggered. Commerce process > Steps > Workflow Step > Participant Profile > Document Views > Transaction > Attributes.
Calculate Price (Sub-Document)
The Calculate Price action applies any pricing changes made on line items to the price attributes. The sub-document (Transaction Line) Prices Array Set is used to hold the prices and charges information for line items.
Change Currency (Main Document)
This actions allows the user to change the currency of an existing quote. By default, users cannot change the currency of a Transaction after it has been created. However, administrators can allow users to change the currency of Transactions that have been created but that do not contain any line items by adding the Change Currency action to the Commerce layout. Once one or more line items exist on a Transaction, the Change Currency button is hidden and cannot be invoked on the Transaction unless all line items are removed from the Transaction. Like any action, access to the Change Currency action can be restricted by using Steps.
When the Change Currency action is on the layout, the site’s supported currencies will be in a drop-down next to the action, with the current currency selected. Selecting a different currency from the drop-down and then clicking Change Currency will change the Transaction’s currency to the selected currency.
Note: Sites that are integrated with a CRM system cannot have the Change Currency button added to the Commerce layout. The action will exist on the site but will not be available to the admin in the Commerce Layout Editor.
Copy Line Items (Main Document)
The Copy Line Items action can only be defined for the main document. This action enables users to make one or more copies of one or more line items (configured and non-configured) at a time.
Note: When a Copy Line Items action is added to the JET UI Line Item Grid, the Copy action is not available when the Select All function is used.
- As a workaround users can select the first item in the Line Item Grid, navigate to the last item, and then press the Shift key while selecting the last item in the Line Item Grid.
The Copy Line Items action is available with the Select All function when the Copy action is outside the Line Item Grid.
Copy Line Items Order of Operations
- Click Copy.
- The form Data is saved as is (along with the line item group attribute values and other main document parameters on the form / document JSP page).
- Run Initialization.
- Run Modify tab of Copy Line Item action.
- Run Advanced Modification of Copy Line Item action.
- Run Advanced Validation of Copy Line Item action.
- Set quantity to
1within the Copy Line Item action Initialization tab. -
Select the option Default to Quantity in the General tab to specify that the Number of Copies field in pop-ups is pre-populated with the desired quantity.
- When the user selects the line item of quantity "n" and then clicks Copy Line Item, a pop-up with the number of copies with a pre-populated value "n" is displayed to the user.
- When the user clicks Copy, "n" copied line items with quantity 1 ( Initialization tab will initialize the quantity to 1) is produced. If n=1, then the Copy Line Items pop-up does not appear.
Implementing Copy Line Items in an Integrated Process
To successfully implement the Copy Line Item action in an integrated process, the user must set the opportunity's line item ID to Revert to Default in the Initialization tab of the Copy Line Item action. This is done to ensure that the copied line items are added to the Salesforce opportunity with the unique line item ID's.
This action does not allow users to copy non-configured line items (parts) if they do not have access to the required Price Books.
Notes:
- Recommended items are copied, maintaining the ratio of the configured line item (model) to the recommended items.
-
You cannot copy a recommended item separately.
Example: Assume that a model M1is associated with a dozen of part P1 (recommended item). If you make two copies of M1, then you will get two additional line items of M1 and two additional dozens of part P1
- Set the maximum number of copies in the General tab for this section. The default value is 10 lines. The maximum amount of lines that can be copied at a time is 99.
- When copying a configured line item, both mandatory and non-mandatory recommended items are copied, along with configured line item.
- If the maximum number of copies is higher than 1, a pop-up appears after clicking Copy Line Item. The user can specify the number of copes in this pop-up. You can also specify that the Number of Copies field in the pop-up be populated with the quantity of the selected line item.
- You can map the line item attribute to the pop-up in the Admin Columns page.
Copy To Favorites (Main Document
The Copy to Favorites is a special action to copy selected line items from a transaction to the Favorites List.
Notes:
-
The Copy To Favorites action is available only on the main document. It is a special action that is used to copy selected line items from the transaction to the Favorites List. From here the user can add it back to the Transaction.
-
Beginning in Oracle CPQ 22A support has been added to invoke a Commerce Transaction when reconfiguring an item from the Favorites List. The Commerce invocation action will be visible on the Configuration page when a Favorite is reconfigured. Prior to this feature implementation, users would need to save the reconfigured Favorite and exit Configuration, and then go into Commerce to add the Favorite to a quote. Note that if you are reconfiguring a Favorite and you invoke a Commerce Transaction instead of saving the Favorite, the changes you made are not saved to that item in the Favorite List.
Create Price Agreement (Main Document) * Automatically created when the process Agreement Stage is enabled
The Create Price Agreement type action is used to publish the pricing for a CPQ sales agreement to the CPQ Pricing Portal as a Price Agreement.
Customer Assets (Main Document)
The Customer Assets type action is used to display Customer Assets when ABO is enabled in standard mode.
Display History (Main Document and Sub-Document)
Used to extract the change history for a document. This action requires an XSL format file that controls how and which changes appear.
The Display History action contains a special tab called XSL Views tab. The XSLs displayed on this tab come from the Printer Friendly/History XSL Views section. This action can be associated with one or more XSL views. If multiple XSL views are made available with the action, users can select the form they want to use.
E-mail (Main Document and Sub-Document)
Enables users to access email-friendly document formatting. It is a Modify action and hence has all characteristics of a Modify action, including document views, integration and the modify tab.
Export Attachment (Main Document and Sub-Document)
The Export Attachment action enables a user to add the proposal (PDF) to the related partner opportunity (only on an integrated application). It is a Modify action and hence has all characteristics of a Modify action including document views, integration, and the modify tab.
Export Line Items (Main Document)
The Export Line Items action enables users to download the Transaction Line Items with all the attributes currently accessible to them. The export includes all their viewable information from the Line Item Grid as determined by their user profile settings.
Upon executing the Export Line Items action, users can download the Transaction Line Items with all the attributes currently accessible to them. The export includes all their viewable information from the Line Item Grid as determined by their user profile settings. If a Line Item Grid column is hidden from the end user by a Commerce access rule or a Line Item Grid view filter, that data is exported.
Note: This action is only available for Redwood Quote UI and JET Transaction UI.
GenAI Assist (Main Document)
The GenAI Assist type action is used to retrieve the GenAI summary from an integrated Oracle Sales site. CPQ leverages Generative AI (GenAI) to automatically generate comprehensive quote summaries. Users can then choose to use the generated quote summary when communicating with customers or internal stakeholders, as needed.
Notes:
-
The GenAI quote summaries are available for Redwood Quote UIs and JET Transaction UIs.
-
In Oracle CPQ 25B, the GenAI Assist type action is only available for CPQ sites integrated with Oracle Sales.
-
Beginning in Oracle CPQ 25C, integrated CRM customers (e.g Salesforce or Microsoft Dynamics) can use the Generative AI - Generic Integrations to develop Generative AI (GenAI) Quote Summaries.
Import Line Items (Main Document)
The Import Line Items action enable users to export line item data to a Microsoft Excel (XLSX) file on the user's local computer. With this file users can run formulas and calculations on the Transaction data quickly and easily.
Upon executing the Import Line Items action, users can import line item data from a modified CPQ-exported Microsoft Excel (XLSX) file. This feature leverages Microsoft Excel with Oracle CPQ Commerce to add new or modify existing transaction line data. End users can perform analysis and approval activities before importing line item modifications into the CPQ Transaction. Independent line items or unconfigured Model line items can be added to the CPQ export XLSX file. The export XLSX file provides necessary identification data to determine modifications to a pre-existing CPQ Line Item.
Note: This action is only available for Redwood Quote UI and JET Transaction UI.
Lock (Main Document) *Collaborative Editing or Transaction Locking must be enabled
The Lock action enables users to lock a Transaction for situations when a Transaction owner needs to freeze activity on the Transaction and prevent any further changes. For example, prior to submitting a quote for approval or when finalizing a quote and converting it to an order. When a Transaction is locked, only the locking user can make changes. Other users are only able to view the Transaction in read-only mode.
Refer to Transaction Locking for more details.
Note: The Lock action is not automatically available on the Transaction UI. Administrators must create a Lock action and then add the action to the Responsive Layout.
Modify (Main Document and Sub-Document)
Most common type of user-defined action. A Modify action can be entirely customized to suit the FullAccess user's needs.
Open Doc (Main Document)
The Open Doc action displays the Line Details for a specified transaction line.
Print (Main Document and Sub-Document)
Enables users to access printer-friendly forms for printing.
It is a Modify action and hence has all characteristics of a Modify action, including document view, integration and the Modify tab.
Reconfigure (Main Document and Sub-Document)
The Reconfigure action allows the user to edit a configuration after its been added to the transaction. The functionality attached to this action will fire before moving to Configuration.
Reconfigure Inbound (Main Document and Sub-Document)
The Reconfigure Inbound action is called when the user returns to the quote after editing a configuration. The functionality attached to this action won't fire until the user has returned to the transaction.
Refresh (Main Document and Sub-Document)
This action refreshes the current Transaction or Transaction Line with last saved data; the refresh action removes the existing values and replaces with the last saved data.
Select Address (Main Document)
Regardless of where you are mastering your customer data, Oracle CPQ makes it easy to find and retrieve account data during your quoting process by using a collection of main document action types such as Auto Fill, Browse, View, and Select Alternate Address.
When alternate addresses are used, the Select Address action can be used to choose one of the additional addresses to replace the default address set or to populate an alternate address set on the transaction.
Submit (Main Document)
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 - Submits the transaction for approval. If no approvals are defined or triggered for the transaction, the status will move directly to the approved step.
- Request Approval - This action is performed when submit action is clicked and there is at least one reason to approve.
- Approve - This action is performed when a transaction is approved by the approver.
- Reject - This action is performed when a transaction is rejected by the approver.
- Revise - This action is performed when an approver requests revision of a transaction.
Refer to Submit Action Set for more details.
Unlock (Main Document) *Collaborative Editing or Transaction Locking must be enabled
Unlock is a main document action type that is only available when administrators enable Collaborative Quoting or Transaction Locking for an existing Commerce process. Unlock type actions unlock a Transaction when performed. However, Unlock type actions do not perform any further action on the Transaction, such as modify. Administrators can configure the Commerce process to allow users other than the Transaction owner to unlock a Transaction using an Unlock type action.
Refer to Transaction Locking for more details.
Note: The Unlock action is not automatically available on the Transaction UI. Administrators must create an Unlock action and then add the action to the Layout.
Version (Main Document)
The Version action creates a new version of the subject transaction and displays this new version for editing. This action is mainly used in Oracle Sales integration, to version Quotes.
Action Tabs
Both main documents and sub-documents can consist of system-generated actions as well as user-defined actions, created based on supported action types. Because actions are required to carry out operations based on the business logic, they are comprised of components. The components of an action are organized in tabs.
The following table shows which tabs are available per action type.
| Action Type | Available Tabs | ||||||
|---|---|---|---|---|---|---|---|
| General | Modify | Initialization | Document Views | Email Fields | Destination | Performance | |
| Add from Catalog | x | x | x | x | x | ||
| Auto Fill | x | x | |||||
| Back | x | x | x | x | |||
| Browse | x | x | |||||
| Calculate Price | x | x | |||||
| Change Currency | x | x | x | x | |||
| Copy Line Items | x | x | x | x | x | ||
| Copy To Favorites | x | x | x | x | |||
| Create Agreement | x | x | x | x | |||
| Display History | x | x | |||||
| x | x | x | x | x | |||
| Export Attachment | x | x | x | x | |||
| Export Line Items | x | x | x | x | |||
| GenAI Assist | x | x | |||||
| Import Line Items | x | x | x | x | x | ||
| Lock | x | x | |||||
| Modify | x | x | x | x | x | ||
| Open Doc | x | x | x | x | |||
| x | x | x | x | ||||
| Reconfigure | x | x | x | x | |||
| Reconfigure Inbound | x | x | x | x | |||
| Refresh | x | x | |||||
| Select Address | x | x | |||||
| Submit | x | x | x | x | |||
|
Request Approval |
x | x | x | x | |||
|
Approve |
x | x | x | x | |||
|
Reject |
x | x | x | x | |||
|
Revise |
x | x | x | x | |||
| Unlock | x | x | |||||
| Version | x | x | |||||





