Initializing help system before first use

New Companion File Format

The format of the companion file has changed since release 3.1 of Xpress Insight.

The most significant change is a simpler and more intuitive way to define custom views for the app.

Here is a simple companion file in the new format that illustrates how to define several custom views: 
<model-companion
    xmlns="http://www.fico.com/xpress/optimization-modeler/model-companion"
    version="3.0">

  <client>
    <view-group title="Main">
      <html-view title="Welcome" path="welcome.html"
                 empty-selection-default="true"/>
      <vdl-view title="Inputs" path="input.vdl" default="true"/>
      <tableau-workbook workbook="ExampleWorkbook"/>
    </view-group>

    <client-resources-local-path>C:\example_app\client_resources
    </client-resources-local-path>
  </client>
</model-companion>

The two new attributes at the document root, xmlns and version, indicate that this is a version 3 companion file. The <client> tag contains one or more view groups, in which the custom views are defined.

Apps containing old-style companion files can still be imported - the companion file will be automatically upgraded and the new version will be printed to the Client Log window. It is recommended that you replace your old companion file with the upgraded version.

Covered Topics
Parent Topic Upgrading from Xpress Insight 4.0 or Earlier

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