Page History

...

• Object-Oriented framework
• Compile-time checking
• Intellisense and documentation
• Simplified design

TypeScript

The Client Logic API (CLA) is written in TypeScript which allows for compile-time checking and intellisense among others.

...

https://www.typescriptlang.org/docs/handbook/typescript-in-5-minutes.html

Visual Studio Code

In the following examples we will be using Visual Studio Code.

...

https://code.visualstudio.com/docs/getstarted/introvideos

Migrating to the Client Logic API

In the following example we will migrate a function to the CLA. The function gets the foreign keys when launching a window to create a new record.

In the Sports Sample Application, open the Customers desktop window. Click the New Order button in the Customer Grid Floating Action Button (FAB) (see picture below).

Calling Client Logic API Functions

You can pass several system objects to a function call written in the Layout Designer or the Smart Component Library (SCL) Maintenance (starting with "$") -

...

Open the SCL Maintenance for the Sports Sample Application. Open the "New Customer Order" Menu Function in the Menu Function Maintenance. Replace "self" with "eventSource" in the Action Options field and save (see picture below).

Writing Client Logic API Functions

Open the /sports-webui/ClientLogic/ folder in VS Code. Open Order/getOrderForeignKeys.js from the Explorer view (see picture below).

...

1. Replace 

   if (akioma.samples)
       akioma.samples = {};

   akioma.samples.getOrderForeignKeys = function(self) {

   With

   namespace akioma.samples {

       export function getOrderForeignKeys(self) { 

   Use namespaces to avoid naming conflicts. Note that functions must be exported to be used outside the namespace.
   
   

2. Replace self with eventSource: akioma.swat.SwatObject.
   
   Note that the function parameter name does not have to be eventSource. For example: eventGrid eventForm, eventRibbon etc. Although self might be confusing with the JavaScript dynObject.
   
   Note that the function parameter type does not have to be the generic base SwatObject as in this case. Use the correct Object Type class to avoid casting.
   
   
3. Replace getObject("CustomerDetailsForm") with getForm("CustomerDetailsForm") and getObject("CustomerGrid") with getGrid("CustomerGrid").
   
   The CLA supports generic traversing functions like getObject(), getLink() etc. which return the generic base SwatObject class object.
   
   The CLA also supports type specific function like getForm(), getGrid(), getRibbon() etc. to avoid casting.
   
   Alternatively you can use TypeScript casting. For example: (eventSource.getObject("MyObject") as akioma.swat.Form).
   
   
4. Replace getValue with getDataValue.
   
   The Form and Grid classes have both a getScreenValue() and getDataValue() functions for getting the field screen value or record value respectively.
   
   Save (Ctrl-S) and rename (F2) the file as Order/getOrderForeignKeys.ts using the .ts TypeScript file extension (see picture below).

Calling JavaScript functions from TypeScript

There are cases where you might need to call JavaScript functions and objects you have created or global functions and objects that have not yet been migrated to TypeScript in the CLA.

...

For example: The JavaScript code: self.myProperty is equivalent to the CLA TypeScript code: eventSource.dynObject.myProperty.

Compiling Client Logic API Functions

Open the swat-webui/akioma/sass/ directory in the command line interface. Type npm run sports and press Enter (see picture below).

...

Note that other environments may have their own custom build and watch scripts that watch for file changes and launch the build scripts automatically.

Debugging Client Logic API Functions

You can view and debug your TypeScript source code using source maps.

...