There are a variety of configurator properties that define the fundamentals of how your configurator looks and works. Since configurators are a type of product, they share many properties with standard products. (Both can have a name, SKU, manufacturer, be added to a category, etc.)
Set at design-time, optionally override at run-time
Properties can be set in two ways. The configurator property defaults you set at design time can be changed dynamically at run time.
-
Default properties are set at design time by editing the configurator, selecting the UI node in the design tree (1), and setting each property shown, such as the name (2).
-
Optionally, those default properties you set at design time can also be overridden at run time through Snap rules. This means you can change the behavior and appearance of your
configurator while it runs, based on your user's actions and data. You don't have to use Snap rules to set your properties: Design-time settings are always used unless overridden by any adjustments made by run-time
Snap rules. Here, for example, a Naming rule (1) overrides the design-time name set above with a dynamic name (2).
Tools to help edit a configurator
When editing a configurator, some tools are shown in the upper-right corner to make your job easier.
- See any errors in your configurator's design by watching the error list. For example, if Snap rules refer to a field and you delete that field, the error list will show you all references to the missing field.
- Preview any UI elements on a page by selecting the UI component in the node tree, then clicking the "eye" icon.
-
Search for anything in a configurator by clicking the magnifying glass. Find comments in your Snap code, fields by their name, UI elements by their label... any element in your configurator that has some
property that matches your search will be displayed. For example, a search for "width" shows both Snap rules (represented by colorful icons) and fields (represented by black icons) that contain that text.
Configurator Properties
| Basic | |
| Name |
The name of the configurator as it appears in the products list you users see, the configurators list administrators see, and elsewhere.
|
| Short Description |
A description of the product, displayed next to the product name in some user-facing product lists.
|
| Active |
If the configurator should appear on the Products page for users to see and interact with. Set this to "false" to hide your configurator.
|
| SKU |
Any standard Stock Keeping Unit, or Product Code, which uniquely defines this product.
|
| Manufacturer's Part Number |
Any part number for this product defined by the manufacturer.
|
| Manufacturer |
The name or other reference to the manufacturer.
|
| Unit of Measure |
Usually set to "ea." meaning "each." Set to another unit if required. For example, this configured product may also be sold by the yard (e.g., a custom cable), by the kilogram (e.g, a chemical powder), or some other unit.
|
| Allow Fractional Quantity |
Usually set to false. Set to true to allow your customer to buy a fractional quantity, such as a 1.5 yards of cable, or 3.25kg of powder.
|
| Starting Price |
The price which would appear next to this product when it's listed on the Products page, before a user opens it and begins configuring it. Also known as a "base price".
|
| Minimum/Maximum Quantity |
Specify the minimum and maximum quantities that can be purchased on one quote, if any.
|
| Max Discount Percentage |
The maximum discount which could be applied to the product's price when it is added to a quote.
|
| Related Products Query |
Defines what other products would appear in the "related products" list shown at the bottom of this product's details page. For example, if you have a related products query of "Box", then any product that has the term "Box" in its name, sku, or description will show up as a related product to this one.
|
Score |
Controls the order in which the product appears in the products page. The higher the score, the closer to the top of the list this product will appear. |
| Categories | |
|
Products can be added to one or more categories. Products will only be visible to a user when that user has access to at least one of the categories the product is assigned to. |
|
| Inherit Category Permissions |
Check this box to hide this configurator from search results if the user's categories to not include any of the categories checked in this section.
|
| Volume Discounts | |
If this item's price should drop when the quantity on the quote increases, you can define one or more volume discount thresholds.
For example, with the following settings, a user adding one item gets no discount. Adding 5,6,7,8, or 9 items results in a 3% discount on those items. Adding 10 or more items results in a 5%
discount on those items. |
|
| Attributes | |
|
If you have implemented faceted search on any of your categories, and added this product to those categories, then you can set the search facet attributes here. |
|
| Media | |
|
Add one or more images from the Media folder here, and they will appear to your users in the configurator's "Details" page. The first image will also be the default product image shown in the products page. |
|
| Validation Properties | |
| When to Validate Fields | When this configurator is launched by a user to create a configured product, when should the validation rules run? The options are:
This is a useful technique if you want to know your user actually entered information into a number of fields, but you don't want the configurator to first appear on screen with so many warnings or errors that you scare your user away. The "on touched" validation setting can be useful for configurators that have many validations on many fields. With validation set to "on touched", your users see those validations appear one at a time, as they work their way through the configurator, instead of being surprised and confused by all of the validations appearing immediately when the configurator is first loaded. |
| Allow user to save to quote when there are validation errors |
Controls if the configured product's validation rules can prevent it from being saved. Remember that saving a quote (committing it to the server, so it can be retrieved later) and submitting a quote (committing it to the server, as well as starting the workflow that processes this configurator's quote) are two separate things. Your users may want to save their work to return to it later.
|
| Layout Properties | |
|---|---|
Layout |
Controls which Layout should be used to render the configurator on-screen. Two standard layouts – "Classic" and "Dream" – are always listed, along with any other layouts you design.
|
| Layouts | |
|
The properties shown in this section change, depending on the layout selected. They are defined in the layout itself. Epicor CPQ comes with a few layouts built-in, and you can design more layouts as well. | |
| User Interface | |
| Header Color |
Controls the color of the header for this configurator when it is launched. Default: Primary.
|
|
Save to Quote Button Text Save Button Text |
A running configurator offers two choices for users to save their work:
The labels of both buttons can be overridden with custom text you specify here.
|
| Custom Text for other Buttons |
If you have nested configurators beneath this configurator, specify how you want them described on the Add, Remove, and Copy buttons.
|
| Viewer Properties | |
| Viewer Mode |
The viewer is an optional space to the left or right of your configurator where extra visual information can be displayed.
Remember that this setting, like most configurator properties, can be adjusted at run time with Snap rules, as shown in these examples. |
| Media |
If Viewer Mode is set to Media, then you can select which media file you wish to show in the viewer.
|
| 3D Scene |
If Viewer Mode is set to 3D Scene, then you can select which scene you wish to show in the viewer.
|
| Referenced Scenes | If this configurator changes the scene shown in the viewer through Snap rules, you must select all the scenes you might switch to here. This allows your configurator to pre-load those scenes for a faster user experience. In Snap rules, to switch the running scene, you can use the 'Set viewer scene' block which can be found in the Snap toolbox category Configurator > Interaction:
|
| Clear memory when switching scenes | If your configurator has multiple scenes associated, adjusting this setting may improve load or switching times. |
| Automatically select corresponding page when nested scene is clicked |
If your user clicks an element in the scene which comes from a nested configurator and scene, should the corresponding page appear, so they can see the detailed settings of that element? For example, if you have a building configurator that consists of 4 floors, and your user clicks on the 3rd floor in the scene, should the page representing that 3rd floor appear automatically? By default, this is true. (This property appears only if this configurator has one or more nested configurators.)
|
| Show Move Animation |
Show an animation over the viewer when the scene loads. This animation invites the user to interact with the 3D scene in the viewer. Otherwise they might think the 3D scene is just a static image, and not
click on it to explore it.
|
| Scene toolbar position |
3D Scenes can have actions, which can appear in a toolbar. Control the location of the toolbar here, or turn it off entirely.
|
| Image Properties | |
| Image Source for Quote |
You can choose the image that will represent the configured product when it is added to a quote. This is also the image that will represent the configured product in a quote output when the products list is added (using the word list field). The options for image source are:
|
| Media File |
When image source is set to 'media', this specifies the media image to use.
This is typically set via snap rules, so that you can pick an appropriate image based on selections the user has made in the configurator.
|
| Scene Render Pass |
When image source is set to 'scene', this specifies which scene render pass to use to build the image. You must type in the exact name of the render pass (case sensitive). Note that rendered images are not immediate, so when the product is added to the quote, it might take several seconds before the rendered image shows up next to the product.
|
| Nested | |
| Only used by a specific parent |
If this configurator is only to be used as a nested configurator by a specific parent, check this box and name the parent configurator. Default: false. This helps prevent the nested configurator from appearing in lists your customer sees.
|
| Kinetic | |
| Use Part Selector |
If you integrate the Epicor Kinetic ERP platform with Epicor CPQ, you can control part selector logic in Kinetic with configuration data from CPQ. Learn more about this feature in your Kinetic documentation.
|
