@insiris/workengine-scripting NPM

WorkEngine Scripting API Documentation

The WorkEngine Scripting API is a set of cross platform APIs that can be utilised by developers and implementors of the WorkEngine platform.

It is designed to support the following environments:

Web - when running on the WorkEngine Web App
Triggers - when running server-side on WorkEngine
iOS - when running on the iOS iPhone/iPad Apps
Android - when running on the Android App

Documentation Breakdown

This documentation is broken into two main sections:

The WorkEngine Scripting API, the entrypoint is at [Api]
Information on the different Lifecycles - which can be accessed at the right hand navigation

Scripting Server

The workengine scripting package comes bundled with a scripting server that serves up scripts when developing locally. Simply run the following command, providing the relative path to the scripting directory you want to serve scripts from. The scripting server will automatically serve up the scripting index.json and all scripting files. Note that it runs on port 4000 by default.

npm run ss ../myscriptingproject

API Concepts

WorkEngine Scripting is made up of a series of components, described in the diagram below:

<path fill="#000000" d="m676.101 261.98203l0 -11.45311l1.515625 0l0 10.093735l5.640625 0l0 1.359375l-7.15625 0zm8.7890625 -9.843735l0 -1.609375l1.40625 0l0 1.609375l-1.40625 0zm0 9.843735l0 -8.29686l1.40625 0l0 8.29686l-1.40625 0zm3.8828125 0l0 -7.2031097l-1.234375 0l0 -1.09375l1.234375 0l0 -0.890625q0 -0.828125 0.15625 -1.234375q0.203125 -0.546875 0.703125 -0.890625q0.515625 -0.34375 1.4375 -0.34375q0.59375 0 1.3125 0.140625l-0.203125 1.234375q-0.4375 -0.078125 -0.828125 -0.078125q-0.640625 0 -0.90625 0.28125q-0.265625 0.265625 -0.265625 1.015625l0 0.765625l1.609375 0l0 1.09375l-1.609375 0l0 7.2031097l-1.40625 0zm9.7890625 -2.671875l1.453125 0.171875q-0.34375 1.28125 -1.28125 1.984375q-0.921875 0.703125 -2.359375 0.703125q-1.828125 0 -2.890625 -1.125q-1.0625 -1.125 -1.0625 -3.140625q0 -2.0937347 1.078125 -3.2499847q1.078125 -1.15625 2.796875 -1.15625q1.65625 0 2.703125 1.140625q1.0625 1.125 1.0625 3.1718597q0 0.125 0 0.375l-6.1875 0q0.078125 1.375 0.765625 2.109375q0.703125 0.71875 1.734375 0.71875q0.78125 0 1.328125 -0.40625q0.546875 -0.40625 0.859375 -1.296875zm-4.609375 -2.28125l4.625 0q-0.09375 -1.0468597 -0.53125 -1.5624847q-0.671875 -0.8125 -1.734375 -0.8125q-0.96875 0 -1.640625 0.65625q-0.65625 0.640625 -0.71875 1.7187347zm13.2421875 1.90625l1.390625 0.1875q-0.234375 1.421875 -1.171875 2.234375q-0.921875 0.8125 -2.28125 0.8125q-1.703125 0 -2.75 -1.109375q-1.03125 -1.125 -1.03125 -3.203125q0 -1.34375 0.4375 -2.3437347q0.453125 -1.015625 1.359375 -1.515625q0.921875 -0.5 1.984375 -0.5q1.359375 0 2.21875 0.6875q0.859375 0.671875 1.09375 1.9374847l-1.359375 0.203125q-0.203125 -0.82810974 -0.703125 -1.2499847q-0.484375 -0.421875 -1.1875 -0.421875q-1.0625 0 -1.734375 0.765625q-0.65625 0.74998474 -0.65625 2.4062347q0 1.671875 0.640625 2.4375q0.640625 0.75 1.671875 0.75q0.828125 0 1.375 -0.5q0.5625 -0.515625 0.703125 -1.578125zm2.53125 6.25l-0.15625 -1.328125q0.453125 0.125 0.796875 0.125q0.46875 0 0.75 -0.15625q0.28125 -0.15625 0.46