Configuration Single Select Pick Lists

Overview

A Single Select Pick List (SSPL), also referred to as a Dynamic Menu, is a Configuration attribute type. Administrators manage the domain of values for a SSPL attribute within a defined resource (e.g. Data Tables or Configuration arrays). The SSPL attribute type can be created in Configuration for Text, Integer, and Float data types. While similar to a Single Select Menu attribute on the user side, a SSPL attribute’s menu options are managed within a defined resource.

SSPL attributes have several advantages:

Administration

ClosedAdd a Single Select Pick List

  1. ClosedNavigate to the Attributes Administration List page.

    1. Click Admin to go to the Admin Home Page.

    2. Click Catalog Definition in the Products section.

      The Supported Products page opens.

    3. In the Navigation column, select Attributes and then click List.

      The Attributes Administration List page opens.

  2. Click Add. The Attribute Editor page opens.

    Attribute Editor with SSPL selected

  3. Enter the information for the following sections:

    Note: The Attribute Editor defines the default display type properties for all layouts.

    ClosedMain Information

    • *Name - Enter the attribute name.
      The Name value appears as the attribute label when this item is added to a Configuration layout.
    • *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.

      Note: Customers should not use any of the following names for Configuration attribute variable names. Using these values may cause issues with customer configurations and could possibly alter site functionality.

      • action_id
      • bm_cm_process_id
      • _bom_
      • bs_id
      • commerce_doc_url_params
      • commerce_list_id
      • document_id
      • document_number
      • folder_id
      • formaction
      • from_config
      • scrollTop
      • shopping_cart_id
      • step_id
      • token
      • version_id
    • *Category - Select Configurable Attribute.
    • Array Type - Select this checkbox if the attribute can be used as a column in an array set.
      Refer to Managing Arrays and Sets for more information
    • *Data Type - Select Text, Float, or Integer.
    • Attribute Type - Select Single Select Pick List.

      The Single Select Pick List section appears.


    ClosedSingle Select Pick List

  4. Select one of the following:

    • Click Add to save changes and open the Menu Attribute Editor, proceed to Edit a Single Select Pick List Attribute.
    • Click Add and New to save changes and create another attribute.
    • Click Cancel to return to the Configurable Attributes Administration List page without saving changes.

ClosedEdit a Single Select Pick List Attribute

  1. ClosedNavigate to the Attributes Administration List page.

    1. Click Admin to go to the Admin Home Page.

    2. Click Catalog Definition in the Products section.

      The Supported Products page opens.

    3. In the Navigation column, select Attributes and then click List.

      The Attributes Administration List page opens.

  2. Click the name of an attribute with Text in the Attribute Type column, or create a new attribute

    The Menu Attribute Editor page opens.

  3. Edit information in the following sections, as required.

    Note: The Attribute Editor defines the default display type properties for all layouts.

    ClosedMain Information

    ClosedProperties

    ClosedImage Menu Properties (Image Menu Properties appear when Image Menus are enabled)

    ClosedSingle Select Pick List

  4. Select one of the following options:

    • If translations are required, click Translations and provide translated values for the label and description fields.

    • Click Apply to save changes and remain on the Attribute Editor page.
    • Click Update to save changes and return to the Configurable Attributes Administration List.

    • Click Update and New to define another attribute.

    • Click Back to return to the Configurable Attributes Administration List without saving changes.


ClosedUsing Distinct Values

ClosedUsing Domains

ClosedUsing Filters

ClosedUsing Images

ClosedUsing Pick Maps

ClosedUse Single Select Attributes and Values in Configuration Rules

ClosedSet the Value of a Single Select Pick List Using a Recommendation Rule Action

Recommendation Rules help buyers configure products by offering suggested attribute values. For each Configuration where a model or part likely has certain attribute values, administrators can create a Recommendation Rule. For example: If a Meat Lovers' pizza has only pepperoni and sausage as toppings, administrators can create a recommendation rule allowing users to modify the toppings.

Administrators can use a Single Select Pick List attribute in a standard action in a Recommendation Rule. When recommendations trigger, they appear to buyers on the Model Configuration page.

