Using the Visual Modeler

Visual Modeler Navigation

Access the Visual Modeler

  1. Click Configuration Models in the Product and Catalog Administration panel on the home page.
The Visual Modeler page displays.
  1. In the Models and Groups frame, click a model or a group.
The current structure of the model or group displays, including option classes, option items, and groups. Click the plus (+) sign to the left to expand the structure of the model.
  1. Click the Edit icon in the toolbar.
The detail page for the model, option class group, or option item group displays.
  1. In the Model navigation frame, click the plus (+) sign to expand the model or group.
  2. Click an option class.
The following tabs display in the Content frame:
General Info: This tab provides general information about the option class. A list box displays the children belonging to this option class. You can also assign a Product ID here, define a ratio for the option class (the number by which the option item quantity will be multiplied to get the necessary option item quantity). You can create nested option classes and option items, and attach groups.
Display: This tab enables you to set display property values specific to the selected option class.
Properties: This tabs enables you to associate properties, which the option class has access to, with the option class. (The option class has access to either properties defined specifically for the model to which the option class belongs or properties defined for any model group above the option class in the model group hierarchy.)
Rules: This tab enables you to attach rules defined for the model as well as for the model group to which it belongs (or to any ancestor model group).
  1. In the Model navigation frame, click the plus (+) to expand the option class.
The children of the option class display.
  1. Click an option item.
The following tabs appear in the Content frame:
General Info: This tab displays general information about the selected option item.
Display: You can set display property values specific to the option item.
Properties: You can associate properties to which the option item has access with the option items. (The option item has access to either properties defined specifically for the model to which the option item belongs or to properties defined for any model group above the option item in the model group hierarchy.)
Rules: You can attach any rules to which the option item has access to the option item. (The option item has access to any rules defined at any level above it in the model group hierarchy.)

On Microsoft Windows platforms, a 256-character limit exists for a fully-qualified pathname, including the pathname and the filename. Do not use long pathnames for model groups or models, particularly if you use non-ASCII characters. When you compile a model, the Visual Modeler recreates the model group structure as directories in a file system and expands the non-ASCII characters.

Visual Modeler Page Layout

The Visual Modeler page consists of three frames:

Model Group navigation: Displays the root model group (the top-level group in the model group hierarchy) and enables you to navigate through the model group hierarchy.
Models and Groups: Displays the models and groups that are children of the model group selected in the Model Group navigation frame.
Content: Displays information about the model group selected in the Model Group navigation frame. It has the following tabs:
General Info: Displays the children of the model group. Use this tab to:
Select, delete, and reorder children.
Create new model groups, new models, and new groups.
Upload models or model groups to the current model group.
Properties: Define and attach properties to any model, option class, or option item within the model group. Properties define the characteristics of models, option classes, and option items. Use properties in rules that constrain customer selections and determine whether or not a configuration is valid.
You can use a property in rules defined for any model or model group in the hierarchy below the model group for which it is defined.
Rules: Define rules for the model group. Rules constrain customer selections and determine whether or not a configuration is valid. You can attach rules to any models, option classes, or option items in the hierarchy below the model group for which they are defined.
Lists: Define lists of values that you can use in properties below the model group in the hierarchy for which they are defined. Lists specify values that you can use in properties.

Visual Modeler Toolbar

The toolbar on the Visual Modeler page contains the following icons:

Edit: Edit a model, option class group, or option item group highlighted in the Models and Groups frame.
Compile: Compile a model, option class group, or option item group to an XML file. You can associate only compiled models with configurable products.
Test: Test a model that you have created or modified.
Copy: Copy an entity such as a model group, a model, or an option class group.
Import: Import an entity to your library of entities.
Export: Export an entity.
Report: Produce a report on an entity in the model library.
Search: Search for entities based on selected search parameters.

Visual Modeler Detail Page

The Visual Modeler Detail Page contains the following frames:

Toolbar: Edit, compile, test, copy, import, export, report, or search for an entity.
Navigation: Navigate the model hierarchy. Click the plus (+) sign to expand the model or group and display its elements: the sub-models, option classes, option items, or groups.
Content: Displays information about the model selected in the Navigation frame. By navigating to a particular node in the model, you can create and update information about that node. This frame has the following tabs:
General Info: Displays general information about the model or group, and its children. You can delete or reorder the children in this frame. You can translate the model, assign a Product ID to the model, create option classes and option items, attach a group, and download models.

For option class groups or option item groups, only the General Info tab is visible.

