frePPLev2.0
open source Production PLanning
  • Home
  • Documentation
    • Getting started
    • Modeling guide
    • User guide
    • Installation guide
    • Developer guide
    • FAQ
  • C++ API

Environment variables

A number of environment variables influence frePPLe.

Variable Description
FREPPLE_HOME FrePPLe uses the following configuration files during the execution of the program:

  • The file frepple.xsd points to the xsd schema for the frePPLe XML files.
    This xsd file typically references additional xsd files located in the same directory.
  • If present, the XML data in the file init.xml are processed automatically when frePPLe is started.
    This is the recommended place to load any standard data entities your application may need.
  • If present, the Python code in the file init.py is executed automatically when frePPLe is started.
    This is the recommended place to define any Python functions or classes your application may need. FrePPLe extension modules are also typcially loaded in this file.
  • Plugin module libraries.

FrePPLe searches the following directories in sequence to locate these files.

  • The current directory.
  • The directory pointed to by the FREPPLE_HOME environment variable.
  • The data directory where the default configuration files are installed.
    This applies only for Linux and Unix platforms.
  • The library directory where the default module libraries are installed.
    This applies only for Linux and Unix platforms.
  • For the loading module libraries frePPLe also searches the standard path for location shared libraries.
    Configuring this is platform dependent.

By setting the FREPPLE_HOME environment variable you can control the directories where the application looks for your application files.

LC_ALL FrePPLe stores string data internally using the encoding associated with your locale.
This setting is important when dealing with non-ascii characters in your data. Your locale needs to support all characters being used, just as your database will also need to support them.
Most modern Linux distributions have a default locale that supports utf-8, which allows every possible unicode character to be represented.
On Windows, this environment variable isn’t used and FrePPLe can only represent characters present in the default windows locale. Use the “regional and language settings” screen from the control panel to change that default locale.
TZ FrePPLe uses the C-library functions for date and time manipulations. These functions are respecting timezones and daylight saving time, which can give sometimes give unexpected results: twice a year you’ll find a day with 25 or 23 hours.
To disable any effects of daylight saving time, change the TZ variable to a timezone without daylight saving time, e.g. ‘EST’.
    • Getting started
    • Modeling guide
      • Simplified domain model
      • Detailed domain model
      • Environment variables
      • Python interpreter
      • Global parameters
      • Buffer
      • Calendar
      • Customer
      • Demand
      • Flow
      • Item
      • Load
      • Location
      • Operation
      • Suboperation
      • Operationplan
      • Problem
      • Resource
      • SetupMatrix
      • Skill
      • Resource skill
      • Solver
      • Extension modules
        • Forecast module
        • REST web service module
        • Linear programming solver module
        • OpenERP connector module
    • User guide
      • Main features
      • Supported browsers
      • Getting around
        • Logging in
        • Logging out
        • Changing password
        • Navigation
          • Menu bar
          • Jump search
          • Context menus
          • Browser bookmarks
        • Filtering data
        • Sorting data
        • Selecting time buckets
        • Exporting data
        • Importing data
        • User preferences
        • User permissions and roles
      • Screens
        • Data input
        • Supply Path / Where Used
        • Comments
        • History – Audit trail
        • Plan analysis
          • Problem report
          • Constraint report
          • Inventory report
          • Inventory detail report
          • Resource report
          • Resource Gantt report
          • Resource detail report
          • Operation report
          • Operation detail report
          • Demand report
          • Demand detail report
          • Demand Gantt report
          • Forecast report
          • Performance indicator report
        • Execute
      • Batch commands
        • manage.py (manage.exe on Windows)
        • frepple (frepple.exe on Windows)
        • freppleservice.exe (Windows only)
    • Installation guide
      • Windows installer
      • Compiling on Windows
      • Linux binary packages
      • Compiling on Linux
      • Compiling on debian-based linux
      • Compiling on Red Hat based Linux
      • Compiling from the subversion source code repository
      • Running the VMWare virtual machine
      • Other platforms
      • Configuring the user interface
      • Configuring multiple models in the user interface
      • Configuring as a Python extension module
    • FAQ
    • Developer guide
      • Code structure
      • Class diagram
      • Solver
        • Solver features
        • Planning algorithm
          • Top level loop
          • Demand solver
          • Buffer solver
          • Flow solver
          • Load solver
          • Operation solver
          • Resource solver
        • Cluster and level algorithm
      • Extension modules
      • Version control
      • Style guide
      • Portability
      • Security
      • Internationalization
      • Translating the user interface
      • Adding or customizing a report
      • Unit tests
        • buffer_procure_1
        • calendar
        • callback
        • cluster
        • constraints_combined_1
        • constraints_combined_2
        • constraints_leadtime_1
        • constraints_material_1
        • constraints_material_2
        • constraints_material_3
        • constraints_material_4
        • constraints_resource_1
        • constraints_resource_2
        • constraints_resource_3
        • constraints_resource_4
        • constraints_resource_5
        • datetime
        • deletion
        • demand_policy
        • flow_alternate_1
        • flow_alternate_2
        • flow_effective
        • forecast_1
        • forecast_2
        • forecast_3
        • forecast_4
        • forecast_5
        • forecast_6
        • jobshop
        • load_alternate
        • load_effective
        • lpsolver_1
        • multithreading
        • name
        • operation_alternate
        • operation_available
        • operation_effective
        • operation_pre_post
        • operation_routing
        • pegging
        • problems
        • python_1
        • python_2
        • python_3
        • safety_stock
        • sample_module
        • scalability_1
        • scalability_2
        • scalability_3
        • setup_1
        • setup_2
        • skill
        • xml
        • xml_remote
    • License
      • GNU Affero General Public License
      • GNU Free Documentation License
    • Third party add-ons
  • Copyright © 2010-2013 frePPLe bvba