Commerce Document Actions

Overview

Commerce actions trigger events within documents 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. It also generates additional actions when Commerce documents include certain attribute types.

ClosedStandard Process Actions

Commerce actions trigger events within documents to occur. Standard Process actions cannot be deleted, but the action functions can be viewed, overridden, and easily returned to their default values. The Standard Process attributes and actions come with predefined functional logic that is ready for customers' use. If required, seeded logic can be overridden by administrators to incorporate their customization logic.

Standard Process Action Overrides

To view a pre-defined function in read-only mode, click View Function.

Standard Process actions come with standard settings and values for advanced modify and the modify tab. These values and settings can also be overridden and returned to the standard values by removing the override.

Standard Process Action Modify tab

For Modify and Add from Catalog actions, the Standard Destination values and options can be overridden if desired. You can quickly return to the standard values and options by removing the override. To view the default values, check to Override Standard Destination option, and then click Apply.

Standard Process Action Destination tab


Select the following options to view a list of respective actions.

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.

ClosedComponents of an Action (i.e. Tabs)

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 available tabs and options on each tab will vary per action type.

Action componenets (Tabs)

ClosedOrder of Operations

Action Types

All Commerce actions are administrated from the Admin Actions page. You can customize system-generated actions by modifying action labels and creating action rules. Administrators can also add and modify the following user-defined action types.

