open source production planning
Documentation v3.1
User guide
Installation guide
Extension modules
Cookbook
Model reference
Developer guide
Frequently asked questions
License
Home
frePPLe 3.1 documentation
To get started we suggest the following
introduction trail
:
Install the software
The easiest start to learn frePPLe is to use the online demo environment.
To try on your own computer you’ll need to install the PostgreSQL database server, and then run the frePPLe installer.
Follow the guided tour
The application has an integrated guided tour. It interactively guides you through all important screens in less than 10 minutes.
Learn the modelling concepts
This page introduces the main modelling concepts you’ll need to understand.
The
cookbook
has some example models which demonstrate specific functionalities.
It is a good idea to study and try out some of those, before you start building your own model.
Visit to the community forum
https://groups.google.com/forum/#!forum/frepple-users
You’re invited to post questions, suggestions and issues to the group.
Table of contents
User guide
Supported browsers
Guided tour
Getting around
Logging in and logging out
Changing your password
Navigation
Filtering data
Sorting data
Selecting time buckets
Exporting data
Importing data
Customizing a report
User preferences
User permissions and roles
Comments
History – Audit trail
Data maintenance
Cockpit
Supply Path / Where Used
Plan analysis screens
Distribution planning screen
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
What-if scenarios
Execution screen
Generate a plan
Export a spreadsheet
Import a spreadsheet
Web service
Scenario management
Back up database
Erase the database
Load a predefined dataset in the database
Generate time buckets
Generate a model
Batch commands
Installation guide
Windows installer
Deployment on Windows with Apache web server
Compiling on Windows
Compiling using Microsoft Visual C++ compiler
Compiling using the Cygwin compiler
Linux binary packages
Supported distributions
Installation and configuration
Debian installation script
Red Hat installation script
Suse installation instructions
Compiling on Linux
Compiling from a source tarball
Compiling from the github source code repository
Compiling from a debian source package
Compiling from a RPM source package
Running the VMWare virtual machine
Other platforms
Configuring multiple models in the user interface
Configuring as a Python extension module
Extension modules
Odoo connector
Openbravo connector
Forecast module
Inventory planning module
Calculation of the reorder quantity
Calculation of the safety stock
Don’t stock flag
Maintenance of inventory planning parameters
Order quoting module
Web service module
Cookbook
Calendar
Working hours
Example
Calendar bucket priority
Example
Resource
Resource type
Example
Resource skills
Example
Tools
Example
Demand
Policies
Example
Priorities
Example
Operation
Operation Type
Example
Post-operation safety time
Example
Buffer
Time based safety stock
Model reference
Modelling concepts
Domain model
API: XML, Python and REST
Environment variables
Python interpreter
loadmodule
readXMLfile
readXMLdata
erase
saveXMLfile
saveplan
printsize
Parameter
Buffer
Buffer_default
Buffer_procure
Buffer_infinite
Calendar
Calendar bucket
Customer
Demand
Flow
Item
Item Supplier
Item Distribution
Load
Location
Operation
Operation_fixed_time
Operation_time_per
Operation_alternate
Operation_split
Operation_routing
Suboperation
Operationplan
Flowplan
Loadplan
Problem
Resource
Resource_default
Resource_buckets
Resource_infinite
Resource skill
Setup matrix
Setup Rule
Skill
Supplier
Developer guide
Architecture
User interface
Creating an extension app
Adding or customizing a report
General case
Using the frePPLe generic report
Translating the user interface
Unit tests
REST API
List API from your browser
Detail API from your browser
API from the command line
Planning engine
Class diagram
Planning algorithm
Cluster and level algorithm
Extension modules
Unit tests
Security
Frequently asked questions
User interface
Data integration
Modelling and solver algorithm
Database
License