Custom Actions

by Community Manager on ‎08-13-2015 11:19 AM - edited on ‎12-08-2016 01:35 PM by Community Manager

OVERVIEW 

Custom Actions are user-created buttons in the Quote Line Editor and Configurator; these buttons can be configured to perform a variety of actions that streamline user workflows.

 

Certain Custom Actions are shipped with all installations of Salesforce CPQ and are present by default in the Quote Line Editor or Configurator. Default Quote Line Editor Custom Actions include:

 

  • Add Products
  • Add Favorites
  • Save
  • Quick Save 
  • Reset Discounts
  • Delete Lines
  • Add Groups
  • Optional: All

CUSTOMA CTIONS.png

 

While all Custom Actions can be viewed by selecting the Custom Actions tab>View All, native Salesforce CPQ Custom Actions can be identified by having a Display Order of 900 or greater. 

 

The walkthroughs below will review how to create a new Custom Action and various methods of useful new Custom Action features.

 

DETAILS

Caution - For versions of SteelBrick CPQ prior to Spring '16: If you have at least one active custom action, then the standard buttons Add Products or Upgrade Assets will not appear on the Line Editor.

 

Tip: There is no limit to the number of line editor buttons you can create, but Salesforce CPQ  best practices advise against creating more than 6-8. More than that could clutter the Quote Line Editor screen and create a diminished user experience.

 

Note: Field dependence between Target Object and Target Field are enabled in the managed package. Adding custom fields to the Target Field picklist will require an update to such dependencies.

 

The following table provides an explanation of the managed fields included in the Custom Action object: 

Field
Description
Action Name Enter a name for the Action. Note: This does not represent the name that will appear on the button.
Label  Choose the label that will appear on the button. NoteYou may need to add additional picklist values to the Label field.
Description  Enter a description that the user will see when they hover over the button.  
Display Order  Enter the order in which this action should appear in the UI.  
URL  Specify the URL to navigate to. See Custom URL for Custom Action for more information. 
URL Target  Specify whether the action firing will cause a new popup page or replace the current the page. 
Active  Select to activate the action so it appears in the UI.  
Default  When checked, this Custom Action will automatically appear in its selected Page. See Setting a Default Custom Action for more information. 
Conditions Met 

Choose the behavior for your conditions: 

  • Any: Works as logical OR
  • All: Works as logical AND
Target Object Choose the Target Object:
  • Product: Opens a Product selection page.
  • Asset: Opens an Asset selection page.
  • Subscription: Opens a Subscription selection page.
Page

Choose the page that you want the custom action to appear on: 

  • Product Configurator: The button will appear next to Save and Cancel in the Configurator.  
  • Quote Line Editor: The button will appear in the header with the other Line Editor actions.  
Location 

Select where the action will be located on the page: (Spring 16)

  • Quote
  • Quote Group
  • Group
  • Line
Type

Each option in this field will render the Custom Action as a different UI element: (Spring 16)

  • Button
  • Menu
  • Separator
Icon

Select an Icon for this Custom Action. (Spring 16)

 

SETUP

  1. Admins may need to add the Custom Actions tab to their org's default tab layout.

 

PROCEDURES

To create Line Editor Buttons :

  1. Navigate to the Custom Actions tab
  2. Click New.
  3. Enter a meaningful Action Name.
  4. Choose a Label from the picklist. This will be the name that appears on the Button. NoteYou may need to add additional picklist values to the Label field.
  5. Enter a Display Order. This sets the order, from Left to Right, that the buttons will be displayed on the Line Editor.
  6. Select Active to activate the rule. Note:If you have at least one active custom action, then the standard buttons will no longer be available in the Line Editor.
  7. Choose the Target Object:
    1. Product: Opens a Product selection page.
    2. Asset: Opens an Asset selection page.
    3. Subscription: Opens a Subscription selection page.
  8. Click Save.

At this point, you can create Search Filters that are initiated with the button you just created.

 

To create a Search Filter associated with a Line Editor Button:

  1. Click New Search Filter, from the Custom Action you just created.
  2. Enter a meaningful Filter Name.
  3. Enter a Display Order. This sets the order that the filter will appear to the user.
  4. Choose the Target Object:
    1. Product: Will filter a Product selection page.
    2. Asset: Will filter an Asset selection page.
    3. Subscription: Will filter a Subscription selection page.
  5. Choose a Target Field, based on the Target Object selected. For example, if you select Product as your Target Object, you can create a filter on the Name, Product Code, Product Name or Product Type.
  6. Choose an Operator to use with the Target Field and Filter Value fields.
  7. Enter a Field Value. This can be left blank to return all results.
  8. Select Hidden if you do not want the filter to display to your users. It will, however, be used in search queries.
  9. Click Save.

 

To create a conditional action: 

