Initializing help system before first use

The App

Apps can be added to the system by uploading ZIP archives containing all required files.
The structure of an app ZIP file is:
  • mymodel.bim (error if more than one BIM file is located in the archive root)
  • mymodel.xml (optional companion file)
  • client_resources (optional folder for user interface resource files)
  • model_resources (optional folder for model resource files)
  • tableau (optional folder for the Tableau workbook and Tableau packaged workbook files)
  • attachments (optional folder containing files to attach to the app when it is created)
Note The contents of the Tableau packaged workbook file is restricted to a Tableau workbook and images.
The following figure shows the correct content structure:

App Folder Structure

A directory named source is allowed in the app ZIP file as a convenient means of bundling the Mosel source with the app. All files in this directory are ignored by Xpress Insight. Model source files are also allowed in the root of the app archive and are also ignored.

Covered Topics
  • 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.
  • App Resource Files
    Three categories of resource files can be provided for the model: model resources, client resources and app attachments.
  • Adding an App Icon
    It is straightforward to customize the icon displayed on an app's tile on the Xpress Insight Home page.
  • Configuring App-Specific Help
    You can configure the app’s companion file so that when the user clicks the Help link in the web client they are directed to help relating to the app rather than Xpress Insight.
Parent Topic Developing an App with Xpress Insight

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