Entity nodes: Adding and editing entities and their properties

Corticon Studio: Quick Reference Guide : Vocabularies : Populating a new Vocabulary : Adding nodes to the Vocabulary tree view : Entity nodes: Adding and editing entities and their properties

Try Corticon Now

Entity nodes: Adding and editing entities and their properties

1. Do one of the following:

Select the name node in the Vocabulary tree to add a new Entity node to the root level of the tree.

Select the newly created Domain node to add a new Entity to the Domain.

2. Do one of the following:

Right-click to display the pop-up menu and choose Add Entity

Choose Vocabulary > Add Entity from the menubar.

Choose

from the toolbar

3. Select the Entity in the Vocabulary tree to display its properties.

4. Assign property values as shown below:

The window shown here lists the basic properties common to every Entity.

Table 12. Basic Entity Properties
Property	Value
Entity Name	Assign a name to the entity. By default, this will be pre-filled as Entity_x, where x is an automatically determined unique number. As with Domains, double-clicking the node in the tree view will also open an editing box. Name changes made in either the node or the property will update in both places
Entity Identity	Used only when using EDC. Specifies which attributes (if any) act as its Entity's primary key. Chose multiple attributes on the pulldown list by opening the list then holding SHIFT while clicking the selections.
Inherits From	Optional. The Vocabulary model contains extensive support for inheritance concepts. For more information on using this feature, refer to the Rule Modeling Guide, Creating the Vocabulary chapter.

When the Vocabulary is showing its details, additional Entity properties are available. These properties and their usage are discussed in the Integration & Deployment Guide's chapter "Preparing Studio files for deployment."

Table 13. XML Mapping and Java Object Mapping Entity Properties
Property	Value
XML Namespace	Specifies the full namespace of XML Element Name when there is no exact match.
XML Element Name	Specifies the XML Element Name when there is no exact match.
Java Package	Specifies the package to be used for Java class metadata mapping.
Java Class Name	Maps the entity to the specified class when no class exists with the entity name.

When the Vocabulary is showing its details, additional Entity database properties are available.

Table 14. Enterprise Data Connector (EDC) Entity Properties
Property	Description	Values	Applicability
Datastore Persistent	Indicates whether this entity will be database bound.	Yes, No	Required, defaults to No.
Table Name	Name of database table, chosen from a drop-down list of all database table names, fully-qualified with catalog and schema if applicable.		Optional, if not specified system will infer best matching table from database metadata.
Datastore Caching	Indicates whether instances of this entity are subject to caching.	Optional, only active when the entity is Datastore Persistent.	Options are: No Cache or blank (default) - Disable caching. Read Only - Caches data that is never updated Read/Write - Caches data that is sometimes updated while maintaining the semantics of "read committed" isolation level. If the database is set to "repeatable read," this concurrency strategy almost maintains the semantics. Repeatable read isolation is compromised in the case of concurrent writes. Nonstrict Read/Write - Caches data that is sometimes updated without ever locking the cache. If concurrent access to an item is possible, this concurrency strategy makes no guarantee that the item returned from the cache is the latest version available in the database.
Identity Strategy	Strategy to generate unique identity for this entity.	Native, Table, Identity Sequence, UUID (These are described in the following table.)	Optional. Only enabled if Entity Identity is not specified and DataStore Persistent is set to Yes.
Identity Column Name	Name of the identity column, chosen from a drop-down list consisting of all column names associated with the table.		Optional. Only enabled if Entity Identity is unspecified. If not specified, system will attempt to find match, namely <entity>_ID.
Identity Sequence	The fully-qualified name of the sequence to be used.		Only applicable if Entity Identity is unspecified and Identity Strategy is Sequence. Required if enabled.
Identity Table Name	The fully-qualified name of the identity table to be used, chosen from a drop-down list of all table names and sequence names.		Only applicable if Entity Identity is unspecified and Identity Strategy is Table. Optional. If not specified, the value will default to SEQUENCE_TABLE.
Identity Table Name Column Name	The name of the column in the identity table that is used as the key (this column will contain the name of the entity). Chosen from a drop-down list of all columns in the table selected in the Table Name field.		Only applicable if Entity Identity is unspecified and Identity Strategy is Table. If not specified the value will default to SEQUENCE_NAME (String).
Identity Table Value Column Name	The name of the column which holds the identity value. Chosen from a drop-down list of all columns in the table selected in the Table Name field.		Only applicable if Entity Identity is unspecified and Identity Strategy is Table. If not specified the value will default to NEXT_VAL (Big Integer).
Version Strategy	Strategy to control optimistic concurrency.	Version Number Timestamp	Optional.
Version Column Name	Name of column that contains either version number or timestamp.		Only applicable if Version Strategy is specified. Required if enabled.

Note: Identity and strategy concepts are general relational database concepts. Refer to your RDBMS brand's documentation for more information, especially the identity strategies that are specific to certain brands. Also see Identity strategies and Advantages of using Identity Strategy rather than Sequence Strategy .

Table 15. Description of the Identity Strategy values
Strategy	Description
Native	Allows database to choose best possible identity strategy.
Table	Uses a database table, whose name may be specified in Identity Table Name. This table will have two columns: a name column and a value column. (Previously referenced as "increment".)
Identity	Uses the native identity capability in DB2, SQL Server (the column is defined as an "identity" column in the database schema).
Sequence	Uses sequence capability in DB2, PostgreSQL and Oracle.
UUID	Generates 128-bit UUID string of 32 hex digits. (Previously referenced as "uuid-hex".)

Note: Databases mentioned in the Identity Strategy table do not imply that they are currently supported RDBMS brands. For the current list of supported RDBMS brands, access the web location Progress Corticon 5.6 - Supported Platforms Matrix.