Initializing help system before first use

Configuring Apps

You can provide an additional file, alongside the compiled model file, that contains metadata that customizes the behavior of the Xpress Insight system.

This file is XML-based and referred to as the companion file or c-file. The companion file is loaded into the system at the same time as the model and should have a XML file extension. Unlike the model itself, the companion file can be updated without deleting and recreating the app.

The full XSD schema of the companion file XML is documented at http://www.fico.com/fico-xpress-optimization/docs/latest/insight/xml_reference/index.html. Examples of companion file mark-up are provided throughout this guide.

The companion file meta-data can be used to perform a number of important configurations that control the way the system behaves for the app and views.

In the earlier, version 2 specification of the companion file, schema settings were specified by <entity> elements within the <schema> element and the enhancements were applied by the server interface when data was requested by a client. Version 3 and later of the companion file removes this section and delegates the configuration of the schema settings to the mosel model via the use of annotations.

Web Client views have a corresponding element in the companion file within the <client> element. 
<model-companion xmlns="http://www.fico.com/xpress/optimization-modeler/model-companion" version="3.0"> 
  <client> 
    <view-group title="Main"> 
      <html-view title="Year Plan" 
                 default="true" 
                 path="yearplan.html"/> 
    </view-group> 
  </client> 
</model-companion>

App Names and Versions

On the Home page each app has a preset name and version. On importing an app the name is taken from the Mosel model name and the version is an optional setting in the Mosel file. For example: 
model "units" 
  version 1.0.0
Parent Topic The App