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

Resource

Resources represent capacity.
They represent a machine, a worker or a group of workers, or some logical limits.

A calendar refers to a time-phased maximum limit of the resource usage.

Operations will consume capacity using loads.

Different types of resources exist:

  • resource_default:
    A default resource is constrained with a maximum available capacity.
  • resource_infinite:
    An infinite resource has no capacity limit.

Fields

Field Type Description
name non-empty string Name of the resource.
This is the key field and a required attribute.
description string Free format description.
category normalizedString Free format category.
subcategory normalizedString Free format subcategory.
owner resource Resources can be organized in a hierarchical tree.
This field defines the parent resource.
No specific planning behavior is currently linked to such a hierarchy.
members list of resource Resources can be organized in a hierarchical tree.
This field defines a list of child resources.
location location Location of the resource.
Default is null.
The working hours and holidays for the resource are taken from the ‘available’ calendar of the location.
maximum double Defines the maximum size of the resource.
The default value is 1, i.e. a resource that can handle 1 operationplan at a time (provided of course that this operationplan requires 1 unit on the resource).
A problem is reported when the resource load exceeds than this limit.
maximum_calendar calendar Refers to a calendar storing the available capacity. Use this field when the resource capacity is varying over time.
If this field is populated, the field maximum is ignored.
cost double The cost of using 1 unit of this resource for 1 hour.
The default value is 0.
detectproblems boolean Set this field to false to suppress problem detection on this resource.
Default is true.
maxearly duration Time window before the ask date where we look for available capacity.
The default value is 100 days.
loads list of load Defines the capacity of the operations.
loadplans list of loadplan This field is populated during an export with the plan results for this resource. It shows the resource load profile.
The field is export-only.
The description of the loadplan model is included in the section on operationplan.
level integer Indication of how upstream/downstream this entity is situated in the supply chain.
Lower numbers indicate the entity is close to the end item, while a high number will be shown for components nested deep in a bill of material.
The field is export-only.
cluster integer The network of entities can be partitioned in completely independent parts. This field gives the index for the partition this entity belongs to.
The field is export-only.
setup non-empty string The name of the current setup of the resource, ie the setup of the resource at the start of the planning horizon.
setupmatrix setupmatrix The name of the setup matrix which specifies the changeover times between setups.
hidden boolean Marks entities that are considered hidden and are normally not shown to the end user.
action A
C
AC (default)
R
Type of action to be executed:

  • A: Add an new entity, and report an error if the entity already exists.
  • C: Change an existing entity, and report an error if the entity doesn’t exist yet.
  • AC: Change an entity or create a new one if it doesn’t exist yet.
  • R: Remove an entity, and report an error if the entity doesn’t exist.

resource_default

A default resource is constrained with a maximum available capacity.

No fields are defined in addition to the ones listed above.

resource_infinite

An infinite resource has no capacity limit.
It is useful to monitor the loading or usage.

The fields ‘maximum’ and ‘maximum_calendar’ are unused for this resource type.

Example XML structures

  • Adding or changing a resource
     <plan>
       <resources>
         <resource name="machine X">
           <maximum_calendar name="capacity calendar for machine X" />
         </resource>
         <resource name="machine Y">
           <maximum>2</maximum>
         </resource>
       </resources>
     </plan>
  • Deleting a resource
     <plan>
        <resources>
           <resource name="machine X" action="R"/>
        </resources>
     </plan>

Example Python code

  • Adding or changing a resource
        cal = frepple.calendar(name="capacity calendar for machine X")
        res_X = frepple.resource(name="machine X", maximum_calendar=cal)
        res_Y = frepple.resource(name="machine X", maximum=2)
  • Deleting a resource
        frepple.resource(name="machine X", action="R")
  • Iterater over resources, loads and loadplans
        for r in frepple.resources():
          print "Resource:", r.name, r.description, r.category
          for l in r.loads:
            print "  Load:", l.operation.name, l.quantity, 
              l.effective_start, l.effective_end
          for l in r.loadplans:
            print "  Loadplan:", l.operationplan.operation.name, 
              l.quantity, l.startdate, l.enddate, l.operationplan.id
    • 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