<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Frepple / Item </title>
<link rel='stylesheet' href='../styles.css' type='text/css' />
<!--PageHeaderFmt-->
</head>
<body>
<div id="container">
<div id="menubar">
<div id="logo" align="center">
<br/><img src='../frepple.bmp' alt="frepple" /><br/>
<a href='http://www.frepple.com/'>
<strong>a Free<br/>Production Planning<br/>Library</strong>
</a></div>
<div id="menu">
<br/>
<h3><a href='../Main/HomePage.html'>Main</a></h3>
<h3><a href='../UI/Main.html'>User Manual</a></h3>
<h3><a href='../Tutorial/Main.html'>Tutorial</a></h3>
<h3><a href='Main.html'>Reference Manual</a></h3>
<h3><a href='../Main/FAQ.html'>FAQ</a></h3>
<h3><a href='../reference/index.html'>C++ API</a></h3>
<br/><div>
</div>
</div>
</div>
<div id="content">
<br/>
<!--PageText-->
<div id='wikitext'>
<p><a class='wikilink' href='../Main/HomePage.html'>Main</a> > <span class='wikitrail'><a class='wikilink' href='Main.html'>Reference Manual</a> > <a class='wikilink' href='Modeling.html'>Modeling</a> > <a class='selflink' href='ModelingItem.html'>Item</a></span>
</p>
<p class='vspace'>An item represents an end product, intermediate product or a raw material.
</p>
<p class='vspace'>Each demand is associated with an item.
</p>
<p class='vspace'>A buffer is also associated with an item: it represents a storage of the item.
</p>
<div class='vspace'></div><h2>Fields</h2>
<table border='1' width='100%' ><tr><td width='20%' valign='top'><strong>Field</strong>
</td><td width='20%' valign='top'><strong>Type</strong>
</td><td width='60%' valign='top'><strong>Description</strong>
</td></tr><tr><td valign='top'>name
</td><td valign='top'>non-empty string
</td><td valign='top'>
<p>Name of the item.<br />This is the key field and a required attribute.
</p></td></tr><tr><td valign='top'>description
</td><td valign='top'>string
</td><td valign='top'>
<p>Free format description.
</p></td></tr><tr><td valign='top'>category
</td><td valign='top'>normalizedString
</td><td valign='top'>
<p>Free format category.
</p></td></tr><tr><td valign='top'>subcategory
</td><td valign='top'>normalizedString
</td><td valign='top'>
<p>Free format subcategory.
</p></td></tr><tr><td valign='top'>owner
</td><td valign='top'>item
</td><td valign='top'>
<p>Items are organized in a hierarchical tree.<br />This field defines the parent item.
</p></td></tr><tr><td valign='top'>members
</td><td valign='top'>list of item
</td><td valign='top'>
<p>Items are organized in a hierarchical tree.<br />This field defines a list of child items.
</p></td></tr><tr><td valign='top'>operation
</td><td valign='top'>operation
</td><td valign='top'>
<p>This is the operation used to satisfy a demand for this item.<br />If left unspecified the value is inherited from the parent item.<br />See also the OPERATION field on the DEMAND.
</p></td></tr><tr><td valign='top'>price
</td><td valign='top'>double
</td><td valign='top'>
<p>Cost or price of the item.<br />Depending on the precise usage and business goal it should be evaluated which cost to load into this field: purchase cost, booking value, selling price... For most applications the booking value is the appropriate one. <br />The default value is 0.
</p></td></tr><tr><td valign='top'>hidden
</td><td valign='top'>boolean
</td><td valign='top'>
<p>Marks entities that are considered hidden and are normally not shown to the end user.
</p></td></tr><tr><td valign='top'>action
</td><td valign='top'>A<br />C<br />AC (default)<br />R
</td><td valign='top'>
<p>Type of action to be executed:
</p><ul><li>A: Add an new entity, and report an error if the entity already exists.
</li><li>C: Change an existing entity, and report an error if the entity doesn't exist yet.
</li><li>AC: Change an entity or create a new one if it doesn't exist yet.
</li><li>R: Remove an entity, and report an error if the entity doesn't exist.
</li></ul></td></tr></table>
<div class='vspace'></div><h2>Example XML structures</h2>
<ul><li>Adding or changing an item and its delivery operation
</li></ul><pre> <plan>
<items>
<item name="item A">
<operation name="Delivery of item A"
xsi:type="operation_fixed_time">
<duration>24:00:00</duration>
</operation>
<owner name="Item class A"/>
</item>
</items>
</plan>
</pre><div class='vspace'></div><ul><li>Deleting an item
</li></ul><pre> <plan>
<items>
<item name="item A" action="R"/>
</items>
</plan>
</pre><div class='vspace'></div><h2>Example Python code</h2>
<ul><li>Adding or changing an item and its delivery operation
</li></ul><pre> oper = frepple.operation_fixed_time(name="Deliver item A",
duration=24*3600)
it1 = frepple.item(name="Item class A")
it2 = frepple.item(name="item A", operation=oper, owner=it1)
</pre><div class='vspace'></div><ul><li>Deleting an item
</li></ul><pre> frepple.item(name="item A", action="R")
</pre>
</div>
<!--PageFooterFmt-->
<!--HTMLFooter-->
</div></div>
</body>
</html>
