Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

REPLACE WITH THIS IMAGE: Images/Settings/Entity Entity Type.png Image Added

Icons

Descriptions

REPLACE WITH THIS IMAGE: Images/Common_Icons/addqueryicon.png

Image Added

Click Add to Create new entity type. Complete the following on the Create a new entity type dialog to create a new entity type:

  • Definition - Entity details are defined in this tab. Refer to Definition Tab for details.
  • Automatic generation - Attributes and Indexes are defined and automatically created when this entity type is assigned. Refer
to
Note
titleNote

An entity type can only be added if

the

the Restrict types

check

 check box is not selected on

the

the Entity> General Settings

window

 window.

REPLACE WITH THIS IMAGE: Images/Common_Icons/renamequeryicon.png


Image Added

Click to Edit the selected entity type.

REPLACE WITH THIS IMAGE: Images/Common_Icons/copyqueryicon.png

Image Added

Click to make a Copy of the selected entity type.

REPLACE WITH THIS IMAGE: Images/Common_Icons/removequeryicon.png

Image Added

Click to Delete the selected entity type.

REPLACE WITH THIS IMAGE: Images/Common_Icons/up.png

Image Added

Click to move the selected entity type a level up.

REPLACE WITH THIS IMAGE: Images/Common_Icons/down.png

Image Added

Click to move the selected entity type a level down.


Note

If you rename an entity type which is used in a model conversion, the Rename entity type dialog is displayed. Refer to Renaming entity types for details.

...

Anchor

...

definitiontab
definitiontab
Definition Tab

This tab enables you to define settings required for creating a new entity type.
REPLACE WITH THIS IMAGE: Images/Settings/Entity Entity Type_1.png
The following definition fields are available: 

Fields

Description

Name

A name for the entity type

Group

This field can be used to organize entity types.

Description

A description of the entity type

Color

Set the color assigned to an entity, which are used to aid identification in the diagram. Click REPLACE WITH THIS IMAGE: Images/Common_Icons/selectarrow.png to select a color.

Entity icon

Keep the existing icon or change to another icon.

Query template

Optionally, assign a template to the entity definition.

Note

The default template option retains the existing assigned template.

DW query template

Optionally, assign a template to the entity definition.

Note

The default template option retains the existing assigned template.

Behavior

Used to tag if entities of this type should have changes tracked.

Characteristic

Select if this entity functions as a Terminal or Hub.

Keywords

A list of keywords to be assigned to entities of this type

Assign attribute types to pk

A list of attribute types that will be assigned to the primary key attribute(s) in entities of this type

Prefix and Suffix

A custom prefix and/or suffix to be added to the entity, all attributes in the entity, all foreign keys to and from the entity, and/or all indexes on the entity.

...

Anchor

...

automaticgentab
automaticgentab
Automatic Generation Tab

This tab enables you to define attributes and indexes to be automatically created when this entity type is assigned through entity type robots. You can create a new robot by clicking REPLACE WITH THIS IMAGE: Images/Common_Icons/addqueryicon.png or by clicking REPLACE WITH THIS IMAGE: Images/Common_Icons/copyqueryicon.png to copy from an existing entity type. Select Attribute or Index from the drop-down list to change whether the currently selected robot creates an attribute or an index.
REPLACE WITH THIS IMAGE: Images/Settings/Entity Entity Type_2.png

Anchor
_attribute_robots
_attribute_robots
Attribute Robots

Fields

Description

Robot name

Attribute robot's name.

Positioning

Enables you to define whether the attribute should be created above or below all existing attributes in the entity. Select one of the following options:

  • Top
  • Bottom

Attribute name

The name of the attribute.

Tip

The percentage sign % can be used to represent the entity name.

Comment

A comment on the attribute.

Data type

Enter the attribute's datatype.

Data type size

Enter the datatype's size parameter.

Data type scale

Enter the datatype's scale parameter.

Character set

The attribute's character set.

Default value

The default value for the attribute.

Primary key

Select the checkbox so the attribute is contained in the primary key for the table

Auto increment

Select the checkbox so the attributes's value is automatically generated.

Unique

Select the checkbox so the attributes's values must be unique.

Nullable

Select the checkbox so the attribute may contain null values.

Attribute types

Select an attribute type from the drop-down list.

Anchor
_index_robots
_index_robots
Index Robots

Fields

Description

Robot name

Index robot's name.

Index name

The name of the index.

Tip

The percentage sign % can be used to represent the entity name.

Description

A short description of index robot.

Index types

Select a type of index from the drop-down list.

Indexed attributes

You can choose any of: primary key attributes, foreign key attributes, selected attributes being created by robots, or all attributes of particular types

Attribute types

Click REPLACE WITH THIS IMAGE: Images/Common_Icons/addqueryicon.png to add index attribute. You can select one of the following options from the Select index attribute dialog:

  • Primary keys
  • Foreign keys
  • Attributes (created by robots)
  • Attribute types (particular types of attributes

Note

  • An entity type can only be added if the Restrict types check box is not selected on the Entity> General Settings window.
  • Click REPLACE WITH THIS IMAGE: Images/Common_Icons/removequeryicon.png to delete the selected attribute.
  • Click REPLACE WITH THIS IMAGE: Images/Common_Icons/up.png to move the selected attribute a level up.
  • Click REPLACE WITH THIS IMAGE: Images/Common_Icons/down.png to move the selected entity type a level down.


Anchor
_renaming_entity_types
_renaming_entity_types
Renaming Entity Types

If any model conversion in the repository references any of the entity types that were renamed in the previous step, you then need to update them to continue to use them.
To do this:

...

  1. Select a Model conversion and then select a Resolution from the list.

    Tip

    Options in the Resolution pane vary depending if the model conversion was created by the user or was supplied with WhereScape 3D.


  2. Options

    Description

    Do not change

    Select to make no changes made to the current model conversion.

    Add type

    Select this option to add the new renamed entity type to the selected model conversion.

    Replace type

    Select this option to replace the entity type with the new entity type (renamed) for the selected model conversion.

    Copy model conversion

    Select this option to make a copy of the selected model conversion and replace with the new entity type (renamed). When you select this option, no changes are applied to the selected model conversion.

    Show category model conversions

    Select the checkbox to display category model conversions.

    Set all to:

     


    Do not change

    Select to make no changes to all the listed model conversions.

    Copy model conversion

    Select to make a copy of all the model conversion and replace with the new entity type (renamed). When you select this option, no changes are applied to the selected model conversions.

  3. Click Next.
  4. On the Entity type in model conversion dialog, enter new names for the copied model conversions.

...