syst_menu_items


Description

Individual menu entries which can serve as actionable menu items, grouping items, references to other menus to include recursively, or any appropriate combination thereof.

User Defined Record Supported Operations

  • INSERT
  • SELECT
  • UPDATE
  • DELETE

System Defined Record Supported Operations

  • SELECT
  • UPDATE - See column comments for applicable restrictions.
  • DELETE - Only user maintainable records.

Columns

Column Type Size Nulls Auto Default Children Parents Comments
id uuid 2147483647 √ null

The record’s primary key. The definitive identifier of the record in the system.

General Usage

This column is system maintained and should be considered read only in normal operations.

Data Requirements

  • Required?: false
  • Unique Values Required?: true
  • Default Value: Automatically Generated

User Defined Record Supported Operations

  • SELECT

System Defined Record Supported Operations

  • SELECT
internal_name text 2147483647 √ null

A candidate key useful for programmatic references to individual records.

General Usage

This column is system maintained and should be considered read only in normal operations.

Data Requirements

  • Required?: true
  • Unique Values Required?: true
  • Default Value: ( No Default Value )

User Defined Record Supported Operations

  • INSERT
  • SELECT
  • UPDATE

System Defined Record Supported Operations

  • SELECT
display_name text 2147483647 √ null

A friendly name and candidate key for the record, suitable for use in user interactions

General Usage

This column is system maintained and should be considered read only in normal operations.

Data Requirements

  • Required?: true
  • Unique Values Required?: true
  • Default Value: ( No Default Value )

User Defined Record Supported Operations

  • INSERT
  • SELECT
  • UPDATE

System Defined Record Supported Operations

  • SELECT
  • UPDATE - Only user maintainable records.
external_name text 2147483647 √ null

A non-unique/non-key value used to display to users and external parties where uniqueness is less of a concern than specific end user presentation.

Data Requirements

  • Required?: true
  • Unique Values Required?: false
  • Default Value: ( No Default Value )

User Defined Record Supported Operations

  • INSERT
  • SELECT
  • UPDATE

System Defined Record Supported Operations

  • SELECT
  • UPDATE - Only user maintainable records.
menu_id uuid 2147483647 √ null

Identifies the Menu to which the menu item belongs.

Data Requirements

  • Required?: true
  • Unique Values Required?: false
  • Default Value: ( No Default Value )

User Defined Record Supported Operations

  • INSERT
  • SELECT

System Defined Record Supported Operations

  • SELECT

Supplemental Notes

This column is part of a composite key. The combined values of menu_id, parent_menu_item_id, and sort_order must be unique. The parent_menu_item_id is allowed to be NULL, but all NULL in this column are considered not distinct, therefore are treated as the same grouping for the purposes of this uniqueness check.
parent_menu_item_id uuid 2147483647 √ null

References the current Menu Item’s parent Menu Item record. If the current Menu Item record is at the root of the Menu, this value will be NULL.

Data Requirements

  • Required?: false
  • Unique Values Required?: false
  • Default Value: ( No Default Value )

User Defined Record Supported Operations

  • INSERT
  • SELECT

System Defined Record Supported Operations

  • SELECT

Supplemental Notes

This column is part of a composite key. The combined values of menu_id, parent_menu_item_id, and sort_order must be unique. The parent_menu_item_id is allowed to be NULL, but all NULL in this column are considered not distinct, therefore are treated as the same grouping for the purposes of this uniqueness check.
sort_order int2 5 √ null

Establishes the current Menu Item’s sorting order relative to sibling Menu Item records

Data Requirements

  • Required?: true
  • Unique Values Required?: false
  • Default Value: ( No Default Value )

User Defined Record Supported Operations

  • INSERT
  • SELECT
  • UPDATE

System Defined Record Supported Operations

  • SELECT
  • UPDATE - Only user maintainable records.

Supplemental Notes

This column is part of a composite key. The combined values of menu_id, parent_menu_item_id, and sort_order must be unique. The parent_menu_item_id is allowed to be NULL, but all NULL in this column are considered not distinct, therefore are treated as the same grouping for the purposes of this uniqueness check.
submenu_menu_id uuid 2147483647 √ null

When not null, indicates that the Menu Item record imports an independently defined Menu.

General Usage

An attempt to associate a Menu which recursively references the current Menu Item’s parent Menu will result in an exception being raised and the transaction attempting to make the association will be rolled back.

Note that the referenced Menu’s descriptive texts and naming will supersede the naming specified directly by this record or the text of any associated Menu Action referenced in the action_id column.

Data Requirements

  • Required?: false
  • Unique Values Required?: false
  • Default Value: ( No Default Value )

User Defined Record Supported Operations

  • INSERT
  • SELECT
  • UPDATE

