Initializing help system before first use

The App Archive Structure

The archive has the following structure:
  • 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. Model resource files are immutable and copied into the working directory of a job prior to the execution of the model.
    Note: Avoid placing large files in the model resources folder because they are copied to the worker every time a job is run.
  • python_source: a folder that serves as a convenient means to bundle the Python model source with the app. FICO® Xpress Workbench expects to find the Python source files in this location. During execution, this folder is added to the Python path.
  • 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.
  • <filename>.bim: the compiled main model of the app
  • <filename>.xml: the companion file of the app
Conventional App Directory Structure
Example App Folder Structure

The python_source folder is zipped to python_source.zip and automatically added to model_resources in the app archive.

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