Skip to content

Business Object API

Lowgile compiles each Business Object into code you can call from app code. This section lists, per Business Object type, the functions and properties that code can use.

Every Business Object belongs to a Module and is reached through that Module’s namespace. Inside a Module, This refers to the Module itself, so This.Order and <ModuleName>.Order are the same object. This reference always writes This..

Some Business Object types are reached directly by name. Others are grouped under a $-prefixed namespace, and for those This.<Name> does not work:

Business Object typeHow to reach itAvailability
EntityThis.<EntityName>Everywhere
Static EntityThis.<StaticEntityName>Everywhere
Server Data StoreThis.<ServerDataStoreName>Both¹
Client Data Storeapp.<storeName>, not This.Client
LabelThis.$T.<LabelName> or This.$T_<LanguageId>.<LabelName>Everywhere
ScreenThis.$Screens.<ScreenName>Everywhere
ProcessThis.$Process.<ProcessName>Both¹
TriggerThis.$Trigger.<TriggerName>Server
ResourceThis.$Resources.<ResourceName>Everywhere
User-Defined ConfigurationThis.<ConfigurationName>Both¹
ReportThis.<ReportName>Both¹
Service IntegrationThis.<ServiceIntegrationName>Server
Service ProviderThis.<ServiceProviderName>Server
Configuration ItemThis.$Config.<ItemName>Everywhere
RoleThis.$Roles.<RoleName>Everywhere
PermissionThis.$Permissions.<PermissionName>Everywhere
Data TypeThis.<DataTypeName>, as a type onlyEverywhere
Theme, Language, Access ControlNothing to call—

¹ On the client, the call is sent to the server, which checks the caller’s access first. For Server Data Stores and Processes, that check is Access Control; each page says which check applies.

Each entry in this reference states where you can call it:

AvailabilityWhere you can call it
ServerServer-side code only: server methods, Process scripts, Triggers, Service Providers.
ClientClient-side code only: Screen code and client methods.
BothServer-side and client-side code, but not shared code.
Both¹Server-side and client-side code. On the client, the call is sent to the server, so it is slower and the server checks the caller’s access first.
EverywhereServer-side, client-side and shared code. Shared code is code Lowgile compiles for both sides, such as Entity methods with availability serverAndClient or calculation.

Calls from the client go through Access Control

Section titled “Calls from the client go through Access Control”

Many client-side functions, such as loading or saving through a Server Data Store or starting a Process, run on the server. The client sends the request, and the server refuses it unless an Access Control covering the Business Object grants it. Calls from server-side code are allowed unless an Access Control restricts them.

Note

Entities have no save, load or delete methods of their own. To persist an Entity, call the Server Data Store that stores it, for example This.MyDataStore.saveOne(order).

  • Sys API
  • Object Types
  • Understanding This and this in Lowgile