Overview
Reserved words (or system variables) in Cloud Construct are special column names in the datasets of grid or properties card containers, visibility 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.
Note
Reserved words in Cloud Construct support the ‘boa’ prefix versions for backwards compatibility purposes, for example, boaEdit, boaUserEmail, and so on.
How Reserved Words Work
Reserved words in Cloud Construct 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, audit columns 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 a container’s dataset, content control views, or validation views act as filter criteria or parameters. For example, a grid container’s dataset containing a ccdEdit column will control the editability of a record.
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.
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 Cloud Construct.
Content Control Components Reserved Words List
Reserved Word | Purpose |
|---|---|
ccdAdd, boaAdd | Controls the ability to add records at the container level. |
ccdColumn, boaColumn | Allows you to specify column names you want to control in a User Control View (UCV). |
ccdControlStatus, boaControlStatus | Controls column behavior specified in the ccdColumn field in a UCV. |
ccdEdit, boaEdit | Controls the ability to modify records at the container level. |
ccdDelete, boaDelete | Controls the ability to delete records at the container level. |
ccdLanguage, boaLanguage | Filters views in grid/form containers by user language preference via all content control components. |
ccdPageID, boaPageID | Controls data using a Page ID via UCV. |
ccdUserEmail, boaUserEmail | Provides the current user's email address for data control. |
ccdUserId | Provides the current user's principal ID (pcp_xxx) for data control. |
ccdUserGroup, boaUserGroup | Allows you to control data using user group names. |
Views and Stored Procedures Reserved Words
The reserved words listed below can be used in the validation or business rules in SQL views or stored procedures, which are then configured in a container’s event.
Reserved Word | Purpose |
|---|---|
boaUserEmail | Provides the current user's email address. |
ContainerName | Provides the container name where the view or stored procedure is registered in an event and gets executed. |
EventName | Provides the event name where the view or stored procedure is registered in an event and gets executed. |
PageName | Provides the page name where the view or stored procedure is registered in an event and gets executed. |
PrincipalId | Provides the current user's principal ID (pcp_xxx) |
WebAppName | Provides the WebApp name where the view or stored procedure is registered in an event and gets executed. |
Table Field Reserved Words
The Syniti Reserved Columns listed below are used in Cloud Construct for basic record auditing. These columns are hidden by default.
Reserved Column | Purpose |
|---|---|
AddedOn | Captures the timestamp when a record is created. |
AddedBy | Captures the user principal ID (pcp_xxx) of the person who created the record. |
ChangedOn | Captures the timestamp of the most recent record modification. |
ChangedBy | Captures the user principal ID (pcp_xxx) of the person who last modified the record. |