Punch-Ins
Overview
Punch-ins are links that hook into specific pages in the system. They can be used to navigate directly from one page to another within your application. They can also be used to jump into a specific page from an external web site.
External punch-ins must enter the username and password information so that an authentication can be performed to ensure that a valid user is trying to access the page.
Administration
Creating a Custom Punch-In
- Navigate from: Admin Home Page > Styles and Templates > Home Page.
- Select the product line/model you need to create a punch-in for in the selector punch-in column.
- Click New.
-
Enter the name and variable name for the punch-in.
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.
-
To hide a punch-in on the home page, select the corresponding checkbox under the Hide column.
You can only hide default punch-ins.
- You can set the following punch inputs in the parameters column:
- To set attribute values on selector configuration or model configuration, use
variableName1=variableValue1&variableName2=variableValue2... - To trigger conditions to pick up the right configuration flow in model configuration, use
variableName1+variableValue1+variableName2+variableValue2... - To enable selector recommendations for model configuration, use
variableName1@variableValue1@variableName2@variableValue2... - Change:
&_variable_name_punchin=true....This parameter controls whether to use the Label or variable name for parameters. It is defaulted to false.
- Click on Save or Save and Close to save changes. Click on Delete to delete the selected custom punch-ins.
-
Deploy the homepage.
When the variable is of menu type, the menu values are passed as a tilde delimited string. When the variable is of array type, the array values are separated by "$,$".
Use Cases
Model Configuration Page Punch-In
https://sitename.oracle.com/commerce/new_equipment/products/model_configs.jsp?segment=Widgets&product_line=bigWidgets&model=widget1&bm_search_result=Direct%20Configured@Yes&_first_time=true
Syntax:
- Parameters:
variableName1=variableValue1&variableName2=variableValue2
- Flow Inputs:
variableName1+variableValue1+variableName2+variableValue2
- Search Results:
variableName1@variableValue1@variableName2@variableValue2
Parts Display Page Punch-In
http://sitename.oracle.com/commerce/parts/display_part.jsp?part_number=00000049&company=4118175
Selector Punch-In
https://sitename.oracle.com/commerce/new_equipment/products/selector_list.jsp?segment=Pumps&product_line=Godzilla%20Pumps&_bm_sel_punch_in_atts=A~10~color~red&from=product]
Syntax:
- Parameters:
variableName1=variableValue1&variableName2=variableValue2
- Flow Inputs:
variableName1+variableValue1+variableName2+variableValue2
- Search Results:
variableName1@variableValue1@variableName2@variableValue2
Array Attribute Punch-In
Use the separator $,$ to specify multiple values for array attributes in punch-ins.
Syntax:
The following example sets three values (white, blue, green) for a "Color" array that has white {w}, red {r}, green {g}, and blue {b} options.
Example:
The following example sets three values (white, blue, green) for a "Color" array that has white {w}, red {r}, green {g}, and blue {b} options.
https://sitename.oracle.com/commerce/new_equipment/products/model_configs.jsp?segment=Widgets&product_line=regular&model=simple&_from_punchin=true&Array%20Control=3&Array%20Color=w$,$b$,$g
Note: Beginning in CPQ 19D, you can no longer use the following format to set multiple values for an array set:
{arrayVariableName}={variableValue1}&{arrayVariableName}={variableValue2}&{arrayVariableName}={variableValue3} Example: Color=w&Color=b&Color=g
Notes
Attribute range calculations are validated on the Value Punch-In. (i.e. If the value was passed in the URL to the Configuration, it will be validated and an error message will appear.
This affects both Mobile and Desktop.
Related Topics
See Also
