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