vbatts/homebox
1
0
Fork 0
forked from mirrors/homebox
Code Pull requests Activity
homebox/import-csv/index.html

741 lines
20 KiB
HTML
Raw Normal View History

Deployed ae4b953 with MkDocs version: 1.4.2
2023-10-10 17:22:02 +00:00
<!doctype html>
<html lang="en" class="no-js">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link rel="canonical" href="https://hay-kot.github.io/homebox/import-csv/">
<link rel="prev" href="../tips-tricks/">
<link rel="next" href="../build/">
<link rel="icon" href="../assets/img/favicon.svg">
<meta name="generator" content="mkdocs-1.4.2, mkdocs-material-9.0.6">
<title>Import and Export - Homebox</title>
<link rel="stylesheet" href="../assets/stylesheets/main.558e4712.min.css">
<link rel="stylesheet" href="../assets/stylesheets/palette.2505c338.min.css">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
<style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
<link rel="stylesheet" href="../assets/stylesheets/extras.css">
<script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
</head>
<body dir="ltr" data-md-color-scheme="homebox" data-md-color-primary="" data-md-color-accent="">
<script>var palette=__md_get("__palette");if(palette&&"object"==typeof palette.color)for(var key of Object.keys(palette.color))document.body.setAttribute("data-md-color-"+key,palette.color[key])</script>
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip">
<a href="#csv-imports" class="md-skip">
Skip to content
</a>
</div>
<div data-md-component="announce">
</div>
<header class="md-header md-header--lifted" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href=".." title="Homebox" class="md-header__button md-logo" aria-label="Homebox" data-md-component="logo">
<img src="../assets/img/favicon.svg" alt="logo">
</a>
<label class="md-header__button md-icon" for="__drawer">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
</label>
<div class="md-header__title" data-md-component="header-title">
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
Homebox
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
Import and Export
</span>
</div>
</div>
</div>
<form class="md-header__option" data-md-component="palette">
<input class="md-option" data-md-color-media="" data-md-color-scheme="homebox" data-md-color-primary="" data-md-color-accent="" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_1">
<label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_2" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12 20 8.69Z"/></svg>
</label>
<input class="md-option" data-md-color-media="" data-md-color-scheme="slate" data-md-color-primary="" data-md-color-accent="" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_2">
<label class="md-header__button md-icon" title="Switch to light mode" for="__palette_1" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12c0-2.42-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12 20 8.69Z"/></svg>
</label>
</form>
<div class="md-header__source">
<a href="https://github.com/hay-kot/homebox" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.2.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
</div>
<div class="md-source__repository">
Homebox
</div>
</a>
</div>
</nav>
<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
<div class="md-tabs__inner md-grid">
<ul class="md-tabs__list">
<li class="md-tabs__item">
<a href=".." class="md-tabs__link md-tabs__link--active">
Home
</a>
</li>
<li class="md-tabs__item">
<a href="https://redocly.github.io/redoc/?url=https://hay-kot.github.io/homebox/api/openapi-2.0.json" class="md-tabs__link">
API
</a>
</li>
</ul>
</div>
</nav>
</header>
<div class="md-container" data-md-component="container">
<main class="md-main" data-md-component="main">
<div class="md-main__inner md-grid">
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href=".." title="Homebox" class="md-nav__button md-logo" aria-label="Homebox" data-md-component="logo">
<img src="../assets/img/favicon.svg" alt="logo">
</a>
Homebox
</label>
<div class="md-nav__source">
<a href="https://github.com/hay-kot/homebox" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.2.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
</div>
<div class="md-source__repository">
Homebox
</div>
</a>
</div>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item md-nav__item--active md-nav__item--nested">
<input class="md-nav__toggle md-toggle " data-md-toggle="__nav_1" type="checkbox" id="__nav_1" checked>
<label class="md-nav__link" for="__nav_1" tabindex="0" aria-expanded="true">
Home
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" aria-label="Home" data-md-level="1">
<label class="md-nav__title" for="__nav_1">
<span class="md-nav__icon md-icon"></span>
Home
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href=".." class="md-nav__link">
Home
</a>
</li>
<li class="md-nav__item">
<a href="../quick-start/" class="md-nav__link">
Quick Start
</a>
</li>
<li class="md-nav__item">
<a href="../tips-tricks/" class="md-nav__link">
Tips and Tricks
</a>
</li>
<li class="md-nav__item md-nav__item--active">
<input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
<label class="md-nav__link md-nav__link--active" for="__toc">
Import and Export
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
Import and Export
</a>
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#quick-start" class="md-nav__link">
Quick Start
</a>
</li>
<li class="md-nav__item">
<a href="#csv-reference" class="md-nav__link">
CSV Reference
</a>
<nav class="md-nav" aria-label="CSV Reference">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#special-syntax-columns" class="md-nav__link">
Special Syntax Columns
</a>
</li>
<li class="md-nav__item">
<a href="#standard-columns" class="md-nav__link">
Standard Columns
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../build/" class="md-nav__link">
Building The Binary
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="https://redocly.github.io/redoc/?url=https://hay-kot.github.io/homebox/api/openapi-2.0.json" class="md-nav__link">
API
</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#quick-start" class="md-nav__link">
Quick Start
</a>
</li>
<li class="md-nav__item">
<a href="#csv-reference" class="md-nav__link">
CSV Reference
</a>
<nav class="md-nav" aria-label="CSV Reference">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#special-syntax-columns" class="md-nav__link">
Special Syntax Columns
</a>
</li>
<li class="md-nav__item">
<a href="#standard-columns" class="md-nav__link">
Standard Columns
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-content" data-md-component="content">
<article class="md-content__inner md-typeset">
<h1 id="csv-imports">CSV Imports</h1>
<h2 id="quick-start">Quick Start</h2>
<p>Using the CSV import is the recommended way for adding items to the database. It is always going to be the fastest way to import any large amount of items and provides the most flexibility when it comes to adding items.</p>
<p><strong>Current Limitations</strong></p>
<ul>
<li>Imports only supports importing items, locations, and labels</li>
<li>Imports and Exports do not support attachments. Attachments must be uploaded after import</li>
<li>CSV Exports do not support nested path exports (e.g. <code>Home / Office / Desk</code>) and will only export the Items direct parent, (though imports <em>do</em> support nested paths)</li>
<li>Cannot specify item-to-item relationships (e.g. <code>Item A</code> is a child of <code>Item B</code>)</li>
</ul>
<div class="admonition tip">
<p class="admonition-title">File Formats</p>
<p>The CSV import supports both CSV and TSV files. The only difference is the delimiter used. CSV files use a comma <code>,</code> as the delimiter and TSV files use a tab <code>\t</code> as the delimiter. The file extension does not matter.</p>
</div>
<h2 id="csv-reference">CSV Reference</h2>
<p>Below are the supported columns. They are case sensitive, can be in any ordered or can be omitted unless otherwise specified.</p>
<h3 id="special-syntax-columns">Special Syntax Columns</h3>
<dl>
<dt><code>HB.import_ref</code></dt>
<dd>
<p>Import Refs are unique strings that can be used to deduplicate imports. Before an item is imported, we check the database for a matching ref. If the ref exists, we skip creation of that item.</p>
<ul>
<li>String Type</li>
<li>Max 100 Characters</li>
</ul>
<p>Import Refs are used to de-duplicate imports. It is HIGHLY recommended that you use them to manage your items if you intend to manage your inventory via CSV import/export. If you do not use import refs, you will end up with duplicate items in your database on subsequent imports.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>Specifying import refs also allows you to update existing items via the CSV import. If you specify an import ref that already exists in the database, we will update the existing item instead of creating a new one.</p>
</div>
</dd>
<dt><code>HB.location</code></dt>
<dd>
<p>This is the location of the item that will be created. These are de-duplicated and won't create another instance when reused.</p>
<ul>
<li>Supports Path Separators for nested locations (e.g. <code>Home / Office / Desk</code>)</li>
</ul>
</dd>
<dt><code>HB.labels</code></dt>
<dd>
<p>List of labels to apply to the item separated by a <code>;</code> can be existing or new labels.</p>
</dd>
<dt><code>HB.field.{field_name}</code> (e.g. <code>HB.field.Serial Number</code>)</dt>
<dd>
<p>This is a special column that allows you to add custom fields to the item. The column name must start with <code>HB.field.</code> followed by the name of the field. The value of the column will be the value of the field.</p>
<ul>
<li>If the cell value is empty, it will be ignored.</li>
</ul>
</dd>
</dl>
<h3 id="standard-columns">Standard Columns</h3>
<table>
<thead>
<tr>
<th>Column</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>HB.quantity</td>
<td>Integer</td>
<td>The quantity of items to create</td>
</tr>
<tr>
<td>HB.name</td>
<td>String</td>
<td>Name of the item</td>
</tr>
<tr>
<td>HB.asset_id</td>
<td>AssetID</td>
<td>Asset ID for the item</td>
</tr>
<tr>
<td>HB.description</td>
<td>String</td>
<td>Description of the item</td>
</tr>
<tr>
<td>HB.insured</td>
<td>Boolean</td>
<td>Whether or not the item is insured</td>
</tr>
<tr>
<td>HB.serial_number</td>
<td>String</td>
<td>Serial number of the item</td>
</tr>
<tr>
<td>HB.model_number</td>
<td>String</td>
<td>Model of the item</td>
</tr>
<tr>
<td>HB.manufacturer</td>
<td>String</td>
<td>Manufacturer of the item</td>
</tr>
<tr>
<td>HB.notes</td>
<td>String (1000)</td>
<td>General notes about the product</td>
</tr>
<tr>
<td>HB.purchase_from</td>
<td>String</td>
<td>Name of the place the item was purchased from</td>
</tr>
<tr>
<td>HB.purchase_price</td>
<td>Float64</td>
<td></td>
</tr>
<tr>
<td>HB.purchase_time</td>
<td>Date</td>
<td>Date the item was purchased</td>
</tr>
<tr>
<td>HB.lifetime_warranty</td>
<td>Boolean</td>
<td>true or false - case insensitive</td>
</tr>
<tr>
<td>HB.warranty_expires</td>
<td>Date</td>
<td>Date in the format</td>
</tr>
<tr>
<td>HB.warranty_details</td>
<td>String</td>
<td>Details about the warranty</td>
</tr>
<tr>
<td>HB.sold_to</td>
<td>String</td>
<td>Name of the person the item was sold to</td>
</tr>
<tr>
<td>HB.sold_time</td>
<td>Date</td>
<td>Date the item was sold</td>
</tr>
<tr>
<td>HB.sold_price</td>
<td>Float64</td>
<td></td>
</tr>
<tr>
<td>HB.sold_notes</td>
<td>String (1000)</td>
<td></td>
</tr>
</tbody>
</table>
<p><strong>Type Key</strong></p>
<table>
<thead>
<tr>
<th>Type</th>
<th>Format</th>
</tr>
</thead>
<tbody>
<tr>
<td>String</td>
<td>Max 255 Characters unless otherwise specified</td>
</tr>
<tr>
<td>Date</td>
<td>YYYY-MM-DD</td>
</tr>
<tr>
<td>Boolean</td>
<td>true or false, yes or no, 1 or 0 - case insensitive</td>
</tr>
<tr>
<td>AssetID</td>
<td>000-000</td>
</tr>
</tbody>
</table>
</article>
</div>
</div>
</main>
<footer class="md-footer">
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">
<div class="md-copyright">
Made with
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
Material for MkDocs
</a>
</div>
</div>
</div>
</footer>
</div>
<div class="md-dialog" data-md-component="dialog">
<div class="md-dialog__inner md-typeset"></div>
</div>
<script id="__config" type="application/json">{"base": "..", "features": ["content.code.annotate", "navigation.instant", "navigation.expand", "navigation.sections", "navigation.tabs.sticky", "navigation.tabs"], "search": "../assets/javascripts/workers/search.e5c33ebb.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
<script src="../assets/javascripts/bundle.51d95adb.min.js"></script>
</body>
</html>
Copy permalink