JavaScript Control Using Library
  • 02 Jun 2022
  • 1 Minute to read
  • Dark
    Light

JavaScript Control Using Library

  • Dark
    Light

Overview

JS Script controls allows users to efficiently reference third-party JS libraries.

Referencing a JS library with a script keeps the library loaded after initial download so it is available for use other JS data controls. Without a script control, using a third party library would require embedding its code inside each Data Control which would negatively impact performance.

Since they only supplement other JS controls, scripts do not populate the JS Control Catalog in the Tool. Instead are saved as a JavaScriptControlResource in the Designer Folder.


Add Script Control

The following example demonstrates how to upload a script control to Decisions.

  1. In a Designer Folder, select CREATE FORM in the Global Action Panel.
  2. Choose the JavaScript control tab in the Create Form dialog. Select Add Script.

  3. In the Add JavaScript Control dialog, enter a name for the library. Other JS controls wishing to reference this library at runtime will match the script's name here.
  4. Upload the library .js file.



Looking Inside the Control

Hook the following Decisions JavaScript to ensure the library loads.

ExampleJSLibrary.prototype.initialize = function (host, component) {
  // here "virtualPath" is a global variable in the Decisions client
  $DP.ScriptLoader.LoadScript(
    virtualPath + "/scripts/FormControls/jsFiles/ExampleJSLibrary.js"
  )
    .then(function () {
      // Do initialization of your data control which that depends on the 3rd party library
    })
    .catch(function (e) {
      console.error("Error loading ExampleJSLibrary", e);
    });
};

For safety, it’s best to do the same check inside the other Decisions JavaScript Control API methods. e.g.

ExampleJSLibrary.prototype.setValue = function (data) {
  $DP.ScriptLoader.LoadScript(
    virtualPath + "/scripts/FormControls/jsFiles/ExampleJSLibrary.js"
  )
    .then(function () {
      /* Update Control */
    })
    .catch(function (e) {
      console.error("Error loading ExampleJSLibrary", e);
    });
};



For further information on Forms, visit the Decisions Forum.

Was this article helpful?