Initializing help system before first use

Introducing the Companion File

Alongside the compiled Mosel file in the archive root directory, you can provide an additional file that contains metadata—the companion file (or cfile)—to customize your Xpress Insight app.

Companion file metadata performs essential configuration activities that control the way the system behaves for apps and views.

The companion file uses the XML format, has an XML file extension and is loaded into the system at the same time as the model itself. Unlike the model, you can update the companion file without deleting and recreating the app. While the companion file is technically optional, it is essential if you plan to add VDL or Tableau views to your app.

A companion file has the same name as your model's MOS/BIM files, but has the XML file extension instead. For example, if your MOS file was called foliodata.mos, the correct name for the companion file would be foliodata.xml, and it should be placed alongside the foliodata.mos file, in the same directory.

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 markup are provided at many places in this guide.

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