BOM Editor

Reference > Rule Studio User Interface > Editors and Views > BOM Editor

BOM Editor

The BOM Editor lets you edit BOM entries and the vocabulary. The editor is form-based and has associated pages described below.

To open the BOM Editor, in Rule Explorer right-click a BOM entry and select Open With > BOM Editor or double-click the BOM entry.

Package Page

Click the Package tab to open a page that allows you to manage the structure of the Business Object Model by manipulating packages and classes.

Table 3 Package Page in the BOM Editor

Section	Enables you to...
Tasks	Shows the tasks you can perform on a BOM. You can Verbalize a BOM entry, Update all the dynamic domains of the BOM entry, and select Create add and remove methods to open the Collection Methods Wizard. Updating the dynamic domain of the BOM entry through a wizard eliminates going through all the BOM elements to update a dynamic domain.
Business Object Model	Displays the packages and classes of the BOM. Right-click the entry area to open a shortcut menu or click: New Class to add a new class. New Package to add a new package. Delete to remove the selected elements of the BOM. Edit to edit the selected elements of the BOM. Rename to rename the selected element of the BOM (shortcut menu only). Move to move the selected element under another package. You can also move a selected element by dragging and dropping it on the target package.

Section

Enables you to...

Tasks

Shows the tasks you can perform on a BOM.

You can Verbalize a BOM entry, Update all the dynamic domains of the BOM entry, and select Create add and remove methods to open the Collection Methods Wizard.

Updating the dynamic domain of the BOM entry through a wizard eliminates going through all the BOM elements to update a dynamic domain.

Business Object Model

Displays the packages and classes of the BOM. Right-click the entry area to open a shortcut menu or click:

New Class to add a new class.
New Package to add a new package.
Delete to remove the selected elements of the BOM.
Edit to edit the selected elements of the BOM.
Rename to rename the selected element of the BOM (shortcut menu only).
Move to move the selected element under another package. You can also move a selected element by dragging and dropping it on the target package.

The icons available in the BOM Editor toolbar include:

Table 4 The BOM Editor Toolbar

Icon	Purpose
	Display a flat view of the BOM entry.
	Display a hierarchical view of the BOM entry.

Class Page

Click the Class tab in the BOM Editor to modify the information relative to a class.

Table 5 Class Page in the BOM Editor

Section	Purpose
General Information	Provides information about the selected class in the BOM Editor, including: Name of the class. Namespace of the class. Superclasses Interfaces Select deprecated to mark the current element as deprecated. For all rules that use this element, a warning is added to the Problems view indicating the BOM element is deprecated. The verbalization of the BOM element is underlined in yellow in the Intellirule Editor. Deprecated elements are not displayed in the completion menus.
Class Verbalization	You have the option to Remove the verbalization and Edit the documentation. If you remove the verbalization, you will be able to Create a default verbalization. The documentation will be available in the Intellirule Editor when you select the term associated to this class. In the Term section, you can also click Edit to edit the term, which is the wording that will be used in place of the class in the rule editors.
Members	Displays class members of the type: Attribute Constructor Method You can add (New), Remove, or Edit a class member.
Domain	Displays the domain of a class. If not specified, Create a domain of the following types: Bounded Collection Literals Static References Other
Categories	Displays the categories of a class. You can Edit these categories.
Custom Properties	Displays the Name and Value of custom properties of the class.
BOM to XOM Mapping	Displays the BOM to XOM mapping definition of the class. Allows you to define the mapping to the Execution Object Model. You can specify an execution class name and extender class name. You can also add a tester to filter out class instances and edit the XOM imports needed by the BOM to XOM mapping code. The imports must list XOM packages and classes that can be found in the XOM defined on the rule project.

Member Page

Click the Member tab in the BOM Editor to open the Member page to modify the information relative to a member of a class.

Table 6 Member Page in the BOM Editor

Section	Purpose
General Information	Provides information about the Name, Type and Class of the member and the following: Static Final Deprecated Update object state Update object state lets you update the working memory when the BOM element changes. For attributes you can set the access rights to read only, write only or read/write.
Member Verbalization	Provides information about the verbalization of the current member. If this section is empty, you can Create a verbalization you can change later. This section also provides fields to edit phrase templates. When the member is an attribute, you can create and edit a navigation phrase and/or an action phrase depending on the read/write state of the attribute: A navigation phrase can be created if the attribute is read/write or read only. You can use the navigation phrase to form an expression in the rule editors in the condition part and action part of the rule. An action phrase can be created if the attribute is read/write or write only. You can only use the action phrase in the action part of the rule. When the member is a method and the return type is not void, you can create a navigation phrase or an action phrase. You should only create a navigation phrase for methods that have no side effect on objects that can be matched by the rules. When the member is a void method, you can only create an action phrase. You can associate a documentation to each phrase. The documentation will be available in the Intellirule Editor when you select the phrase.
Arguments	Displays the arguments by Name, Type and Domain. You can Edit, Add, Remove, change the order (Up, Down) of arguments.
Domain	Displays the domain of values of the member. If not specified, you can Create a domain of the following types: Bounded Collection Literals Static References Other
Categories	Displays the categories of the member. You can Edit these categories.
Custom Properties	Displays the Name and Value of custom properties of the member.
BOM to XOM Mapping	Displays the BOM to XOM mapping definition of the member. If the member is a method, you can edit a Body; if it is an attribute, you can edit the getter and setter parts separately.

Keyboard Shortcuts

In the template fields, you can use CTRL+SPACE to get the list of available placeholders.

BOM Editor

Package Page

Class Page

Member Page

Keyboard Shortcuts

Related Concepts

Related Tasks

Related Reference

Related Samples and Tutorials