Complete the following steps:

  1. Navigate to the Admin Home page.
  2. Under Products, click Catalog Definition.

    The Supported Products page opens.

  3. From the Navigation menu, select Recommendations.
  4. Click List.

    The Recommendation: Rules List page opens.

  5. Click Add.

    The Recommendation: New Rule page opens.

  6. In the Name field, enter a name for the Recommendation Rule.
  7. Click in the Variable Name field to auto-populate the field.
  8. Select Simple Condition as the Condition Type.
  9. Under Action: (Values to Set), click Add Attributes.

    The Attributes dialog opens.

  10. Select the Single Select Pick List attributes to include as actions in the Recommendation Rule.

    Select the Single Select Pick List attributes to include as actions in the Recommendation Rule.

  11. Click Add.

    The Recommendation Rule displays.

  12. Use the Value to Set text entry field to set a value for the Single Select Pick List attribute.
  13. As with other Recommendation Rules, use the Set Type menu to auto-populate the recommended values in the attribute field.

    Set Type

    Description

    None

    The selected value for the action attribute in the rule is the recommended value for the attribute. It will show as a message and it can be modified by the user.

    Set

    The setting of a recommended value can be prevented by locking the attribute, in which case, only the recommended values message is shown. This can be modified by the user.

    Forced Set

    The rule will set the attribute value to the value chosen in the rule. This value is read-only and cannot be modified by the user.

    Recommendation Rule Editor

    Notes:

    • When using Static Text to set the value of a Single Select Pick List via a standard action in a Recommendation Rule, the value is validated in the data table upon performing a Save. If the value does not exist in the data table, an error displays at the top of the Recommendation page noting that the attribute and value are invalid. If the entry is invalid, administrators can insert a correct value to save the Recommendation Rule.
    • If a Single Select Pick List has an invalid entry and administrators choose to set the entry via BML, they must first remove the Static Text entries before setting up the BML action for the attribute. Otherwise, administrators cannot save the Recommendation Rule unless they revert, remove the entries, and re-select the BML.

    Shown below is an example of the Single Select Pick List attributes in Configuration. The attributes are used as actions in a Recommendation Rule and display under the Content heading.

     Single Select Pick List attributes in Configuration


ClosedSet the Value of a Single Select Pick List Using a Punch-In Value

A punch-in is a link used to navigate users directly from one page to another. Oracle CPQ extends the functionality available in Configuration by allowing administrators to set the initial value of a Single Select Pick List by specifying a parameter in a punch-in value.

Complete the following steps:

  1. Navigate to the Admin Home page.
  2. Under Styles and Templates, select Home Page.

    The Home Page Setup page opens.

    Set the Value of a Single Select Pick List Using a Punch-In Value

  3. Select the icon under the Model Punch-In column.

    The Model Punch-ins List page opens.

  4. Click New.
  5. Set the initial value for the Single Select Pick List by browsing to a specific variable name and specifying a parameter in the URL.

    Sample Parameter: exampleSSPL=<variable value>

    Set the initial value for the Single Select Pick List by browsing to a specific variable name and specifying a parameter in the URL.

  6. Click Save.

    In the following example, the initial value of the Single Select Pick List is set to Phone 1.

    Initial value of the Single Select Pick List is set to Phone 1.

    Note: The phone attribute is a Single Select Pick List attribute. Administrators can map the various phone attributes to the associated phone descriptions by creating pick maps. As shown below, the description will then change when users select a different phone option.

    Description change when users select a different phone option.


ClosedSet the Value of a Single Select Pick List Attribute Using a SOAP API

Administrators can use a SOAP API call to set the value of a Single Select Pick List attribute using a punch-in URL or a Recommendation Rule. When sending a SOAP request to set a value for a Single Select Pick List attribute, administrators must use a value in the request. The default value for <displayedValue> is false. Administrators can specify the <displayedValue> as true in the request to show the display value in the response.

Sample Text Single Select Pick List SOAP API request:

Sample Text Single Select Pick List SOAP API request:

Sample Text Single Select Pick List SOAP API response:

Sample Text Single Select Pick List SOAP API response:

Note: Beginning in Release 17D, the SOAP response displays the value of Single Select Pick Lists in the Value column. The default value for <displayedValue> is false. Administrators can specify the <displayedValue> as true in the request to show the display value in the response.

Sample Integer and Float Single Select Pick List SOAP API request:

Sample Integer and Float Single Select Pick List SOAP API request:

