> ## Documentation Index
> Fetch the complete documentation index at: https://docs.assetinfinity.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Kits

> Sets of assets, tools and parts that go out together and move as one — the kit register, filling a kit, moving it, taking it back, dismantling it, and the templates that say what a kit should hold.

A kit is a named set of assets, tools and parts that goes out together and is moved as one — a
field engineer's laptop, meter and radios, or everything a new site needs on its first day. The
**Kits** screen lists every kit, says which are short of something, and opens each one to fill it,
move it and take it back. Open it from **Assets → Kits**.

> [!NOTE]
>
> **Kits** appears only where your organisation has kits switched on, and only to people with **View
> kits and what is in them**. If you don't see it, your administrator can switch the module on under
> **Administration → Modules**, or it may not be included in your plan.

A kit exists so that nothing is handed out short. Where a kit is assembled to a
[template](#kit-templates), the template says what it should hold, and a kit missing anything on a
line that is not optional cannot be handed to anybody until it is filled.

## The kit register

The register opens newest first. The header counts the kits, and how many on the page are short of
something.

![The kit register with four kits in Workshop bay 3, one flagged One line short, each with what it holds and its template](https://mintcdn.com/assetinfinity/Zwhoqsm-bybIxi-T/images/assets/kits-light.png?fit=max\&auto=format\&n=Zwhoqsm-bybIxi-T\&q=85\&s=75eb0fad540b301c941783dc56f54bdc)

| Column | What it shows |
| - | - |
| **Kit** | The kit's name, with its kit number underneath |
| **State** | **In store**, **With somebody** or **Dismantled**, and beside it **One line short** (or ***N* lines short**) when a line that is not optional is not filled, or **One optional line empty** when only optional lines are |
| **Where** | The site and location the kit is at |
| **Who has it** | Who is holding it, or a dash while it is in store |
| **Holds** | How many things are in it now — assets, tools and parts together |
| **Template** | The template and version it was assembled to, or **Ad hoc** |
| **Department** (hidden by default) | The department that answers for it |
| **Holding it since** (hidden by default) | When the person holding it took it |

A kit short of a required line is tinted, so it stands out before anybody opens it. **Short of
something** in the toolbar narrows the list to those kits. The search box reads kit numbers, names,
holders, sites and templates.

| Button | What it does | Who sees it |
| - | - | - |
| **Templates** | Opens [kit templates](#kit-templates) | People with **View kit templates** |
| **New kit** | Opens the kit form | People with **Create kits** |

Ticking kits opens a bar at the foot of the screen with **Print labels**, which prints the label for
each kit's case from the kit design in the [label studio](https://docs.assetinfinity.ai/config/labels.md). A kit cannot be edited in
a grid, because what it holds and where it is change only by filling and moving it.

### Creating a kit

**New kit** asks for:

| Field | What it means | Notes |
| - | - | - |
| **Kit number** | The number on the case | Leave it empty and the next number is assigned. Type one only to keep a number already marked on the case |
| **Name** | What people call this kit — "Field kit 3" | Required |
| **Template** | The template this kit is assembled to | Optional. Leave it empty for an ad-hoc kit, which nothing says the contents of. It cannot be changed afterwards. Only a published template is offered |
| **Description** | Anything worth knowing about this particular kit | Optional |
| **Site**, **Location** | Where the kit is now | Assemble it where its things are: everything put in a kit has to be at its site and location |
| **Department** | The department that answers for the kit | Optional |

The form does not ask who is holding the kit. A kit starts in store, and is handed to somebody by
[moving it](#moving-a-kit), which checks first that it holds what it should.

## Inside a kit

Clicking a kit opens its page. The header shows the kit number, its state and any shortfall.

![A kit's page: where it is and who has it, What it should hold with one radio of two filled, and the gas detector and radio in the kit](https://mintcdn.com/assetinfinity/Zwhoqsm-bybIxi-T/images/assets/kit-detail-light.png?fit=max\&auto=format\&n=Zwhoqsm-bybIxi-T\&q=85\&s=7b2f44dfa153ed4b4d83af7180a437a6)

| Section | What it shows |
| - | - |
| **Where it is, and who has it** | **Where**, **Who has it** (and since when) and **Template** — the template and version, or *Ad hoc — nothing says what it should hold* |
| **What it should hold** | For a kit assembled to a template, one row per template line with how many of it are **In it** — *2 of 3* — in amber where a required line is short. **Fill** on a short line opens a picker for exactly that line |
| **Parts put aside** | Shown while a part line is short or a hold is open. See [putting parts aside](#putting-parts-aside) |
| **In the kit** | Everything in it now: **What** (its number and name, linking to the asset, tool or part), **Kind**, **Status** — for a part, how much and which store it came from — and which line it **Fills**, or **extra**. **Take out** removes one: an asset stays exactly where it is and can be moved on its own again, a tool's checkout to the kit is closed, and a part goes back to the store it came from. **Show what used to be in it** lists what was taken out, when, by whom and why |
| **Moves** | Each move of the kit: its consignment number and when, where it went **To** and to whom, how many things it **Holds**, and a button to produce the handover document |

### Putting things in

**Add an asset**, **Add a tool** and **Add a part** sit beside **In the kit**. Each opens a picker
that offers only what the kit would accept, so a refusal is the exception rather than the way you
learn the rules.

| Kind | What is offered | Also needs |
| - | - | - |
| Asset | Assets at the kit's site and location, held by nobody else and in no other kit. Move an asset to the kit first, then put it in | **Rename kits, and add assets to them or take them out** |
| Tool | Tools at the kit's site and location, out to nobody, in no other kit, in a condition that allows use and not past calibration. The tool is checked out to the kit, so the tool room's rules still hold | **Book, check out and return tools**, and the tool register switched on |
| Part | Stock in a store at the kit's site, or in a store that belongs to no site, with how much is available in each. You say **How many**. The part is issued to the kit from that store, and is never used up while it is in the kit | **Issue, consume, return and reserve stock**, and inventory switched on |

**Put in** adds the row. Filling from a template line offers only what fits that line — its
category, model, tool type or part.

Once in a kit, an asset goes where the kit goes. Moving it, handing it to somebody, splitting it or
disposing of it on its own is refused until it is taken out of the kit — move the kit instead.

### Putting parts aside

While a part line is short, **Put parts aside** holds what the part lines are still short of in one
store you choose, so the store does not issue it elsewhere before the kit is assembled. Only stores at
the kit's site holding some of a part the kit asks for are offered, and a store that cannot cover
every part is refused. Each part then put in from that store is taken from the hold first. **Let them
go** releases the hold.

### Header actions

| Button | What it does | Who sees it |
| - | - | - |
| **All kits** | Back to the register | Everyone |
| **Print labels** | Prints the label for the kit's case, which the field app scans to move the kit | Everyone who can see the kit |
| **Edit** | Opens the kit form to correct its details | **Rename kits, and add assets to them or take them out** |
| **Delete** | Deletes a kit created by mistake. Offered only while nothing has ever been put in it or moved with it | **Delete a kit created by mistake, before anything was put in it** |
| **Dismantle** | Empties the kit for good. See [dismantling a kit](#dismantling-a-kit) | **Dismantle a kit, letting go of everything in it** |
| **Save as template** | Makes a draft template from what an ad-hoc kit holds now | **Create kit templates** |
| **Take back** | Checks the kit back in from whoever has it. Shown while somebody is holding it. See [taking a kit back](#taking-a-kit-back) | **Move a kit, or hand it to somebody, with everything in it** |
| **Move kit** | Moves the kit or hands it to somebody. See [moving a kit](#moving-a-kit) | **Move a kit, or hand it to somebody, with everything in it** |

A dismantled kit keeps its page and its moves, but offers none of these except **All kits**.

## Moving a kit

**Move kit** sends a kit somewhere new, or to somebody new, with everything in it. It is a smaller
form than [moving an asset](https://docs.assetinfinity.ai/assets/detail.md#move), because what goes is already decided.

| Field | What it means | Notes |
| - | - | - |
| **Where it is going** | The new site or location | Optional — **Leave it where it is** to hand it over without moving it. Moving to another site clears the location, because a room belongs to the site it is in |
| **Who is taking it** | The new holder, from the people with an account | Optional. Choose **Nobody new, or somebody with no account…** to type a name — a driver, a contractor — and their email |
| **Status of everything in it afterwards** | One status for every asset in the kit | Optional — **Leave each status alone** |
| **Department** | A new department | Optional — **Leave the department alone** |
| **Due back** | When the kit should come back | Optional |
| **Notes** | Anything worth recording about the move | Optional |

The kit moves whole or not at all: if one thing in it cannot go, nothing moves. So the form offers
**Check** before **Move kit**. **Check** tries the move exactly as it would be made, without keeping
it, and lists each thing in the kit with **Can go**, **Already there; nothing to change**, or the
reason it would be refused. When everything can go, it says *Everything in the kit can go.*

Where moves need approval, **Check** says so, and **Move kit** sends one request for the whole kit;
nothing moves until it is approved. Once the kit has moved, the result names the consignment
everything moved as, and offers its handover document — one document listing everything in the kit,
headed by the kit.

The field app can move a kit too: scanning a kit's label offers **Move this kit**. See [scanning in the field app](https://docs.assetinfinity.ai/field/scan.md).

## Taking a kit back

**Take back** checks a kit in from whoever has it, one thing at a time. Nothing starts ticked. Scan
each label — a scanner types the code and presses Enter — or tick each thing as it is handed over,
and count the parts that came back. A scan of something not in the kit says so.

Where assets come back, choose **What the assets go back into** — the status they return in. **Why**
is optional.

Anything not checked in is what did not come back, and the dialog says so before you press **Take
back**: a missing asset is taken out of the kit and left with whoever had it, and reported missing
where [missing assets](https://docs.assetinfinity.ai/assets/register.md#the-missing-view) are recorded; a missing tool stays checked
out to the kit; parts that are short are written off.

## Dismantling a kit

**Dismantle** asks for confirmation and an optional **Why**. Everything comes out at once: assets stay
where they are, tools go back to the tool room and parts to the stores they came from, and anything
put aside for the kit is let go. The kit stays on the register with its moves, but cannot be filled
or moved again.

## Kit templates

A template says what a kit of one kind should hold — a laptop, a meter, two radios — so a kit short of
something is noticed before it is handed out. Open it from **Templates** on the kit register. It needs
**View kit templates** as well as access to kits. Kits can also be put together without one.

![Kit templates: two in use with Start next version and Retire, and one draft with Publish](https://mintcdn.com/assetinfinity/Zwhoqsm-bybIxi-T/images/assets/kit-templates-light.png?fit=max\&auto=format\&n=Zwhoqsm-bybIxi-T\&q=85\&s=13f89b958eb1044da733d130823858e4)

| Column | What it shows |
| - | - |
| **Kit template** | The template's name and code |
| **Version** | Its version number |
| **Status** | **Draft**, **In use** or **Retired** |
| **Lines** | How many lines it has |
| **Kits** | How many kits were assembled to this version |

Clicking a template shows its lines underneath — what a kit of that version holds.

### Templates are versioned

A template is versioned the way a bill of materials is, so a kit assembled last year can still be
compared with what it was meant to hold then.

| Status | What can be done |
| - | - |
| **Draft** | Edit it and its lines freely. **Publish** puts it into use. Only a published template can be chosen for a new kit |
| **In use** | Its lines are fixed. **Start next version** makes a new draft carrying the same lines; **Retire** takes it out of use without changing the kits assembled to it |
| **Retired** | Out of use. **Start next version** can still bring it back as a new draft |

**Start next version** is not offered while a draft of the same template already exists.

A version no kit was assembled to can be deleted. Changing templates needs **Edit draft kit templates,
publish and retire them**; making one needs **Create kit templates**; deleting one needs **Delete kit
templates nothing was assembled from**.

**New template** asks for a **Code** (a short code people can type, such as FIELD-ENG, shared by every
version), a **Name** and a **Description**. A template starts as a draft.

### Template lines

**Add a line** on a draft adds one thing a kit holds.

| Field | What it means |
| - | - |
| **Line** | What this line is called on the kit — "Laptop", "Spare radio". Shown on the kit and on its handover document |
| **Category** | Any asset in this category, or in a category under it, fills the line |
| **Model** | Only assets of this model fill the line. Leave empty to accept any model |
| **Tool type** | For a line that holds a tool rather than an asset. Leave the category and model empty when you choose one |
| **Part** | For a line that holds stock from the store — fuses, cable ties, a spare filter. Leave the category, model and tool type empty when you choose one |
| **How many** | How many of this kind a kit holds |
| **Optional** | An optional line can be left empty. A kit missing a line that is not optional cannot be handed to anybody |

### Saving a kit as a template

An ad-hoc kit that turned out right can become a template. **Save as template** on the kit asks for a
**Code** and a **Name**, then makes a draft in which each asset becomes a line for its category, each
tool a line for its type and each part a line for itself, with how many the kit holds now. Narrow a
line to a model or mark one optional before you publish it.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.