Reserved Words

Prev Next

Overview

Reserved words (or system variables) in Syniti Construct are special column names in page views, control views, or stored procedures that trigger specific system behaviors. When the system detects these reserved words as column names, it automatically applies predefined functionality without requiring additional configuration. Reserved words also act as environment parameters that pass user session information to views, stored procedures, and business rules.

How Reserved Words Work

Reserved words function differently depending on their context:

  • In Tables: When reserved word columns exist in a table registered as a page's underlying data source, the system automatically manages the fields in a table. For example, appending audit columns using the Append Columns button provides basic auditing functionality at the record level, and tracks who created and modified each record, when, and through which interface.

  • In Views: Reserved words in horizontal views, control views, or validation views act as filter criteria or parameters. For example, a horizontal view containing a @boaUserEmail column shows only records where the data matches the current user's email address.

  • In Stored Procedures: Reserved words as stored procedure parameters receive session values automatically when the procedure executes through event rules or validations. For example, a stored procedure with parameter @boaUserEmail receives the current user's email without requiring manual configuration in the event rule.

  • In List Boxes: Reserved words in dynamic WHERE clauses filter data based on user session information. For example, dropdown lists automatically display values in the user's language preference when you include a field like boaSAPLanguage in the list view.

The system recognizes reserved words by their exact column name and applies the corresponding functionality automatically. The tables below lists the reserved words available in Syniti Construct.

Note

Not all of these words are currently used by Syniti Construct; however, they are registered as reserved words for backward compatibility.

Reserved Words List

Reserved Word

Purpose

boaAdd

Controls whether the Add button displays at the page level when used in a Page or User Control View.

boaApplicationName

Provides the name of the current WebApp.

boaApplicationVersion

Provides the version number set in System Administration for the WebApp.

boaAudit

Controls the display of the audit icon on a page through a User, Data or Page Control View.

boaBack

Not applicable in Syniti Construct.

boaChoose

Reserved word related to the ComboBox list filter form, not a user accessible control.

boaDatabase

Provides the database identifier

boaDataSourceID

Provides the data source ID for the current page.

boaDelete

Controls whether users can delete records at record or page level in a Control View.

boaEdit

Controls whether users can edit records at record level (DCV) or page level (PCV).

boaForward

Not applicable in Syniti Construct.

boaHorizontalView

Provides the horizontal view name for the current page.

boaIndex

Not applicable in Syniti Construct.

boaInstance

Not applicable in Syniti Construct.

boaKeywords

Not applicable in Syniti Construct.

boaLanguage

Provides a way to filter List, Horizontal and Vertical views against the current user's language preference (alternative to boaSAPLanguage).

boaLocaleID

Provides the current user's locale setting from their profile.

boaPageID

Provides the current page ID.

boaSAPLanguage

Provides a way to filter List, Horizontal and Vertical views against the current user's language preference.

boaSave

Reserved word for the Save field on the data grid rows. Not a user accessible control.

boaSessionID

Provides the unique session identifier for the current user session.

boaTable

Provides the underlying table name for the current page.

boaUserEmail

Provides the current user's email address.

boaUserGroup

Provides the user's group or role assignment.

boaUserName

Provides the current user's email address, same as boaUserEmail.

boaVertical

Reserved word for the Vertical icon column on the data grid. Can be used in Control Views (DCV, PCV, UCV) to disable or hide the Vertical View column and therefore controls access to the Vertical view.

boaVerticalView

Provides the vertical view name for the current page.

boaWebAppID

Provides the ID of the current WebApp.

cranProcessed

Not applicable in Syniti Construct.

Reserved Columns Added Using the Append Columns Feature

In Syniti Construct, reserved columns are only automatically added to tables when the Append Columns icon is clicked on the Data Sources Vertical View.

Reserved Column

Purpose

AddedBy

Captures the email address of the person who created the record, same as boaUserEmail.

AddedOn

Captures the timestamp when a record is created.

AddedVia

Records the interface or method used to create the record.

boaLockType

Manages Excel integration locking when Excel Integration is enabled.

boaStatus

Controls the display of the status icon on a page.

ChangedBy

Captures the email address of the person who last modified the record, same as boaUserEmail.

ChangedOn

Captures the timestamp of the most recent record modification.

ChangedVia

Records the interface or method used for the last modification.

LockedBy

Identifies which user currently holds a lock on the record.

LockedOn

Records when a record was locked for editing.

Audit Table Reserved Words

In Syniti Construct, the following reserved words are used in the Audit tables generated to capture data changes recorded by the audit process:

Reserved Word

Purpose

boaAuditChange

Stores information about changes made during an audit event.

boaAuditDateCreated

Records the timestamp when an audit entry was created.

boaAuditEvent

Identifies the type of audit event (Insert, Update, Delete).

boaAuditID

Unique identifier for each audit record.

boaAuditPageID

Identifies which page triggered the audit event.

boaAuditProcedureName

Records the name of the stored procedure that executed the audit.

boaAuditProcedureType

Type of procedure (validation or business rule) that triggered the audit event.

boaAuditProcessToken

Not applicable in Syniti Construct.

boaAuditSequence

Sequential order of audit events within a transaction.

boaAuditUserID

Email address of the person who performed the audited action, same as boaUserEmail.