Display: Define display properties at the model level. The properties include constant guiding text, as well as pre- and post-pick guiding text. Some display properties have default values that can be overridden by display values set at the option class or option item levels. You can also set the properties displayed on the Display tab by setting UI properties on the Properties tab.
Properties: Attach properties to the current node when the node is an option class, option class group, option item, or option item group.
When the current node is a model, this tab consists of the Attach, Define.
Use the Attach tab to attach properties to the model. You can attach only those properties to which the model has access. The model has access to properties defined for the model itself or to properties defined for any model group above the model in the model group hierarchy.
Use the Define tab to define new properties for use locally, in the model's structure.
Rules: If the current node is a model, this tab consists of two tabs: Attach and Define. Otherwise, you can use this tab to attach rules to the node. In the Attach tab, you can attach to the model rules to which the model has access. (The model has access either to rules defined specifically for the model or rules defined for any model group above the model in the model group hierarchy.) In the Define tab, you can define new rules for use locally, in the model's structure.
Lists: If the current node is a model, the lists you define here can be used locally, in any properties you define for the model.
Tables: If the current node is a model, you can use this tab to create constraint tables.
Tabs: If the current node is a model, you can use this tab to create a tab-based configuration for your customers.
Worksheets: If the current node is a model, this tab enables you to manage properties using worksheets. The worksheets provide you with a quick way to view and manage related properties and option items.

About Model Groups

Model groups enable you to organize related models into appropriate sections.

Models are compiled to XML files. Do not use the following characters in model, model group, property, or rule names: "&", "/". "@", "!", " and '.

Create a Model Group

  1. Navigate to and select the model group under which you want to create the new model group.
  2. Click New Model Group.
The New Model Group tab displays.
  1. Enter a name and description for the model group.
  2. Click Save to save the model group or click Save and Edit to save the model group and modify its details.

Modify a Model Group

  1. Navigate to and select the model group you want to modify.
The General Info tab displays. You can:
Delete model groups, models, or groups that are children of the selected model group.
Create a model group as a child of this group.
Create a model as a child of this group.
Create either an option class group or an option item group.
.
Click Save All Changes to save your changes before you move to the next tab.
  1. Click the Properties tab to create or modify properties for the model group.
  2. Click Save All Changes to save your changes before you move to the next tab.

  3. Click the Rules tab to create or modify rules for the model group.
  4. Click the Lists tab to create or modify lists for the model group.

Delete the Children of a Model Group

  1. Navigate to and select the parent model group that contains the child you want to delete.
  2. From the list box, select the model group (MG), model (M), option class group (OCG), or option item group (OIG) you want to delete.
  3. Click Delete.
  4. Click Save All Changes.

Limitations: Deleting the Children of a Model Group

Consider the following before you delete the children of a model group:

You cannot delete a model group if the group has children. You must delete the children first.
You cannot delete a model if it is attached as a sub-model anywhere in the model group hierarchy.
You cannot delete an option class group if it is attached to another model or option class group.
You cannot delete an option item group if it is attached to another model, option class group, or option item group.

Copy a Model Group

  1. Navigate to and select the model group you want to copy.
  2. In the toolbar, click the Copy icon.
The Copy window displays.
  1. Enter the Destination Model Group.
Click Browse....
A Hierarchy Browser displays.
Navigate to and select the destination model group.
Click Done.
  1. As desired, modify the Destination Name field.
The name defaults to the name of the model group being copied.
  1. Click Copy in the Copy window.

Working with Models

Create a Model

  1. Navigate to and display the model group under which you want to create a model.
  2. In the General Info tab, click New Model.
The New Model tab displays.
  1. Enter a name and description.
If you want to associate the model with a Product ID, you can skip this step. If the name and description match the name and description of the Product ID, you can auto-fill these fields when you assign the Product ID.
.
On Microsoft Windows platforms, a 256-character limit exists for a fully-qualified pathname, including the pathname and the filename. Do not use long pathnames for model groups or models, particularly if you use non-ASCII characters. When you compile a model, the Visual Modeler recreates the model group structure as directories in a file system and expands the non-ASCII characters.
  1. Select the Start Date and End Date for the model.
These are the dates within which the model is available for configuration. If the current date is outside these dates, the model is not available for configuration for any product with which it is associated.
  1. If applicable, assign a Product ID.
  2. Click Save to save the model, or Save and Edit to save and modify the model.
If you click Save, the new model appears in the Models and Groups frame.
If you click Save and Edit, the Model Detail page appears with the new model in the Navigation frame. You can then add properties, rules, lists, and constraint tables for the model, and associate the model with a product.

