Sys API
Sys is the global namespace through which app code reaches platform functionality: dates, text, mail, files, AI, users, processes, and more. You call it from any script in Lowgile Studio, for example Sys.Log.info('Order saved') or Sys.Date.format(new Date(), 'dd.MM.yyyy').
Sys is not the same object everywhere. Lowgile gives your code the Sys that matches where the code runs, and each one contains only what works there.
Availability
Section titled “Availability”Each entry in this reference states where you can call it:
| Availability | Where you can call it |
|---|---|
| Server | Server-side code only: server methods, Process scripts, Triggers, Service Providers. |
| Client | Client-side code only: Screen code and client methods. |
| Both | Server-side and client-side code, but not shared code. |
| Everywhere | Server-side, client-side and shared code. Shared code is code Lowgile compiles for both sides, such as Entity methods with availability serverAndClient or calculation. |
A member’s availability is the broadest availability of its functions. Some members, such as Sys.Text and Sys.User, have more functions on one side than in shared code, so check each function’s own availability line.
Members
Section titled “Members”| Member | Purpose | Availability |
|---|---|---|
| Sys.Ai | Call AI models, including structured output, and manage AI chat sessions. | Server |
| Sys.App | Control the running app in the browser. | Client |
| Sys.Audit | Read and write audit trail entries. | Both |
| Sys.Auth | Create file access tokens. | Server |
| Sys.Banking | Exchange banking data through EBICS and ISO 20022. | Server |
| Sys.Crypto | Hash, encrypt, sign and generate keys. | Server |
| Sys.Data | Convert, copy and compare data objects. | Everywhere |
| Sys.Date | Format dates in the current language, with date-fns included. | Everywhere |
| Sys.Db | Access the database connection behind a Server Data Store directly. | Server |
| Sys.Debug | Serialize objects for inspection. | Both |
| Sys.Ext | Reach Extension exports (not functional yet). | Server |
| Sys.Files | Manage stored files and file access tokens. | Server |
| Sys.Fs | Read and write files in the app’s working directory. | Server |
| Sys.GoogleMaps | Call Google Maps services. | Server |
| Sys.Idb | Store data in the browser’s IndexedDB. | Client |
| Sys.Image | Read, convert and transform images. | Server |
| Sys.Language | Read and change the current language. | Everywhere |
| Sys.Layout | React to the screen size and layout. | Client |
| Sys.Log | Write entries to the server log. | Server |
| Sys.Mail | Send and receive email. | Server |
| Sys.Math | Rounding and other numeric helpers. | Everywhere |
| Sys.Microsoft | Call Microsoft Graph and Azure services. | Server |
| Sys.Pdf | Create, read and change PDF documents. | Server |
| Sys.Process | Work with Process instances and User Tasks. | Both |
| Sys.RateLimiting | Run lists of async tasks with concurrency and rate limits. | Everywhere |
| Sys.Screen | Navigate between Screens and open dialogs. | Client |
| Sys.Sftp | Transfer files over SFTP. | Server |
| Sys.Soap | Call SOAP services. | Server |
| Sys.Storage | Store values in the browser’s local storage and IndexedDB. | Client |
| Sys.System | Information about the running system. | Everywhere |
| Sys.Text | Convert, format and generate text. | Everywhere |
| Sys.Types | Shared types used across the API. | Everywhere |
| Sys.User | The current user, and user and role checks. | Everywhere |
| Sys.Version | The running platform version. | Everywhere |
| Sys.Xls | Create and read Excel workbooks. | Server |
| Sys.Zip | Create and extract ZIP archives. | Server |
| Utilities and bundled libraries | Sys.wait and the third-party libraries Lowgile exposes: Ramda, HttpClient, getHttpClient, Https, Path, Xml, QrCode, Confetti, RustLib. | Varies |
Related
Section titled “Related”- Business Object API
-
Understanding
Thisandthisin Lowgile