mirror of
https://github.com/inventree/inventree-website.git
synced 2025-04-30 06:26:50 +00:00
451 lines
22 KiB
HTML
451 lines
22 KiB
HTML
<!DOCTYPE html>
|
||
<html lang=" en-US ">
|
||
|
||
<head>
|
||
<meta charset="UTF-8">
|
||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||
|
||
<link rel="stylesheet" href="/assets/splide/css/splide.min.css">
|
||
<link rel="stylesheet" href="/assets/index.css">
|
||
<link rel="shortcut icon" type="image/png" href="/assets/icon/favicon.ico">
|
||
|
||
<script src="/assets/splide/js/splide.min.js"></script>
|
||
|
||
<!-- Fontawesome integration -->
|
||
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.2.1/css/all.min.css">
|
||
|
||
<title>InvenTree - Inventree Bulk Plugin</title>
|
||
<meta itemprop="description" name="description"
|
||
content="InvenTree is an open-source inventory management system which provides intuitive parts management and stock control. It is at the center of an ecosystem of a..." />
|
||
|
||
<!-- Begin Jekyll SEO tag v2.8.0 -->
|
||
<title>Inventree Bulk Plugin | InvenTree</title>
|
||
<meta name="generator" content="Jekyll v4.3.2" />
|
||
<meta property="og:title" content="Inventree Bulk Plugin" />
|
||
<meta name="author" content="wolflu05" />
|
||
<meta property="og:locale" content="en_US" />
|
||
<meta name="description" content="Bulk creation plugin for InvenTree" />
|
||
<meta property="og:description" content="Bulk creation plugin for InvenTree" />
|
||
<link rel="canonical" href="/wolflu05/inventree-bulk-plugin" />
|
||
<meta property="og:url" content="/wolflu05/inventree-bulk-plugin" />
|
||
<meta property="og:site_name" content="InvenTree" />
|
||
<meta property="og:type" content="article" />
|
||
<meta property="article:published_time" content="2023-08-06T00:54:51+00:00" />
|
||
<meta name="twitter:card" content="summary" />
|
||
<meta property="twitter:title" content="Inventree Bulk Plugin" />
|
||
<script type="application/ld+json">
|
||
{"@context":"https://schema.org","@type":"BlogPosting","author":{"@type":"Person","name":"wolflu05"},"dateModified":"2023-08-06T00:54:51+00:00","datePublished":"2023-08-06T00:54:51+00:00","description":"Bulk creation plugin for InvenTree","headline":"Inventree Bulk Plugin","mainEntityOfPage":{"@type":"WebPage","@id":"/wolflu05/inventree-bulk-plugin"},"url":"/wolflu05/inventree-bulk-plugin"}</script>
|
||
<!-- End Jekyll SEO tag -->
|
||
|
||
<script async defer src="https://umami.invenhost.com/umami.js" data-website-id="c713a5e9-25cf-4bb6-9e84-ceb041a53986" data-do-not-track="true"></script>
|
||
</head>
|
||
|
||
<body class="flex flex-col antialiased cm-gray-1 min-h-screen">
|
||
<div class="flex-none">
|
||
<header class="cm-gray-2 body-font sticky top-0 z-50 bg-gradient-to-r from-white to-secondary">
|
||
<div class="container mx-auto flex flex-wrap p-5 flex-row items-center">
|
||
<a class="flex title-font font-medium items-center cm-gray-1 mb-0 mr-2" href="/">
|
||
<img src="/assets/logo.png" alt="logo" height="32" width="32" class="h-8">
|
||
<span class="ml-3 text-xl">InvenTree</span>
|
||
</a>
|
||
|
||
<div class="flex-grow xs:flex-none"></div>
|
||
|
||
<nav class="md:mr-auto md:py-1 xs:ml-4 xs:pl-4 xs:border-l xs:border-gray-400 flex flex-wrap items-center text-base justify-center">
|
||
<a class="mr-5 hover:cm-gray-1" href="/deploy.html">Deploy</a>
|
||
<a class="mr-5 hover:cm-gray-1" href="https://docs.inventree.org/en/latest/">Docs</a>
|
||
<a class="mr-5 hover:cm-gray-1" href="/blog">Blog</a>
|
||
</nav>
|
||
|
||
|
||
</div>
|
||
</header> <article class="max-w-p90">
|
||
|
||
<h2>inventree-bulk-plugin
|
||
<span class="sm:ml-2 text-sm">
|
||
<a href="/wolflu05">
|
||
<span class="inline-flex">by <img src="https://github.com/wolflu05.png?size=40" alt="mdo" class="self-center w-5 h-5 rounded-full" style="margin:0px"> wolflu05</span>
|
||
</a></span>
|
||
<span class="sm:ml-2 text-sm">last modified: 06 Aug 2023</span>
|
||
</h2>
|
||
|
||
<div class="flex-wrap md:flex md:flex-nowrap">
|
||
<div class="w-full md:w-auto md:mr-4">
|
||
<p>Bulk creation plugin for InvenTree</p>
|
||
|
||
<h1 id="inventree-bulk-plugin">inventree-bulk-plugin</h1>
|
||
|
||
<p><a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="License: MIT"></a>
|
||
<img src="https://github.com/wolflu05/inventree-bulk-plugin/actions/workflows/ci.yml/badge.svg" alt="CI"></p>
|
||
|
||
<p>This plugin helps you bulk create storage locations and part categories in <a href="https://inventree.org/">InvenTree</a> by using customized naming strategies. That means you not only have the option to generate multidimensional* names for stock locations or part categories, but also have the option to save the templates for later usage if your storage room uses e.g. drawer towers, saved templates help to ensure naming consistency for all later added towers.</p>
|
||
|
||
<blockquote>
|
||
<p>multidimensional means that you are not limited to namings like <code class="language-plaintext highlighter-rouge">D1</code>,<code class="language-plaintext highlighter-rouge">D2</code>, .. but also something like <code class="language-plaintext highlighter-rouge">D1.A</code>, <code class="language-plaintext highlighter-rouge">D1.B</code>, <code class="language-plaintext highlighter-rouge">D2.A</code>, <code class="language-plaintext highlighter-rouge">D2.B</code>, …</p>
|
||
</blockquote>
|
||
|
||
<h2 id="screenshots">🌟Screenshots</h2>
|
||
|
||
<details open="">
|
||
<summary>This will generate the previous mentioned example:</summary>
|
||
|
||
|
||
|
||
</details>
|
||
|
||
<h3 id="-some-more-examples">📄 Some more examples</h3>
|
||
|
||
<details>
|
||
<summary>But even nested generations don't stop you.</summary>
|
||
|
||
|
||
|
||
</details>
|
||
|
||
<details>
|
||
<summary>And with parent name match, you can even generate different sub-locations depending of the name of the parent.</summary>
|
||
|
||
|
||
|
||
|
||
</details>
|
||
|
||
<details>
|
||
<summary>Pad your numeric dimensions with zeros.</summary>
|
||
|
||
|
||
|
||
</details>
|
||
|
||
<details>
|
||
<summary>Extend from a template.</summary>
|
||
|
||
|
||
|
||
|
||
</details>
|
||
|
||
<details>
|
||
<summary>Use more generate keys.</summary>
|
||
|
||
|
||
|
||
</details>
|
||
|
||
<details>
|
||
<summary>Using input to reuse a saved template.</summary>
|
||
|
||
|
||
|
||
</details>
|
||
|
||
<h2 id="️-installation">⚙️ Installation</h2>
|
||
|
||
<p>Install this plugin as follows:</p>
|
||
|
||
<ol>
|
||
<li>
|
||
<p>Make sure you allow the use of the url integration and app integration (see <a href="#why-does-this-plugin-needs-the-app-mixin">Why does this plugin needs the app mixin?</a>)</p>
|
||
</li>
|
||
<li>
|
||
<p>Goto Settings > Plugins > Install Plugin, enter <code class="language-plaintext highlighter-rouge">inventree-bulk-plugin</code> as package name. Enable the confirm switch and click submit.</p>
|
||
</li>
|
||
<li>
|
||
<p>Restart your server and activate the plugin.</p>
|
||
</li>
|
||
<li>
|
||
<p>Stop your server and run <code class="language-plaintext highlighter-rouge">invoke update</code> (for docker installs it is <code class="language-plaintext highlighter-rouge">docker-compose inventree-server invoke update</code>). This ensures that all migrations run and the static files get collected. You can now start your server again and start using the plugin.</p>
|
||
</li>
|
||
</ol>
|
||
|
||
<h2 id="-usage">🏃 Usage</h2>
|
||
|
||
<h3 id="bulk-create">Bulk create</h3>
|
||
|
||
<p>You can bulk create sub-stocklocations and sub-partcategories. Goto one and use the panel “Bulk-creation”. Either load a <a href="#saved-templates">saved template</a> or set up the output quickly. Use “Preview” to see how the bulk creation will look like and create to bulk create the locations/categories. To see how this editor works see <a href="#bulk-creation-editor">bulk creation editor</a>.</p>
|
||
|
||
<h3 id="saved-templates">Saved templates</h3>
|
||
|
||
<p>You can save bulk creation templates to ensure consistency along your storage trees. Let’s say you have a bunch of drawer towers. With saved templates you can now easily store your templates to re-use it when you want to add a new tower to the system.</p>
|
||
|
||
<ol>
|
||
<li>Goto the stock index and select the “Manage bulk creation” panel.</li>
|
||
<li>Click on “New Template”.</li>
|
||
<li>Adjust the schema to your needs and use “Preview” to see how the creation will look like</li>
|
||
<li>Create you template by using “Create”</li>
|
||
<li>Goto the specific sub-location where you want to apply that template, load it and Bulk generate your locations to your needs.</li>
|
||
</ol>
|
||
|
||
<blockquote>
|
||
<p>You can use <a href="#input">inputs</a> to make your bulk creation schema dynamic in amount of drawers or their names.</p>
|
||
</blockquote>
|
||
|
||
<h3 id="bulk-creation-editor">Bulk creation editor</h3>
|
||
|
||
<p>The bulk creation editor helps you to define the generation schema.</p>
|
||
|
||
<blockquote>
|
||
<p>You can use <a href="https://jinja.palletsprojects.com/en/3.1.x/templates/">Jinja2 templating</a> in every field (except in the <code class="language-plaintext highlighter-rouge">input</code> section). You can also use filters to manipulate the dimension output.
|
||
<strong>Global context:</strong></p>
|
||
<ul>
|
||
<li>
|
||
<code class="language-plaintext highlighter-rouge">inp.<key></code> - Access <a href="#input">input variables</a>, e.g. (``)</li>
|
||
</ul>
|
||
</blockquote>
|
||
|
||
<h4 id="input">Input</h4>
|
||
|
||
<p>You can define key/value pairs of inputs which you can later reference in your schema via ``. This is useful for <a href="#saved-templates">saved templates</a> to dynamically generate the amount of locations as you want, but still keep the structure.</p>
|
||
|
||
<h4 id="templates">Templates</h4>
|
||
|
||
<p>You can define templates from which you can later extend in your output. Template values can also be overwritten.</p>
|
||
|
||
<ul>
|
||
<li>
|
||
<code class="language-plaintext highlighter-rouge">Template name</code> - Template name, is later used to select for extending</li>
|
||
</ul>
|
||
|
||
<p>For the rest of the fields see <a href="#output">output</a>.</p>
|
||
|
||
<h4 id="output">Output</h4>
|
||
|
||
<h5 id="parent-name-match">Parent name match</h5>
|
||
<p>First child that matches the parent name matcher will be chosen for generating the child’s for a specific parent. This must evaluate to something that can be casted to a boolean. You can use Jinja2 for dynamically decide based on the parent. E.g. ``. The global jinja2 and <code class="language-plaintext highlighter-rouge">par</code> context is available here.</p>
|
||
|
||
<h5 id="extends">Extends</h5>
|
||
<p>Select a template to extend from</p>
|
||
|
||
<h5 id="dimensionscount">Dimensions/Count</h5>
|
||
<p>Dimensions are a way to add various counting strategies to your naming. You can add a dimension by clicking on “Add dimension” and remove it via the red “X” on the right of the dimension field.</p>
|
||
|
||
<p>A <code class="language-plaintext highlighter-rouge">dimension</code> can contain comma separated generators which generate the values for you. There are three types of generators. You can use the <code class="language-plaintext highlighter-rouge">count</code> field to limit a dimension to a specific amount of generating items. These generators can have arguments parsed via the following syntax: <code class="language-plaintext highlighter-rouge">GENERATOR(key1=value,key2=value)</code>, where <code class="language-plaintext highlighter-rouge">GENERATOR</code> is the name/range. <br></p>
|
||
|
||
<p><strong>Generator types:</strong><br>
|
||
Word: <em>any arbitrary word, not starting with <code class="language-plaintext highlighter-rouge">*</code></em>. E.g. <code class="language-plaintext highlighter-rouge">hello world</code><br>
|
||
Ranges: <em>ranges are defined with a - in the middle</em> E.g. <code class="language-plaintext highlighter-rouge">a-bx</code><br>
|
||
Infinity: <em>infinity generators start with a *</em> E.g. <code class="language-plaintext highlighter-rouge">*NUMERIC</code><br></p>
|
||
|
||
<p><strong>Available Generators:</strong><br>
|
||
Numeric generator: <code class="language-plaintext highlighter-rouge">*NUMERIC(start=0,end=10,step=2,count=5)</code> or <code class="language-plaintext highlighter-rouge">0-10(step=2}</code><br>
|
||
Alpha generator: <code class="language-plaintext highlighter-rouge">*ALPHA(casing=upper|lower,start=A,end=F,step=2,count=3)</code> or <code class="language-plaintext highlighter-rouge">a-z(step=2)</code><br><br></p>
|
||
|
||
<p>Example: <code class="language-plaintext highlighter-rouge">1-3,hello,*NUMERIC(start=1,step=2,end=10),*ALPHA(casing=upper,end=B),A-D(step=2)</code>, this will generate the following dimension: <code class="language-plaintext highlighter-rouge">12,3,hello,1,3,5,7,9,A,B,A,C</code>.</p>
|
||
|
||
<blockquote>
|
||
<p>Infinity generators need a <code class="language-plaintext highlighter-rouge">count</code> argument or a global count limitation, otherwise generation will fail.</p>
|
||
</blockquote>
|
||
|
||
<h5 id="generate">Generate</h5>
|
||
|
||
<p>These fields my differ between stock location and part category. They correspond to the generated items property. For example “Name” will be the name of the created location/category. Fields like “Structural” must evaluate to something that ca be casted to a boolean (e.g. <code class="language-plaintext highlighter-rouge">true</code> or <code class="language-plaintext highlighter-rouge">false</code>).</p>
|
||
|
||
<blockquote>
|
||
<p><strong>Extended Jinja2 context</strong>:</p>
|
||
<ul>
|
||
<li>
|
||
<code class="language-plaintext highlighter-rouge">len</code> - count of elements this child will generate</li>
|
||
<li>
|
||
<code class="language-plaintext highlighter-rouge">dim.<x></code> - x-th dimension, one-based (e.g. `` to access the first dimension)</li>
|
||
<li>
|
||
<code class="language-plaintext highlighter-rouge">dim.<x>.len</code> - count of items the x-th dimension has</li>
|
||
<li>
|
||
<code class="language-plaintext highlighter-rouge">par.<...></code> - parent’s context</li>
|
||
<li>
|
||
<code class="language-plaintext highlighter-rouge">par.dim.<x></code> - parents’s dimensions</li>
|
||
<li>
|
||
<code class="language-plaintext highlighter-rouge">par.gen.<name></code> - parent’s generated fields (e.g. to reuse the parents name ``)</li>
|
||
<li>
|
||
<code class="language-plaintext highlighter-rouge">par.par.<...></code> - parent’s parent context, can be nested deeply</li>
|
||
</ul>
|
||
</blockquote>
|
||
|
||
<h5 id="childs">Child’s</h5>
|
||
|
||
<p>Child’s are a way to add some nesting to your bulk creation tree. You can use them for e.g. generating sections in every of your drawer. You can use the <a href="#parent-name-match">Parent name match</a> option to add for your drawers named from <code class="language-plaintext highlighter-rouge">Drawer 1</code> - <code class="language-plaintext highlighter-rouge">Drawer 10</code> two sections while your other drawers have different sections.</p>
|
||
|
||
<h2 id="-faq">❓ FAQ</h2>
|
||
|
||
<h4 id="why-does-this-plugin-needs-the-app-mixin">Why does this plugin needs the App Mixin?</h4>
|
||
|
||
<blockquote>
|
||
<p>This plugin uses the App Mixin to add a custom model to the database to manage stored templates which ensure consistency along your creation of storage trees. (See <a href="#saved-templates">Saved templates</a>). Additionally the App Mixin is used to provide the static files that are required for the reactive interface powered by preact.</p>
|
||
</blockquote>
|
||
|
||
<h4 id="why-does-this-plugin-needs-the-url-mixin">Why does this plugin needs the Url Mixin?</h4>
|
||
|
||
<blockquote>
|
||
<p>This plugin uses the Url Mixin to expose custom API endpoints for previewing and bulk create locations.</p>
|
||
</blockquote>
|
||
|
||
|
||
</div>
|
||
|
||
<div class="w-full md:w-1/4">
|
||
<h2 class="block sm:hidden">Detail section</h2>
|
||
<div>
|
||
<p class="mb-0">License:
|
||
<i class="fa-brands fa-osi"></i>
|
||
MIT<br>
|
||
</p>
|
||
<div class="flex flex-wrap">
|
||
Status:
|
||
<div>
|
||
<i class="fa-regular fa-circle-check"></i>Stable</div>
|
||
<div>
|
||
<i class="fa-regular fa-circle-check"></i>Maintained</div>
|
||
</div>
|
||
Package on PyPI:<pre class="my-0">inventree-bulk-plugin</pre>
|
||
|
||
|
||
|
||
|
||
|
||
<a href="https://github.com/wolflu05/inventree-bulk-plugin/issues" class="no-underline" aria-label="open the issue tracker">
|
||
<div>
|
||
<h4 class="plugin_links">Issue Tracker <i class="fa-solid fa-arrow-up-right-from-square" title="External link"></i>
|
||
</h4>
|
||
</div>
|
||
</a>
|
||
|
||
|
||
|
||
<a href="https://github.com/wolflu05/inventree-bulk-plugin" class="no-underline" aria-label="open source on GitHub">
|
||
<div>
|
||
<h4 class="plugin_links">Sourcecode on GitHub <i class="fa-solid fa-arrow-up-right-from-square" title="External link"></i>
|
||
</h4>
|
||
<p class="font-normal">wolflu05/inventree-bulk-plugin</p>
|
||
</div>
|
||
</a>
|
||
|
||
|
||
|
||
|
||
<div>
|
||
<h4 class="plugin_links">Categories</h4>
|
||
<div>
|
||
|
||
<a href="/plugins/categories/#appmixin"><span class="plugin_cat">AppMixin</span></a>
|
||
|
||
</div>
|
||
</div>
|
||
|
||
<div>
|
||
<h4 class="plugin_links">Tags</h4>
|
||
<div>
|
||
|
||
<a href="/plugins/tags/#bulk"><span class="plugin_tag">Bulk</span></a>
|
||
|
||
<a href="/plugins/tags/#stock"><span class="plugin_tag">Stock</span></a>
|
||
|
||
<a href="/plugins/tags/#part"><span class="plugin_tag">Part</span></a>
|
||
|
||
<a href="/plugins/tags/#locations"><span class="plugin_tag">Locations</span></a>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
</article>
|
||
|
||
</div>
|
||
|
||
<div class="flex-grow"></div>
|
||
<div class="flex-none">
|
||
<footer class="cm-gray-2 body-font">
|
||
<div class="container px-5 pt-8 mx-auto flex md:flex-row md:flex-nowrap flex-wrap flex-col">
|
||
<div class="w-64 flex-shrink-0 md:mx-0 mx-auto text-center md:text-left">
|
||
<div class="flex title-font font-medium items-center md:justify-start justify-center cm-gray-1">
|
||
<img src="/assets/logo.png" alt="logo" height="32" width="32" class="h-8">
|
||
<span class="ml-3 text-xl">InvenTree</span>
|
||
</div>
|
||
<p class="mt-2 text-sm cm-gray-3">Intuitive Inventory Management</p>
|
||
</div>
|
||
|
||
<div class="flex-grow flex flex-wrap md:pl-10 mb-1 md:mt-0 mt-10 md:text-left text-center md:justify-left justify-center">
|
||
|
||
|
||
<div class="md:w-1/4 px-4">
|
||
<h2 class="footer-categorie title-font">
|
||
Quick
|
||
</h2>
|
||
<nav class="list-none mb-10"><ul>
|
||
|
||
<li><a href="/demo.html" class="footer-link">Demo</a></li>
|
||
|
||
<li><a href="/deploy.html" class="footer-link">Deploy</a></li>
|
||
|
||
<li><a href="https://docs.inventree.org/en/latest/" class="footer-link">Docs</a></li>
|
||
|
||
<li><a href="/news" class="footer-link">News</a></li>
|
||
|
||
<li><a href="/plugins" class="footer-link">Plugin List</a></li>
|
||
|
||
</ul></nav>
|
||
</div>
|
||
|
||
<div class="md:w-1/4 px-4">
|
||
<h2 class="footer-categorie title-font">
|
||
<a href="/extend/">Ecosystem</a>
|
||
</h2>
|
||
<nav class="list-none mb-10"><ul>
|
||
|
||
<li><a href="/extend/api.html" class="footer-link">API</a></li>
|
||
|
||
<li><a href="/extend/app.html" class="footer-link">App</a></li>
|
||
|
||
<li><a href="/extend/integrate/" class="footer-link">Integrate</a></li>
|
||
|
||
<li><a href="/extend/plugin/" class="footer-link">Plugins</a></li>
|
||
|
||
<li><a href="https://github.com/sparkmicro/Ki-nTree" class="footer-link">KiCad</a></li>
|
||
|
||
</ul></nav>
|
||
</div>
|
||
|
||
<div class="md:w-1/4 px-4">
|
||
<h2 class="footer-categorie title-font">
|
||
Sitemap
|
||
</h2>
|
||
<nav class="list-none mb-10"><ul>
|
||
|
||
<li><a href="/about/" class="footer-link">About</a></li>
|
||
|
||
<li><a href="/alternatives/" class="footer-link">Alternatives</a></li>
|
||
|
||
<li><a href="/blog" class="footer-link">Blog</a></li>
|
||
|
||
<li><a href="/contribute.html" class="footer-link">Contribute</a></li>
|
||
|
||
<li><a href="/support.html" class="footer-link">Support</a></li>
|
||
|
||
</ul></nav>
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
|
||
<div class="bg-gray-100">
|
||
<div class="container mx-auto py-4 px-5 flex flex-wrap flex-col sm:flex-row">
|
||
<p class="cm-gray-2 text-sm text-center sm:text-left">© 2021-now InvenTree by<a href="https://github.com/inventree" rel="noopener" class="cm-gray-2 ml-1" target="_blank">@inventree</a>— website made with ♥ by<a href="https://github.com/matmair" rel="noopener" class="cm-gray-2 ml-1" target="_blank">@matmair</a></p>
|
||
<span class="inline-flex sm:ml-auto sm:mt-0 mt-2 justify-center sm:justify-start">
|
||
<a href="https://github.com/inventree/inventree" alt="github repo" class="ml-3 cm-gray-3">
|
||
<img class="h-5 w-5" alt="GitHub logo" src="/assets/github.svg">
|
||
</a>
|
||
<a href="https://reddit.com/r/inventree" alt="Reddit" class="ml-3 cm-gray-3">
|
||
<img class="h-5 w-5" alt="Reddit logo" src="/assets/reddit.svg">
|
||
</a>
|
||
<a href="https://twitter.com/inventreedb" alt="Twitter" class="ml-3 cm-gray-3">
|
||
<img class="h-5 w-5" alt="Twitter logo" src="/assets/twitter.svg">
|
||
</a>
|
||
</span>
|
||
</div>
|
||
</div>
|
||
</footer>
|
||
</div>
|
||
</body>
|
||
|
||
</html> |