Modify a Model

  1. Navigate to the Model Detail page for the model you want to modify.
  2. In the General Info tab, you can perform the following tasks:
Modify the name, description, or the start and end dates.
Delete the option classes or groups associated with the model.
Rearrange the order of the children in the list.
Assign a product to the model, or change the current product assignment.
.
Click Save All Changes to save your changes before you navigate away from the General Info tab.
Create option classes.
Attach an option class group.
Modify display properties.
  1. Click the Properties tab to define properties for or to attach properties to the model.
  2. Click the Rules tab to define rules for or attach rules to the model.
  3. Click the Lists tab to create lists for the model.
  4. Click the Tables tab to create or modify constraint tables.

Delete a Model

Find the model group that is the parent of the model, then delete the model from that group. You cannot delete a model if it is attached as a sub-model anywhere in the model group hierarchy.

Delete the Children of a Model

To delete option classes or groups that are children of a model:

  1. Navigate to the Model Detail page of the model containing the entities you want to delete.
The General Info tab contains a list box showing the option classes (OC), option class groups (OCG) or option item groups (OIG) that are children of the model.
  1. In the list box, select the entities you want to delete and click Delete.
This does not delete the attached sub-models and groups. This removes only the attachment to the sub-models and groups.
  1. Click Save All Changes.

Associate a Product with a Model, Option Class, or Option Item

You can reference a model, option class, or option item to a Product ID in the product catalog. If the Product ID has been assigned to a price list, you can associate a price with the entity. If the item associated with a product is selected as part of a configuration, when the user adds the configured product to their cart, the item displays with its associated Product ID and product information.

  1. In the model group hierarchy, navigate to the model, option class, or option item that you want to associate with a Product ID.
  2. The General Info tab of the Visual Modeler Detail Page displays. You can:
Click Browse... to search for the Product ID. After you select the Product ID, the Product ID is displayed in the Assigned Product ID field, and the Product Name and Product Description fields are auto-filled.
Enter the Product ID in the Assigned Product ID field. The Product Name and Product Description fields are not auto-filled until you save the information.
If you are creating a new entity, you can use the product name as the name of the new entity. If the Name field is blank, it will be auto-filled with the product name. If the Name field has an entry, you will be prompted to use the product name.
If you are modifying a model, you can click Product Detail to view the details of the assigned product.
  1. Click Save All Changes.

Copy a Model to a Model Group

  1. In the Model Groups frame, navigate to and select the model group that contains the model you want to copy.
  2. In the Models and Groups frame, click the model to copy.
The current structure of the model displays.
  1. Click the Copy icon in the toolbar.
The Copy window displays.
  1. Enter the Destination Model Group.
Click Browse....
A Hierarchy Browser displays.
Navigate to and select the destination model group.
Click Done.
  1. Modify the Destination name field as appropriate.
The default value is the name of the model being copied.
  1. Click Copy.

Copy a Model Reference to Another Entity

You can re-use a model as part of another entity without recreating the model by attaching the model to the entity. The attachment then becomes a model reference. You can copy the model reference to any entity.

To copy a model reference:

  1. In the Model Groups frame, navigate to and select the model group that contains the entity with the model reference you want to copy. The entity name is displayed in the Models and Groups frame.
  2. In the Models and Groups frame, click the entity that contains the model reference you want to copy.
The current structure of the entity displays.
  1. Click Edit in the toolbar.
The General Info tab displays.
  1. In the Navigation frame, find and select the model reference you want to copy.
  2. Click the Copy icon in the toolbar.
The Copy window displays.
  1. Enter the Destination Option Class.
Click Browse....
A Hierarchy Browser displays.
Navigate to and select the destination option class.
Click Done.
  1. Modify the Destination name field as appropriate.
The default value is the name of the model reference being copied.
  1. Click Copy.

To Embed a Model Within an Option Class

  1. In the Model Groups frame, navigate to and select the model group that contains the model structure you want to embed.
  2. In the Models and Groups frame, click the model whose structure you want to embed.
  3. Click the Edit icon in the toolbar.
The General Info tab displays.
  1. Click the Copy icon in the toolbar.
The Copy window displays.
  1. Enter the Destination Option Class.
Click Browse....
A Hierarchy Browser displays.
Navigate to and select the destination option class.
Click Done.
  1. Modify the Destination name field as appropriate.
The default value is the name of the model being embedded.
  1. Click Copy.

Option Classes and Option Items

Option classes and option items comprise the configurable parts or the services of a model. Option classes represent questions or components that need to be configured, while option items represent answers or choices of components. Sometimes, the answer to a question can give rise to further questions. In these cases, it is useful to nest option classes within other option classes to help guide a user to the configuration that best meets the user's needs.

