syst_complex_format_values


Description

The list of values provided by an enumeration as well as related behavioral and informational metadata.

Columns

Column Type Size Nulls Auto Default Children Parents Comments
id uuid 2147483647 uuid_generate_v7()
mstr_country_address_format_assocs.address_format_id mstr_country_address_format_assocs_address_formats_fk C
mstr_country_name_format_assocs.name_format_id mstr_country_name_format_assocs_name_formats_fk R
mstr_country_phone_format_assocs.phone_format_id mstr_country_phone_format_assocs_phone_formats_fk R

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.
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.
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.
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.
complex_format_id uuid 2147483647 null
syst_complex_formats.id syst_complex_format_values_complex_format_fk C

The format record with which the value is associated.
format_default bool 1 false

If true, indicates that this value is the default selection from all values defined for the enumerations. If false then the value record has no special significance relative to defaulting.

Note that if a record is inserted or updated in this table with enum_default set true, and another record already exists for the enumeration with its enum_default set true, the newly inserted/updated record will take precedence and the value record previously set to be default will have its enum_default setting set to false.
syst_defined bool 1 false

Values of TRUE in this column indicate that the record is considered a “System Defined” record, a record which is created and primarily maintained by the system using automated processes. A value of FALSE indicates that the record is considered a “User Defined” record which is maintained by user actions in the application.

General Usage

This column is system maintained and should be considered read only in normal operations.
user_maintainable bool 1 false

If a record is system defined (see the syst_defined column), there may be some user data maintenance operations permitted in some cases. If the value of this column for a record is TRUE and the record is also “System Defined”, then permitted user maintenance operations are available for the record. If the record is system defined and the value of this column is FALSE, no user maintenance is allowed. If the record is not system defined, the value in this column will have no meaning or effect; user defined records may set this value TRUE as a simple information point indicating that the record is user maintainable.

General Usage

This column is system maintained and should be considered read only in normal operations.
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.
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.
sort_order int4 10 null

Indicates the sort ordering of the particular value record with the lowest value sorting first. When a value record for an enumeration is inserted or updated and this column is being set to a value which equals another enumeration value record for the same enumeration, the system assumes that the new record is being set to precede the existing record and it will be set to sort after the newly inserted/updated enumeration value.
syst_data jsonb 2147483647 null

For the system expected data definition this column identifies the individual fields that make up the complex format type along with the expected type and other expected metadata for each field.
syst_form jsonb 2147483647 null

Describes how the individual data fields of the complex format are presented in user interfaces and printed documents.
user_data jsonb 2147483647 √ null

Allows for custom user data fields to be defined in place of the system provided data in syst_data. Note that when this column is not null, it replaces the system definition: it does not augment it. This means that any system expected data fields should also appear in the user data.
user_form jsonb 2147483647 √ null

Allows for custom user layout of the format data fields in user interfaces and other user presentations. Note that when this column is not null, it replaces the system definition and so any system expected layout elements should also be accounted for in this user layout.
diag_timestamp_created timestamptz 35,6 now()

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.
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.
diag_timestamp_modified timestamptz 35,6 now()

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.
diag_wallclock_modified timestamptz 35,6 clock_timestamp()

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.
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.
diag_row_version int8 19 1

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.

Direct Usage

This column is frequently used by by application logic to resolve the “dirty write” issues which can arise from concurrent data changes. As such any administrative override of automatic system maintenance of this value should consider the ramifications on application function.
diag_update_count int8 19 0

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.

Indexes

Constraint Name Type Sort Column(s)
syst_complex_format_values_pk Primary key Asc id
syst_complex_format_values_display_name_udx Must be unique Asc display_name
syst_complex_format_values_internal_name_udx Must be unique Asc internal_name

Relationships

Close relationships within degrees of separation