Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
mvach committed Nov 10, 2024
1 parent 453b7cd commit 55e09f6
Showing 1 changed file with 23 additions and 5 deletions.
28 changes: 23 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# thwInventoryMerge
Dieses kleine Tool ermöglicht es, erfasstes Equipment mit den THW-Inventurdaten aus THWin zu mergen. Das Equipment wird dabei mittels Barcode-Scannern erfasst, die die gescannten Codes als CSV-Dateien speichern.
Das THW pflegt sein Equipment in THWin. Aus THWin können die entsprechenden Daten für Inventurzwecke als CSV exportiert werden.

Dieses kleine Tool ermöglicht es, das vorhandene Equipment mit den THW-Inventurdaten aus THWin zu mergen. Das Equipment kann dabei z. B. mittels Barcode-Scannern erfasst werden, die die gescannten Codes als CSV-Dateien speichern.

In den THW-Inventurdaten ist ein großer Teil des Equipments als geringwertiges Material (GWM) eingestuft. GWM-Equipment besitzt keine Inventarnummer und ist somit nur schwer automatisiert zu erfassen. Daher ermöglicht das Tool zusätzlich die Erzeugung sogenannter Pseudo-Inventarnummern für geringwertiges Material. Diese Pseudo-Inventarnummern setzen sich aus der Sachnummer und der nächsthöheren Inventarnummer der übergeordneten Ebene zusammen.

## Installation
Das Tool lädt man am einfachsten aus der [Releases-Sektion](https://github.com/mvach/thwInventoryMerge/releases) herunter und legt es in ein beliebiges leeres Verzeichnis (das `working_dir`).
Expand All @@ -16,9 +20,11 @@ Zudem erstellt man eine Konfigurationsdatei (`config.json`), die man auch in das
{
"inventory_csv_file_name": "20240101_Bestand_FGr_N.csv",
"columns": {
"equipment_layer": "Ebene",
"equipment_part_number": "Sachnummer",
"equipment_id": "Inventar Nr",
"equipment_count_actual": "Menge"
"equipment_count_target": "Menge Ist"
"equipment_count_actual": "Bestand IST",
"equipment_count_target": "Menge"
}
}
```
Expand Down Expand Up @@ -54,8 +60,20 @@ C:/

## Ausführung

Befinden sich alle Dateien gemeinsam im `working_dir`, kann die Datei `thwInventoryMerge.exe` einfach per Doppelklick ausgeführt werden.
Zur Ausführung öffnet man ein Terminal im `working_dir` und startet dort das Tool.

Zu Beginn einer Inventur ist es notwendig, die CSV-Datei aus THWin einmalig zu initialisieren. Dabei werden Pseudo-Inventarnummern sowie die Spalte "Bestand IST" im CSV (siehe `inventory_csv_file_name`) erstellt.

```bash
?>thwInventoryMerge.exe -i init
```

Anschließend können die Inventurdaten durch die Daten der Scanner ergänzt werden. Dazu reicht es, das Tool entweder per Doppelklick oder im Terminal aufzurufen.

```bash
?>thwInventoryMerge.exe
```

Nach der Ausführung wird im `working_dir` ein `result`-Verzeichnis erstellt, in dem sich eine Datei namens `result_<timestamp>.csv` befindet. Diese Datei enthält die zusammengeführten Inventurdaten.
Nach der Ausführung wird im `working_dir` ein Verzeichnis namens `result` erstellt, das eine Datei `result_<timestamp>.csv` enthält. Diese Datei beinhaltet die zusammengeführten Inventurdaten.

Jede weitere Ausführung erzeugt eine neue Datei `result_<timestamp>.csv`.

0 comments on commit 55e09f6

Please sign in to comment.