System Defined Record Supported Operations

  • SELECT
  • UPDATE - Only user maintainable records.
action_id uuid 2147483647 √ null

Associates a specific action to be invoked when the Menu Item that the record represents is “selected”.

General Usage

Note that the referenced Action’s texts will supersede the Menu Item texts in any user facing situations, though if the Menu Item is also associated with a Menu (submenu_menu_id), the Menu’s text will prevail.

Data Requirements

  • Required?: false
  • Unique Values Required?: false
  • Default Value: ( No Default Value )

User Defined Record Supported Operations

  • INSERT
  • SELECT
  • UPDATE

System Defined Record Supported Operations

  • SELECT
  • UPDATE - Only user maintainable records.
syst_description text 2147483647 √ null

A system defined description indicating the purpose and use cases of a given record. Text defined in this column is system maintained and should not be changed under normal circumstances.

General Usage

This column is system maintained and should be considered read only in normal operations.

Data Requirements

  • Required?: false
  • Unique Values Required?: false
  • Default Value: ( No Default Value )

User Defined Record Supported Operations

  • SELECT

System Defined Record Supported Operations

  • SELECT
user_description text 2147483647 √ null

An optional user defined description of the record and its use cases. If this value is not NULL, the value will override any syst_description defined text in application user interfaces and other presentations.

Data Requirements

  • Required?: false
  • Unique Values Required?: false
  • Default Value: ( No Default Value )

User Defined Record Supported Operations

  • INSERT
  • SELECT
  • UPDATE

System Defined Record Supported Operations

  • SELECT
  • UPDATE - Always updatable, even when not otherwise user maintainable.
diag_timestamp_created timestamptz 35,6 √ null

The database server date/time when the transaction which created the record started.

General Usage

This column is system maintained and should be considered read only in normal operations.

Data Requirements

  • Required?: false
  • Unique Values Required?: false
  • Default Value: Automatically Generated

User Defined Record Supported Operations

  • SELECT

System Defined Record Supported Operations

  • SELECT
diag_role_created text 2147483647 √ null

The database role which created the record.

General Usage

This column is system maintained and should be considered read only in normal operations.

Data Requirements

  • Required?: false
  • Unique Values Required?: false
  • Default Value: Automatically Generated

User Defined Record Supported Operations

  • SELECT

System Defined Record Supported Operations

  • SELECT
diag_timestamp_modified timestamptz 35,6 √ null

The database server date/time when the transaction which modified the record started. This field will be the same as diag_timestamp_created for inserted records.

General Usage

This column is system maintained and should be considered read only in normal operations.

Data Requirements

  • Required?: false
  • Unique Values Required?: false
  • Default Value: Automatically Generated

User Defined Record Supported Operations

  • SELECT

System Defined Record Supported Operations

  • SELECT
diag_wallclock_modified timestamptz 35,6 √ null

The database server date/time at the moment the record was actually modified. For long running transactions this time may be significantly later than the value of diag_timestamp_modified.

General Usage

This column is system maintained and should be considered read only in normal operations.

Data Requirements

  • Required?: false
  • Unique Values Required?: false
  • Default Value: Automatically Generated

User Defined Record Supported Operations

  • SELECT

System Defined Record Supported Operations

  • SELECT
diag_role_modified text 2147483647 √ null

The database role which modified the record.

General Usage

This column is system maintained and should be considered read only in normal operations.

Data Requirements

  • Required?: false
  • Unique Values Required?: false
  • Default Value: Automatically Generated

User Defined Record Supported Operations

  • SELECT

System Defined Record Supported Operations

  • SELECT
diag_row_version int8 19 √ null

The current version of the row. The value here indicates how many actual data changes have been made to the row. If an update of the row leaves all data fields the same, disregarding the updates to the diag_* columns, the row version is not updated, nor are any updates made to the other diag_* columns other than diag_update_count.

General Usage

This column is system maintained and should be considered read only in normal operations.

Data Requirements

  • Required?: false
  • Unique Values Required?: false
  • Default Value: Automatically Generated

User Defined Record Supported Operations

  • SELECT

System Defined Record Supported Operations

  • SELECT
diag_update_count int8 19 √ null

Records the number of times the record has been updated regardless as to if the update actually changed any data. In this way needless or redundant record updates can be found. This row starts at 0 and therefore may be the same as the diag_row_version - 1.

General Usage

This column is system maintained and should be considered read only in normal operations.

Data Requirements

  • Required?: false
  • Unique Values Required?: false
  • Default Value: Automatically Generated

User Defined Record Supported Operations

  • SELECT

System Defined Record Supported Operations

  • SELECT

Relationships

Close relationships within degrees of separation

View Definition

Possibly Referenced Tables/Views