Migrating from Xpress Insight 4 to Xpress Insight 5

• Tableau is not currently supported in Xpress Insight.
• Internet Explorer 11 support is replaced by MS Edge support. Custom views should be validated against MS Edge.
• Custom views should use VDL and JS API version 4.0 or later.
• Mosel models must be compiled with Mosel 5 (Insight 4.50+) or later.
• REST API
  • App models that make custom REST API calls will need to be modified to call the v2 REST API.
  • Custom views that make custom REST API calls will need to be modified to call the v2 REST API.

  • Custom views that make custom REST API calls should adopt resolveRestEndpoint to add a prefix to the url path if the Insight server is running in an environment where path-based routing is used. The JavaScript method insight.resolveRestEndpoint is documented in the Javascript API Reference.

  • REST clients will need to authenticate with API credentials not username and password. This includes app models making custom REST calls. For more see the Accessing the Xpress Insight Server Using the REST API.
  • Common changes required for REST API v2 compatibility are:
    • API base path change from /insightservices to /api.
    • Resource names in paths are plural e.g., /api/scenarios.
    • Requests need to specify the API version in Content-Type and Accept content negotiation headers.
    • The precise http codes returned may have changed.
    • Endpoint that return collections are now paginated.
    • Code which extracts an error message from a response needs to be updated to handle the new error structure with error and optional inner error properties.
    • REST endpoints for import and export behave substantially differently in API v2. Import and export processing is a background task and the response to the initial request indicates that the task has been accepted, not that it has been completed.
    .

 <?xml version="1.0" encoding="UTF-8"?> <model-companion xmlns="http://www.fico.com/xpress/optimization-modeler/model-companion" version="3.1">
</model-companion>

• System authorities PROJECT* have been renamed to APP*.
  • Custom code that tests against the system authorities assigned to a user must be updated to use the new names.
  • Users must check all assigned authorities are still valid and any custom authorities they have created do not clash.
• Apps that rely on parameters the model does not explicitly declare will need to be modified as such parameters are excluded from the app schema.
• The onQueue and onExecute results deletion settings (configured in the cfile) are not used. Data will be replaced when the execution completes.