Initializing help system before first use

Using the JavaScript API to Create Custom Views

The Xpress Insight JavaScript API provides another powerful means to create custom views, and access and manipulate the state of the system.

It is a good idea to read Getting Started and perform the exercises before reading this chapter. Even though it was primarily focused on building simple VDL views, many of the concepts introduced are universal and carry over into the JavaScript environment.

With the JavaScript API you can access the underlying data model, modify scenario data and control scenario execution. It ensures that the same data is not fetched multiple times per view, even if your code contains multiple requests to the same entity.

Apps can be very responsive because all communications with the server are asynchronous and batched where possible. The API includes a recommended set of CSS styling and a library of components designed to automate many typical view operations.

JavaScript API version 4.7 views are supported for IE11, and the latest versions of Firefox and Chrome.

Full reference documentation for the JavaScript API can be found at: http://www.fico.com/fico-xpress-optimization/docs/latest/insight/javascript_api/index.html.

Covered Topics
  • Loading the API
    Every HTML view starts with a definition in the companion file that points to the associated HTML file.
  • Concepts
    The JavaScript API relies on several high-level Xpress Insight concepts.
  • Hello World!
    This section shows a very simple JavaScript application that you should be able to run within minutes.
  • The ScenarioObserver
    If you want to work with data from scenarios you need to create a scenario observer, from now on referred to as an 'observer'.
  • View Properties
    It is often necessary to track some state or user input specifically for the view.
  • The Promise API
    Some methods in the JavaScript API return an instance of the Promise object
  • Modifying Scenario Data
    The JavaScript API provides a way of requesting a set of changes to scenario input data and applying those changes on the server.
  • The AutoComponents
    The AutoText component that we used in the Hello World example is one of the AutoComponents supplied with the JavaScript API for Xpress Insight.
  • Creating Custom Tables
    The Table component is a wrapper around the third-party library, DataTables.
  • Entity Formatting
    The Xpress Insight API provides a display formatter that can make formatting consistent for numeric and other data.
  • Entity Validation
    The Xpress Insight API provides an entity validator, insight.validation.EntityValidator.
  • Custom Set Sorting
    As of JS API 4.7, all Set entities have default sorting applied when the data is loaded into a view.
  • View Configuration
    This section describes some techniques common to many applications.
  • Working with Attachments
    The JavaScript API provides access to all of the attachments on the scenario and the app.
  • Advanced Topics
    This section describes a selection of topics for advanced users.
Parent Topic Insight 4 Developers Guide for Mosel

© 2001-2020 Fair Isaac Corporation. All rights reserved. This documentation is the property of Fair Isaac Corporation (“FICO”). Receipt or possession of this documentation does not convey rights to disclose, reproduce, make derivative works, use, or allow others to use it except solely for internal evaluation purposes to determine whether to purchase a license to the software described in this documentation, or as otherwise set forth in a written software license agreement between you and FICO (or a FICO affiliate). Use of this documentation and the software described in it must conform strictly to the foregoing permitted uses, and no other use is permitted.