syst_hierarchies

Columns

Related columns Constraint Comments

Search:

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.

hierarchy_type_id

uuid

2147483647

√

null

A reference indicating in which specific functional area or with which feature of the application the Hierarchy is associated with.

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

hierarchy_state_id

uuid

2147483647

√

null

A reference indicating at which point in the Hierarchy life-cycle the record sits.

General Usage

The record may only be set in an active state if the record and any associated Hierarchy Item records are in a consistent, valid state. Similarly, the record may only be set to an inactive state if the Hierarchy record is not in use, which is defined as the record being referenced by an Hierarchy implementing Component’s 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

syst_defined

bool

1

√

null

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.

Data Requirements

Required?: false
Unique Values Required?: false
Default Value: FALSE

User Defined Record Supported Operations

SELECT

System Defined Record Supported Operations

SELECT

user_maintainable

bool

1

√

null

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.

Data Requirements

Required?: false
Unique Values Required?: false
Default Value: TRUE

User Defined Record Supported Operations

SELECT

System Defined Record Supported Operations

SELECT

structured

bool

1

√

null

A flag indicating whether or not the Hierarchy actually defines a structure, or if the any implementations allow fully ad hoc structuring within the implementing Component.

General Usage

This configuration exists for cases where a Component implements Hierarchy functionality, but can also operate while bypassing any hierarchy checks at all; this way we can still require a Hierarchy record reference in the implementation while allowing the Hierarchy definition itself be the configuration point for determining whether or not hierarchical structure is required.

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

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

Showing 1 to 17 of 17 entries

Relationships

Close relationships within degrees of separation

One

View Definition

 
SELECT id,
    internal_name,
    display_name,
    hierarchy_type_id,
    hierarchy_state_id,
    syst_defined,
    user_maintainable,
    structured,
    syst_description,
    user_description,
    diag_timestamp_created,
    diag_role_created,
    diag_timestamp_modified,
    diag_wallclock_modified,
    diag_role_modified,
    diag_row_version,
    diag_update_count
   FROM ms_syst_data.syst_hierarchies;

Description

Columns

Relationships

Close relationships within degrees of separation

View Definition

Possibly Referenced Tables/Views