Files
obsidian/TallyFlow/Product/TallyFlow User's Guide.md
TNB e494ec0312 docs: Scout re-review to v0.6.2+14
Refresh product strategy, code review, User's Guide, and Dashboard after
latest tallyflow-assets-iot pull: Edge optional toggle, tag decode sheet,
Locate hit indicator, Collect clear/sort, SDG RAIN CIN filter fix.
2026-07-30 16:55:28 -04:00

198 lines
9.7 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# TallyFlow User's Guide
**Version:** July 2026
**Purpose:** This guide provides an overview of TallyFlows full product capabilities for operators, administrators, and systems integrators.
---
## Overview
TallyFlow is an asset tracking and management platform designed to reduce time and material waste in operations that rely on physical assets, tools, and tagged items. It combines mobile data capture, web-based core management, on-site printing/encoding, automated capture, and Edge connectivity.
TallyFlow is particularly well suited for industries requiring reliable identification and traceability, including manufacturing, logistics, rail, and agriculture.
**Core Value Proposition**
**TallyFlow Assets (Mobile) Highlights**
- Geiger-counter-style seek & find for locating one or multiple assets
- Lightweight inventory with optional zone moves
- Produce shipping workflows for FSMA 204 compliance
- Fast asset enrollment and editing
- Reduce time spent locating and managing assets
- Minimize material waste through better visibility and accountability
- Provide practical, affordable RFID, barcode, and Edge solutions for systems integrators
---
## Main Components
### 1. TallyFlow Core (Web Application)
The central web platform for managing assets, tags, categories, zones, and reporting.
**Integration hub (Core):** TallyFlow Assets (Mobile), TallyFlow Print, and TallyFlow Capture integrate with TallyFlow Core. **TallyFlow Edge** can feed Core (e.g. AMQP) or stand alone (CSV/REST). **TallyFlow Scout** connects to **Edge**, not Core, and does not replace Assets.
**Key Capabilities:**
- Add and manage assets manually
- View and search tagged items
- Import assets and tags via Excel
- Configure categories, zones, and organizational settings
- Reporting and exception management
- Zone notifications: configurable Alert Time (minutes) + email recipients for exceptions (e.g. asset in zone too long)
- Zone delete events for automatic tag recycling
- Parent/child asset handling (children can be detached while parent asset remains)
- Core web can display and filter photos with tags (integration with Capture app)
- Integration points for external systems (ERP via API and webhooks)
### 2. TallyFlow Assets (Mobile)
Core-connected mobile app for field asset work (`tallyflow_mobile`). **This is not TallyFlow Scout.**
**Key Capabilities:**
- Enroll new tags and associate them with assets
- Scan and update asset information in the field
- Lightweight inventory with optional zone moves
- Geiger-style seek & find for one or many assets
- **Scan-and-print** — trigger Print jobs from mobile enrollment/scan workflows
- Support for both barcode and RFID workflows
- Works offline with later synchronization to Core
**UX Design (Industrial Focus):**
- Built with Material 3
- Large, glove-friendly buttons prioritized for use in harsh industrial environments
### 3. TallyFlow Print
Desktop and mobile application (Flutter) paired with a Rust backend service for printing and encoding labels.
**Key Capabilities:**
- Print and encode RFID + barcode labels with ZPL support on Zebra and compatible printers
- Strong **GS1-128 / Case Label** support (GTIN-14 treated as case labels, proper AI (21) serial handling)
- Dedicated **FSMA 204** 300dpi label templates and ZPL configs for food traceability compliance
- Pre-configured **workflow profiles** for popular use cases including **FSMA**, **SSCC** (Serialized Shipping Container Code), and internal-use barcode/RFID labeling
- Support for Internal tags, GS1 case tags, parent/child tag structures
- **Parent container tags:** SDG RAIN assignment **8000** reserved for parent/container namespace (customer internal tags cannot use 8000)
- Retail GS1-128 companion barcodes can inject **per-unit AI (21)** serials so multi-unit jobs are not identical GTIN+lot barcodes
- Print-and-register **rejects** jobs when units would share identity tags (blocks Core collisions)
- CSV part-catalog import for parts + quantities to print
- Category names printed on labels
- Multiple printer management and connection testing
- Optional automatic registration of printed items as assets in TallyFlow Core
- Print job logging and history
- Windows, macOS, iOS, and Android support (enhanced Windows reliability)
**Backend Services:**
- Print API (job submission)
- Print Worker (ZPL delivery to printers)
- Orchestrator (category/zone proxy + Core registration)
### 4. TallyFlow Capture
Mobile photo documentation linked to barcodes, RFID, jobs/orders, and categories (formerly PhotoTag). iOS + Android apps with web review.
**Key Capabilities:**
- Capture photos tied to scanned IDs and categories
- Offline-friendly capture with later upload (categories cacheable; GPS fallback when address lookup fails)
- Library / detail review; full-resolution viewing
- **Public share collections** (web) for controlled external photo access
- Android: barcode symbology selection in Settings; highlight scanned barcodes
- Integrates with Core for tagged photo visibility where deployed
### 5. TallyFlow Edge
Site edge service for fixed and remote RFID/barcode readers. Runs as an always-on Windows or Linux service (repo `tallyflow-iot`).
**Key Capabilities:**
- Multi-reader management (e.g. Impinj, Zebra fixed readers; ATID ATF862 Master mode where supported)
- Unified tag stream with ops UI (start/stop, health, statistics)
- **Remote reader API** for handhelds — used by **TallyFlow Scout**
- Reader-side filtering (site-specific; validate before promising)
- Egress: CSV/spreadsheet, REST, AMQP → TallyFlow Core
- Keyboard wedge (+ optional lookup) into focused ERP/apps
- MCP read tools for AI copilots (health/readers/recent tags — not autonomous dock control by default)
- Compatible with Core in cloud or on-premises, or standalone without Core
### 6. TallyFlow Scout
Handheld Flutter app for **Edge** floors (`tallyflow-assets-iot`, app v0.6.x). **Does not replace TallyFlow Assets.**
**Three sections:**
- **Collect** — scan barcode/RFID; submit to Edge as a remote reader, or export CSV when Edge is offline/disabled; list clear/sort; tap a row for tag decode (GS1 / SDG RAIN / barcode AIs)
- **Verify** — GS1 barcode vs RFID EPC identity match (SGTIN/SSCC/GRAI/GIAI-style); optional auto-confirm
- **Locate** — seek-and-find by EPC/GTIN/part with geiger feedback and in-field hit indicator; works offline without Edge
**Settings:** optional **Use TallyFlow Edge** toggle (CSV/demo without health checks when off).
**Hardware:** Industrial Android scanners (e.g. Janam XR2, ATID, SEUIC, URFID); camera barcode fallback; desktop simulator for demos. EN/ES UI.
---
## Tag Ingestion Methods
TallyFlow supports multiple ways to bring tags and asset data into the system:
1. **TallyFlow Assets (Mobile)**
Field operators enroll, inventory, locate, and scan-and-print against Core.
2. **TallyFlow Core (Web)**
Manual asset creation with tag assignment.
3. **Excel Import**
Bulk import of assets and tag data via spreadsheet.
4. **TallyFlow Print**
On-demand tag printing and encoding with optional automatic Core registration. Supports prefix/serialization logic, parent/child relationships, and category-aware labeling.
5. **TallyFlow Capture**
Photo + barcode/RFID documentation into Capture/Core workflows.
6. **TallyFlow Edge (+ Scout)**
Fixed readers and Scout handheld Collect submit into the site edge feed (CSV/REST/AMQP/Core as configured).
---
## Hardware
TallyFlow is a **distributor** of Atid handheld RFID readers (such as the AT909) to systems integrators. These devices are commonly used for mobile scanning and enrollment workflows.
The platform also supports fixed RFID readers through **TallyFlow Edge**, and handheld industrial scanners for **Assets** and **Scout**.
**Note:** TallyFlow does not currently provide native support for AEI (Automatic Equipment Identification) tags used in the rail industry.
---
## Typical Workflows
- **Asset Onboarding:** Print/encode a tag using TallyFlow Print → optionally register in Core.
- **Field Operations (Core):** Use **Assets** to locate assets, update status, enroll, or scan-and-print.
- **Field Operations (Edge):** Use **Scout** Collect / Verify / Locate with Edge remote reader or offline CSV/locate.
- **Automated Receiving/Shipping:** Fixed readers via **Edge** detect tagged assets at docks/tunnels; Scout can add handheld reads to the same site feed.
- **Bulk Operations:** Import large numbers of assets via Excel.
- **Compliance & Traceability:** Use category, zone, tag, and Edge data for reporting and audit trails (e.g., FSMA 204 food traceability scenarios).
---
## Integrations
TallyFlow is designed to work alongside existing systems:
- Existing RFID infrastructure (Impinj, Zebra readers)
- IoT platforms and sensor networks
- Custom label formats via configurable templates
- Intermediary database integrations (e.g. BlueCherry)
---
## Current Limitations
- No native AEI rail tag support
- TallyFlow Print requires a local print server (Print API + Worker) for production use
- Some advanced rail-specific compliance features are not yet implemented
- Edge and Capture modules may require additional gateway hardware and configuration
---
## Getting Started
1. Work with your systems integrator to deploy TallyFlow Core and any required backend services (Print, Capture, Edge gateways).
2. Configure categories, zones, and org settings in Core.
3. Install the Mobile App, TallyFlow Print, and/or Capture/Edge components as needed.
4. Begin enrolling, printing, or automatically capturing tagged assets using the methods that best fit your operation.
For detailed Print-specific instructions, see the **TallyFlow Print User Guide**.
---
*This document is maintained in the TallyFlow Obsidian vault and should be updated as new capabilities are released.*