syst_action_groups


Description

Defines groups of actions which can be associated with an invoking primary command.

There are two fundamental roles fulfilled by the Action Group. The first of these is a simple organizing role related to child Action records (ms_syst_data.syst_actions); there is little functional purpose to this first role aside from user interface categorization.

The second fundamental role establishes the Primary Command component of a user commandline interaction model. The Primary Commands defined by Action Groups express the general action a user wishes to take: “new”, “open”, “display” are examples of such generalized actions. These generalized actions in turn can then be specialized using a secondary Command (defined by Actions) to a specific system function: “new purchase order”, “new sales order”, “open sales order”, “display report” are examples showing how the generalized commands (Action Group) are tied to specific Action commands (Actions).

Columns

Column Type Size Nulls Auto Default Children Parents Comments
id uuid 2147483647 uuid_generate_v7()
syst_actions.action_group_id syst_actions_action_group_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.
command text 2147483647 √ null

Provides the primary text “Command” used for identifying the Action Group.

Commands associated with Action Groups are used for commandline-like input by application users to specify a class of action. For example, the Command “new” may designate a class of Actions which all deal with record or transaction creation; secondary Commands at the Action level would delineate which specific creation action to take.

General Usage

When the value of this column is NULL, the Action Group is not searchable or available to the user using command line interfaces. Such Action Groups exist to organize Actions which are only accessible via menu interfaces (or similar). Note that if this value is NULL other command_* columns must also be NULL.

command designated Commands have priority over similar “Command Aliases” defined in the command_aliases column.
command_config regconfig 2147483647 √ null

Establishes the PostgresSQL text search configuration to use when parsing the Command strings. The primary use of this column is to set the value of the generated column command_search, though establishing the appropriate configuration for use with the record may be useful elsewhere.

General Usage

The null/not null state of this column must match the null/not null state of the command column.
command_aliases _text 2147483647 √ null

An array of strings which designate alternate, possibly non-unique values which may be used in addition to the command value in identifying the record. In searched results, command_aliases received a reduced priority vs. command values.

General Usage

The null/not null state of this column must match the null/not null state of the command column.
command_search tsvector 2147483647 √ ms_syst_priv.generate_command_tsvector(p_config => command_config, p_command => command, p_command_aliases => command_aliases)

A generated column containing the PostgreSQL tsvector value used when resolving an Action Group Command. Being a generated column, the system will automatically update this column when its source columns are updated.

General Usage

Being a generated column, the system will automatically update this column when its source columns are updated. The null/not null state of this column will match the null/not null state of the command column.
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 true

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.
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_action_groups_pk Primary key Asc id
syst_action_groups_command_search_idx Performance Asc command_search
syst_action_groups_command_udx Must be unique Asc command
syst_action_groups_display_name_udx Must be unique Asc display_name
syst_action_groups_internal_name_udx Must be unique Asc internal_name

Check Constraints

Constraint Name Constraint
syst_action_groups_command_validity_chk ((((command IS NULL) AND (command_config IS NULL) AND (command_aliases IS NULL) AND (command_search IS NULL)) OR ((command IS NOT NULL) AND (command_config IS NOT NULL) AND (command_aliases IS NOT NULL) AND (command_search IS NOT NULL))))

Relationships

Close relationships within degrees of separation