A Shown when formula controls whether a field or Group appears on the Sales Form. When a Group uses the Checkbox Visualization, you can show nested fields only while that Group is checked by using the Group variable with .IsExpanded.
You write these formulas on the Product Sales Form in System Settings / Components / Products & Modifiers.
Table of Contents
- Important Information
- Open the Sales Form
- Set a Group Visualization to Checkbox
- Write a Shown when Formula
- Shown when vs Included on the order when
- Frequently Asked Questions
- Related Articles
Important Information
- Shown when hides or shows a field on the Sales Form. It does not add or remove that field from the order by itself.
- .IsExpanded applies to a Group whose Visualization is Checkbox, Toggle, or Expand / Collapse. Insert the Group variable from Variables, then type .IsExpanded. .IsExpanded is not a separate item in the Variables list.
- A Checkbox field (not a Group) is already true or false. Use that field’s variable directly. Do not add .IsExpanded to a Checkbox field.
- After you change Visualization or a formula, click Save on the Product to keep the change.
Open the Sales Form
Navigate to System Settings / Components / Products & Modifiers.
1. Select the Product.
2. Click Edit on the Sales Form.
Set a Group Visualization to Checkbox
The Group Side Panel is where you set Visualization and write Shown when formulas.
1. Click the Group on the Sales Form.
2. Click Visualization.
3. Select Checkbox.
When Visualization is Checkbox, DISPLAY includes extra options:
a. Visualization is set to Checkbox. The Group appears as a checkbox on the Sales Form.
b. Use multiple labels lets the Group show different labels when it is checked and unchecked.
c. Checked by default starts the Group checked when the Product is added to an Estimate or Order.
Write a Shown when Formula
With Visualization set to Checkbox, LOGIC includes Expanded when and Shown when.
a. Expanded when controls when the Group is checked. Use Add formula here if the Group should check itself based on another field.
1. Click Add formula under Shown when.
The Visibility Formula dialog is where you write the formula that shows this Group (or another field).
a. Enter the formula in the editor. To show nested fields only while this Group is checked, use the Group variable plus .IsExpanded. For a Material Group whose variable is MaterialGroup, the formula is =MaterialGroup.IsExpanded.
b. Open the Variables tab and insert the Group variable. Then type .IsExpanded after the variable name.
c. Select the Group variable in the list (for example, MaterialGroup).
Example: To show a Group only when another checkbox is not checked, use =NOT(IncludeInstallation).
Close the dialog, then click Save on the Product.
Shown when vs Included on the order when
Shown when only controls whether the field is visible on the Sales Form. A hidden field can still be on the order.
Linked components such as Material use Included on the order when in LOGIC. That formula controls whether the component is included on the Estimate or Order. If no formula is set, the Side Panel shows that the component is always included.
Use both when you need a component to appear on the form only while a Group is checked, and also to stay off the order until that Group is checked.
Frequently Asked Questions
1. Why is .IsExpanded not in the Variables list?
Answer: .IsExpanded is a property you add to a Group variable. Insert the Group variable from Variables, then type .IsExpanded after the name, such as MaterialGroup.IsExpanded.
2. If a field is hidden by Shown when, is it removed from the order?
Answer: No. Shown when only hides the field on the Sales Form. To keep a linked component off the order until a condition is met, use Included on the order when on that component.
3. Can I use a Checkbox field instead of a Group?
Answer: Yes. A Checkbox field’s variable is already true or false. Use that variable in a Shown when formula. Do not add .IsExpanded to a Checkbox field.