Creating an Option Class

  1. In the model group hierarchy, navigate to the model, option class group, or option class in which you want to create the option class.
You can create an option class within another option class, a model, or an option class group.
To create option classes as children of the model or option class group, click New Option Class.
To create nested option classes, navigate to and select the option class where you want to nest the new class, and then click New Option Class.
The New Option Class tab displays.
  1. Enter a name and description for the new option class.
If you want to associate the option class with a Product ID, you may skip this step. If the name and description match the name and description of the Product ID, you can auto-fill these fields when you assign the Product ID.
  1. Define the effectivity dates by modifying the Start Date and the End Date as appropriate.
  2. If applicable, assign a Product ID.
  3. Click Save to save the new option class, or click Save and Edit to save the new option class and modify it.

Modify an Option Class

  1. In the model group hierarchy, navigate to the model, option class group, or option class that contains the option class you want to modify.
  2. In the Navigation frame, find and click the option class that you want to modify.
The General Info tab displays.
  1. Modify the Name, Description, Start Date and End Date as appropriate.
  2. Enter a ratio in the Ratio field as appropriate.
The ratio field determines the quantity of option items that are added to a customer's order. The quantity of any child item selected is multiplied by this ratio to compute the ''extended'' quantity of the child item. For example, a bicycle model may have a wheel option class defined with a ration of ''2''. When a user selects a particular wheel item from the option class, two wheels will be added to the configured product.
You can enter the Ratio as a whole number or as a decimal.
  1. Reorder or delete the children as appropriate.
  2. Assign a Product ID or modify the current assignment as appropriate.
  3. Click Save All Changes.
  4. Click the Display tab to modify the display properties for the option class.
  5. Click the Properties tab to attach properties to the option class.
  6. Click the Rules tab to attach rules to the option class.
  7. When you finish modifying the option class, click Save All Changes.

Add Option Items to an Option Class

  1. In the model group hierarchy, navigate to the option class to which you want to add the option items.
  2. In the General Info tab, click New Option Item.
  3. Enter a name and description for the new option item.
If you want to associate the option item with a Product ID, you may skip this step. If the name and description match the name and description of the Product ID, you can auto-fill these fields when you assign the Product ID.
  1. Define the effectivity dates by modifying the Start Date and the End Date as appropriate.
  2. Assign a Product ID as appropriate.
  3. Click Save or Save and Edit.

Copy an Option Class to a Model, Option Class Group, or Another Option Class

  1. Navigate to and select the parent model group of the model or option class group that contains the option class.
  2. In the Models and Groups frame, click the model or option class group that contains the option class.
The current structure of the model or option class group displays.
  1. Click the Edit icon in the toolbar.
The General Info tab displays.
  1. In the Navigation frame, find and click the option class that you want to copy.
The General Info tab for the option class displays.
  1. Click the Copy icon in the toolbar.
The Copy window displays.
  1. Enter the destination model, option class group, or option class.
Click Browse....
A Hierarchy Browser displays.
Navigate to and select the destination model, option class group, or option class.
Click Done.
  1. Enter the Destination name.
The default value is the name of the option class being copied.
  1. Click Copy.

Modify an Option Item

  1. Navigate to and select the option item you want to modify.
The General Info tab displays.
  1. Modify the Name, Description, Start Date, and End Date as appropriate.
  2. Assign a Product ID as appropriate.
  3. Click Save All Changes.
  4. Click the Display tab to modify the display properties for the option item.
  5. Click the Properties tab to attach properties to the option item.
  6. Click the Rules tab to attach rules to the option item.

Copy an Option Item to an Option Item Group or Option Class

  1. Navigate to and select the option item that you want to copy.
The General Info tab displays.
  1. Click Copy in the toolbar.
The Copy window displays.
  1. Enter the destination option item group or option class.
Click Browse....
A Hierarchy Browser displays.
Navigate to and select the option item group or option class.
Click Done.
  1. Enter the Destination name.
The default value is the name of the option item being copied.
  1. Click Copy.

Delete an Option Class

An option class can be a child of a model, another option class, or an option class group. Deleting an option class automatically deletes any option items, nested option classes, or attachments to groups.

.
When you delete an option class, nested groups are not deleted. However, the attachment to the nested groups is removed..

Delete the Children of an Option Class

You can delete option items and nested option classes, as well as any attachments to groups.

  1. Navigate to the detail page for the model or option class group that contains the option class.
  2. In the Navigation frame, navigate to and select the option class.