ClosedAdd from Catalog (Available for 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 and sub-document:

  • 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.

These actions are supported for the Favorites List page, the Commerce home page, and Catalog pages. Although this section can be directed to external URLs, it is not possible to return to a Commerce document from an external URL.

ClosedBack (Available for 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.

This action does not save user data.

ClosedCopy Line Items (Available for 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.

ClosedCopy Line Items Order of Operations

ClosedSplitting Line Items

ClosedImplementing Copy Line Items in an Integrated Process

This action does not allow users to copy non-configured line items (parts) if they do not have access to the required Price Books.

  • 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.
  • 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.

ClosedCopy To Favorites (Available for Main Document

ClosedCreate Price Agreement (Available for Main Document)

ClosedDisplay History (Available for Main Document and Sub-Document)

ClosedE-mail (Available for Main Document and Sub-Document)

ClosedExport Attachment (Available for Main Document and Sub-Document)

ClosedExport Line Items (Available for Main Document)

ClosedImport Line Items (Available for Main Document)

ClosedLock (Available for Main Document)

ClosedModify (Available for Main Document and Sub-Document)

ClosedPrint (Available for Main Document and Sub-Document)

ClosedRefresh (Available for Main Document and Sub-Document)

ClosedSubmit (Available for Main Document)

ClosedUnlock (Available for Main Document)

ClosedVersion (Available for Main Document)

Administration

ClosedAdd Commerce Actions Watch Video  Video icon

  1. Navigate to the Admin home page.
  2. Click Process Definition in the Commerce and Documents section.
  3. Click on the applicable Commerce process.
  4. Select Actions from the Navigation drop-down for the applicable document, and then click List.
  5. Click Add at the bottom of the Actions List page.
    1. Enter a Label.
    2. Enter a unique 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.

    3. Select your desired Action Type from the drop-down.
  6. Click Add to save changes and open Admin Action editor or click Cancel to return to Action List without saving changes.
  7. Edit the available tabs.

    ClosedGeneral Tab

    ClosedModify Tab

    ClosedDestination Tab

    ClosedXSL Views Tab

    ClosedEmail Fields Tab

    ClosedIntegration Tab

    ClosedInitialization Tab

    ClosedMappings Tab

    ClosedDocument Views Tab

  8. Select one of the following:
    • Translations: Oracle CPQ content and product templates can be translated into the following languages: French, German, and Spanish.
    • Apply: saves changes and remains on the page.
    • Update: saves changes and returns to the Document List page.
    • Update and New: saves changes and creates a new action.
    • Back: returns to the Document List page without saving changes.
    The new action appears in alphabetical order on the Actions List page.

ClosedCloning Commerce Actions Watch Video  Video icon

  1. Navigate to the Action List page and perform one of the following actions:
    • Mark the checkbox of the desired action under the Select column and then click Clone.

      Action List page

      Only one Commerce action can be selected to clone at a time. Selecting multiple actions from the Admin List page results in an error message.
    • Click on the name of the action you wish to clone. When the Admin Action page displays, click Clone.

      Admin Action page

      The Admin Action page for the newly cloned action displays.

      Admin Action page for the newly cloned action

  1. Enter a Name in the Label field for the new cloned action.
  2. Enter a unique Variable Name or accept the default variable name in the Variable Name field for the new cloned action.

    Click Clone

  3. Click Clone. The Admin Action page for the new cloned action displays.

ClosedDeleting Commerce Actions Watch Video  Video icon

  1. Mark the checkbox of the desired action under the Select column within the Actions List page.

    Actions List page - select action to delete

  2. Click Delete.

Use caution when deleting a Commerce action because it is not possible to recover the deleted data. Upon a deletion, all associated rules within the Commerce action are also deleted.

Notes:

  • It is not possible to delete default, system-generated actions. For default actions created in association with document attributes, the system deletes these actions automatically when the corresponding attribute is deleted.
  • Standard Process actions cannot be deleted, but the action functions can be viewed, overridden, and easily returned to their default values Most Standard Process actions can be removed from the layout if a customer does not want to use them.
  • You can delete all custom actions by checking the Select All box and then clicking Delete.

ClosedGenerate a Commerce Action Performance Analysis Watch Video  Video icon

To generate a Commerce action performance analysis, perform the following steps:

  1. Navigate to the Action List page.

    Admin > Commerce and Documents > Process Definition > Documents > Actions

  2. Click on the name of the applicable action.

    The Admin Action page opens.

  3. Click on the Performance tab.
  4. Enter the applicable information:

    1. For main document actions, enter the Transaction ID.

      Generate Performance Analysis for Transaction ID

    2. For sub-documents, enter the Transaction ID and Document #.

      Generate Performance Analysis for sub-document

  5. Click Generate.

    The performance analysis operation includes BML functions in Advanced Modify Before and After Formulas, Advanced Validation, Modify options, Destination options, and BML integrations. Upon execution, the Commerce action Performance tab displays the following times for associated BML loops, BMQL, URL data calls, library calls, and JSON parsing.

    • Total Time: Total time taken, in milliseconds, to execute the nested BML, including any time spent executing BML items that have their own entries.
    • Incremental Time: Time taken, in milliseconds, to execute the nested BML, excluding time spent executing BML items that have their own entries.
    • Child Rollup Time: Total combined time taken, in milliseconds, for all BML items called from this BML item.

    Performance Analysis

Notes:

  • Actions that do not have BML functions will not show the Performance tab.
  • The run-time breakdowns are specific to BML functions and do not reflect non-BML execution times.
  • Generating a Performance Analysis does not save changes to the quote.
  • The external integrations defined in the Integration tab are not executed when generating a Performance Analysis, but calls from other BML using the urldata functions will execute and may modify external systems

ClosedFormulas in Reconfiguration Scenarios

The Reconfigure action is split into one parent (Reconfigure) and one sub-action (Reconfigure Inbound). This eliminates the need for conditionals to segregate logic.

  • The parent action (Reconfigure) contains all things common to both Reconfigure actions and its own identifiers: Label, Variable Name, Description, Action Icon, Show Loading Dialog, Layout Path, and Document Views Tab.
  • The sub-action (Reconfigure Inbound) only contains what is specific to it.
  • This allows administrators to execute a formula per attribute on:
    • Outbound paths from a Commerce Transaction.

    The Formula will run immediately after the user clicks the Reconfigure action in Commerce, and before the user enters Configuration.

    • Inbound paths to a Commerce Transaction.

    The Formula runs after the user clicks Save in the Reconfiguration, and before the user returns to the Commerce page.

  • Formula execution is consistent with the existing order of operations for inbound and outbound executions.

 

Notes

Notes:

  • In order for any action to appear on a commerce document, it must be included in the document view.
  • Commerce actions can be created, deleted, and edited one document at a time.
  • User will be prevented from creating or adding Quotes from Configuration to Commerce if mandatory items are missing.

Custom Variable Name Conventions

In Oracle CPQ 23D, CPQ adopted Oracle CX Sales variable naming conventions for custom items. When an administrator creates a new custom Commerce item, the "_c" suffix is appended to the variable name. The new naming convention for custom variable names provides more consistency for integrations with Oracle Sales.

Beginning in Oracle CPQ 24C, customers can submit a service request to disable the "_c" suffix on variable names for custom Commerce entities (Actions, Analytics, Attributes, Data Columns, Integrations, Library Functions, Rules, Steps, etc.). The "_c" suffix is enabled by default for standard and legacy Commerce processes.

  • Customers can submit a Service Request (SR) on My Oracle Support to disable the "_c" suffix on variable names for custom Commerce entities
  • When the "_c" is disabled, the "_c" variable name suffix will not be required for newly created custom Commerce entities.
  • Disabling the "_c" variable name suffix for custom Commerce entities will not change existing variable names.
  • The "_c" suffix setting will not impact existing variable names when cloning a Commerce process or migrating Commerce items. Target variable names will be the same as the variable names from the source Commerce process.
Oracle CPQ recommends avoiding actions that call other actions on the same quote through BML. If this is implemented, the advanced validation of the parent action should be "modify without saving or validating".

 

Related Topics

Related Topics Link IconSee Also