frePPLeOpen source Production Planning
  • Home
  • Documentation
  • C++ API

frepplectl

Before 2.1 this command was called manage.py (manage.exe on windows)

 
This command has a long list of subcommands that allow different operations on the user interface and the database.
 
Usage:

  • frepplectl subcommand [options] [args]
     
    Type ‘frepplectl.py help <subcommand>’ for help on a specific subcommand.
     
    Some subcommands optionally expect application names as arguments. The frePPLe user interface has the following applications: “input”, “output”, “execute”, “common”, “auth”, “forecast” (enterprise edition only) and “quoting” (enterprise edition only).

 
Commonly used subcommands are:
 

  • dumpdata:
    Output the contents of the database as a fixture of the given format.
     
  • frepple_copy:
    Creates a copy of a database schema into another database schema.
     
  • frepple_dotgraph:
    Generates output in the DOT language to visualize the frePPLe model. This output needs to be sent to the DOT command to generate the graph: manage frepple_dotgraph | dot -o mymodel.png -T png
    Graphviz is required to process the resulting output.
     
  • frepple_flush:
    Deletes the data from the frePPLe database.
     
  • frepple_import_openerp:
    Execute the OpenERP import connector, which loads data from an OpenERP database into the frePPLe database.
     
  • frepple_run:
    Runs the frePPLe planning engine.
    This subcommand is a wrapper around the frepple(.exe) executable.
     
  • frepple_loadxml:
    Loads an XML file into the database.
     
  • frepple_runserver:
    Runs a production web server for environments with very few users.
    For a more scalable solution, deploying frePPLe on Apache with mod_wsgi is required.
     
  • help:
    Display help on the available subcommands or a specific subcommands.
     
  • loaddata:
    Installs a dataset in the format of a fixture in the database.
     
  • runserver:
    Run a development web server. Do not use for actual production.
     
  • syncdb:
    Initializes an empty database with the frePPLe tables, indexes and sequences.
     
  • frepple_backup:
    Backs up the content of the database to a file.
     
  • frepple_restore:
    Restores the content of the database from a file.
     

Less commonly used:

  • changepassword:
  • cleanup:
  • compilemessages:
  • createcachetable:
  • createsuperuser:
  • dbshell:
  • diffsettings:
  • flush:
  • frepple_createbuckets:
    Initiliazes the date bucketization table in the database.
  • frepple_createmodel:
    Generates a sample model in the database. Only useful during testing and demoing.
  • inspectdb:
  • makemessages:
  • reset:
  • runfcgi:
  • shell:
  • sql:
  • sqlall:
  • sqlclear:
  • sqlcustom:
  • sqlflush:
  • sqlindexes:
  • sqlinitialdata:
  • sqlreset:
  • sqlsequencereset:
  • startapp:
  • test:
  • testserver:
  • validate:

 
Options:

  • -v VERBOSITY, –verbosity=VERBOSITY:
    Verbosity level: 0=minimal output, 1=normal output, 2=all output
  • –settings=SETTINGS:
    The Python path to a settings module, normally leave to the default “freppledb.settings”
  • –pythonpath=PYTHONPATH:
    A directory to add to the Python path, e.g. “/home/frepple/myproject”.
  • –traceback:
    Print traceback on exception.
  • –version:
    Show program’s version number and exit.
  • -h, –help:
    Show a help message either showing all commands or help on a specific command.

 
More detailed information on the commands which frePPLe inherits from the Django freamework can be found at https://docs.djangoproject.com/en/dev/ref/django-admin/

    • Getting started
      • 1 – Introduction
      • 2 – Installation
      • 3 – Entering data
      • 4 – Modelling concepts
      • 5 – Your first model
      • 6 – Your first plan
    • 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
    • User guide
      • Supported browsers
      • Getting around
        • Logging in
        • Logging out
        • Changing password
        • Navigation
          • Menu bar
          • Jump search
          • Context menus
        • Filtering data
        • Sorting data
        • Selecting time buckets
        • Exporting data
        • Importing data
        • Customizing a screen
        • User preferences
        • User permissions and roles
        • Comments
        • History – Audit trail
      • Data maintenance screens
      • Supply Path / Where Used
      • Plan analysis screens
        • 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
      • Execution screen
      • Batch commands
        • frepplectl
        • frepple
        • freppleservice.exe (Windows only)
    • Installation guide
      • Windows installer
      • Compiling on Windows
      • Linux binary packages
      • Compiling on Linux
      • Compiling from the source code repository
      • Running the VMWare virtual machine
      • Other platforms
      • Configuring multiple models in the user interface
      • Configuring as a Python extension module
    • Extension modules
      • Forecast module
      • Order quoting module
      • REST web service module
      • OpenERP connector module
      • Linear programming solver module
    • Technical guide
      • Architecture
      • Source code repository
      • User interface
        • Creating an extension app
        • Translating the user interface
        • Adding or customizing a report
        • Style guide
      • Solver engine
        • Code structure
        • Class diagram
        • Planning algorithm
          • Top level loop
          • Demand solver
          • Buffer solver
          • Flow solver
          • Load solver
          • Operation solver
          • Resource solver
        • Cluster and level algorithm
        • Extension modules
        • Style guide
        • Portability
      • Security
      • 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
    • FAQ
    • License
      • GNU Affero General Public License
      • GNU Free Documentation License
    • Third party add-ons
  • Copyright © 2010-2013 frePPLe bvba