The General Info tab displays.
  1. From the list box containing the children of the option class, click the entity you want to delete and click Delete.
This does not delete the nested groups. This removes only the attachment to the nested groups.
  1. Click Save All Changes.

Option Class Groups and Option Item Groups

Create an Option Class Group or Option Item Group

  1. In the Model Groups frame, navigate to and select the model group for which you want to create the option class group or option item group.
The General Info tab displays.
  1. Click New Option Group.
The New Option Class/Item Group tab displays.
  1. Enter a name and description for the group.
  2. Select Option Class Group to create an option class group, or Option Item Group to create an option item group.
  3. Click Save to save the group, or Save and Edit to save the group and modify it.

Modify an Option Class Group or Option Item Group

When you modify and compile a group, the modifications are reflected in any model to which the group is attached once the model is recompiled.

To modify a group:

  1. In the model group hierarchy, navigate to and select the option class group or option item group that you want to modify.
The General Info tab displays.
  1. Modify the name and description, reorder or delete the children as appropriate.
  2. (For option item groups) If applicable, define the Start Date and End Date.
  3. Click Save All Changes.
  4. (For option class groups) Click New Option Class to add option classes to the option class group.
  5. (For option item groups) Click New Option Item to add option items to the option item group.
  6. Click Attach to attach groups to the option class group or option item group.

Copy an Option Class Group to a Model Group

  1. In the Model Groups frame, navigate to and select the model group that contains the option class group you want to copy.
  2. In the Models and Groups frame, click the option class group you want to copy.
  3. Click the Copy icon in the toolbar.
The Copy window displays.
  1. Enter the Destination Model Group.
Click Browse....
A Hierarchy Browser displays.
Navigate to and select the destination model group.
Click Done.
  1. Enter the Destination name.
The default value is the name of the option class group being copied.
  1. Click Copy.

Embed an Option Class Group Within a Model, Another Option Class Group, or Option Class

  1. In the Model Groups frame, navigate to and select the model group that contains the option class group you want to embed.
  2. In the Models and Groups frame, click the group you want to embed.
  3. Click the Edit icon in the toolbar.
The General Info tab displays.
  1. Click the Copy icon in the toolbar.
The Copy window displays.
  1. Enter the destination model, option class group, or option class as follows:
Click Browse....
A Hierarchy Browser displays.
Navigate to and select the destination model, option class group, or option class.
Click Done.
  1. Click Copy.

Copy an Option Item Group to a Model Group

  1. In the Model Groups frame, navigate to and select the model group that contains the option item group you want to copy.
  2. In the Models and Groups frame, click the option item group you want to copy.
  3. Click the Copy icon in the toolbar.
The Copy window displays.
  1. Enter the Destination Model Group as follows:
Click Browse....
A Hierarchy Browser displays.
Navigate to and select the destination model group.
Click Done.
  1. Enter the Destination name.
The default value is the name of the option item group being copied.
  1. Click Copy.

Embed an Option Item Group Within Another Option Item Group or Option Class

  1. In the Model Groups frame, navigate to and select the model group that contains the option item group you want to embed.
  2. In the Models and Groups frame, click the option item group you want to copy.
  3. Click the Edit icon in the toolbar.
The General Info tab displays.
  1. Click the Copy icon in the toolbar.
The Copy window displays.
  1. Enter the destination option item group or option class as follows:
Click Browse....
A Hierarchy Browser displays.
Navigate to and select the destination option item group or option class.
Click Done.
  1. Click Copy.

Attach a Group to a Model or Another Group

You can attach a model only to an option class. You can attach an option class group to a model, an option class, or another option class group. You can attach an option item group to an option class or to another option item group.

  1. In the Model Groups frame, navigate to and select the model group that contains the model or group to which you want to attach the group.
  2. In the Models and Groups frame, click the model or group to which you want to attach the option class group or option item group.
  3. Click the Edit icon in the toolbar.
The General Info tab displays.
  1. Click Attach.
The Attach tab displays.
  1. Enter a name and description for the attachment to the group or model.
  2. Select the option class group or option item group you want to attach as follows:
Click Browse....
A Hierarchy Browser displays.
Navigate to and select the option class group or option item group.
Click Done.
  1. Click Assign.
  2. Click Return to General to return to the General Info tab.

Attach a Model, Option Class Group, or Option Item Group to an Option Class

  1. In the Model Groups frame, navigate to and select the model group that contains the model with the option class.
  2. In the Models and Groups frame, click the model or option class group that contains the option class.
  3. Click the Edit icon in the toolbar.
