Design

Namespaces

The JavaScript engine provides access to built-in Adaptive Planning Integration through the 'adaptive' namespaces or 'ai' (Adaptive Planning) namespace (Alias). This is similar to popular JavaScript libraries like jQuery (https://jquery.com/).

// JavaScript short namespace example.
ai.log.logError('this is a log');

// JavaScript long namespace example.
adaptive.log.logError('this is a log');

Beneath the root 'ai' namespace, a number of core functions are exposed to allow the JavaScript to interact with the internet and Adaptive Planning Discovery/Integration features. These public JavaScript APIs are modeled using Node.js (https://nodejs.org/) APIs as a guide.

Functions

Functions get and set data to make the API consistent, provide encapsulation, and explicitly allow setters and getters. Functions also provide encapsulation of C# objects to only expose JavaScript language functionality and prevent unnecessary crossing of the JavaScript / C# boundary to improve performance. The getters are prefixed with get and setters are prefixed with set.

var isEnabled= item.getIsEnabled();
item.setIsEnabled(true);

Functions Context

Each function called by a CCDS takes a Context object. The context contains read-only objects to help with the processing.

function importData(context) {
 var tableId = context.getTableId();
 var tables = context.getDataSource().getTables();
 var setting = context.getDataSource().getSetting('password');
}

The context is made up of objects passed in from C#. To improve performance, we avoid exposing C# objects in the JavaScript by encapsulating each object in a JavaScript object. This allows managing communication across the JavaScript / C# boundary. For example, when asking the context for tables, the C# object returns wrapped in a JavaScript object. When there is an object hierarchy, we wrap each level in a JavaScript object. When asking for the columns in a table, we return a list of JavaScript wrapped objects.

Limitations

The limits below apply to a running CCDS script process session.

The limits below apply to the CCDS Script Pool Manager.