Initializing help system before first use

Completing the Recommended Directory Structure

When you deploy an Xpress Insight app, you will need to present an app archive file - a ZIP or GZIP file containing the app's resources arranged within a known directory structure.
Following a convention over configuration approach, the expected structure for the example app is representative of the general pattern of files and folders expected by Xpress Insight for all apps:
  • foliodata.mos - an optional model source file, ultimately ignored by Xpress Insight. By convention, and when packaging apps manually, it is typically moved to the source folder.
  • foliodata.bim - the compiled model, located in the app root. Only one BIM file is allowed.
  • foliodata.xml - an optional companion file (also known as a cfile) which contains app configuration definitions.
  • client_resources - an optional folder containing user interface resource files - for example, files containing View Definition Language (VDL) code.
  • model_resources - an optional folder for model resource files. It currently contains the folio.dat file.
  • tableau - an optional folder for the Tableau workbooks and Tableau packaged workbook files.
    Note The contents of a Tableau packaged workbook file are restricted to a Tableau workbook and images.
  • project_attachments - an optional folder containing files to attach to the app when it is created.
  • source - an optional folder that serves as a convenient means to bundle the Mosel model source with the app. All files in this folder are ignored by Xpress Insight. Model source files are also permitted in the root of the app archive, where they are also ignored.

Using Xpress Workbench, you don't have to generate the archive ZIP file manually - as soon as you publish the app to Xpress Insight, Xpress Workbench automatically generates it for you - if you have followed along as the example has progressed, there will be a foliodata.zip file underneath your project's root Portfolio Optimization folder.

Covered Topics
Parent Topic Building an Xpress Insight App

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