The General Info tab displays.
  1. In the Navigation frame, navigate to and select the option class to which you want to attach the group.
The General Info tab for the option class displays.
  1. Click Attach.
The Attach tab displays.
  1. Enter a name and description for the attached group or model.
  2. Select the model, option class group, or option item group you want to attach as follows:
Click Browse....
A Hierarchy Browser displays.
Navigate to and select the model, option class group, or option item group.
Click Done.
  1. Click Assign.
  2. Click Return to General to return to the General Info tab.

View the Structure of an Attached Group

  1. Navigate to the level in the hierarchy (model, option class or option item) where the group is attached.
  2. Click Show Detail.
A read-only view of the group's structure displays.

Copy an Option Class Group Attachment to a Model, Option Class Group, or Option Class

  1. In the Model Groups frame, navigate to and select the model group that contains the entity with the option class group attachment you want to copy.
  2. In the Models and Groups frame, click the entity that contains the attachment you want to copy.
  3. Click the Edit icon in the toolbar.
The model displays in the Navigation frame and the General Info tab for the group.
  1. In the Navigation frame, navigate to and select the attached group you want to copy.
  2. Click the Copy icon in the toolbar.
The Copy window displays.
  1. Enter the destination model, option class group, or option class as follows:
Click Browse....
A Hierarchy Browser displays.
Navigate to and select the destination model, option class group, or option class.
Click Done.
  1. Enter the Destination name.
The default value is the name of the option class group being copied.
  1. Click Copy.

Copy an Option Item Group Attachment to an Option Item Group or Option Class

  1. In the Model Groups frame, navigate to and select the model group that contains the entity with the option item group attachment you want to copy.
  2. In the Models and Groups frame, click the entity that contains the attachment you want to copy.
  3. Click the Edit icon in the toolbar.
The entity displays in the Navigation frame and the General Info tab for the group.
  1. In the Navigation frame, navigate to and select the attached group you want to copy.
  2. Click the Copy icon in the toolbar.
The Copy window displays.
  1. Enter the destination option item group or option class.
Click Browse....
A Hierarchy Browser displays.
Navigate to and select the option item group or option class.
Click Done.
  1. Click Copy.

Delete an Option Class Group or Option Item Group

To delete an option class group or option item group, you must navigate to the model group that is the parent of the group you want to delete and then delete the group from that model group.

Consider the following when you delete an option class group or an option item group:

You cannot delete an option class group if another model or option class group refers to it.
You cannot delete an option item group if another model, option class group, or option item group refers to it.

Delete the Children of an Option Class Group or Option Item Group

  1. Navigate to and select the parent model group that contains the group with the children you want to delete.
  2. In the Models and Groups frame, click the group.
  3. Click Edit.
The General Info tab displays a list box showing the children belonging to the group.
  1. From the list box, select the entities you want to delete and click Delete.
This does not delete the groups. This removes only the attachment to the groups.
  1. Click Save All Changes.

Include Sub-Models in Models

You can include a model in another model to enable a sub-component of the parent model to be modeled and configured separately, such as

Steps: To Include a Sub-Model in a Model

Suppose that you have Model A and you want to use Model B as an option item in Model A to enable end users to configure the Model B component as part of a session to configure Model A.

  1. Create Model B as a model and compile it. Make a note of the location of the model in the model group and model hierarchy. For example: Matrix/Computers/Workstations/Configurable Monitors/Matrix Monitor.
  2. Navigate to Model A and the location in the model hierarchy where you want to include Model B as an option item.
  3. Create the option item and enter a Name, Description, Start Date, and End Date for it. Click Save.
  4. Click the Properties tab.
  5. Select CONFIG: SUBMODEL NAME from the Unattached Properties drop-down list.
  6. In the Value field, enter the fully qualified pathname for Model B. For example, Matrix/Computers/Workstations/Configurable_0020Monitors/Matrix_0020Monitor. Note the use of escape characters to encode special characters such as spaces.
  7. Click Attach.
  8. Click Save All Changes.
  9. A separate property called CONFIG: SUBMODEL RETURN controls whether end users return to the main model after configuring the child model.
To return end users to the main model when they finish configuring Model B, set CONFIG: SUBMODEL RETURN to "true".
To return end users directly to the calling application when they finish configuring Model B, set CONFIG: SUBMODEL RETURN to "false".
  1. Click Attach.
  2. Click Save All Changes.
  3. Click Compile to re-compile Model A.
  4. Click Test to test the model.

Special Character Encoding

