Initializing help system before first use

New Functionality and Changes Introduced with FICO Xpress Executor 4.6

This section describes the new features and changes introduced with FICO Xpress Executor 4.6.

New in Release 4.6.0

Summary

  • Integrates with new Optimization Designer IDE which provides a rich set of development tools for authoring and debugging Optimization Modeler projects.
  • Explicit support for custom execution modes
  • Expanded configuration of Execution Services with thread based scheduling. New web based configuration UI replaced the Analyst Client dialog.
  • Support for Mosel annotations. A number of configuration options previously set in the companion file (most notably the schema settings) are now set in the model source using annotations. Some configuration options have been removed in v3 of the companion file, see below for more details.
  • Tableau data sources can now be defined in the companion file.
  • Boolean values now rendered with checkboxes in tables.
  • Improved filtering tables. Search and column filter now support "exact" matching by prefixing search term with an =

Execution Modes and Execution Services

  • Custom Execution Modes defined using annotations in the model source.
  • The Execution Servers available to the system can be partitioned into Execution Services.
  • Jobs of a given Execution Mode can be configured to route to a designated Execution Service.
  • Webadmin interface to define and manage Execution Modes, Execution Services, Execution Workers and the mapping between them
  • Because of these changes, the contents of the job queue will not be preserved when upgrading to this version of Optimization Modeler. Any pending jobs will need to be re-queued once the upgrade is complete.

Companion File Version 3

  • Companion File version 3 introduced. This introduces a number of changes and requires applications to migrate to using annotations. Existing applications using companion file version 2 will be unaffected. For more details refer to the Developer Guide.
    • Added datasources tag within database-mirror tag
    • Moved mirror-table tag beneath new mirror-tables tag within database-mirror tag
    • Removed Schema tag and its contents. These are now read from Mosel model annotations.
    • Removed useNameAsAppTitle tag. This is now always enabled.
    • Removed name tag. This is read from the Mosel model name.
    • Removed project-version tag. This is read from the Mosel model version.
    • Removed change-log tag. This is controlled at the OM server level, rather than per application.
    • Removed resultdata tag. This is read from the om.resultdata annotation.
  • Mirror database datasources can now be specified directly in the v3 companion files. Optimization Modeler uses these to automatically define and publish Tableau datasources for use with workbook authoring. For more details refer to the Developer Guide.

VDL 3.1

  • VDL 3.1 and JS API 3.1 include compatibility with custom execution modes.
  • vdl-table-column: Boolean arrays now rendered with checkboxes in display mode.
  • vdl-table-column: filter-by-formatted now defaults to true if the column's entity has a label entity. Otherwise it defaults to false as before.
  • vdl-table: Search and column filter now support "exact" matching by prefixing search term with an =

JavaScript API 3.1

  • Added getExecutionModes() method to Project type.
  • Added error handling for data responses that don't contain expected entities.
  • An error is logged to the console if attempting to create a scenario observer with the same entity both filtered and unfiltered. The scenario observer will fail to start.
  • Table / Autotable: Boolean arrays now rendered with checkboxes in display mode.
  • Table / Autotable: Search and column filter now support "exact" matching by prefixing search term with an =
  • Autotable: filterByFormatted now defaults to true if the column's entity has a label entity. Otherwise it defaults to false as before.
  • Added method View#promptToClearInputData that will (by default) show the user a confirmation dialog only if executing the model with the given execution mode would cause the input data to be replaced; this behaviour can be customized. See API docs for details.
  • The VDL execute button and Autoform run and load buttons now use the View#promptToClearInputData mentioned above.

JavaScript API 3.0

  • Added error handling for data responses that don't contain expected entities.
  • An error is logged to the console if attempting to create a scenario observer with the same entity both filtered and unfiltered. The scenario observer will fail to start.
  • REST interface
    • Expanded the EXECUTION_STATUS type with properties relating to Execution Services
    • Added EXECUTION_MODE type, and executionModes property to the PROJECT type
    • The /v1/data/execution/ endpoint now takes an EXECUTION_REQUEST type, to allow specification of execution modes. (Passing an id and objectType of SCENARIO or EXECUTION_STATUS is still accepted for compatibility.)

Mosel interface (execution modes and annotations)

  • The insightgetmode function now returns the execution mode of the model.
    • To reflect this change, the INSIGHT_MODE_* constants have new values:
      • INSIGHT_MODE_RUN now has value "RUN"
      • INSIGHT_MODE_LOAD now has value "LOAD"
      • INSIGHT_MODE_NONE now has value ""
    • Code should continue to compare the result of insightgetmode against the relevant INSIGHT_MODE_* constants, but it may now also return custom execution modes instead.
    • Code compiled with previous versions of mminsight will continue to have the old function behaviour, and the odl values of the constants.
  • Support for definition of model schema and execution modes via Mosel annotations. For more details of the supported annotations refer to the Mosel Interface Reference Manual.
  • Default rmt: node resolves to the master scenario model when compiled with 4.6 and above.

Analyst Client

  • The Admin menu, with its associated Optimization Services dialog, has been removed; this functionality has been migrated to the Execution Services tab of the Web Admin user interface.
  • The Job Queue table now lists the Execution Service and Execution Worker for a job.
  • Login username is now case insensitive

Web Client

  • Login username is now case insensitive
  • Job Queue has extra columns to support Execution Modes

Fixed in Release 4.6.0

JavaScript API 3.1

  • Fixed an issue where filtering / searching for a decimal number (eg 12.0) fails to find the equivalent integer (eg 12).

Web client

  • Fixed an issue which causes the entity explorer fails to truncate data on a large array in certain circumstances.
  • Fixed an issue which causes the entity explorer to display 0 rows when truncating data in certain circumstances.

Fixed in Release 4.6.1

Mosel interface

  • Fixed an issue where the response to insightgetiteminfos includes details about scenarios and folders which the user does not have read access to. Inaccessible items are now no longer returned.
  • Fixed an issue where insightgetiteminfo raises a Mosel ERROR when attempting to access information about a folder or scenario the user does not have access to. An IOERR is now raised instead, allowing the model to trap the error.

Fixed in Release 4.6.2

Web Client

  • Fixed an issue where an unexpected error message appeared intermittently when reloading or unloading a Tableau view.

Fixed in Release 4.6.3

Tableau

  • Fixed an intermittent issue where Tableau views could take significantly longer to display.

Fixed in Release 4.6.4

Web Client

  • Fixed an issue where project update would be rejected when the companion file referred to model resources.
  • Fixed an issue where the view navigator would sometimes appear empty until the browser was resized.

JavaScript API 2.0+

  • Fixed an issue where the JavaScript API could fail to initialize on a slow network.
  • An error message is displayed if the JavaScript API takes longer than 30 seconds to initialize.
Parent Topic Updates from Previous Versions and Known Issues

© 2001-2019 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.