Enumeration Field Definition

Overview

Next Design allows you to define fields that allow users to select values ​​from a set of options. Such fields are called enumeration fields.

The following explains the steps to define an enumeration field, in order:

• Add an enumeration field
• Delete an enumeration definition
• Change enumeration settings

Enumeration Field Definition Image

---

Add an Enumeration Field

There are several ways to add an enumeration field:

• Define an enumeration on a class diagram and add a field
• Define a new enumeration when adding a field

Define an enumeration on a class diagram and add a field

To add an enumeration field on a class diagram, follow these steps:

Instructions

1. Drag and drop [Enum] from the Class Toolbox and enter a name.
2. The newly added enumeration has [Enumeration_Literal_1] defined as the first option. To change the value of an option, double-click the option you want to change, or select it and press f2.
3. To add an option to the enumeration, move the pointer over the enumeration's value display area, click the [+] icon in the upper right corner of the value display area, and enter the option's value.
4. This defines a set of options for the enumeration.
5. To add a defined enumeration field to an entity, click the [+] icon in the upper right corner of the entity's field display area to open the Add New Fields dialog box, just as you would when adding a field to an entity.
6. When specifying the data type in the Add New Fields dialog box, click the [...] button to the right of Data Type to open the finder, just as you would when specifying an existing entity.
7. Search for and click the enumeration type in the finder list to enter the enumeration type in Data Type.
8. Enter the settings in the Add New Fields dialog box and click OK.
9. This will add the enumeration field to the entity.

Defining a new enumeration type when adding a field

To define a new enumeration type at the same time as adding a field to an entity, follow these steps:

Instructions

1. Open the [Add New Fields] dialog box, just as you would when adding a field to an entity.
2. When specifying a data type in the [Add New Fields] dialog box, click [New Enum Type...] from the data type options to open the [New Enum Type] dialog box.
3. Enter the settings in the [New Enum Type] dialog box.
4. An enumeration must have at least one option. To add an option to an enumeration, click the [+] icon in the lower right corner of the [Enum Literal] grid to open the [New Enum Literal] dialog box.
5. Enter the settings in the [New Enum Literal] dialog box and click the [OK] button. This will return you to the [New Enum Type] dialog box, where the option will be added to the enumeration.
6. Enter the settings in the [New Enum Type] dialog and click [OK]. You will return to the [Add New Fields] dialog, where the enumeration type will be entered in [Data Type].
7. Enter the settings in the [Add New Fields] dialog and click [OK].
8. This will define a new enumeration type and add a field of that enumeration type to the entity.

Deleting an Enumeration Type Definition

There are several ways to delete an enumeration type:

• Delete the enumeration type from the metamodel
• Delete the enumeration type from the class diagram (hide it from the class diagram without deleting it from the metamodel)

Deleting an Enumeration Type from the Metamodel

To delete an enumeration type from the metamodel, follow the steps below, similar to deleting an entity.

Instructions

1. If you want to delete an enumeration used as a data type in an entity field, first delete the field.
2. Select the target enumeration in the class diagram and select [Delete From Model] from the context menu.
3. This will delete the target enumeration from the class diagram, the metamodel, and the Profile Navigator.

Note

• If you select the target enumeration in the class diagram and press the delete key, it will only be deleted from the class diagram, not the metamodel, as with the [Delete From Diagram] option in the context menu. It will remain in the Profile Navigator.

You can also delete an enumeration from the metamodel by following these steps:

Other Operation Procedures

1. Select the target enumeration in the Profile Navigator and select [Delete] from the context menu, or press the delete key.

Deleting an Enumeration from a Class Diagram

To remove an enumeration from a class diagram and hide it, follow these steps:

Operation Procedure

1. Select the target enumeration in the class diagram and select [Delete From Diagram] from the context menu, or press the delete key.
2. This will delete it from the class diagram, but not from the metamodel. The target enumeration will remain in the Profile Navigator. To redisplay it on the class diagram, manually add it to the class diagram using Metamodel Definition > Model Structure Definition > Add Entity > Add Existing Entity to Class Diagram.

Modifying Enumeration Settings

To add options to an enumeration or change their order, use the Inspector as follows:

Instructions

1. Click [View] > [Pane] > [Inspector] from the ribbon to display the Inspector on the right side of the screen.
2. Select the target enumeration in the class diagram or Profile Navigator.
3. Select [Enum Type] from the tab at the top of the Inspector.
4. To add a choice to the enumeration, click the + icon in the lower right corner of the Enum Literal grid in the Enum group, enter settings in the New Enum Literal dialog, and click OK.
5. To remove a choice from the enumeration, select the value you want to remove in the Enum Literal grid in the Enum group and click the - icon in the lower right.
6. To change the order of the choices defined in the enumeration, select the value you want to reorder in the Enum Literal grid in the Enum group and click the Up or Down arrow icon in the lower left.