You must encode any special characters when you provide model group pathnames and model pathnames.

The following table lists the common special character encodings:

Character
Encoding
" " (blank)
_0020
"-"
_002D
"/"
_002F
"!"
_0021
"@"
_0040
"#"
_0023
"$"
_0024

Test a Model

You can test a model at any point while you are creating it by performing the following steps:

  1. Compile the model to an XML file.
  2. Launch the browser.
  3. Display the model as an HTML page.

Steps: Test a Model

  1. Navigate to the model that you want to test.
  2. Click Compile.
A dialog box displays showing that the compilation is successful.
  1. Click Test Model.
A configuration window displays.
Click Compile and Test to compile and test the model.
  1. To change some of the environmental variables that affect how a model displays, click Set Defaults.
You can change the following environmental variables:
Current Effective Date: Change the date in this field to view the model as a customer would view it on the specified date. You see only option classes and option items that are effective on that date, and the prices that you see are based on price lists effective on that date.
Current Partner: Select a specific partner to view the model as a user of that partner would see it. Depending on the assignment of price lists to the partner, this may affect which option classes and option items are displayed.
Vertical Market: When customers create carts and orders, they can specify a customer type. This is used to filter the price lists used in calculating prices. Select a customer type to check how the model will appear to customers who select the same customer type.
Currency: When customers create carts and orders, they can specify a currency. This is used to filter the price lists used in calculating prices. Select a currency to check how the model will appear to customers who select the same currency.

Compile a Model

Before you associate a model with a configurable product and before a customer can use the model you created to configure a product, you must compile the model to XML format and store the model in a location accessible by the Sterling Product Configurator. You can associate only compiled models with configurable products.

Steps: Compile a Model

  1. Navigate to the model that you want to compile.
  2. Click Compile.

The model is compiled to an XML file. The XML file is placed in the debs_home/Sterling/WEB-INF/data/config/ directory. This directory contains several directories, one for each locale. The model resides within the directory representing your preferred locale in either the folder representing the root model group folder or in one of the folders representing model groups within the root model group. They are stored in the shared location of a clustered deployment of the application.

If your implementation makes use of a staging system and a production system, you may either need to move the XML files to the production environment or the model directories must be shared between the systems.

Product records for configurable products in the Knowledgebase may need to be updated to point to the location of the XML files.

Special (non-alphanumeric) characters are encoded in directory and file names. If your model group and model hierarchy include special characters, the special characters are encoded in the corresponding directory and files names.

Steps: Compile All Models in a Model Group at One Time

  1. Navigate to the model group that contains the models you want to compile.
  2. Click Compile All.
The Compile All Models window displays.
  1. Click Compile All Models.
The Compile All Models Status window displays.
  1. When the status window reports that all the models are compiled, click Close.

Search the Product Catalog for a Product ID

When you assign a Product ID, you can click Browse... to display the Hierarchical Entity Chooser.

Use the Hierarchical Entity Chooser window to navigate the hierarchy until you find the Product ID that you want to assign to the model object. You can click the Search tab to search for products unassigned to any product category.

Click Done when you find the Product ID that you want to assign. The Product ID appears in the Assigned Product ID field.

Design a Tabbed User Interface

You can design the end-user product configuration interface so that the option classes appear within a series of tabs instead of being displayed in a single frame. The general steps are:

  1. In the Display tab at the model level, choose Tabbed Configurator from the JSP Template drop-down list.
  2. Create the top-level option classes or option class groups that make up your model. Top-level option classes or option class groups are those at the top of the model group hierarchy, directly below the model.
  3. Navigate to the Tabs tab within your model to create the tabs. Populate the tabs with one or more of the top-level option classes or option class groups that you created for this model.

Steps: Create a Tabbed User Interface

  1. Navigate to the model for which you want to create a tabbed interface.
  2. Click the Display tab.
  3. Select Tabbed Configurator from the JSP Template drop-down list.
This sets the UI: JSP FILENAME property to Configurator_Tabbed.jsp.
  1. Click the Tabs tab.
  2. Enter a name for the tab in the Tab Name field.
  3. Click Add.
The content frame displays an area for editing the new tab.
  1. Select an option class or option class group from the drop-down list, and click Add.
Repeat this step for each option class or option class group you want to add to the tab.

If you are creating a tabbed user interface, not all option classes must be accounted for in the tabs. Any option class not included in a tab is not displayed to the end user.

  1. Click Move Up or Move Down to arrange the order of the entities. To remove an entity, click the entity and click Remove.
  2. Click Save All Changes.

