Initializing help system before first use

# Configuring Apps with the Companion File

You must provide a file in the app source code that contains metadata to customize the behavior of Insight 5 for this app.
This file is XML-based and referred to as the companion file or cfile. The companion file is loaded into the system at the same time as the model and should have a XML file extension.
Note: For Python based apps, the companion file should be named application.xml.

The full XSD schema of the companion file XML is documented at https://www.fico.com/fico-xpress-optimization/docs/latest/insight5/xml_reference. Examples of companion file markup are provided throughout this guide.

The companion file metadata can be used to perform a number of important configurations that control the way the system behaves for the app and views. A minimal companion file is given by:

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

Note: The XML schema version specified by the companion file also determines the version of the Xpress Insight annotations that are available. Therefore, it is important to use the latest companion file schema version (currently `5.0`).

## 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

For Python apps, the name and version is taken from the `AppConfig` decorator:

    import xpressinsight as xi
        @xi.AppConfig(name="My App",
                      version=xi.AppVersion(1, 0, 0),
                      raise_attach_exceptions=True)
        class InsightApp(xi.AppBase):
            pass

Parent Topic The App

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