You can conditionally hide or show an action based on a defined set of criteria.  For example, you only want the button to appear in the configurator if Product Code = ABC.  

  1. Navigate to an existing Custom Action or create a new one as explained in the previous section.  
  2. For Upgrades:  Add Custom Action Conditions Related List to the Custom Action page layout.  
  3. Choose Any or All from the Conditions Met picklist.  
  4. Click New Custom Action Condition from the Custom Action Conditions related list. 
  5. Enter a Custom Action Condition Name.  
  6. Choose a Target Object:  
    • Quote: The condition will be evaluated against a Quote object field.  
    • Product: The condition will be evaluated against a Product object field.  
  7. Choose a Field that is related to the Target Object.  Note: You will have to add the API name of the field to the picklist.  
  8. Choose an Operator.  
  9. Choose a Field Value.  
  10. Click Save.  

CustomActionCond.png

 

DEFAULT CUSTOM ACTIONS

Administrators can set a Custom Action as the default Action when creating new Quotes. Previously, sales reps were directed to the Line Editor after creating a new Quote, requiring them to manually click an Action button in order to add Products.

 

Details

  • Setting a Custom Action as the default determines which set of Products the sales rep is directed to when created a new Quote. 
  • If multiple Custom Actions are flagged as "Default," sales reps are automatically directed to the Products associated with the first Custom Action that appears in the Display Order.

Setup

Admins may need to modify the following page layouts:

  • Add the Default field to the Custom Actions page layout.

Procedures

  1. Navigate to the Custom Actions tab and select a Custom Action to edit or create a new one.
  2. Enter any relevant information into the Custom Action Edit page, such as: Action Name, Label, Display Order, and Target Object.custom action1.png
  3. Select the Default checkbox.
  4. Select the Active checkbox.
  5. Click Save.

Note: SteelBrick CPQ Minor Releases contain features and upgrades, for specific customers, that are not yet available in a public release. The feature noted below will be publicly available in the next Major Release.

 

Custom Actions Inheriting Brand Button Styling

By default, Custom Actions will inherit the Group Button styling assigned to Buttons in an active Theme. As of Salesforce CPQ 26.1, Custom Actions may inherit Brand Button (Primary Button before 26.1) styling instead. This can be changed by navigating to a Custom Action's record and checking the Brand Button checkbox field - when checked, all Custom Actions with the Type field set to Button will inherit the active Theme's Brand Button styling. This will only style un-nested Custom Actions.

 

Note: Admins may need to add the Brand Button field to the Custom Action page layout.

 

SEE ALSO

Custom URL for Custom Action

Setting a Default Custom Action

Integration to 3rd Party Web Applications

 

 

Comments
by KSmith
on ‎01-05-2016 12:08 PM

On a search filter, if the Filter Value is populated, should the filter be populated with that value automatically when in the product search screen? 

by KSmith
on ‎01-05-2016 12:12 PM

Can check box fields on the product be used as search filters?

by Community Manager
on ‎02-18-2016 11:31 AM

The description for URL Target was blank. I have replaced it with 

Specify whether the action firing will cause a new popup page or replace the current the page. 

 

 

Let me know if this can be made more descriptive.

by Community Manager
on ‎02-18-2016 11:47 AM

For the first tip, do we need to explain how it diminishes user experience? IE, "...diminished user experience by greatly increasing processing time."

by MattSchuett
‎02-23-2016 11:59 PM - edited ‎02-23-2016 11:59 PM

I can set search filters by product family.  How can I set search result columns by product family?

by camilasnapbi
on ‎08-17-2016 06:10 PM

Can I remove the select & add more button from the quote line editor?


by chickman2
on ‎08-22-2016 02:48 PM
@lvoelz2 the link for the related article "Integrating to 3rd Party Web Applications" does not work, FYI.
by Community Manager
on ‎08-22-2016 02:50 PM

@chickman2 Fixed, thank you for the heads-up.

by OpFocus
on ‎10-27-2016 09:25 AM

Is it possible add Quote Line as a Target Object for a Custom Action Condition? (Currently it works only for Quote and Product.) I'd like to be able to add a Custom Action at the Quote Line level that is available only if the line has been saved.

by
on ‎12-02-2016 12:47 AM

Only the following are listed for objects that can be used for custom action conditions.

  1. Choose a Target Object:  
    • Quote: The condition will be evaluated against a Quote object field.  
    • Product: The condition will be evaluated against a Product object field.

This implies that you can't set conditions based on quote line object fields, despite being able to set custom actions at the quote line level.

 

Is this correct? If so, is this a bug or an enhancement?

 

Thanks,

 

Dan Hansen

by wweisger
on ‎04-25-2017 08:34 AM

I set up the Custom Action to go straight into the Product Selector when clicking Edit Lines. What I have realized though is that in loading, it will actually briefly show the Line Editor screen and then jump to the Product Selector. Is this common, or is it due to being in Sandbox versus Production?


by
on ‎05-14-2017 11:32 PM

I having a hard time getting a custom action to show dynamically on an indavidual quote line based on the Product Code. The custom action references a custom VF page. Is using custom action conditions for custom actions that reference a VF page not supported. It appears to not work no matter what the condition is.

 

I have the target object set to Product and am using the starts with operator as shown above. Regardless the, Custom Action always shows for all products.