Steps: Modify a Tab

  1. Navigate to the model with the tabbed interface.
  2. Click the Tabs tab.
The Tabs tab displays.
  1. Find the tab element you want to modify.
  2. To rearrange the order of the entities within the tab:
Find and select the entity you want to move.
Click Move Up or Move Down.
  1. To remove an entity:
Find and select the entity you want to remove.
Click Remove.
  1. To rearrange the location of the tab within the list of tabs, click the up or down arrows.
  2. Click Save All Changes.

Steps: Delete a Tab

  1. Navigate to the model with the tabbed interface.
  2. Click the Tabs tab.
The Tabs tab displays.
  1. Find the tab element you want to delete.
  2. Click the Delete icon (X) for that tab.
  3. Click Save All Changes.

Design a Step-by-Step User Interface

You can design a step-by-step (Stepwise) user interface to guide your customers through the steps required to configure a product. The Stepwise user interface provides a simple product configuration UI that is especially appealing for novice consumers. Tabs represent each step, and each tab contains a collection of option classes relevant to that step. Consumers can follow the steps in order or move freely among the tabs.

As the modeler, you select visual cues at the model level to help the consumer through the configuration process, such as active tab color, inactive tab color, tab background color, and page color. The colors are defined during implementation and are contained in properties files. This ensures a unified look-and-feel for your product offerings. You can also define guiding text (or "Help Me Decide" text) at the option class or option item level to ease the consumer's decision-making process.

Stepwise configuration is best suited to simple models that have relatively flat model structures, with a small number of tabs, each containing one level of option classes.You can design Stepwise UI's for models with nested option classes, but the deeper the nesting, the harder it will be to present a usable and coherent user interface to the consumer.

The default option items display features include an image (icon) representing the option class, a description, and guiding text. Option items display with inline pricing. As the consumer makes selections, the product configurator displays a summary of their configuration.

The tabs (steps) use icons to represent the option classes.You associate each option class with an image representing that class. Consumers can scroll through the images to navigate among the option classes. For example, to configure a laptop computer, the consumer can click through tabs for display panel, memory, bundled software, and so on. You can also choose not to display images with your option classes.

Following is a sample Stepwise configuration UI for a notebook product. Related option classes are grouped together using tabs. For example, the Components tab includes speakers, memory, disk drive, optical drive, display, and so on. Each option class is represented by an icon. The consumer can click among the icons to select the components they want, and their selections display in a My components window.

The general steps for designing a Stepwise UI are:

  1. In the Display tab at the model level, choose Stepwise Configurator from the JSP Template drop-down list, then choose the UI properties such as active and inactive tab color, background page color, guiding text, and so on.
  2. Create the top-level option classes or option class groups that make up your model. Top-level option classes or option class groups are those at the top of the model group hierarchy, directly below the model.
  3. Navigate to the Tabs tab within your model to create the tabs. Populate the tabs with one or more of the top-level option classes or option class groups that you created for this model.

Steps: Create a Stepwise User Interface

  1. Navigate to the model for which you want to create a Stepwise user interface.
  2. Click the Display tab and choose the display properties:
Select Stepwise Configurator from the JSP Template drop-down list.
This sets the UI: JSP FILENAME property to Configurator_Stepwise.jsp.
Use the Configurator Tabs and Background Colors group's drop-down lists to select the colors for the Stepwise UI, such as active tab color, inactive tab color, tab background color, and page color.
Select how to handle nested option classes: inline or nested. Nested is the default.
Remember that for Stepwise models, it is best to use simple structures that do not use nested option classes.
In the Summary Sections field, enter a semi-colon separated list of section headings to display in the Summary Section panel of the configuration display. The default is to use the tab names as the Summary Section headings.
You define the section heading under which an option item displays at the option item level. The Summary Sections field at the option item level is a drop-down list, from which you select a single section name. This tells the Product Configurator the section in which to display the option item. Visual Modeler populates the drop-down list using the values you defined for the Summary Sections field at the model level.
  1. Click the Tabs tab.
  2. Enter a name for the tab in the Tab Name field.
  3. Click Add.
The content frame displays an area for editing the new tab.
  1. Select an option class or option class group from the drop-down list, and click Add.
Repeat this step for each option class or option class group you want to add to the tab.

If you are creating a tabbed user interface, not all option classes must be accounted for in the tabs. Any option class not included in a tab is not displayed to the end user.

  1. Click Move Up or Move Down to arrange the order of the entities. To remove an entity, click the entity and click Remove.
  2. Click Save All Changes.

© 2011 IBM Corporation. All Rights Reserved