Sample Integer and Float Single Select Pick List SOAP API response:

Sample Integer and Float Single Select Pick List SOAP API response:

Note: If a SOAP API calls a Single Select Pick List entry that does not exist or is invalid, the Web Service call is still passed. However, the Single Select Pick List value is not populated and the following error message displays: The value for the attribute is not among the menu items.

Notes

Notes:

  • Prior to Oracle CPQ 19A, the system_user_cpq_server_as_client user was used for OAuth authentication within Oracle CPQ to enable Single Select Pick List functionality. The system_user_cpq_server_as_client user cannot be inactivated or modified—errors will occur when an administrator attempts to inactivate the user and when an administrator attempts to save changes made to the user.
  • Beginning with Release 18B, administrators must include the list of Pick Maps associated with a Single Select Pick List in the XML or CSV upload file. Otherwise, pre-existing Pick Maps will be removed.

  • For best performance, ensure that Filters on large Data Tables have suitable indexes defined. For more information, see Data Table Overview.
  • If a Single Select Pick List is on a desktop layout that has a corresponding mobile layout, the mobile layout will not be available on the user side and the desktop layout will always be used. Additionally, if a Single Select Pick List is on a desktop layout that does not have a corresponding mobile layout, a mobile layout cannot be created. The mobile layout will become available and new mobile layouts can be created as soon as all Single Select Pick List attributes are removed from the desktop layout.

    Mobile layouts will still be available on the user side for Configuration Flow nodes that do not have a Single Select Pick List on the desktop layout. For example, if a Start Node has a Single Select Pick List on the desktop layout but the End Node in the sequence does not have a Single Select Pick List on the desktop layout, the desktop layout will be used for the Start Node but the mobile layout will be used for mobile users on the End Node.

  • After a site restart, the first time a user enters a Configuration Flow on the user side that contains one or more Single Select Pick List attributes, the Single Select Pick List(s) will take longer to load than the rest of the page as the JavaScript cache is loaded.

    The rest of the page will function as expected, and the Single Select Pick List attributes will function as expected once they load. All subsequent times that a user enters a Configuration Flow on the user side that contains one or more Single Select Pick List attributes, Single Select Pick List attributes will load normally.

  • If a Single Select Pick List Array attribute has a Filter and/or a Pick Map that references other Array attributes with the same array control attribute, neither the Single Select Pick List Array attribute nor the Array attributes being filtered-on or pick-mapped can be removed from an array set with the same array control attribute (until the Filter and/or Pick Map references are removed from the Single Select Pick List).

  • If a Single Select Pick List Array attribute has a Filter and/or a Pick Map that references other Array attributes with the same array control attribute, neither the Single Select Pick List Array attribute nor the Array attributes being filtered on or pick-mapped can have their array control attribute changed (until the Filter and/or Pick Map references are removed from the Single Select Pick List).

  • If an array set contains a Single Select Pick List Array attribute that has a Filter and/or a Pick Map that references other Array attributes with the same array control attribute, the array set cannot be deleted (until the Filter and/or Pick Map references are removed from the Single Select Pick List).

  • Have as few attributes "auto-update" as possible.
  • If the data in the Display or Variable name column is empty or specified as “null” in the Data Table, then pick maps do not work correctly. Single Select Pick maps will display “null” for empty values.

  • When a Data Table contains a column name of “class” or “null”, an administrator can use the Data Table but cannot use the column. On the user side, Data Table columns named “class” or “null” break in Configuration.

  • Numeric Configuration attributes used in a Single Select Pick List filter are now validated when the attribute focus is lost, which occurs when a user clicks away or uses the Tab key to go to the next attribute on the page. In previous releases, numeric Configuration attributes (e.g. integer or float) were not validated until the Configuration was saved or updated.

  • Beginning in 2016 R1, Single Select Pick List Configuration attributes show both the Display value and the Variable name “Label[varname]" in the pipeline viewer for all Configuration attribute types.

Best Practices

When using Single Select Menus, Multi-Select Menus, or Single Select Pick Lists in a BOM Mapping implementation CPQ recommends that all menu option values are mapped in the BOM Item Mapping table to ensure proper operation.

For more information, refer to BOM Item Mapping Table and BOM Mapping Implementation Resources.

 

Related Topics

Related Topics Link IconSee Also