content(guide): customer-facing module guides across 13 SPAs (DRAFT, Refs #3)
62 plain-language audience:customer Overview guides, one per primary user-facing module (analytics/aria/claims/dashboard/devices/incident/msp/ profile/recon/reports/transactions/vault + fleet), authored by a per-module parallel pass grounded in each component's actual UI, mirroring the fleet.tasks voice. Existing hand-made guides were skipped, not overwritten. Deployed to guide.bcos.dev for review; all DRAFT. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This commit is contained in:
@@ -0,0 +1,25 @@
|
||||
---
|
||||
module: analytics.adoons
|
||||
title: Adoons Insights
|
||||
tab: Overview
|
||||
order: 10
|
||||
audience: customer
|
||||
---
|
||||
|
||||
Automatic, plain-language observations about your ATM fleet, surfaced by Adoons. Use this screen for a quick read on what's trending across your machines without digging through reports.
|
||||
|
||||
## 💡 What you can do here
|
||||
1. **Read active insights** — each card highlights something Adoons noticed in your fleet.
|
||||
2. **Refresh** — click **Refresh** to pull the latest insights.
|
||||
3. **Dismiss** — click the **✕** on a card to clear an insight once you've acted on it or no longer need it.
|
||||
|
||||
> When there's nothing to report, you'll see "No active fleet insights" — new ones appear as patterns emerge.
|
||||
|
||||
## 📇 What you're looking at
|
||||
Each insight card shows:
|
||||
- **Severity** — how much attention it needs: **CRITICAL**, **HIGH**, **MEDIUM**, **LOW**, or **INFO**.
|
||||
- **Category** — the area of the fleet the insight relates to.
|
||||
- **Time** — how long ago the insight was published (e.g. "2h ago").
|
||||
- **Title and detail** — a short headline plus a sentence or two explaining what Adoons observed.
|
||||
|
||||
> Good to know: Insights are colour-coded by severity, so red and orange cards are the ones worth looking at first.
|
||||
@@ -0,0 +1,35 @@
|
||||
---
|
||||
module: analytics.agents
|
||||
title: Agents
|
||||
tab: Overview
|
||||
order: 10
|
||||
audience: customer
|
||||
---
|
||||
|
||||
A quick health check on the HiveIQ agent software running across your ATM fleet. Use this screen to see which ATMs are online, which software versions they're running, and which ones need an update.
|
||||
|
||||
## 👀 What you're looking at
|
||||
|
||||
### Version Distribution
|
||||
A bar chart showing how many ATMs are on each agent software version. The version with the most ATMs has the longest bar, and the current release is marked with a green **latest** badge — so you can tell at a glance how much of your fleet is up to date.
|
||||
|
||||
### Connection Status
|
||||
A live count of your fleet broken into three groups, each with a percentage:
|
||||
- **Connected** — ATMs checking in normally.
|
||||
- **Disconnected** — ATMs that were online before but have gone quiet.
|
||||
- **Never Connected** — ATMs that have been added but have not yet reported in.
|
||||
|
||||
The **Latest** version is also shown here for reference.
|
||||
|
||||
### Outdated ATMs
|
||||
A list of the specific ATMs that are not yet on the latest version. If everything is current, you'll see a confirmation that all ATMs are on the latest version instead.
|
||||
|
||||
For each outdated ATM the table shows:
|
||||
- **ATM ID** — which machine it is.
|
||||
- **Version** — the agent version it's currently running.
|
||||
- **Last Seen** — how long ago it last checked in (for example, "2h ago" or "3d ago").
|
||||
- **Status** — whether it's currently Connected, Disconnected, or Never Connected.
|
||||
|
||||
## 💡 Good to know
|
||||
- This screen is view-only — it's a snapshot of fleet health, not a place to push updates.
|
||||
- An ATM that's **Disconnected** or **Never Connected** may need attention regardless of its software version.
|
||||
@@ -0,0 +1,37 @@
|
||||
---
|
||||
module: analytics.cash
|
||||
title: Cash Intelligence
|
||||
tab: Overview
|
||||
order: 10
|
||||
audience: customer
|
||||
---
|
||||
|
||||
A quick, fleet-wide view of how your ATM cash is doing — which machines are balanced, which are running low, and which have counting differences that need attention. Check it at the start of the day or before scheduling replenishments.
|
||||
|
||||
## 📊 What you can do here
|
||||
- See at a glance how many ATMs are **balanced** versus how many have a **variance**.
|
||||
- Spot machines that are **running low on cash** before they run empty.
|
||||
- Review machines with **counting differences** so you can follow up.
|
||||
|
||||
## 🔢 The summary numbers
|
||||
Four counts across the top give you the fleet snapshot:
|
||||
- **Balanced** — ATMs whose cash counts match, no issues.
|
||||
- **Variance** — ATMs where the counted amount doesn't match what's expected.
|
||||
- **Open Cycle** — ATMs with a cash cycle still in progress.
|
||||
- **Pending Conf.** — cash counts still waiting to be confirmed.
|
||||
|
||||
## 🪫 ATMs Near Empty
|
||||
A list of machines running low, lowest balance first so the most urgent are on top.
|
||||
- **ATM ID** — the machine.
|
||||
- **Est. Balance** — the estimated cash still available.
|
||||
- **Last Replenishment** — when it was last refilled.
|
||||
|
||||
> Rows highlighted in red are especially low on cash and should be prioritised for a refill.
|
||||
|
||||
## ⚖️ ATMs With Variance
|
||||
Machines where the cash count doesn't match, largest difference first.
|
||||
- **ATM ID** — the machine.
|
||||
- **Variance** — the size of the difference. A negative amount (shown in red) means cash is short.
|
||||
- **Cycle Status** — where that machine is in its current cash cycle.
|
||||
|
||||
> If either list shows "No ATMs…", there's nothing needing attention in that category right now.
|
||||
@@ -0,0 +1,32 @@
|
||||
---
|
||||
module: analytics.fleet-health
|
||||
title: Fleet Health
|
||||
tab: Overview
|
||||
order: 10
|
||||
audience: customer
|
||||
---
|
||||
|
||||
A one-glance summary of how your ATM fleet is doing right now — how many machines are online, what kinds of problems are happening, and which ATMs need the most attention. Check it at the start of the day or whenever you want a quick read on fleet health.
|
||||
|
||||
## 🔌 Connectivity
|
||||
The donut shows your whole fleet at a glance, with the big total in the center.
|
||||
|
||||
- **Connected** (green) — ATMs currently checking in.
|
||||
- **Disconnected** (red) — ATMs that were online but have gone quiet.
|
||||
- **Never connected** (grey) — ATMs registered but never yet reporting in.
|
||||
|
||||
The large percentage is the share of your fleet that's connected right now.
|
||||
|
||||
## 📊 Event Breakdown
|
||||
A ranked bar chart of recent events grouped by category, so you can see where the trouble is coming from — for example **Hardware**, **Network**, **Cash**, **Power**, **Auth**, **System**, or **Operations**. The longest bar is the most common type. If nothing has been reported, it shows "No events recorded."
|
||||
|
||||
## 🏧 Top Problematic ATMs
|
||||
A ranked list of the machines generating the most events, worst first. Each row shows the ATM's ID and its event count, so you know exactly which machines to prioritize for a service visit.
|
||||
|
||||
## 🚨 Alerts & Gaps
|
||||
Two headline numbers to watch:
|
||||
|
||||
- **Open Incidents** — issues currently open across the fleet.
|
||||
- **ATMs with Journal Gaps** — machines with missing stretches in their reporting, which can hint at a connection or logging problem.
|
||||
|
||||
> Good to know: This screen reflects your current fleet only, so the numbers update as machines reconnect and issues are resolved. Use the Top Problematic list and Open Incidents together to decide where to send help first.
|
||||
@@ -0,0 +1,39 @@
|
||||
---
|
||||
module: analytics.incidents
|
||||
title: Incident Trends
|
||||
tab: Overview
|
||||
order: 10
|
||||
audience: customer
|
||||
---
|
||||
|
||||
See how incidents across your ATM fleet are trending over time, which kinds of problems happen most, when they cluster, and which machines keep failing. Use this screen to spot patterns and get ahead of recurring issues.
|
||||
|
||||
## 📈 30-Day Incident Trend
|
||||
A line chart showing how many incidents were raised each day over the last 30 days.
|
||||
|
||||
- Rising line = incidents are climbing; falling line = things are settling down.
|
||||
- The date labels along the bottom mark the timeline.
|
||||
|
||||
> If there isn't enough history yet, you'll see "Not enough data."
|
||||
|
||||
## 🗂️ Event Category Breakdown
|
||||
A ranked bar chart of incidents grouped by the type of problem, largest first.
|
||||
|
||||
- Categories include **Hardware**, **Network**, **Cash**, **Power**, **Auth**, **System**, and **Operations**.
|
||||
- The number on the right is how many incidents fall into that category.
|
||||
|
||||
## 🔥 Peak Hours Heatmap
|
||||
A grid of the week (Mon–Sun down the side, hours 0–23 across the bottom) showing when incidents happen most.
|
||||
|
||||
- Darker cells mean quiet periods; brighter red cells mean busy ones.
|
||||
- Hover a cell to see the exact day, hour, and count.
|
||||
- Use this to plan maintenance and staffing around your busiest windows.
|
||||
|
||||
## 🔁 Recurring Failures
|
||||
A table of ATMs that keep hitting the same issue.
|
||||
|
||||
- **ATM** — the machine's ID.
|
||||
- **Event Type** — the specific fault it keeps reporting.
|
||||
- **Count** — how many times it's recurred. The badge turns yellow at 3+ and red at 5+, so high-repeat problems stand out.
|
||||
|
||||
> Good to know: a machine near the top of Recurring Failures is usually worth a closer look or a service visit — repeated faults often point to a root cause that a single fix can clear.
|
||||
@@ -0,0 +1,31 @@
|
||||
---
|
||||
module: analytics.transactions
|
||||
title: Transactions
|
||||
tab: Overview
|
||||
order: 10
|
||||
audience: customer
|
||||
---
|
||||
|
||||
A daily snapshot of transaction activity across your ATM fleet. Use it to see how much journal data is coming in, whether it is being read correctly, and which machines are busiest or missing records.
|
||||
|
||||
## 👀 What you can do here
|
||||
1. Check **today's journal volume** at a glance to confirm your fleet is reporting activity.
|
||||
2. See how reliably journals are being read with the **parse success rate**.
|
||||
3. Spot machines that are missing records under **open journal gaps**.
|
||||
4. Identify your busiest ATMs in the **Top 10 by transaction volume** list.
|
||||
|
||||
> This screen is view-only — it refreshes to show the latest fleet activity.
|
||||
|
||||
## 📊 What you're looking at
|
||||
|
||||
**Today's Journal Volume** — A bar chart of daily activity. Each bar is split into **Successful** (green) records that were read cleanly and **Failed** (red) records that could not be read. Dates run along the bottom.
|
||||
|
||||
**Parse Success Rate** — The share of today's journals that were read successfully, shown as a percentage. Green means healthy (95%+), amber is a warning (80–95%), and red flags a problem (below 80%).
|
||||
|
||||
**Open Journal Gaps** — The total number of unresolved gaps, meaning stretches where expected journal records are missing.
|
||||
|
||||
**ATMs With Gaps (Top 10)** — A list of the machines with the most open gaps, each showing its **ATM ID** and **Gap Count** — a quick shortlist of where to look first.
|
||||
|
||||
**Top 10 ATMs by Transaction Volume (Today)** — Your busiest machines ranked by transaction count, with a bar showing each one relative to the top performer.
|
||||
|
||||
> **Good to know:** A high failure rate or a growing gap count usually points to a machine that has stopped reporting cleanly — a good prompt to check that ATM before records are lost.
|
||||
@@ -0,0 +1,43 @@
|
||||
---
|
||||
module: analytics.uptime
|
||||
title: Uptime
|
||||
tab: Overview
|
||||
order: 10
|
||||
audience: customer
|
||||
---
|
||||
|
||||
See at a glance how available your ATM fleet is right now and how it has been trending. Use this screen for a quick health check or when you need to spot machines that are currently offline.
|
||||
|
||||
## 📊 What you can do here
|
||||
|
||||
- Read the **live availability score** for your fleet at this moment.
|
||||
- Compare it against the **7-day** and **30-day** averages to see if things are improving or slipping.
|
||||
- Check how many ATMs are **down right now** and how many have **never connected**.
|
||||
- Follow the **30-day trend line** to see good and bad days across the month.
|
||||
- Review the list of **ATMs currently down**, including how long each has been offline.
|
||||
|
||||
## 🔎 What you're looking at
|
||||
|
||||
**Top cards**
|
||||
|
||||
- **NOW** — the percentage of your ATMs that are online this moment.
|
||||
- **7-DAY AVG** — average availability over the past week.
|
||||
- **30-DAY AVG** — average availability over the past month.
|
||||
- **CURRENTLY DOWN** — the number of ATMs offline right now, out of your total fleet. If everything is online you'll see **All online**. A small badge also shows any machines that have **never connected**.
|
||||
|
||||
> The rings are colour-coded: green is healthy (95% and above), amber is a warning (80–94%), and red means attention is needed (below 80%).
|
||||
|
||||
**30-Day Uptime Trend**
|
||||
|
||||
- A line chart of daily availability over the last 30 days, with guide marks at 80%, 90% and 100%. The dot on the far right is today.
|
||||
|
||||
**ATMs Currently Down**
|
||||
|
||||
- **ATM** — the machine's ID.
|
||||
- **Status** — its current connection state (for example, Disconnected).
|
||||
- **Down Since** — how long the ATM has been offline.
|
||||
|
||||
## 💡 Good to know
|
||||
|
||||
- This screen refreshes with the latest data each time you open it — no buttons to press.
|
||||
- If the trend chart shows **Not enough data**, the fleet simply hasn't been reporting long enough yet to draw a line.
|
||||
@@ -0,0 +1,40 @@
|
||||
---
|
||||
module: aria.dashboard
|
||||
title: Threat Dashboard
|
||||
tab: Overview
|
||||
order: 10
|
||||
audience: customer
|
||||
---
|
||||
|
||||
Your at-a-glance view of security activity across your ATM fleet. Open this screen for a quick read on threats, alerts, and device security posture — and to jump straight to the details that need attention.
|
||||
|
||||
## 👀 What you're looking at
|
||||
|
||||
The dashboard is grouped into three sections of summary cards.
|
||||
|
||||
### 🛡️ Threat Activity
|
||||
- **Total Events** — the total number of threat-related events recorded across your fleet.
|
||||
- **Critical** — the count of critical-severity events, your highest-priority items.
|
||||
- **High** — the count of high-severity events.
|
||||
- **Active Sequences** — ongoing alert sequences, where a series of related events points to a possible attack in progress.
|
||||
|
||||
### 🔒 Compliance
|
||||
- **Active IOCs** — the number of active Indicators of Compromise being watched for across the fleet.
|
||||
- **Low Posture** — devices with a security posture score below 50, meaning they may need attention.
|
||||
- **EOL Devices** — end-of-life devices that are no longer fully supported and carry extra risk.
|
||||
- **Non-Critical Events** — all remaining events that aren't critical or high severity.
|
||||
|
||||
## 🖱️ What you can do here
|
||||
|
||||
1. Click the **Critical** or **High** card to open the matching list of threat events.
|
||||
2. Click **Active Sequences** to review the current alerts.
|
||||
3. Click **Active IOCs** to manage your Indicators of Compromise.
|
||||
4. Click **Low Posture** or **EOL Devices** to open device posture and see which machines need attention.
|
||||
|
||||
> **Total Events** and **Non-Critical Events** are summary counts only — they aren't clickable.
|
||||
|
||||
## 🧭 Phase Coverage
|
||||
|
||||
Below the summary cards is a reference list showing the attack phases HiveIQ watches for — Physical Access, Malware Staging, Malware Execution, Persistence, and Cleanup — each with a short description of what it means. This is a guide to the kinds of activity being monitored across your fleet.
|
||||
|
||||
> **Good to know:** The figures update each time you open the dashboard, so it's a reliable starting point for your daily security check. Start with the Critical card, then work down.
|
||||
@@ -0,0 +1,38 @@
|
||||
---
|
||||
module: aria.device-posture
|
||||
title: Device Posture
|
||||
tab: Overview
|
||||
order: 10
|
||||
audience: customer
|
||||
---
|
||||
|
||||
Device Posture gives you a per-device security health check across your fleet. Use it to spot machines that are out of compliance — unencrypted disks, outdated operating systems, or images that have drifted from your approved build.
|
||||
|
||||
## 🔍 What you can do here
|
||||
|
||||
1. **Browse devices by institution** — devices are grouped under a collapsible institution header. Click a header to expand or collapse its list. Each header shows the device count, an average score, and a **⚠ below 80** flag if any device needs attention.
|
||||
2. **Filter the list** — open the **Filters** sidebar on the left and narrow by:
|
||||
- **Score** — *Low (<50)* or *Below Good (<80)*.
|
||||
- **OS Status** — *EOL*, *Supported*, or *Unknown*.
|
||||
3. **Clear filters** — active filters appear as chips at the top; remove one with its **×**, or use **✕ Clear all** in the sidebar.
|
||||
4. **Open device detail** — click any row (or its **Detail** button) to slide open a panel with the full breakdown for that device.
|
||||
5. **Stay current** — the screen auto-refreshes every 60 seconds. Toggle **Auto-refresh** off if you prefer, or hit the **↻** button to refresh right now.
|
||||
|
||||
## 📊 What you're looking at
|
||||
|
||||
Each device row shows:
|
||||
|
||||
- **Device** — the device's agent ID.
|
||||
- **OS Version** / **OS Status** — the operating system and whether it's still *Supported* or has reached end-of-life (*EOL*).
|
||||
- **Disk Enc.** — whether disk encryption is on (✓) or off (✗).
|
||||
- **Audit Policy** — whether the device meets the audit policy (✓/✗).
|
||||
- **Whitelist** — whether software whitelisting is enabled (✓/✗).
|
||||
- **Image** — **Match** if the device matches your approved (gold) image, or **Drift** if it has changed.
|
||||
- **Score** — an overall posture score from 0–100 (green = good, amber = needs review, red = poor).
|
||||
- **Last Check** — when the device last reported its posture.
|
||||
|
||||
## 🗂️ Device detail panel
|
||||
|
||||
Opening a device shows its big **Posture Score** plus each check that affects it — Disk Encryption, Audit Policy, Software Whitelist, OS Version, and OS EOL Status. Failing checks display the point penalty they cost (for example, a device with encryption off shows **−25**). The panel also shows the approved and current image references so you can see exactly where a device drifted, along with the last posture check and record update times.
|
||||
|
||||
> **Good to know:** A higher score is better — anything below 80 is worth a look. If a device shows no posture data, it simply hasn't reported yet through the ARIA signals module.
|
||||
@@ -0,0 +1,40 @@
|
||||
---
|
||||
module: aria.ioc-feeds
|
||||
title: IOC Feeds
|
||||
tab: Overview
|
||||
order: 10
|
||||
audience: customer
|
||||
---
|
||||
|
||||
Keeps HiveIQ's threat intelligence up to date by pulling the latest known-bad indicators from trusted public sources. Use this screen to check that each feed is healthy and to pull in fresh threats on demand.
|
||||
|
||||
## 🛰️ The Feeds
|
||||
Three threat intelligence sources are tracked:
|
||||
- **AlienVault OTX** — community-shared threat indicators.
|
||||
- **MalwareBazaar** — known malware samples and signatures.
|
||||
- **ThreatFox** — active attack indicators.
|
||||
|
||||
## 🔄 What you can do here
|
||||
1. Click **Run All Feeds** to refresh every feed at once.
|
||||
2. Click **↻ Run Feed** on any single card to refresh just that source.
|
||||
3. Click **Refresh** to reload the latest status and history without pulling new data.
|
||||
|
||||
> Status updates on its own every 30 seconds while you have the screen open.
|
||||
|
||||
## 📇 What each feed card shows
|
||||
- **Status badge** — Success, Error, Running, or Never run.
|
||||
- **Configured** vs **API key required** — a feed tagged *API key required* still needs a key before it can run, and its **Run Feed** button stays disabled until then.
|
||||
- **Last run** — how long ago the feed was pulled.
|
||||
- **IOCs added** — new indicators brought in on the last run.
|
||||
- **Updated** — existing indicators refreshed on the last run.
|
||||
|
||||
## 📜 Run history
|
||||
The table below the cards lists every feed run, newest first:
|
||||
- **Feed** — which source ran.
|
||||
- **Started** — when the run began.
|
||||
- **Duration** — how long it took.
|
||||
- **Status** — the result of that run.
|
||||
- **Added** / **Updated** — how many indicators were brought in or refreshed.
|
||||
- **Error** — a short reason if a run failed (hover to read the full message).
|
||||
|
||||
> **Good to know:** A run marked *Error* usually points to a feed that still needs an API key or a source that was temporarily unreachable — try running it again, and check the Error column if it keeps failing.
|
||||
@@ -0,0 +1,36 @@
|
||||
---
|
||||
module: aria.ioc-management
|
||||
title: IOC Management
|
||||
tab: Overview
|
||||
order: 10
|
||||
audience: customer
|
||||
---
|
||||
|
||||
Your watchlist of known threat indicators. Use this screen to review, add, and retire the Indicators of Compromise (IOCs) HiveIQ watches for across your fleet — for example a malicious filename, service, or address flagged in an FBI FLASH or FS-ISAC alert.
|
||||
|
||||
## 🔎 What you can do here
|
||||
- **Filter by type** — open the Filters panel and pick one or more IOC types (Filename, MD5, Registry Key, Directory, Service Name, IP, File Path). Selected filters show as chips you can remove.
|
||||
- **Show inactive** — tick this in the Filters panel to include retired indicators alongside active ones.
|
||||
- **Add an IOC** — click **+ Add IOC** to add a new indicator to the watchlist.
|
||||
- **Edit** — update an existing indicator's description, source, confidence, or expiry.
|
||||
- **Deactivate** — retire an indicator so it no longer triggers detections (you'll be asked to confirm).
|
||||
|
||||
## 📝 Adding or editing an IOC
|
||||
1. Click **+ Add IOC** (or **Edit** on a row).
|
||||
2. Choose the **IOC Type** and enter the **Value** — both are required (for example `atmii.exe` or `C:/Temp/atr/`).
|
||||
3. Optionally add a **Description**, a **Source Reference** (such as an FBI FLASH number), a **Confidence** level, and an **Expires** date.
|
||||
4. Click **Add IOC** / **Update** to save.
|
||||
|
||||
> The IOC Type can't be changed once an indicator has been created — deactivate it and add a new one if the type was wrong.
|
||||
|
||||
## 📊 What you're looking at
|
||||
Each row is one indicator on the watchlist:
|
||||
- **Type** — what kind of indicator it is (filename, address, registry key, and so on).
|
||||
- **Value** — the exact thing being watched for.
|
||||
- **Description** — a short note on what it means.
|
||||
- **Source** — where it came from: FBI FLASH, FS-ISAC, or a Manual entry.
|
||||
- **Confidence** — how strong the indicator is: High, Medium, or Low.
|
||||
- **Added** / **Expires** — when it was added and when it stops being watched (if an expiry was set).
|
||||
- **Status** — Active indicators trigger detections; Inactive ones are retired and dimmed in the list.
|
||||
|
||||
> **Good to know:** Deactivating never deletes an indicator — it simply stops detections. Turn on **Show inactive** any time to review or edit past entries.
|
||||
@@ -0,0 +1,35 @@
|
||||
---
|
||||
module: aria.precursor-alerts
|
||||
title: Precursor Alerts
|
||||
tab: Overview
|
||||
order: 10
|
||||
audience: customer
|
||||
---
|
||||
|
||||
Precursor Alerts flags devices where a series of warning signs points to an attack building up — such as the early steps of jackpotting (cash-out) or card skimming. Use this screen to spot these multi-step patterns early, review what happened, and clear each alert once your team has looked into it.
|
||||
|
||||
## 🔎 What you can do here
|
||||
- **Scan active alerts** — the list opens showing alerts that still need attention.
|
||||
- **Open the filters** using the ▶ arrow on the left, then narrow the list by:
|
||||
- **Device ID** — type a device to see only its alerts.
|
||||
- **Status** — Active, Resolved, or All.
|
||||
- **Type** — Jackpotting, Skimming, or Unknown.
|
||||
- **Clear all** filters at once with the ✕ button, or remove one at a time using the filter chips above the table.
|
||||
- **View the details** — click any row (or the **Events** button) to open a side panel showing every warning signal that made up the sequence.
|
||||
- **Resolve an alert** — click **Resolve** on a row, or **Mark Resolved** in the detail panel, once it's been reviewed or handled.
|
||||
- **Auto-refresh** keeps the list current on its own; the toggle in the top-right lets you turn it off, and the ↻ button refreshes on demand.
|
||||
|
||||
## 📊 What you're looking at
|
||||
Each row is one detected sequence:
|
||||
- **Type** — the kind of attack the pattern suggests: 💰 Jackpotting, 💳 Skimming, or ❓ Unknown.
|
||||
- **Device** — the ATM or device where the pattern was seen.
|
||||
- **Phases Detected** — the stages of the attack that were spotted, shown as chips.
|
||||
- **Confidence** — how strongly the signs point to a real attack, shown as a bar and percentage. Green is lower confidence, orange is medium, and red is high.
|
||||
- **Triggered** — when the pattern was first flagged.
|
||||
- **Status** — **Active** (needs attention) or **Resolved** (already handled).
|
||||
|
||||
Open the detail panel to see the individual **Events in Sequence** — each warning signal, its attack phase, when it was detected, and how severe it was.
|
||||
|
||||
## 💡 Good to know
|
||||
- A higher confidence percentage means more of the tell-tale steps lined up — treat red, high-confidence alerts as most urgent.
|
||||
- Resolving an alert records who cleared it and moves it out of the Active list; you can always switch Status to **Resolved** or **All** to review past alerts.
|
||||
@@ -0,0 +1,32 @@
|
||||
---
|
||||
module: aria.threat-events
|
||||
title: Threat Events
|
||||
tab: Overview
|
||||
order: 10
|
||||
audience: customer
|
||||
---
|
||||
|
||||
A running list of suspicious activity HiveIQ has spotted across your ATM fleet. Use this screen to see what was detected, how serious it is, and which device it happened on.
|
||||
|
||||
## 🔎 What you can do here
|
||||
1. **Browse detected events** — the newest activity across your fleet appears at the top.
|
||||
2. **Filter by severity** — open the **Filters** panel and pick a severity (Critical, High, Medium, Low, or Info) to focus on what matters most.
|
||||
3. **Search by device** — type a Device (Agent) ID in the Filters panel to see events for one machine.
|
||||
4. **Clear filters** — use **Clear all** to return to the full list.
|
||||
5. **Stay current** — the list auto-refreshes every 60 seconds. Toggle **Auto-refresh** off if you'd rather it hold still, or press the **↻ refresh** button to update on demand.
|
||||
|
||||
> The counter next to the Filters panel and in the toolbar shows how many events match your current view.
|
||||
|
||||
## 📋 What you're looking at
|
||||
Each row is one detected event:
|
||||
|
||||
- **Severity** — how serious it is, from Critical down to Info.
|
||||
- **Signal** — a short description of the behavior that was flagged.
|
||||
- **Device** — the ATM (Agent ID) where it was detected.
|
||||
- **Attack Phase** — where the activity fits in a typical attack: Physical Access, Staging, Execution, Persistence, or Cleanup.
|
||||
- **IOC Match** — the known threat indicator that was matched, along with its type.
|
||||
- **Detected** — when the event was seen.
|
||||
|
||||
## 💡 Good to know
|
||||
- Sort your attention by **severity** first — Critical and High events are the ones worth acting on right away.
|
||||
- The **Attack Phase** helps you gauge how far along a threat may be; earlier phases (Physical Access, Staging) are warning signs, later ones (Execution, Persistence, Cleanup) need urgent follow-up.
|
||||
@@ -0,0 +1,50 @@
|
||||
---
|
||||
module: claims.claim-detail
|
||||
title: Claim Detail
|
||||
tab: Overview
|
||||
order: 10
|
||||
audience: customer
|
||||
---
|
||||
|
||||
The Claim Detail panel opens when you select a shortage claim. Use it to review the claim, keep it moving toward resolution, and coordinate with your cash and service vendors — all in one place.
|
||||
|
||||
## 📋 Overview Tab
|
||||
The main view of the claim.
|
||||
|
||||
1. Read the key facts at a glance: claim number, terminal, location, loss period, and shortage amount.
|
||||
2. Click **Edit** to update the claim.
|
||||
3. You can change the **Claim Type** (Withdraw or Deposit), move the **Status** forward, and assign or clear the **CIT Vendor** and **SP Vendor**.
|
||||
4. Click **Save**.
|
||||
|
||||
### What you're looking at
|
||||
- **Shortage** — the dollar amount in dispute for this claim.
|
||||
- **Loss Start / Loss End** — the date range the shortage covers.
|
||||
- **CIT Vendor / SP Vendor** — the cash-in-transit and service provider parties assigned to the claim.
|
||||
- **Status** — where the claim stands: Open, Waiting CIT, Waiting SP, Waiting Institution, Pending Payment, or a Resolved outcome (Paid, Offage Found, or Denied).
|
||||
- **Submitted / Filed / Updated** — key dates for the claim's lifecycle.
|
||||
|
||||
## 💬 Messages Tab
|
||||
Send and track messages with the vendors on the claim.
|
||||
|
||||
1. Use the dropdown to view **All messages** or filter to one vendor.
|
||||
2. Pick a vendor to message, or leave it on "All messages" and add a **recipient email** to reach someone else.
|
||||
3. Type your message and click **Send**.
|
||||
|
||||
> Your own messages appear on the right; vendor replies appear on the left.
|
||||
|
||||
## 📎 Files Tab
|
||||
Keep supporting documents attached to the claim.
|
||||
|
||||
1. Click **+ Upload File** to add transaction logs, reconciliation reports, or service records.
|
||||
2. Click any file name to download it.
|
||||
|
||||
## 🔒 Notes Tab
|
||||
Add **internal notes** for your team. These are private to your institution and are never shown to vendors.
|
||||
|
||||
## 💵 Payment Tab
|
||||
Track who owes what and how much has been paid.
|
||||
|
||||
1. Each assigned party (Institution, and CIT/SP when set) has its own card showing **Owed**, **Paid**, and the remaining **Balance**.
|
||||
2. Click **Edit** on a card to update the owed or paid amounts, then **Save**.
|
||||
|
||||
> The shortage is split across the assigned parties. Assigning a vendor later adds their card without re-splitting existing amounts.
|
||||
@@ -0,0 +1,50 @@
|
||||
---
|
||||
module: claims.dashboard
|
||||
title: Claims Dashboard
|
||||
tab: Overview
|
||||
order: 10
|
||||
audience: customer
|
||||
---
|
||||
|
||||
Your home base for tracking ATM cash shortage loss recovery. Use it to see every open claim at a glance, check how much money is at stake, and jump into any claim that needs attention.
|
||||
|
||||
## 📊 What you're looking at
|
||||
|
||||
At the top of the screen are summary cards for your institution:
|
||||
|
||||
- **Active Claims** — how many claims are still being worked.
|
||||
- **Deposit Exposure** — total dollars at risk on deposit-type claims.
|
||||
- **Withdraw Exposure** — total dollars at risk on withdrawal-type claims.
|
||||
- **Awaiting Response** — claims waiting on a reply from a party involved.
|
||||
- **Deposit Recovered YTD** — deposit dollars recovered so far this year.
|
||||
- **Withdraw Recovered YTD** — withdrawal dollars recovered this year, plus your overall recovery percentage.
|
||||
|
||||
## 🔍 What you can do here
|
||||
|
||||
1. **File a new claim** — click **+ File New Claim** to start recording a shortage.
|
||||
2. **Open a claim** — click any row in the table to view its full detail.
|
||||
3. **Filter the list** — open the **Filters** panel on the left to narrow things down:
|
||||
- Search by **Claim #**.
|
||||
- Search by **Terminal ID**.
|
||||
- Filter by one or more **Status** values (Open, Waiting CIT, Waiting SP, Waiting Institution, Pending Payment, Resolved – Paid, Resolved – Offage Found, Resolved – Denied).
|
||||
- Click **✕ Clear all** to reset every filter.
|
||||
4. **Sort** — click a column header (Claim #, Terminal, Loss Period, Shortage, Status, Submitted, Updated) to reorder the list.
|
||||
5. **Refresh** — the list refreshes on its own every 60 seconds. Toggle **Auto-refresh** off if you'd rather it hold still, or click the refresh button to update immediately.
|
||||
|
||||
## 📋 The claims table
|
||||
|
||||
Each row is one claim:
|
||||
|
||||
- **Claim #** — the reference number for the shortage.
|
||||
- **Terminal / Location** — which ATM and where it sits.
|
||||
- **Loss Period** — when the shortage occurred.
|
||||
- **Shortage** — the dollar amount short.
|
||||
- **Type** — **Deposit** or **Withdraw**.
|
||||
- **Status** — where the claim is in the recovery process.
|
||||
- **CIT Vendor / SP Vendor** — the cash-in-transit and service-provider partners assigned to the claim (a dash means none assigned yet).
|
||||
- **Submitted / Updated** — when the claim was filed and last changed.
|
||||
|
||||
## 💡 Good to know
|
||||
|
||||
- A claim with a new update is marked with an amber stripe down its left edge, so you can spot what's changed at a glance.
|
||||
- The count above the table always reflects your current filters, so you know exactly how many claims match.
|
||||
@@ -0,0 +1,26 @@
|
||||
---
|
||||
module: claims.settings
|
||||
title: Settings
|
||||
tab: Overview
|
||||
order: 10
|
||||
audience: customer
|
||||
---
|
||||
|
||||
The Settings screen shows how outgoing messages to your vendors are configured. Check here when you want to confirm which email template is applied to the messages you send to your CIT and service provider vendors.
|
||||
|
||||
## ✉️ Email Template
|
||||
|
||||
This screen displays the email template used whenever you send a message to a vendor from a claim. There is nothing to fill in here — it's a read-only view of what's currently in effect.
|
||||
|
||||
## 👀 What you're looking at
|
||||
|
||||
Depending on your setup, you'll see one of three things:
|
||||
|
||||
- **Active Template** — a custom template set up for your institution. Shows the template **name** and the **subject line** that goes out with your vendor messages.
|
||||
- **Global Template (inherited)** — the system-wide default template. Shows the same name and subject, and a note that this is the shared default rather than one of your own.
|
||||
- **No template configured** — no template is set, so messages fall back to a built-in default.
|
||||
|
||||
## 💡 Good to know
|
||||
|
||||
- To set up or change a template for your institution, contact your administrator — templates can't be edited from this screen.
|
||||
- If you see the global or fallback template and want your own branding or wording, that's the cue to reach out to your administrator.
|
||||
@@ -0,0 +1,37 @@
|
||||
---
|
||||
module: claims.vendors
|
||||
title: Vendors
|
||||
tab: Overview
|
||||
order: 10
|
||||
audience: customer
|
||||
---
|
||||
|
||||
Your registry of the outside companies you work with on cash shortage claims. Set them up here first so you can assign them to a claim when you file one.
|
||||
|
||||
## 👥 What You're Looking At
|
||||
|
||||
The screen splits your vendors into two groups:
|
||||
|
||||
- **CIT — Cash-in-Transit** — the companies that transport and load cash into your ATMs.
|
||||
- **SP — Service Provider** — the companies that service and maintain your machines.
|
||||
|
||||
A count at the top shows how many vendors you have in total, and each group shows its own count.
|
||||
|
||||
## ➕ What You Can Do Here
|
||||
|
||||
1. Click **+ Add Vendor** in the toolbar to register a new CIT or SP company.
|
||||
2. Review your existing vendors in the CIT and SP tables below.
|
||||
|
||||
## 📋 Vendor Details
|
||||
|
||||
Each vendor row shows:
|
||||
|
||||
- **Name** — the company name.
|
||||
- **Contact** — your main point of contact there.
|
||||
- **Email** — the contact's email address.
|
||||
- **Phone** — the contact's phone number.
|
||||
- **Added** — the date the vendor was registered.
|
||||
|
||||
Any detail that hasn't been filled in shows a dash (—).
|
||||
|
||||
> **Good to know:** Register your CIT and SP companies here before filing a claim — you can only assign a vendor to a claim once it exists in this registry. Your vendors are private to your institution.
|
||||
@@ -0,0 +1,40 @@
|
||||
---
|
||||
module: dashboard.cash-stats
|
||||
title: Cash Stats
|
||||
tab: Overview
|
||||
order: 10
|
||||
audience: customer
|
||||
---
|
||||
|
||||
A fleet-wide view of how much cash is in each ATM's cassettes, based on the latest inventory each machine reported. Use it to spot machines running low or empty before customers do, and to plan cash replenishment runs.
|
||||
|
||||
## 👀 What you're looking at
|
||||
|
||||
Each row is one ATM, showing its name, the time it last reported, and a strip of coloured pills — one per cassette.
|
||||
|
||||
- **[position]** — the cassette slot on the machine.
|
||||
- **$denomination** — the bill value in that cassette (e.g. $20).
|
||||
- **(count)** — how many bills are currently loaded.
|
||||
- **$total** — the cash value in that cassette (denomination × bill count).
|
||||
|
||||
Pill and row colours tell you the status at a glance:
|
||||
|
||||
- 🟢 **OK** — plenty of bills.
|
||||
- 🟡 **Low** — 200 bills or fewer; schedule a refill soon.
|
||||
- 🔴 **Empty** — 0 bills; this cassette can no longer dispense.
|
||||
- ⚪ **No data** — the ATM hasn't reported cash inventory (or only sent configuration, not counts).
|
||||
|
||||
Rows are automatically sorted so the machines needing attention — empty first, then low — sit at the top.
|
||||
|
||||
## 🖱️ What you can do here
|
||||
|
||||
1. Use the **Empty**, **Low**, **OK**, and **No Data** cards at the top to see a live count of ATMs in each state.
|
||||
2. Click any card to filter the list to just those ATMs. Click it again (or the same card) to clear the filter and show all.
|
||||
3. Click the **↻ Refresh** button to pull the latest inventory on demand.
|
||||
|
||||
> The screen refreshes on its own about once a minute, so the counts stay current without you doing anything.
|
||||
|
||||
## 💡 Good to know
|
||||
|
||||
- Times show when each ATM last sent an inventory report — a stale time can mean the machine hasn't checked in recently.
|
||||
- Cassettes marked "no data" are set up on the machine but haven't reported an actual bill count yet.
|
||||
@@ -0,0 +1,38 @@
|
||||
---
|
||||
module: dashboard.overview
|
||||
title: Fleet Overview
|
||||
tab: Overview
|
||||
order: 10
|
||||
audience: customer
|
||||
---
|
||||
|
||||
Your at-a-glance home screen for the whole ATM fleet. Open it to see how many machines are online, what's going wrong right now, and what work is in progress.
|
||||
|
||||
## 🔢 The Top Numbers
|
||||
Four cards summarize the fleet at a glance:
|
||||
1. **Total ATMs** — every machine in your fleet, with how many are online.
|
||||
2. **Connected** — machines currently reporting in, and what share of the fleet that is.
|
||||
3. **Open Incidents** — active issues across the fleet, including how many are critical.
|
||||
4. **Active Tasks** — fleet jobs in progress, split into pending and running.
|
||||
|
||||
## 🩺 Fleet Health
|
||||
1. See a bar for **Connected**, **Disconnected**, and **Never Connected** machines, each with a live count.
|
||||
2. Under **By Model**, view your top ATM models and how many of each you have.
|
||||
|
||||
> "Never Connected" means the machine has been added but has not yet checked in.
|
||||
|
||||
## 📦 Fleet Operations
|
||||
- Task counts broken out as **Total**, **Pending**, **Running**, **Completed**, and **Failed**.
|
||||
- **Artifacts** and **Modules Reporting** totals for the fleet.
|
||||
- A quick count of **incidents this week**.
|
||||
|
||||
## 🚨 Recent Incidents
|
||||
1. Review the latest open incidents in one list.
|
||||
2. Each row shows the **ATM**, issue **Type**, **Severity**, and when it was **Opened**.
|
||||
3. Use **View all** to jump to the full Incidents app.
|
||||
|
||||
> If everything is healthy, this list simply reads "No open incidents."
|
||||
|
||||
## 🔄 Keeping It Current
|
||||
- The screen **auto-refreshes** every 60 seconds — the toggle shows the countdown.
|
||||
- Turn auto-refresh off, or press the **refresh** button, to update on your own schedule.
|
||||
@@ -0,0 +1,33 @@
|
||||
---
|
||||
module: devices.agent-profile
|
||||
title: Agent Profile
|
||||
tab: Overview
|
||||
order: 10
|
||||
audience: customer
|
||||
---
|
||||
|
||||
Agent Profiles let you group your ATMs by hardware type so each machine only receives the software modules it actually needs. Use this screen when you add a new make of ATM to your fleet or want to control which features run on which machines.
|
||||
|
||||
## 🗂️ What you can do here
|
||||
1. **Add a profile** — click **+ Add Profile**, then give it a key (lowercase, no spaces, e.g. `hyosung`), a label, and an optional description.
|
||||
2. **Edit a profile** — click **Edit** on any row to change its label, description, sort order, or status.
|
||||
3. **Search** — use the search box to quickly find a profile by key or label.
|
||||
4. **See what's included** — click the module count in the **Modules** column to expand the full list of modules that profile installs.
|
||||
5. **Enable or disable** — turn a profile on so its ATMs receive modules, or off to pause provisioning.
|
||||
6. **Delete a profile** — click **Delete** to remove one you no longer need.
|
||||
|
||||
> ATMs are matched to a profile in their device detail page, or in bulk from a group.
|
||||
|
||||
## 📋 What you're looking at
|
||||
Each row is one hardware profile:
|
||||
|
||||
- **Key** — the short code that ties this profile to the machines that use it.
|
||||
- **Label** — the friendly name shown across the app.
|
||||
- **Description** — an optional note describing the profile.
|
||||
- **Modules** — how many software modules ATMs on this profile receive. A **+ exclusive** badge means some modules only ever install on this profile.
|
||||
- **Status** — **Active** (ATMs receive modules) or **Disabled** (paused).
|
||||
|
||||
## 💡 Good to know
|
||||
- A ★ marks an **exclusive** module — it installs only on ATMs with that profile. All other modules install on every ATM regardless of profile.
|
||||
- A profile **can't be deleted** while any ATMs are still assigned to it — reassign those machines first.
|
||||
- The **Sort Order** value controls where a profile appears in the list; lower numbers sort first.
|
||||
@@ -0,0 +1,38 @@
|
||||
---
|
||||
module: devices.agent-scripts
|
||||
title: Agent Scripts
|
||||
tab: Overview
|
||||
order: 10
|
||||
audience: customer
|
||||
---
|
||||
|
||||
Store reusable scripts here and send them out to your ATMs when you need to run a routine maintenance or housekeeping task across the fleet.
|
||||
|
||||
## 📋 What you're looking at
|
||||
|
||||
The list shows every script you've saved:
|
||||
|
||||
- **Name** — the script's file name, with a colored tag showing its type (**CMD**, **PS1**, or **SH**).
|
||||
- **Description** — your short note about what the script does.
|
||||
- **Updated** — the date the script was last changed.
|
||||
|
||||
## ➕ Add a Script
|
||||
1. Click **+ Add Script** in the toolbar.
|
||||
2. Enter a **Script Name** ending in `.cmd`, `.sh`, or `.ps1`.
|
||||
3. Add an optional **Description**.
|
||||
4. Type or paste the **Script Content** into the editor.
|
||||
5. Click **Add Script** to save it.
|
||||
|
||||
> The file type is set by the name's ending, and the editor adjusts to match.
|
||||
|
||||
## ✏️ Edit or Delete
|
||||
- **Edit** — update a script's description or content. The name can't be changed after it's created.
|
||||
- **Delete** — remove a script from this list. This can't be undone. If the script was already pushed to an ATM, it stays on that ATM.
|
||||
|
||||
## 🚀 Push a Script to the Fleet
|
||||
1. Click **Push** next to the script you want to send.
|
||||
2. HiveIQ prepares the list of **connected ATMs** — TCR machines are automatically left out.
|
||||
3. Review the number of ATMs that will receive it.
|
||||
4. Click **Push to [n] ATMs** to send it. A fleet task is created for each ATM, and they pick it up on their next check-in.
|
||||
|
||||
> Only ATMs that are currently online will receive the script. Every script is delivered securely, and each ATM confirms it's genuine before saving it.
|
||||
@@ -0,0 +1,28 @@
|
||||
---
|
||||
module: devices.config-audit
|
||||
title: Config Audit
|
||||
tab: Overview
|
||||
order: 10
|
||||
audience: customer
|
||||
---
|
||||
|
||||
A running history of every change made to your institutions' device configuration settings. Use it to see who changed what and when, and to review the exact before-and-after of any change.
|
||||
|
||||
## 🔍 What you can do here
|
||||
1. **Browse the change log** — the newest changes appear at the top.
|
||||
2. **Filter by institution** — pick an institution from the dropdown to see only its changes, or leave it on **All institutions**.
|
||||
3. **Refresh** — click **Refresh** to pull in the latest changes.
|
||||
4. **View the diff** — click **View diff** on any row to expand a side-by-side comparison of what changed. Click **Hide** to collapse it.
|
||||
5. **Page through history** — use **Previous** and **Next** to move through older entries.
|
||||
|
||||
## 📋 What you're looking at
|
||||
Each row is one save to an institution's configuration:
|
||||
|
||||
- **Institution** — the institution key and name the change applies to.
|
||||
- **Changed By** — the person who made the change.
|
||||
- **When** — the date and time it was saved.
|
||||
- **Changes** — a quick summary. **Initial save** means these settings were recorded for the first time; **X fields changed** means an existing setting was updated.
|
||||
|
||||
When you open a diff, each changed setting is listed with its **Field** name, the **Before** value, and the **After** value, so you can confirm exactly what was adjusted.
|
||||
|
||||
> **Good to know:** This is a read-only record — it captures history but doesn't change any settings itself. It's handy for troubleshooting ("what changed right before this started happening?") and for keeping an audit trail.
|
||||
@@ -0,0 +1,54 @@
|
||||
---
|
||||
module: devices.device-detail
|
||||
title: Device Detail
|
||||
tab: Overview
|
||||
order: 10
|
||||
audience: customer
|
||||
---
|
||||
|
||||
The single-device view for one ATM in your fleet. Use it to check a machine's live status, review its hardware and software, update its details, or dig into recent activity and incidents.
|
||||
|
||||
## 🔎 Pick a Device
|
||||
|
||||
1. Use the device selector at the top to switch to any ATM in your fleet.
|
||||
2. The header shows the device's live status and connection at a glance.
|
||||
3. Everything below is organised into tabs — click a tab to jump to that area.
|
||||
|
||||
## 📑 What the Tabs Show
|
||||
|
||||
- **Details** — the ATM's ID, institution, location, make/model, coordinates, address, service hours, and connection status.
|
||||
- **System Info** — transit number and other identifying details reported by the machine.
|
||||
- **Agent** — details about the monitoring agent running on the ATM, including its latest log file.
|
||||
- **Software** — installed programs, operating system, security software, and patches.
|
||||
- **Hardware** — processor, storage, network, and fitted device modules. A badge flags any hardware changes to review.
|
||||
- **Cassettes** — current cash cassette inventory and the cassette template applied to the machine.
|
||||
- **ATM Config / Config Changes** — the machine's configuration and a history of changes (shown when available).
|
||||
- **Transactions** — recent transactions processed at the ATM.
|
||||
- **Incidents** — the incident history for this machine.
|
||||
- **Journal** — journal coverage and any gaps.
|
||||
- **Activity** — a timeline of power, in/out-of-service, supervisor, and replenishment events.
|
||||
- **Captures / Other Logs** — network captures and additional log files.
|
||||
- **Hotfix / SW Deploy / Task History** — fleet tasks targeting this device and their history.
|
||||
|
||||
## ✏️ Manage the Device (Details tab)
|
||||
|
||||
1. **Edit** — update institution, location, make, model, hardware profile, coordinates, address, terminal comment, service schedule, and any custom fields.
|
||||
2. **Lookup Coords** — while editing the address, click this to fill in latitude and longitude automatically.
|
||||
3. **Rename** — change the ATM ID or display name.
|
||||
4. **Move Institution** — reassign the device to a different institution.
|
||||
5. **Reset to In Service** — clear supervisor mode and service state, returning the machine to IN SERVICE.
|
||||
6. **Deactivate / Delete** — remove a device from the active fleet; deleting an already-inactive device removes it permanently.
|
||||
|
||||
## 📊 What You're Looking At
|
||||
|
||||
- **Status** — the live state: IN SERVICE, OUT OF SERVICE, or IN SUPERVISOR (someone is at the machine).
|
||||
- **Admin Status** — whether the device is active or inactive in your fleet records.
|
||||
- **Agent Connection** — whether the monitoring agent is currently reaching HiveIQ (Connected, Disconnected, or Never Connected).
|
||||
- **Last Heartbeat** — the last time the machine checked in.
|
||||
- **Service Schedule** — the ATM's opening hours (shown as 24/7 when always open).
|
||||
|
||||
## 💡 Good to Know
|
||||
|
||||
- The page refreshes on its own about once a minute, so status stays current without reloading.
|
||||
- A red badge on the Hardware or Config Changes tab means there are changes waiting for you to review and dismiss.
|
||||
- Setting a hardware profile queues a configuration update to the machine automatically.
|
||||
@@ -0,0 +1,48 @@
|
||||
---
|
||||
module: devices.device-groups
|
||||
title: Device Groups
|
||||
tab: Overview
|
||||
order: 10
|
||||
audience: customer
|
||||
---
|
||||
|
||||
Device Groups let you organize your devices into named collections — for example "Downtown ATMs" or a single branch — so you can view and manage them together instead of one at a time.
|
||||
|
||||
## 👥 What you can do here
|
||||
- **Create a group** — click **+ New Group** to open the form.
|
||||
- **Assign devices** to a group and change which devices belong to it.
|
||||
- **Assign a hardware profile** to every device in a group at once.
|
||||
- **Set a default group** so your device lists open pre-filtered to it.
|
||||
- **Edit** a group's name, description, color, or membership.
|
||||
- **Delete** a group you no longer need.
|
||||
|
||||
## ➕ Create a group
|
||||
1. Click **+ New Group** in the toolbar.
|
||||
2. Enter a **Name** (required) and an optional **Description**.
|
||||
3. Optionally pick an **Institution** — choosing one automatically pre-selects all of that institution's devices for the group.
|
||||
4. Pick a **Color** from the preset swatches, or choose a custom one — this color labels the group in lists.
|
||||
5. Add devices using the two-panel picker: highlight devices in **Available**, use the arrows to move them to **Assigned**, and use the **Filter ATMs** box to search by device ID or location.
|
||||
6. Click **Create Group**.
|
||||
|
||||
## 🔧 Managing a group
|
||||
Each row in the table has quick actions:
|
||||
|
||||
1. **Assign Devices** — open the two-panel picker to add or remove devices, then **Save Assignment**.
|
||||
2. **Assign Profile** — choose a hardware profile to apply to every device in the group; HiveIQ pushes the update out to those devices for you.
|
||||
3. **Edit** — change the group's name, description, institution, color, or membership.
|
||||
4. **Delete** — remove the group. Your devices are not deleted; only the grouping goes away.
|
||||
|
||||
## ⭐ Setting a default
|
||||
- Click **Set Default** on a group to make your device views open filtered to it.
|
||||
- Click **✕ Clear** on the current default to go back to showing all devices.
|
||||
|
||||
## 📋 What you're looking at
|
||||
The groups table shows:
|
||||
|
||||
- **Name** — the group's label, with its color shown as a strip on the left.
|
||||
- **Description** — your optional note about the group.
|
||||
- **Institution** — the institution the group is tied to, or **All** if it spans everything.
|
||||
- **ATMs** — how many devices are currently in the group.
|
||||
- **Default** — whether this group is your default view.
|
||||
|
||||
> Removing a device from a group — or deleting the group — never removes the device itself. Groups are just a way to organize your fleet.
|
||||
@@ -0,0 +1,42 @@
|
||||
---
|
||||
module: devices.device-list
|
||||
title: Device List
|
||||
tab: Overview
|
||||
order: 10
|
||||
audience: customer
|
||||
---
|
||||
|
||||
The Device List is your full inventory of every ATM and TCR in your fleet. Use it to find a specific machine, check whether it's online and in service, and open a device to see its details.
|
||||
|
||||
## 🔍 Find & Filter Devices
|
||||
1. Type in the **Search** box to look up a device by ID, location, and more.
|
||||
2. Open the **Filters** sidebar (left edge) to narrow the list by:
|
||||
- **Group** — a saved set of devices.
|
||||
- **Device Type** — ATM or TCR.
|
||||
- **Status** — In Service, Down, Maintenance, Inactive, Agent Offline, In Supervisor, or Out of Service.
|
||||
- **Model** — the machine make/model.
|
||||
- **Agent Status** — Connected, Disconnected, or Never Connected.
|
||||
- **Agent Version** — the software version running on the device.
|
||||
3. Active filters appear as tags above the table. Click the **×** on a tag to remove it, or **Clear all** to reset.
|
||||
|
||||
## 📋 What You're Looking At
|
||||
Each row is one device. Key columns include:
|
||||
- **ATM ID** — the unique identifier for the device.
|
||||
- **Location** / **Institution** — where the device is and which institution owns it.
|
||||
- **Model** / **Type** — the machine model and whether it's an ATM or TCR.
|
||||
- **Status** — a colored badge showing the device's current service state. If the agent is offline, this shows **Agent Offline**.
|
||||
- **Agent** — a colored dot for the connection (green = connected, red = disconnected, gray = never connected), the installed agent version, and a small signal bar showing download speed to the device.
|
||||
- **Last Heartbeat** — the last time the device checked in.
|
||||
|
||||
> Use the **⚙ Columns** button to show or hide columns like Address, Terminal Comment, Last Service, and Added. Drag a column's edge to resize it, or click a column header to sort.
|
||||
|
||||
## ➕ Add a Device
|
||||
1. Click **+ Add Device** in the toolbar.
|
||||
2. Enter the required fields: **ATM ID**, **Location**, **Model**, and **Address** (Institution is set for you if you only manage one).
|
||||
3. Click **📍 Lookup Coords** to fill in map coordinates from the address automatically, or enter latitude/longitude by hand.
|
||||
4. Click **Create Device**.
|
||||
|
||||
## 💡 Good to Know
|
||||
- Click any row to open its detail panel, with **Properties**, **Modules**, and **Command Center** tabs.
|
||||
- Turn on **Auto-refresh** (top right) to keep the list updating on its own, or click the **↻** button to refresh right away.
|
||||
- The **Total** count and per-page controls sit above the table so you can page through large fleets.
|
||||
@@ -0,0 +1,43 @@
|
||||
---
|
||||
module: devices.map
|
||||
title: Map
|
||||
tab: Overview
|
||||
order: 10
|
||||
audience: customer
|
||||
---
|
||||
|
||||
See every ATM in your fleet on a single map, colour-coded by live status. Use it to spot problems by location at a glance and jump straight to the ATM or incident that needs attention.
|
||||
|
||||
## 🗺️ What you're looking at
|
||||
Each pin is an ATM, placed at its address and coloured by its current state:
|
||||
|
||||
- 🟢 **Online** — in service and healthy
|
||||
- 🔴 **Offline** — down, in maintenance, or inactive
|
||||
- 🟠 **Out of Cash / Open Incident** — needs attention
|
||||
- 🔵 **Supervisor Mode** — currently in supervisor mode
|
||||
|
||||
When several ATMs sit at the same location, they share one pin with a small **count badge**, and the pin takes the colour of the most serious ATM in that group. The bar above the map shows how many ATMs are currently displayed out of your total.
|
||||
|
||||
## 🔍 Filter the map
|
||||
Narrow the map down to what you care about:
|
||||
|
||||
1. **Status** — show only Online, Offline, Out of Cash, Open Incident, or Supervisor Mode ATMs (each option shows a live count).
|
||||
2. **Incident Type** — show only ATMs with a specific type of open incident.
|
||||
3. **Group** — show only ATMs in one of your ATM groups.
|
||||
|
||||
Active filters appear as tags below the controls. Remove one with its **×**, or click **Clear all** to reset.
|
||||
|
||||
## 💾 Save filter presets
|
||||
1. Set the filters you use often.
|
||||
2. Click **Save preset**, give it a name, and click **Save**.
|
||||
3. Your presets appear in the **Saved** bar — click one to reapply those filters instantly, or use its **×** to delete it.
|
||||
|
||||
## 📍 Open an ATM or incident
|
||||
1. Click any pin to open its popup.
|
||||
2. The popup lists the ATM ID, location, address, current status, agent connection, and any open incidents.
|
||||
3. Click the **ATM ID** to open the full ATM detail, or click an **incident tag** to open that incident.
|
||||
|
||||
## 🔄 Auto-refresh
|
||||
The map refreshes on its own and shows a countdown to the next update. Toggle **Auto-refresh** off if you'd rather it hold still.
|
||||
|
||||
> **Good to know:** ATMs without a latitude and longitude can't be placed on the map. When some are missing coordinates, a banner shows how many — click **View in ATM List** to find them and add their location in ATM properties.
|
||||
@@ -0,0 +1,39 @@
|
||||
---
|
||||
module: fleet.dashboard
|
||||
title: Fleet Dashboard
|
||||
tab: Overview
|
||||
order: 10
|
||||
audience: customer
|
||||
---
|
||||
|
||||
A quick, at-a-glance snapshot of your fleet — task activity and how your ATMs break down by model and institution. Open it when you want a fast health check without digging into individual tasks or devices.
|
||||
|
||||
## 👀 What you can do here
|
||||
- See a live count of your fleet tasks by status.
|
||||
- See how many artifacts you have and how many devices are actively reporting.
|
||||
- Expand **ATMs by Model** to see totals split by machine model.
|
||||
- Expand **ATMs by Institution** to see totals split by institution.
|
||||
|
||||
> The screen refreshes on its own about once a minute — no need to reload.
|
||||
|
||||
## 📊 What you're looking at
|
||||
|
||||
**Task Statistics**
|
||||
- **Total** — all fleet tasks.
|
||||
- **Pending** — created but not yet started.
|
||||
- **Running** — currently in progress.
|
||||
- **Completed** — finished successfully.
|
||||
- **Failed** — did not complete.
|
||||
|
||||
**Fleet Overview**
|
||||
- **Artifacts** — the number of uploadable items (agents, patches, scripts) available to deploy.
|
||||
- **Modules Reporting** — how many device modules are actively checking in.
|
||||
|
||||
**ATMs by Model / ATMs by Institution**
|
||||
|
||||
Click either heading to expand the table. Each row shows:
|
||||
- **Total** — how many ATMs are in that model or institution.
|
||||
- **Operational** — machines currently in service.
|
||||
- **Offline** — machines out of service, down, or inactive.
|
||||
|
||||
> The header next to each section shows a running count, e.g. "5 models · 120 ATMs", so you get the totals even before expanding.
|
||||
@@ -0,0 +1,32 @@
|
||||
---
|
||||
module: fleet.modules
|
||||
title: Modules
|
||||
tab: Overview
|
||||
order: 10
|
||||
audience: customer
|
||||
---
|
||||
|
||||
The Modules screen shows the capabilities running on your ATM agents — what each one does and how it's doing across your fleet. Use it to confirm the right features are active and to spot modules that are failing or not reporting.
|
||||
|
||||
## 👀 What you can do here
|
||||
- Browse every agent module, grouped into four categories: **Data Collection**, **Monitoring**, **Fleet Management**, and **Updates**.
|
||||
- Read a plain-language description of what each module does.
|
||||
- See the fleet-wide status of each module at a glance using the status badges.
|
||||
|
||||
## 📊 What you're looking at
|
||||
Each module is shown as a card with:
|
||||
- **Name** — the module's display name, with its short reference code beneath it.
|
||||
- **Description** — what the module does on the ATM.
|
||||
- **Status badges** — a live count of how your fleet is using that module:
|
||||
- **Running** — number of ATMs where the module is active and working.
|
||||
- **Disabled** — number of ATMs where the module is switched off.
|
||||
- **Failed** — number of ATMs where the module hit an error.
|
||||
- **Not reporting** — no ATMs are currently reporting this module.
|
||||
|
||||
## 🗂️ The four categories
|
||||
- **Data Collection** — modules that gather journal files, logs, and images from the ATM.
|
||||
- **Monitoring** — modules that watch logs and disk usage and raise alerts when something looks wrong.
|
||||
- **Fleet Management** — modules that run remote commands, sync settings, and keep hardware inventory up to date.
|
||||
- **Updates** — modules that keep the agent and its parts up to date automatically.
|
||||
|
||||
> Good to know: This screen is a read-only overview. A **Failed** or **Not reporting** count is a useful early warning that an ATM may need attention.
|
||||
@@ -0,0 +1,42 @@
|
||||
---
|
||||
module: incident.dashboard
|
||||
title: Dashboard
|
||||
tab: Overview
|
||||
order: 10
|
||||
audience: customer
|
||||
---
|
||||
|
||||
A live snapshot of your fleet's health — how many devices are up, how many tickets are open, and how incidents are trending. Start your day here to spot problems at a glance.
|
||||
|
||||
## 📊 What you can do here
|
||||
1. **Watch it refresh on its own** — the Dashboard updates automatically. The countdown next to **Auto-refresh** shows how many seconds until the next update.
|
||||
2. **Turn auto-refresh off** — flip the **Auto-refresh** toggle if you'd rather the numbers hold still.
|
||||
3. **Refresh now** — click the **↻** button to pull the latest figures immediately.
|
||||
4. **Change the time range** — use the drop-down on the **Incident Trends** and **Incidents by Type** panels to switch between **Last 7 days**, **Last 30 days**, and **Last 60 days**.
|
||||
|
||||
> If you're viewing a specific device group, its name appears in the header so you know the numbers are scoped to that group.
|
||||
|
||||
## 🖥️ Device Status
|
||||
Top-line counts for your fleet:
|
||||
- **Total Devices** — everything in your fleet, with an ATM / TCR split when you have both.
|
||||
- **In Service** — devices running normally, shown as a count and a percentage of the fleet.
|
||||
- **Out of Service** — devices currently down.
|
||||
- **In Supervisor** — devices in supervisor mode (only shown when at least one is).
|
||||
|
||||
## 🎫 Tickets
|
||||
A quick tally of your incident tickets:
|
||||
- **Open** — reported but not yet picked up.
|
||||
- **Assigned** — handed to someone to work.
|
||||
- **In Progress** — actively being worked.
|
||||
- **Critical** — active tickets flagged as critical.
|
||||
- **This Week** — tickets created in the last 7 days.
|
||||
|
||||
## 🔌 Fleet health panels
|
||||
- **Device Status** — a colored breakdown of every device state (In Service, Down, Maintenance, and so on) with a bar showing the mix.
|
||||
- **Agent Connection** — how many devices are **Connected**, **Disconnected**, or have **Never** connected.
|
||||
|
||||
## 📈 Trends and types
|
||||
- **Incident Trends** — a bar chart of how many incidents were created each day over your chosen range.
|
||||
- **Incidents by Type** — the most common problem types (Card Reader Fail, Cassette Low, Dispenser Jam, and more), ranked by count. Each row can show how many are still **active**, how many are **critical**, and the **average** time to resolve.
|
||||
|
||||
> Good to know: ticket totals count across all time, while the trend and type panels reflect only the range you pick in the drop-down. If a panel shows "No incidents found," there's simply nothing in that window.
|
||||
@@ -0,0 +1,44 @@
|
||||
---
|
||||
module: incident.incident-management
|
||||
title: Incident Management
|
||||
tab: Overview
|
||||
order: 10
|
||||
audience: customer
|
||||
---
|
||||
|
||||
Your working list of everything that needs attention across your fleet. Use this screen to track, assign, and resolve incidents from the moment a device reports a problem to the moment it's closed.
|
||||
|
||||
## 🗂️ Active vs. Parked
|
||||
- **Active** — the day-to-day queue of open, assigned, in-progress, and resolved incidents.
|
||||
- **Parked** — incidents you've set aside for later so they don't clutter the active list.
|
||||
|
||||
## 🔍 Find the right incidents
|
||||
1. Open the **Filters** sidebar on the left.
|
||||
2. Narrow by **Group**, **ATM** (terminal ID, name, or location), **Incident #**, **Status**, **Severity**, **Type**, **Technician**, or **Helpdesk**.
|
||||
3. Use **Incident Text** to search across descriptions, titles, and notes.
|
||||
4. Click **💾 Save preset** to store a filter combination you use often, then reload it any time.
|
||||
|
||||
> Sort any column by clicking its header, and use **⚙ Columns** to show, hide, or resize columns.
|
||||
|
||||
## ✏️ Work an incident
|
||||
1. Click a row to open its detail panel.
|
||||
2. **Assign** a technician or helpdesk person from the dropdowns.
|
||||
3. Move it through its workflow — **Assign**, **Start**, **Resolve**, **Close**, **Reopen**, or **Park** — depending on its current status.
|
||||
4. Add **Notes**, review the **Event Timeline** from the device, and see any **Linked Tickets**.
|
||||
5. **Reclassify** the incident type if it was categorized incorrectly.
|
||||
|
||||
> Closing an incident flagged as **Possible Fraud** requires a note before it can be closed.
|
||||
|
||||
## ✅ Handle several at once
|
||||
1. Tick the checkboxes on the incidents you want.
|
||||
2. **Close** them in bulk, or **🔗 Link** two or more together (they must belong to the same device).
|
||||
|
||||
## What you're looking at
|
||||
- **ATM** — the device the incident belongs to.
|
||||
- **Type** — what kind of problem it is (e.g. Card Reader Fail, Cassette Low).
|
||||
- **Severity** — Critical, High, Medium, or Low.
|
||||
- **Status** — Open, Assigned, In Progress, Resolved, Closed, or Parked.
|
||||
- **Helpdesk / Technician** — who it's assigned to.
|
||||
- **Created / Updated** — when it was raised and last touched.
|
||||
|
||||
> Good to know: turn on **Auto-refresh** in the top bar to keep the list current, or hit the **↻** refresh button any time. The counter next to the toggle shows when the next refresh is due.
|
||||
@@ -0,0 +1,31 @@
|
||||
---
|
||||
module: incident.incident-tracker
|
||||
title: Incident Tracker
|
||||
tab: Overview
|
||||
order: 10
|
||||
audience: customer
|
||||
---
|
||||
|
||||
A live, at-a-glance view of every ATM that currently needs attention. Use it as your daily "what's wrong right now" board, so you can see which machines have open incidents and how far along each one is toward being resolved.
|
||||
|
||||
## 👀 What you can do here
|
||||
1. **See every ATM with an open incident** — each machine that needs action shows up as its own row.
|
||||
2. **Track progress at a glance** — a 5-step pipeline shows how far each ATM's incident has moved: **Open → Assigned → In Progress → Resolved → Closed**.
|
||||
3. **Show recently closed items** — click the **Recently Closed** chip in the toolbar to also show machines whose incidents were just resolved or closed. Click it again to hide them.
|
||||
4. **Open the details** — click **View Incidents** on any row to jump to the full incident list for that ATM.
|
||||
5. **Refresh** — the board updates on its own about once a minute, or click the refresh button in the top-right to update immediately.
|
||||
|
||||
## 📊 What you're looking at
|
||||
Each row is one ATM:
|
||||
|
||||
- **ATM ID & location** — which machine it is and where it lives.
|
||||
- **Incident numbers** (e.g. `#1042`) — the open incidents currently tied to that ATM.
|
||||
- **The pipeline** — filled steps show how far the incident has progressed through the stages.
|
||||
- **Action Required** — a warning badge on machines that still need someone to act.
|
||||
- **Severity** — the most urgent incident on that ATM: **Critical**, **High**, **Medium**, or **Low**.
|
||||
- **Open count** — how many incidents are currently open on that machine.
|
||||
- **Recently Closed** — for resolved/closed rows, shows how long ago the incident was closed (e.g. "2h 15m ago").
|
||||
|
||||
At the top, the **Open** chip counts how many ATMs need action, and **Recently Closed** counts how many were just wrapped up.
|
||||
|
||||
> **Good to know:** Rows are sorted so the most urgent work comes first — machines needing action lead the list, ordered by severity. When there's nothing outstanding, you'll see **"All ATMs clear — no open incidents."**
|
||||
@@ -0,0 +1,38 @@
|
||||
---
|
||||
module: incident.journal-events
|
||||
title: Journal Events
|
||||
tab: Overview
|
||||
order: 10
|
||||
audience: customer
|
||||
---
|
||||
|
||||
A live, searchable log of what's happening on a single ATM. Use it to see recent activity on a terminal — card reader problems, cash cassette levels, power and network changes, and more — when you're investigating an issue or checking how a machine is behaving.
|
||||
|
||||
## 🖥️ Pick an ATM
|
||||
1. Open the **Filters** panel on the left.
|
||||
2. Type in the **ATM** search box to find a terminal by its ID or location.
|
||||
3. Click a terminal in the list to load its events.
|
||||
|
||||
> Nothing shows until you select an ATM. The screen remembers your choice as you move around the app.
|
||||
|
||||
## 🔍 Narrow down what you see
|
||||
1. **Category** — tick one or more event groups to focus on: Card Reader, Cassette, Network, Power, Authentication, System, App Logs, or EJournal DB.
|
||||
2. **Period** — choose how far back to look: last 1 hour, 6 hours, 24 hours, 3 days, or 7 days.
|
||||
3. Active choices appear as tags across the top — remove one with its **×**, or click **Clear all** to reset everything.
|
||||
|
||||
> The list refreshes automatically as you change filters. The default period is the last 24 hours.
|
||||
|
||||
## 📋 What you're looking at
|
||||
Events are listed newest-first, with a running total shown above the table:
|
||||
|
||||
- **Time** — when the event happened. Click the header to sort oldest-first or newest-first.
|
||||
- **Event Type** — what occurred, shown as a colored badge. Red means a failure or error, amber a warning, green a recovery or success, blue a status change.
|
||||
- **Category** — the group the event belongs to (Card Reader, Cassette, etc.).
|
||||
- **Source** — where the entry came from, such as the Agent, an App Log, or a Manual entry.
|
||||
- **Details** — a short summary of the event.
|
||||
|
||||
## 🔎 See the full detail
|
||||
1. Rows with extra information show a small arrow. Click the row to expand it.
|
||||
2. The expanded panel can include the full event text plus hardware readings — card reader **slot** and **status**, or cassette **type**, **fill level**, and **bill count** with currency.
|
||||
|
||||
> If a terminal shows no events, try widening the period or clearing category filters. Use the **◀** button to collapse the Filters panel and give the table more room.
|
||||
@@ -0,0 +1,49 @@
|
||||
---
|
||||
module: incident.processing-rules
|
||||
title: Processing Rules
|
||||
tab: Overview
|
||||
order: 10
|
||||
audience: customer
|
||||
---
|
||||
|
||||
Processing Rules decide what HiveIQ does when your devices report events — whether an event becomes an incident, gets ignored, or automatically closes one. Use this screen to cut down on noise and tailor incident handling to your fleet.
|
||||
|
||||
The screen has three tabs: **Opening Rules**, **Closing Rules**, and **Event Exceptions**.
|
||||
|
||||
## 🟢 Opening Rules
|
||||
Control how incoming device events create and manage incidents.
|
||||
|
||||
1. Click **+ Add Rule** to create a rule.
|
||||
2. Give it a **name**, pick the **event type** it applies to, and choose an **action**:
|
||||
- **Create Incident** — raise an incident, optionally with an override severity or incident type.
|
||||
- **Suppress** — ignore matching events so they never become incidents.
|
||||
- **Open & Close** — record the incident but close it immediately, so it shows in reports without cluttering the active board.
|
||||
3. Optionally add a **Text Pattern** so the rule only fires when the event details contain that text.
|
||||
4. Scope the rule to one **institution**, or leave it **Global** to apply fleet-wide.
|
||||
5. Save. Use the **Enabled / Disabled** toggle any time to turn a rule on or off.
|
||||
|
||||
> Each rule row can be **Edited**, viewed with **History** (a full change log), or **Deleted**. Filter the list by keyword, device type (ATM or TCR), or action using the left sidebar.
|
||||
|
||||
## ✨ Suggest a Rule (Adoons)
|
||||
Not sure how to write a rule? Let Adoons help.
|
||||
|
||||
1. Click **✦ Suggest a Rule**.
|
||||
2. Paste a sample log line, describe what you want to catch, or both.
|
||||
3. Click **Get Suggestion** — Adoons proposes a rule with a confidence score and its reasoning.
|
||||
4. Choose **Publish Directly**, **Save as Draft** for later review, or **Edit First** before saving.
|
||||
|
||||
> Saved drafts appear under **Pending Drafts**, where you can **Approve**, **Edit**, or **Reject** each one before it goes live.
|
||||
|
||||
## 🔴 Closing Rules
|
||||
Automatically resolve or close open incidents when a matching recovery event arrives — for example, closing a "card reader failed" incident once the reader recovers. Add, edit, and enable these rules the same way as opening rules.
|
||||
|
||||
## ⚠️ Event Exceptions
|
||||
Shows events received with event types HiveIQ doesn't yet recognise, grouped by type with how often and on how many devices they occurred. Review them to create a matching rule or add a new event type, and **Dismiss** ones you don't need.
|
||||
|
||||
## What you're looking at
|
||||
- **Action** — what the rule does: Create Incident, Suppress, or Open & Close.
|
||||
- **Override Severity** — the severity applied when an incident is created (blank means the default is used).
|
||||
- **Institution** — the institution the rule is scoped to, or **Global** for the whole fleet.
|
||||
- **Status** — whether the rule is currently Enabled or Disabled.
|
||||
|
||||
> Good to know: institution-scoped rules take priority over global ones, and if no rule matches an event, HiveIQ falls back to its built-in default behaviour.
|
||||
@@ -0,0 +1,38 @@
|
||||
---
|
||||
module: msp.contact-groups
|
||||
title: Contact Groups
|
||||
tab: Overview
|
||||
order: 10
|
||||
audience: customer
|
||||
---
|
||||
|
||||
Contact Groups let you build distribution lists of your people and choose which HiveIQ notifications each list receives — system updates, incident summaries, and announcements. Use it so the right team members are kept in the loop automatically.
|
||||
|
||||
## 👥 What you can do here
|
||||
|
||||
- **Create a group** — click **+ New Group**, give it a name (e.g. "Managers", "Operations Team") and an optional description.
|
||||
- **Manage a group** — click any row (or **Manage**) to open it and edit its name, description, members, and subscriptions.
|
||||
- **Add or remove members** — inside a group, click **Add Members**, search your users by name or email, tick the ones to include, and add them. Remove anyone with the **Remove** button next to their name.
|
||||
- **Choose notification subscriptions** — tick the notification types a group should receive. A group only gets a message if it's subscribed to that type.
|
||||
- **Send a notification** — click **Send Notification** to compose a message that goes out to every group subscribed to the type you pick.
|
||||
- **Find groups fast** — open the **Filters** sidebar to search by name or filter by a subscription type.
|
||||
- **Delete a group** — click **Delete** to remove a group along with its members and subscriptions.
|
||||
|
||||
## 📋 What you're looking at
|
||||
|
||||
The main table lists every contact group:
|
||||
|
||||
- **Group Name** — the name you gave the list.
|
||||
- **Description** — an optional note about what the group is for.
|
||||
- **Members** — how many users are in the group.
|
||||
- **Subscriptions** — the notification types this group is signed up to receive (or "None").
|
||||
- **Created** — the date the group was set up.
|
||||
|
||||
## ✉️ Sending a notification
|
||||
|
||||
1. Click **Send Notification**.
|
||||
2. Pick a **Notification Type** — System Update, Incident Summary, Report System Change, or System Announcement.
|
||||
3. Enter a **Subject** and **Message**.
|
||||
4. Click **Send Notification** — it's delivered to every group subscribed to that type, and you'll see how many recipients it reached.
|
||||
|
||||
> 💡 **Good to know:** Only groups subscribed to the chosen type receive the message, so set each group's subscriptions to match what its members actually care about. The list auto-refreshes every 60 seconds — you can turn that off or refresh manually using the controls at the top right.
|
||||
@@ -0,0 +1,40 @@
|
||||
---
|
||||
module: msp.institution-keys
|
||||
title: Institution Keys
|
||||
tab: Overview
|
||||
order: 10
|
||||
audience: customer
|
||||
---
|
||||
|
||||
Institution Keys link a short institution code to the full institution name your devices use. Use this screen when you add a new institution, correct a name, or control which kinds of devices are allowed to connect.
|
||||
|
||||
## 🔎 Find a Mapping
|
||||
1. Use the **Search** box to filter by key code or institution name.
|
||||
2. Toggle **Auto-refresh** to keep the list current, or click the **↻** refresh button to update it now.
|
||||
|
||||
## ➕ Add a Mapping
|
||||
1. Click **+ Add Mapping** in the toolbar.
|
||||
2. Enter the **Key** — a short code of 2–10 uppercase letters (e.g. `AICU`).
|
||||
3. Enter the **Institution Name** exactly as it appears on your devices — this is case-sensitive and must match precisely.
|
||||
4. Choose the **Supported Device Types** (ATM, TCR, or both).
|
||||
5. Click **Add Mapping** to save.
|
||||
|
||||
## ✏️ Edit a Mapping
|
||||
1. Click **Edit** on any row.
|
||||
2. Update the institution name or the supported device types.
|
||||
3. Click **Save Changes**.
|
||||
|
||||
> The key code itself can't be changed after a mapping is created — only the name and device types.
|
||||
|
||||
## 🗑️ Delete a Mapping
|
||||
1. Click **Delete** on the row you want to remove.
|
||||
2. Confirm in the pop-up.
|
||||
|
||||
> Deleting a mapping means users tied to that key will no longer see any devices until a new mapping is created. Remove one only when you're sure it's no longer in use.
|
||||
|
||||
## 📋 What You're Looking At
|
||||
- **Key** — the short institution code.
|
||||
- **Institution Name** — the full name devices are registered under.
|
||||
- **Device Types** — the kinds of devices allowed to connect (ATM, TCR, or both).
|
||||
|
||||
> Good to know: the device name must match exactly. If a device connects with a device type that isn't listed here, its registration is turned away — so double-check the name and device types when a new device won't come online.
|
||||
@@ -0,0 +1,44 @@
|
||||
---
|
||||
module: msp.institutions
|
||||
title: Institutions
|
||||
tab: Overview
|
||||
order: 10
|
||||
audience: customer
|
||||
---
|
||||
|
||||
The Institutions screen lists every bank or institution allocated to your MSP. Use it to check licensing, keep contact details current, manage the agent tokens your ATMs use to connect, and confirm an institution is ready to go live.
|
||||
|
||||
## 🔍 Find an Institution
|
||||
1. Open the **Filters** sidebar and type in the **Search** box.
|
||||
2. Match on institution name, domain, or institution key.
|
||||
3. Click **✕ Clear all** to reset the search.
|
||||
|
||||
> The list auto-refreshes every 60 seconds. Toggle **Auto-refresh** off, or click the refresh button, to control updates yourself.
|
||||
|
||||
## 📋 What You're Looking At
|
||||
- **Institution** — the institution name plus its unique institution key.
|
||||
- **Contact** — the primary contact's name, email, and phone (shows a dash if none set).
|
||||
- **License Key** — the assigned license and its expiry. Expiry turns amber within 30 days and red once expired; some licenses show **No expiry**. Click **Copy** to copy the key.
|
||||
- **Granted** — the date this institution was allocated to your MSP.
|
||||
|
||||
## ✏️ Edit Contact
|
||||
1. Click **Edit Contact** on the institution's row.
|
||||
2. Update the contact **Name** (required), **Email** (required), and **Phone**.
|
||||
3. Click **Save Changes**.
|
||||
|
||||
## 🔑 Manage Agent Tokens
|
||||
1. Click **Tokens** on the institution's row to see its agent tokens.
|
||||
2. To add one, enter a token name (for example the ATM's ID) and click **+ Generate**.
|
||||
3. Copy the new token straight away — it's shown once and can't be retrieved later.
|
||||
4. Each token shows its name, a short prefix, status (**ACTIVE** or **REVOKED**), and when it was last used.
|
||||
5. Click **Revoke** to disable a token, or **Delete all revoked** to clear out revoked ones.
|
||||
|
||||
> To replace a token's value, revoke the old one and generate a new token.
|
||||
|
||||
## ✅ Onboarding Readiness
|
||||
1. Click **Readiness** on the institution's row.
|
||||
2. A banner shows whether the institution is **Ready to onboard** or **Not ready**.
|
||||
3. Checks are grouped into **Customer Profile** (institution key, domain, contact info), **Licensing** (an active, unexpired license), and **Agent Connectivity** (at least one active agent token).
|
||||
4. Resolve any item marked with a ✗ before onboarding.
|
||||
|
||||
> Readiness is a quick pre-flight check — green across all categories means the institution is fully configured and ready to go live.
|
||||
@@ -0,0 +1,40 @@
|
||||
---
|
||||
module: msp.module-allocations
|
||||
title: Module Allocations
|
||||
tab: Overview
|
||||
order: 10
|
||||
audience: customer
|
||||
---
|
||||
|
||||
Control which HiveIQ Browser app modules each of your users can open. Use this screen when you add a new user, change someone's responsibilities, or need to tidy up who has access to what.
|
||||
|
||||
## 👥 Find a User
|
||||
Users are grouped under their institution. Click an institution heading to expand or collapse its list.
|
||||
|
||||
1. Use the **Search** box in the filter sidebar to match on a name or email.
|
||||
2. Use the **Institution** filter to show only one institution's users.
|
||||
3. Active filters show as chips at the top — click **✕ Clear all** (or an individual chip) to reset.
|
||||
|
||||
> The count pill in the filter bar tells you how many users match.
|
||||
|
||||
## ✏️ Assign Modules to a User
|
||||
1. Click a user's row to open the slide-in panel on the right.
|
||||
2. Tick or untick each module to grant or remove access.
|
||||
3. Click **Save Allocations** to apply, or **Cancel** to discard.
|
||||
|
||||
> The panel lists every available module with its name and a short description, so you can see exactly what you're granting.
|
||||
|
||||
## 📊 What You're Looking At
|
||||
Each institution's table shows one row per user:
|
||||
|
||||
- **User** — the person's name.
|
||||
- **Status** — **Active** or **Disabled**. A disabled user can't sign in.
|
||||
- **Email** — the sign-in email address.
|
||||
- **Current Modules** — small icons for the modules they can currently open (up to five, with a **+N** badge if there are more). Shows **None** if nothing is assigned.
|
||||
|
||||
The **Available modules** legend at the top lists every module you can hand out.
|
||||
|
||||
## 🕐 Good to Know
|
||||
- Assignments save per user and take effect the next time they open the HiveIQ Browser launcher.
|
||||
- **Auto-refresh** keeps the list current on its own; toggle it off or click the refresh button to reload on demand.
|
||||
- Only optional modules appear here — default modules everyone gets are not shown.
|
||||
@@ -0,0 +1,42 @@
|
||||
---
|
||||
module: msp.users
|
||||
title: Users
|
||||
tab: Overview
|
||||
order: 10
|
||||
audience: customer
|
||||
---
|
||||
|
||||
Manage the people who can sign in to HiveIQ across the institutions assigned to you. Use this screen to add or update accounts, control who can approve fleet deployments, and help users who are locked out.
|
||||
|
||||
## 👥 What You're Looking At
|
||||
Users are grouped by **institution** — click an institution row to expand or collapse its list. Each user shows:
|
||||
|
||||
- **Name** — the person's full name.
|
||||
- **Email** — the address they sign in with.
|
||||
- **Role** — **Customer** (standard access) or **MSP Admin** (manage users and settings).
|
||||
- **Status** — **Active** (can sign in) or **Disabled** (blocked from signing in).
|
||||
- **Last Login** — the date they last signed in, or a dash if they never have.
|
||||
|
||||
## 🔍 Find a User
|
||||
1. Open the **Filters** panel on the left.
|
||||
2. **Search** by name or email.
|
||||
3. Narrow the list by **Institution**, **Role**, or **Status**.
|
||||
4. Click **Clear all** to reset every filter.
|
||||
|
||||
## ✏️ Edit a User
|
||||
1. Click **Edit** on a user's row.
|
||||
2. Update their **Full Name** or **Role**.
|
||||
3. Turn on **Fleet Task Approver** to let them approve or reject hotfix and software deployment tasks.
|
||||
4. Click **Save Changes**.
|
||||
|
||||
> A user's email address can't be changed here.
|
||||
|
||||
## 🔑 Reset a Password
|
||||
1. Click **Reset PW** on a user's row.
|
||||
2. Confirm — a password reset email is sent to that user so they can set a new password themselves.
|
||||
|
||||
## 🚫 Enable or Disable Access
|
||||
- Click **Disable** to block a user from signing in (you'll be asked to confirm). Click **Enable** to restore access.
|
||||
- You can't disable your own account.
|
||||
|
||||
> Good to know: the list refreshes on its own every 60 seconds. Use the **Auto-refresh** toggle or the **↻** button in the top corner to control this.
|
||||
@@ -0,0 +1,30 @@
|
||||
---
|
||||
module: profile.appearance
|
||||
title: Appearance
|
||||
tab: Overview
|
||||
order: 10
|
||||
audience: customer
|
||||
---
|
||||
|
||||
Set how HiveIQ looks for you — the color theme and how tightly information is packed into tables. Use this whenever the screen is too bright, too dark, or you want to see more rows at once.
|
||||
|
||||
## 🎨 Choose a Theme
|
||||
1. Under **Theme**, pick one of:
|
||||
- **☀️ Light** — bright background.
|
||||
- **🌙 Dark** — dark background, easier on the eyes in low light.
|
||||
- **💻 System** — automatically follows your computer's light or dark setting.
|
||||
2. Click **Save** to apply.
|
||||
|
||||
> Saving your theme keeps the rest of HiveIQ looking consistent across the app.
|
||||
|
||||
## 📋 Choose Table Density
|
||||
1. Under **Table density**, pick one of:
|
||||
- **Comfortable** — more spacing between rows, easier to scan.
|
||||
- **Compact** — fits more rows on screen at once.
|
||||
2. Click **Save** to apply.
|
||||
|
||||
## 💾 Saving Your Changes
|
||||
- When you make a change, an **Unsaved changes** badge appears at the top.
|
||||
- Click **Save** to keep your choices, or **Discard** to undo them and go back to your last saved settings.
|
||||
|
||||
> Your preferences are remembered for next time you sign in.
|
||||
@@ -0,0 +1,25 @@
|
||||
---
|
||||
module: profile.display
|
||||
title: Display
|
||||
tab: Overview
|
||||
order: 10
|
||||
audience: customer
|
||||
---
|
||||
|
||||
Control how dates, times, and lists appear for you across HiveIQ. Set these once and every screen matches your preference.
|
||||
|
||||
## ⚙️ What you can do here
|
||||
1. **Items per page** — choose how many rows show in tables at once: 10, 25, 50, or 100.
|
||||
2. **Date format** — pick how dates are written: MM/DD/YYYY, DD/MM/YYYY, or YYYY-MM-DD.
|
||||
3. **Time format** — choose **12-hour** (3:00 PM) or **24-hour** (15:00).
|
||||
4. **Timezone** — set the timezone used to display times, from UTC and common regions worldwide.
|
||||
5. Click **Save** to apply your changes.
|
||||
|
||||
> An **Unsaved changes** badge appears when you edit a field. Click **Discard** to undo your edits and return to your last saved settings.
|
||||
|
||||
## 👀 What you're looking at
|
||||
- **Items per page** — a larger number shows more rows before you need to page forward; a smaller number keeps pages short.
|
||||
- **Date & time format** — affects how every date and time is shown to you across the app.
|
||||
- **Timezone** — times are displayed in the zone you pick here, so schedules and timestamps read correctly for where you work.
|
||||
|
||||
> **Good to know:** These settings are personal to your account and don't change what teammates see. Save isn't available until you've made a change.
|
||||
@@ -0,0 +1,42 @@
|
||||
---
|
||||
module: profile.inbox
|
||||
title: Inbox
|
||||
tab: Overview
|
||||
order: 10
|
||||
audience: customer
|
||||
---
|
||||
|
||||
Your Inbox is where you read and send internal messages and system notifications inside HiveIQ. Use it to reach other users on your team and to keep an eye on alerts the platform sends you.
|
||||
|
||||
## 📥 Read Your Messages
|
||||
1. The **Inbox** tab lists messages sent to you, newest activity first.
|
||||
2. Unread messages are highlighted and show a blue dot with a bold subject.
|
||||
3. Click any row to open the full message in a side panel — it's marked as read automatically.
|
||||
4. The count at the top shows how many messages you have and how many are still unread.
|
||||
|
||||
> Click **Mark all read** in the toolbar to clear every unread message at once.
|
||||
|
||||
## 📤 Sent
|
||||
1. Switch to the **Sent** tab to see messages you've sent.
|
||||
2. Each row shows who it went **To**, the subject, and a short preview.
|
||||
3. Click a row to read the full message.
|
||||
|
||||
## ✏️ Compose a Message
|
||||
1. Click **+ Compose** in the toolbar.
|
||||
2. Choose a type: **Direct** to message specific people, or **Broadcast** to reach a whole group (available to administrators).
|
||||
3. For a Direct message, search by name or email and add one or more recipients — added people appear as removable chips.
|
||||
4. Add an optional **Subject** and write your **Message**.
|
||||
5. Click **Send**.
|
||||
|
||||
> Administrators can target a **Broadcast** to a specific institution, or send it to all institutions at once.
|
||||
|
||||
## 🗂️ What You're Looking At
|
||||
- **Type** — a colored tag showing the kind of message: **Direct** (person to person), **Broadcast** (sent to a group), or **Action** (a system notification that may need your attention).
|
||||
- **Subject / Preview** — the message subject with a short snippet of the body.
|
||||
- **From / To** — who sent it (Inbox) or who received it (Sent); system notifications show as **System**.
|
||||
- **Date** — recent messages show a time, older ones show the day or full date.
|
||||
|
||||
## 💡 Good to Know
|
||||
- Use **Delete** on a message row, or from the open message, to remove it from your inbox.
|
||||
- The inbox refreshes automatically about once a minute — toggle **Auto-refresh** off, or hit the refresh button, to control this yourself.
|
||||
- Messages are for internal HiveIQ users only.
|
||||
@@ -0,0 +1,34 @@
|
||||
---
|
||||
module: profile.notifications
|
||||
title: Notifications
|
||||
tab: Overview
|
||||
order: 10
|
||||
audience: customer
|
||||
---
|
||||
|
||||
Choose how and when HiveIQ alerts you. Use this screen to pick your alert channels, decide which severity levels are worth a ping, and set quiet hours so you aren't disturbed overnight.
|
||||
|
||||
## 📣 Choose Your Channels
|
||||
1. Turn on **Email notifications** to receive alerts in your inbox.
|
||||
2. Turn on **Push notifications** to receive alerts on your device.
|
||||
|
||||
> You can use either channel, both, or neither.
|
||||
|
||||
## ⚠️ Pick Alert Severity
|
||||
Decide which events are worth notifying you about:
|
||||
- **Critical alerts** — the most urgent issues.
|
||||
- **High alerts** — important but less urgent issues.
|
||||
- **Incident assignments** — get notified when an incident is assigned to you.
|
||||
- **Status changes** — get notified when an incident's status is updated.
|
||||
|
||||
## 🕐 Set Quiet Hours
|
||||
1. Set a **From** and **To** time to define a do-not-disturb window.
|
||||
2. During that window, no notifications will be sent.
|
||||
3. Leave both blank to receive alerts around the clock.
|
||||
|
||||
## 💾 Saving Changes
|
||||
1. When you change anything, an **Unsaved changes** badge appears at the top.
|
||||
2. Click **Save** to apply your settings.
|
||||
3. Click **Discard** to undo your changes and go back to your last saved settings.
|
||||
|
||||
> Your settings only take effect once you click Save.
|
||||
@@ -0,0 +1,30 @@
|
||||
---
|
||||
module: profile.profile
|
||||
title: Profile
|
||||
tab: Overview
|
||||
order: 10
|
||||
audience: customer
|
||||
---
|
||||
|
||||
Your personal profile — the name, contact details, and photo other HiveIQ users see. Update it whenever your role or contact information changes.
|
||||
|
||||
## ✏️ What you can do here
|
||||
1. Add or edit your **Full name**, **Job title**, and **Phone number**.
|
||||
2. Click your photo to upload a new **profile picture**, or click **Remove** to clear it.
|
||||
3. Click **Save changes** to keep your edits, or **Discard** to undo them.
|
||||
|
||||
> An **Unsaved changes** badge appears while you have edits that haven't been saved yet.
|
||||
|
||||
## 🖼️ Profile picture
|
||||
1. Click the circular photo (or your initials) to choose an image from your device.
|
||||
2. The image is cropped to a square automatically.
|
||||
3. Maximum file size is **2 MB** — larger images are rejected.
|
||||
|
||||
## 👤 What you're looking at
|
||||
Some details are shown for reference and can't be edited here:
|
||||
|
||||
- **Email address** — the address you sign in with.
|
||||
- **System role** — your access level (for example, Customer, Admin, or MSP Admin).
|
||||
- **Institution** — the organization your account belongs to (shown when applicable).
|
||||
|
||||
> If your email, role, or institution is wrong, contact your administrator — those are managed for you and can't be changed on this screen.
|
||||
@@ -0,0 +1,27 @@
|
||||
---
|
||||
module: profile.security
|
||||
title: Security
|
||||
tab: Overview
|
||||
order: 10
|
||||
audience: customer
|
||||
---
|
||||
|
||||
Manage your own sign-in security from this screen. Use it to change your password or control how long you can stay signed in when you step away.
|
||||
|
||||
## 🔑 Change Password
|
||||
1. Type your new password in the **New password** field (must be at least 8 characters).
|
||||
2. Re-type the same password in the **Confirm password** field.
|
||||
3. Click **Change Password**.
|
||||
|
||||
> If the two entries don't match, or the password is too short, you'll see a message and nothing is saved. Once saved, you'll get a confirmation.
|
||||
|
||||
## 🕐 Session Timeout
|
||||
1. Enter the number of **minutes** of inactivity before you're automatically logged out (between 5 and 480).
|
||||
2. Click **Save** to apply the new value.
|
||||
3. Changed your mind before saving? Click **Discard** to go back to the previous setting.
|
||||
|
||||
> A shorter timeout is more secure on shared or public computers; a longer one is more convenient on your own device.
|
||||
|
||||
## Good to know
|
||||
- These settings apply to your account only — they don't affect other users.
|
||||
- The **Save** button stays greyed out until you actually change the timeout value, so you always know when there's something to save.
|
||||
@@ -0,0 +1,35 @@
|
||||
---
|
||||
module: recon.atm-cycle-history
|
||||
title: ATM Cycle History
|
||||
tab: Overview
|
||||
order: 10
|
||||
audience: customer
|
||||
---
|
||||
|
||||
See every replenishment cycle for a single ATM and check whether its cash balanced. Use this when you want to confirm a machine reconciled cleanly or investigate where a variance came from.
|
||||
|
||||
## 📋 What you can do here
|
||||
1. **Browse cycles** — the left panel lists every replenishment cycle for the ATM, newest activity first.
|
||||
2. **Open a cycle** — click any row to see its full cash breakdown on the right.
|
||||
3. **↻ Sync Journal** — pull the latest transactions for the open cycle so its totals are up to date.
|
||||
4. **⚙ Cassette Configuration** — set up which slots the ATM has, their denomination, and cassette type (Dispenser, Recycler, Mix, or Retract). You can enter these by hand or **Sync from Device** to import them automatically.
|
||||
|
||||
## 🔎 What you're looking at
|
||||
|
||||
**Cycle list**
|
||||
- **#** — the cycle number.
|
||||
- **Started / Ended** — the dates the cycle opened and closed. An open (still-running) cycle shows **Open**.
|
||||
- **Status** — **Balanced** if the cash matched, or **Variance** if it didn't.
|
||||
- **Variance** — the difference between the expected and actual cash (blank while the cycle is still open).
|
||||
|
||||
**Cycle detail** (right panel)
|
||||
- A running total that starts with the **Opening Balance**, then adds cash loaded and deposits, and subtracts cash removed, withdrawals, and reversals to reach the **Expected Closing** balance.
|
||||
- **Actual Closing (Physical Count)** — what was actually counted at the machine.
|
||||
- **Variance** — expected vs. actual; shows **Balanced ✓** when it's zero.
|
||||
- Quick stats for withdrawal and deposit counts, total dispensed, and when the cycle was last synced.
|
||||
- **Cassette Breakdown** — per-slot opening and closing balances by denomination and type.
|
||||
- **Daily Reboot Snapshots** — cassette balances captured each day, when available.
|
||||
|
||||
## 💡 Good to know
|
||||
- A cycle covers the period from one replenishment to the next; each new replenishment closes the current cycle and opens the next one.
|
||||
- If cassette slots look wrong or missing, open **Cassette Configuration** and use **Sync from Device** to refresh them before reconciling.
|
||||
@@ -0,0 +1,39 @@
|
||||
---
|
||||
module: recon.cash-forecast
|
||||
title: Cash Forecast
|
||||
tab: Overview
|
||||
order: 10
|
||||
audience: customer
|
||||
---
|
||||
|
||||
See which ATM cassettes are running low on cash and when each one is likely to empty — so you can plan replenishment trips before an ATM runs out.
|
||||
|
||||
## 💵 What You're Looking At
|
||||
|
||||
Each row is a single cassette in an ATM, sorted with the **soonest runout first**:
|
||||
|
||||
- **ATM** — the ATM the cassette belongs to.
|
||||
- **Slot** — which cassette position.
|
||||
- **Denomination** — the note value in that cassette.
|
||||
- **Current Level** — how much cash is in the cassette right now.
|
||||
- **Burn Rate / Day** — how fast that cassette is being dispensed, shown per day (and the number of notes).
|
||||
- **Projected Runout** — the estimated date the cassette will empty, with how many days away it is (e.g. "3d", "tomorrow", or "overdue").
|
||||
- **Fill By** — the recommended date to replenish so it doesn't run dry.
|
||||
- **Status** — the confidence of the forecast (see below).
|
||||
|
||||
> Rows turn **amber** when a cassette is due to run out within 3 days, and **red** when the recommended Fill By date has already passed.
|
||||
|
||||
## 🔍 What You Can Do Here
|
||||
|
||||
1. Use the **Filters** panel on the left to narrow the list — search by ATM ID, pick an Institution, or filter by Forecast Status.
|
||||
2. Click any column header to **sort** by that value (for example, sort by Current Level or Burn Rate).
|
||||
3. Click **Recompute** to refresh the forecasts on demand instead of waiting for the automatic update.
|
||||
4. Use the round **refresh** button to reload the latest numbers.
|
||||
|
||||
## 📊 Forecast Status
|
||||
|
||||
- **OK** — enough history to give a reliable runout prediction.
|
||||
- **Insufficient History** — not enough recent activity yet to forecast confidently.
|
||||
- **No Burn** — the cassette isn't being dispensed, so no runout is expected.
|
||||
|
||||
> Forecasts refresh automatically overnight, so you'll normally have fresh numbers each morning. If a cassette shows no prediction, give it a little more dispensing history or click Recompute.
|
||||
@@ -0,0 +1,36 @@
|
||||
---
|
||||
module: recon.cash-reconciliation
|
||||
title: Cash Reconciliation
|
||||
tab: Overview
|
||||
order: 10
|
||||
audience: customer
|
||||
---
|
||||
|
||||
See the current cash position of every ATM in your fleet at a glance. Use this screen to check which machines are balanced, which have a variance to investigate, and which are still waiting to be reconciled.
|
||||
|
||||
## 🔍 Find the ATMs you care about
|
||||
Open the **Filters** panel on the left (click **»** to expand it) and narrow the list:
|
||||
|
||||
1. **Search** — type an **ATM ID** to jump to one machine.
|
||||
2. **Status** — show only Open, Balanced, Variance, Pending Confirmation, or Unreconciled machines.
|
||||
3. **Journal Format** — filter by machine type: Recycler, PrintCash, or Slot.
|
||||
4. **Device Group** — show only ATMs in one of your saved groups.
|
||||
5. **Devices** — add one or more specific ATM IDs to build a custom shortlist.
|
||||
6. **Last Replenishment** — limit to machines replenished Today, or in the last 7, 14, or 30 days.
|
||||
|
||||
> A counter shows how many ATMs match (e.g. **12 / 340**), and **✕ Clear all** resets every filter at once.
|
||||
|
||||
## 📊 What you're looking at
|
||||
Each row is one ATM. Click any **column header** to sort, or click a row (or **View →**) to open that machine's full reconciliation detail.
|
||||
|
||||
- **ATM ID** — the machine.
|
||||
- **Last Replenishment** — the date cash was last loaded.
|
||||
- **Projected Balance** — the expected cash on hand right now, based on the last replenishment plus activity since.
|
||||
- **Last Known Balance** — the most recent confirmed balance.
|
||||
- **Cycle Status** — where the current cash cycle stands (Balanced, Variance, Open, Pending Confirmation, or Unreconciled).
|
||||
- **Variance** — the difference between expected and actual cash. This is highlighted in red when it isn't zero — those are the machines to review.
|
||||
- **Last Sync** — when this machine's activity was last pulled in.
|
||||
|
||||
## 💡 Good to know
|
||||
- A ⚠ badge next to a Projected Balance means that machine's data hasn't updated recently, so the figure may be behind. Yellow is a mild delay; red means it's been several hours.
|
||||
- Use the page-size control to show 10, 25, 50, or 100 ATMs per page.
|
||||
@@ -0,0 +1,29 @@
|
||||
---
|
||||
module: recon.device-cycle-mgmt
|
||||
title: Device Cycle Management
|
||||
tab: Overview
|
||||
order: 10
|
||||
audience: customer
|
||||
---
|
||||
|
||||
Choose which ATMs show up in Cash Reconciliation. Use this when you only want to reconcile a specific set of machines and keep the rest out of the way.
|
||||
|
||||
## 🎛️ How the two lists work
|
||||
- **Available** (left) lists ATMs that are not currently chosen.
|
||||
- **Selected for Recon** (right) lists the ATMs that will appear in Cash Reconciliation.
|
||||
- Each list has a **Filter** box — type an ATM ID to narrow a long list.
|
||||
- The count badge on each list header shows how many ATMs are in it.
|
||||
|
||||
## ✅ What you can do here
|
||||
1. Click an ATM to highlight it. Click again to un-highlight. You can highlight several at once.
|
||||
2. Use the middle buttons to move ATMs between the lists:
|
||||
- **>** move the highlighted ATMs into **Selected**.
|
||||
- **>>** move **all** Available ATMs into Selected.
|
||||
- **<** remove the highlighted ATMs from Selected.
|
||||
- **<<** remove **all** ATMs from Selected.
|
||||
3. **Double-click** an ATM to move it across instantly — one way or the other.
|
||||
4. Click **Save Selection** in the toolbar to apply your choice. A confirmation message shows how many ATMs Cash Reconciliation will display.
|
||||
|
||||
## 💡 Good to know
|
||||
- If **Selected for Recon** is empty, Cash Reconciliation shows **all** ATMs. An empty selection is not a mistake — it just means "show everything."
|
||||
- Nothing changes until you click **Save Selection**, so you can rearrange the lists freely first.
|
||||
@@ -0,0 +1,29 @@
|
||||
---
|
||||
module: recon.recon-rules
|
||||
title: Recon Rules
|
||||
tab: Overview
|
||||
order: 10
|
||||
audience: customer
|
||||
---
|
||||
|
||||
Recon Rules is where HiveIQ keeps the settings that tell reconciliation how to read cash replenishment records from different ATM makes and models. You'll come here to check how a format is handled, or to fine-tune it when a machine's replenishment data isn't being read correctly.
|
||||
|
||||
## 📋 What you can do here
|
||||
- See every replenishment **format** HiveIQ knows how to read, with a count of how many rules are configured.
|
||||
- Click any row to open its full detail panel.
|
||||
- In the panel, view the rule's settings and the exact configuration behind it.
|
||||
- **Edit** a rule's configuration and **Save** your changes.
|
||||
- **Reload** to refresh the rules from the latest saved configuration.
|
||||
|
||||
## 📊 What you're looking at
|
||||
Each row is one replenishment format. The columns explain how that format is recognized and read:
|
||||
|
||||
- **Format** — the name of the ATM replenishment format, with a short description underneath.
|
||||
- **Detection Sentinel** — the wording HiveIQ looks for in a machine's record to recognize this format. A format marked *fallback* is used when nothing else matches.
|
||||
- **Slot Strategy** — how cash slots are identified: by **Letter**, by **Denomination** (bill value), or by **Position**.
|
||||
- **Deduplication** — how repeated entries in a record are handled so cash isn't counted twice.
|
||||
- **Pre-Block End** — the point where the relevant replenishment section of the record ends.
|
||||
|
||||
## 💡 Good to know
|
||||
- Rules are checked in order, and the first matching detection wins — the *fallback* rule catches anything that doesn't match a specific format.
|
||||
- Editing a rule changes how future replenishment records are read, so only adjust a format when you're confident of the change. Use **Reload** if you want to discard back to the last saved version.
|
||||
@@ -0,0 +1,65 @@
|
||||
---
|
||||
module: reports.builder
|
||||
title: Report Builder
|
||||
tab: Overview
|
||||
order: 10
|
||||
audience: customer
|
||||
---
|
||||
|
||||
Build your own reports from HiveIQ fleet data — incidents, ATM health, transactions, and more — then run them on demand or on a schedule and download the results.
|
||||
|
||||
## 📋 The Two Tabs
|
||||
- **Templates** — your saved report definitions (and reports others have shared with you).
|
||||
- **Run History** — every report that has been generated, with its status and a download link.
|
||||
|
||||
> Turn on **Auto-refresh** (top right) to keep statuses and results updating on their own.
|
||||
|
||||
## 🆕 Create a Report Template
|
||||
1. On the **Templates** tab, click **+ New Report**.
|
||||
2. Give it a **Name** and pick a **Data Source** — Incidents, ATM Health, Transactions, Fleet Tasks, Agent Versions, or Agent Modules.
|
||||
3. Choose an **Output Format**: **CSV** (for spreadsheets and BI tools) or **JSON** (for in-app preview).
|
||||
4. Under **Columns**, click the fields you want to include in the report.
|
||||
5. (Optional) Add a **Description** so the report is easy to recognize later.
|
||||
6. Save.
|
||||
|
||||
> You must select at least one column (or a group-by field) before you can save.
|
||||
|
||||
## 📊 Summarize with Group By
|
||||
1. Pick one or more **Group By Fields** to combine rows that share the same value (for example, group incidents by ATM).
|
||||
2. A **count** is always included for each group.
|
||||
3. (Optional) Add **Aggregations** — **SUM**, **AVG**, **MIN**, or **MAX** — on numeric fields to total or average them per group.
|
||||
|
||||
## ▶ Run a Report
|
||||
1. Click **▶ Run** next to a template.
|
||||
2. Choose a **saved query** for a quick, pre-set run, or pick **Custom** to set a date range and select specific ATMs just for this run.
|
||||
3. Submit — the run is queued and you're taken to **Run History** to watch it finish.
|
||||
|
||||
## 🔖 Saved Queries
|
||||
Queries are reusable run settings (a date range plus a chosen set of ATMs) attached to a template.
|
||||
1. Click **Queries** on a template, then **+ New Query**.
|
||||
2. Name it, pick a **date range** (All time, Last 7/30 days, This month, Last month, or a Custom range), and move the ATMs you want into the selected list.
|
||||
3. Save — the query is now available whenever you run that report.
|
||||
|
||||
> Queries also let you set which run a schedule uses (see below).
|
||||
|
||||
## 🕐 Schedule a Report
|
||||
1. In the report form, enable scheduling and choose a frequency: every X minutes, hourly, daily, weekly, or monthly.
|
||||
2. Set the time (and days, for weekly/monthly) for it to run automatically.
|
||||
3. On the **Queries** panel, click **Set Scheduled** on the query the schedule should use.
|
||||
|
||||
> The **Next Run** column on the Templates tab shows when a scheduled report will fire next. Scheduled reports are delivered to you automatically inside HiveIQ.
|
||||
|
||||
## 🤝 Share a Report
|
||||
- Click **Share** on any of your templates to make it available to other users; click **Unshare** to stop.
|
||||
- Reports shared with you appear under **Shared Reports**, where you can run them yourself.
|
||||
|
||||
## 📥 View & Download Results
|
||||
On the **Run History** tab you'll see each run's:
|
||||
- **Status** — Pending, Running, Completed, or Failed.
|
||||
- **Rows** — how many rows the report produced.
|
||||
- **Triggered By** — the person who ran it, or "Scheduled".
|
||||
- **Started** / **Completed** — timestamps.
|
||||
|
||||
For a **Completed** run, click **Preview** to see the first rows in-app, or **Download** to save the full file. A **⚠ Failed** run shows the reason when you hover over it.
|
||||
|
||||
> Old runs you no longer need can be removed with **Delete**.
|
||||
@@ -0,0 +1,38 @@
|
||||
---
|
||||
module: reports.queries
|
||||
title: Saved Queries
|
||||
tab: Overview
|
||||
order: 10
|
||||
audience: customer
|
||||
---
|
||||
|
||||
Saved Queries let you attach reusable presets to a report — a named date range and set of ATMs — so you can run the same report the same way every time without re-picking options.
|
||||
|
||||
## 📂 Open Saved Queries
|
||||
1. On the **Templates** tab, find your report in the list.
|
||||
2. Click the **Queries** button on that report's row (the count in brackets shows how many it already has).
|
||||
3. The Saved Queries panel opens beneath the report.
|
||||
|
||||
## ➕ Create a Query
|
||||
1. Click **+ New Query**.
|
||||
2. Give it a **Name** (e.g. "Downtown branch — last 30 days").
|
||||
3. Choose a **Date Range**: All time, Last 7 days, Last 30 days, This month, Last month, or a **Custom range** with your own start and end dates.
|
||||
4. Pick which ATMs to include — leave it empty to cover **All ATMs**, or select specific machines.
|
||||
5. Save. The query now appears as a card in the panel.
|
||||
|
||||
## ▶ Using a Query
|
||||
- When you click **Run** on a report, your saved queries appear as ready-made options — pick one instead of setting the date range and ATMs by hand.
|
||||
- Click **Edit** on a query card to change its name, dates, or ATMs, or **Delete** to remove it.
|
||||
|
||||
## 🕐 Schedule a Query
|
||||
1. First make sure the report has a schedule turned on.
|
||||
2. On a query card, click **Set Scheduled** to make that query the one used for automatic runs — it gets a **Scheduled** badge.
|
||||
3. Click **Unschedule** to stop using it for scheduled runs.
|
||||
|
||||
## What you're looking at
|
||||
Each query card shows:
|
||||
- **Name** — your label for the preset.
|
||||
- **Date range** — the period the report covers (custom ranges show the exact start and end dates).
|
||||
- **ATMs** — either the number of selected machines or **All ATMs**.
|
||||
|
||||
> **Good to know:** A report needs at least one saved query before it can run on a schedule. Only one query can be the scheduled one at a time.
|
||||
@@ -0,0 +1,37 @@
|
||||
---
|
||||
module: reports.runs
|
||||
title: Run History
|
||||
tab: Overview
|
||||
order: 10
|
||||
audience: customer
|
||||
---
|
||||
|
||||
Every time a report is generated — whether you run it by hand or it runs on a schedule — it shows up here. Use **Run History** to check whether a report finished, preview the results, and download the file.
|
||||
|
||||
## 📋 What you're looking at
|
||||
|
||||
Each row is one report run, with these details:
|
||||
|
||||
- **Report** — the file name of the generated report (based on the report name and the date it ran).
|
||||
- **Status** — where the run is in its lifecycle:
|
||||
- **PENDING** — queued, waiting to start
|
||||
- **RUNNING** — currently being generated
|
||||
- **COMPLETED** — finished and ready to view or download
|
||||
- **FAILED** — something went wrong; hover the **⚠ Failed** marker to see why
|
||||
- **Rows** — how many rows of data the report produced.
|
||||
- **Triggered By** — who started it: a user's email address, or **Scheduled** if it ran automatically.
|
||||
- **Started / Completed** — when the run began and finished.
|
||||
|
||||
## ✅ What you can do here
|
||||
|
||||
1. **Preview** — on a completed run, click **Preview** to see the first 50 rows right in the browser, without downloading anything.
|
||||
2. **Download** — click **Download** to save the finished report to your computer (CSV or JSON, depending on the report).
|
||||
3. **Delete** — remove a run you no longer need. You'll be asked to confirm first.
|
||||
|
||||
> To start a new report run, go to the **Templates** tab and click **▶ Run** on the report you want.
|
||||
|
||||
## 🕐 Good to know
|
||||
|
||||
- The list refreshes on its own about every minute. Use the **Auto-refresh** toggle at the top right to turn this off or on — handy for watching a **RUNNING** report finish.
|
||||
- **Preview** and **Download** only appear once a run reaches **COMPLETED**.
|
||||
- A **FAILED** run can be deleted and re-run from the Templates tab.
|
||||
@@ -0,0 +1,49 @@
|
||||
---
|
||||
module: reports.schedule
|
||||
title: Scheduling & Distribution
|
||||
tab: Overview
|
||||
order: 10
|
||||
audience: customer
|
||||
---
|
||||
|
||||
Build reusable report templates from your fleet data, then have HiveIQ run them automatically on a schedule and deliver the results — no need to remember to pull the numbers each week.
|
||||
|
||||
## 📄 Create a Report Template
|
||||
1. On the **Templates** tab, click **+ New Report**.
|
||||
2. Give it a **Name** and pick a **Data Source** — Incidents, ATM Health, Transactions, Fleet Tasks, Agent Versions, or Agent Modules.
|
||||
3. Choose your **Columns** (the fields that appear in the report) and, optionally, **Group By** fields with **Aggregations** (SUM, AVG, MIN, MAX) to summarize.
|
||||
4. Set an **Output Format** — **CSV** for spreadsheets/BI tools, or **JSON** for in-app preview.
|
||||
5. Click **Save Report**.
|
||||
|
||||
## 🕐 Put It on a Schedule
|
||||
1. While creating or editing a report, tick **Enable Schedule**.
|
||||
2. Pick a **Frequency**: every few minutes, hourly, daily, weekly, or monthly.
|
||||
3. Set the **Time**, **Day(s)**, or **Day of month** as needed — the schedule summary shows when it will next run.
|
||||
4. Save. Scheduled reports show a schedule badge and a **Next Run** time in the templates list.
|
||||
|
||||
> A scheduled report needs a saved query to know which date range and ATMs to use — see below.
|
||||
|
||||
## 🔖 Save Queries (Reusable Filters)
|
||||
1. In the templates list, click **Queries** on a report to expand its saved queries.
|
||||
2. Click **+ New Query**, name it, choose a **Date Range** (All time, Last 7/30 days, This month, Last month, or a Custom range), and pick specific **ATMs** (leave empty to include all ATMs).
|
||||
3. To tie a saved query to a scheduled report, click **Set Scheduled** on that query. Use **Unschedule** to detach it.
|
||||
|
||||
## ▶ Run a Report Now
|
||||
1. Click **▶ Run** on any report.
|
||||
2. Choose a saved query, or pick **Custom (one-off)** to set a date range and ATMs just for this run.
|
||||
3. Click **▶ Run Report** — you'll be taken to **Run History** where the new run appears.
|
||||
|
||||
## 📊 Run History & Downloads
|
||||
The **Run History** tab lists every run with:
|
||||
|
||||
- **Status** — Pending, Running, Completed, or Failed.
|
||||
- **Rows** — how many records the report produced.
|
||||
- **Triggered By** — "Scheduled" for automatic runs, or the user who ran it.
|
||||
- **Started / Completed** — when the run happened.
|
||||
|
||||
For a completed run, click **Preview** to view the data in-app, or **Download** to save the CSV/JSON file. Failed runs show a warning you can hover for the reason.
|
||||
|
||||
## 🤝 Share With Your Team
|
||||
Click **Share** on one of your reports to make it available to other users in your organization — it appears under their **Shared Reports** list, where they can run it too. Click **Unshare** to stop sharing.
|
||||
|
||||
> Good to know: the page auto-refreshes about once a minute so run statuses stay current — you can toggle **Auto-refresh** off in the header if you prefer.
|
||||
@@ -0,0 +1,47 @@
|
||||
---
|
||||
module: reports.templates
|
||||
title: Report Templates
|
||||
tab: Overview
|
||||
order: 10
|
||||
audience: customer
|
||||
---
|
||||
|
||||
Build reusable reports from your fleet data — pick what to include once, then run it on demand or on a schedule. Use this when you need a recurring pull of incidents, ATM health, transactions, fleet tasks, or agent versions.
|
||||
|
||||
## 📝 Create a Report
|
||||
1. Click **+ New Report** in the toolbar.
|
||||
2. Give it a **Name** and pick a **Data Source**: Incidents, ATM Health, Transactions, Fleet Tasks, Agent Versions, or Agent Modules.
|
||||
3. Choose your **Columns** — click the fields you want in the report.
|
||||
4. (Optional) Add a short **Description** and choose an **Output Format**: CSV (for spreadsheets/BI tools) or JSON.
|
||||
5. (Optional) Pick **Group By** fields to summarize rows. When grouped, a count is always included, and you can add **SUM / AVG / MIN / MAX** on numeric fields.
|
||||
6. Save. Your report appears under **My Reports**.
|
||||
|
||||
> You must select at least one column or a group-by field before saving.
|
||||
|
||||
## ▶ Run a Report
|
||||
1. On any report, click **▶ Run**.
|
||||
2. Choose a saved query, or pick **Custom** to set a date range and select specific ATMs for this run.
|
||||
3. Submit — the run is queued and you're taken to **Run History** to watch it finish.
|
||||
|
||||
## 🔖 Saved Queries
|
||||
1. Click **Queries** on a report to open its saved queries.
|
||||
2. Click **+ New Query** to save a reusable combination of date range (e.g. Last 7 days, This month, or a custom range) and a set of ATMs.
|
||||
3. Saved queries give you quick run options and are required to schedule a report.
|
||||
|
||||
## 🕐 Schedule a Report
|
||||
1. While creating or editing a report, turn on scheduling and pick a frequency: every X minutes, hourly, daily, weekly, or monthly.
|
||||
2. Open the report's **Queries** and click **Set Scheduled** on the query that should run automatically.
|
||||
3. The **Schedule** and **Next Run** columns show when it will run next. Completed scheduled reports are delivered to you in-app.
|
||||
|
||||
> A report with no schedule shows **Manual** — it only runs when you click Run.
|
||||
|
||||
## 🤝 Share
|
||||
- Click **Share** on a report to make it available to other users in your organization; they'll see it under **Shared Reports** and can run it.
|
||||
- Click **Unshare** to stop sharing.
|
||||
|
||||
## 📊 What you're looking at
|
||||
- **My Reports** — your saved reports, showing **Data Source**, **Format**, **Schedule**, and **Next Run**.
|
||||
- **Shared Reports** — reports others shared with you, with the person who shared them.
|
||||
- **Run History** — every run with its **Status** (Pending, Running, Completed, Failed), **Rows** returned, who triggered it, and start/finish times. On a completed run, click **Preview** to view the first rows in-app or **Download** to save the file.
|
||||
|
||||
> The page auto-refreshes about once a minute so run statuses stay current — toggle it off with the switch in the header if you prefer.
|
||||
@@ -0,0 +1,49 @@
|
||||
---
|
||||
module: transactions.browser
|
||||
title: Transactions Browser
|
||||
tab: Overview
|
||||
order: 10
|
||||
audience: customer
|
||||
---
|
||||
|
||||
Browse every transaction across your fleet in one place. Use this screen to look up a specific withdrawal or deposit, investigate a disputed transaction, or spot patterns in failures and timeouts.
|
||||
|
||||
## 🔍 Find Transactions
|
||||
Open the **Filters** panel on the left (click **»** to expand it) and narrow the list:
|
||||
|
||||
1. **Device Type** — show **All**, **ATM** only, or **TCR** (teller cash recycler) only.
|
||||
2. **Group** — limit to a saved group of ATMs.
|
||||
3. **ATM** — type in the search box to pick a single machine.
|
||||
4. **Date Range** — choose a preset (Today, Yesterday, Last 7 days, Last 30 days, This month, Last month, All time) or **Custom range…** to set your own dates.
|
||||
5. **Transaction Type** — e.g. Withdrawal, Deposit, Balance Inquiry, Transfer.
|
||||
6. **Result** — Success, Fail, or Timeout.
|
||||
7. **Card / Account** — search by part of a card number or account number (e.g. `424002` or `8525`).
|
||||
8. **Foreign transactions only** — show only transactions that carried a surcharge or fee.
|
||||
9. **Advanced** — set a minimum and maximum **Amount** to filter by dollar value.
|
||||
|
||||
Active filters appear as removable tags above the table. Click **✕ Clear filters** to reset everything.
|
||||
|
||||
## 📊 What You're Looking At
|
||||
Each row is one transaction:
|
||||
|
||||
- **ATM** — the machine where it happened.
|
||||
- **Date / Time** — when the transaction started.
|
||||
- **Type** — Withdrawal, Deposit, and so on. Settlement and replenishment rows are highlighted.
|
||||
- **Amount** — the transaction value and currency.
|
||||
- **Card** — the masked card number, or the account number if there's no card.
|
||||
- **Result** — Success, Fail, or Timeout.
|
||||
- **Seq #** — the machine's sequence number for the transaction.
|
||||
|
||||
Use the **pagination** controls at the top of the table to move between pages and change how many rows show per page.
|
||||
|
||||
## 🧾 View Full Detail
|
||||
Click any row to open the transaction panel, which shows:
|
||||
|
||||
- **Transaction Flow** — a step-by-step timeline of what happened during the session.
|
||||
- **Transaction Records** — the underlying journal detail.
|
||||
- **Cheque images** — scanned deposit images, when available.
|
||||
- **Adoons Analysis** — an on-demand plain-language summary of the transaction. Click **Analyze** to generate it (when Adoons is available).
|
||||
|
||||
## 💡 Good to Know
|
||||
- **Auto-refresh** keeps the list current every 60 seconds. Toggle it off in the header, or use the refresh button to reload on demand.
|
||||
- Querying data older than 90 days is **archived** — you'll be asked to confirm before it loads, as it can take longer.
|
||||
@@ -0,0 +1,46 @@
|
||||
---
|
||||
module: transactions.customer-journey
|
||||
title: Customer Journey
|
||||
tab: Overview
|
||||
order: 10
|
||||
audience: customer
|
||||
---
|
||||
|
||||
A step-by-step replay of a single ATM transaction. Open it when you need to understand exactly what happened during a withdrawal, deposit, or balance inquiry — for a customer dispute, a "did I get my cash?" question, or a support call.
|
||||
|
||||
## 🔎 Opening a Journey
|
||||
1. In the transaction list, click a transaction to open the Customer Journey drawer on the right.
|
||||
2. The header shows the **ATM**, the **date and time**, and the **transaction type** (Withdrawal, Deposit, and so on).
|
||||
3. Close the drawer with the **✕** button or the **Escape** key.
|
||||
|
||||
## 👀 What you're looking at
|
||||
Just under the header, quick chips summarize the transaction:
|
||||
|
||||
- **Card / Account** — the masked card number or account used.
|
||||
- **Amount** — the transaction value and currency.
|
||||
- **Result** — whether the host **APPROVED** or **DECLINED** it.
|
||||
- **Seq** — the transaction's sequence number.
|
||||
- **⏱ Dwell time** — how long the card was in the machine (inserted → ejected).
|
||||
|
||||
## 🧭 Transaction Flow
|
||||
The main timeline reads top to bottom, in the order things happened at the ATM:
|
||||
|
||||
- **Card Inserted / Session Started** and **Card Ejected / Session Ended**.
|
||||
- The **transaction type** with its **Amount** and any **Fee**.
|
||||
- **Host Approved** or **Host Declined**.
|
||||
- **Cash Dispensed** — for approved withdrawals, showing the notes handed out (and, where the machine reports it, the denominations, e.g. `$20 × 5`).
|
||||
- **Check / Cash Accepted** — for approved deposits.
|
||||
|
||||
Green steps succeeded, red steps failed, amber steps need attention.
|
||||
|
||||
## 📄 Extra detail
|
||||
- **Transaction Records** — expand to see the full field-by-field record (amounts, account, result codes, receipt text). Multiple records show as tabs.
|
||||
- **Cheque Images** — for deposits, front and back scans of any deposited cheques appear automatically.
|
||||
- **Raw Block** — the unedited ATM journal for this transaction, with a **Copy** button to paste into a support ticket.
|
||||
|
||||
## 🤖 Ask Adoons
|
||||
1. Click **Ask Adoons** at the bottom to get a plain-language read on the transaction.
|
||||
2. Adoons returns a **verdict** (successful, failed, or suspicious), a short narrative, and a breakdown of the key steps.
|
||||
3. Click **Re-analyze** to run it again, or **View Analysis** to reopen a saved result.
|
||||
|
||||
> Adoons only appears when it's available for your account. Its verdict is a helpful summary — always confirm against the Transaction Flow and records for disputes.
|
||||
@@ -0,0 +1,30 @@
|
||||
---
|
||||
module: transactions.journal-parsing
|
||||
title: Journal Parsing Rules
|
||||
tab: Overview
|
||||
order: 10
|
||||
audience: customer
|
||||
---
|
||||
|
||||
Controls how HiveIQ reads the journal files your ATMs upload and turns them into transactions. Use this screen when transactions look wrong or incomplete, or when you add ATMs from a new vendor.
|
||||
|
||||
## 📋 Parsing Rules
|
||||
1. The **Journal Parsing Rules** panel shows the active rules — transaction types, field patterns, and system events — grouped into sections like Version, Timestamp Pattern, Transaction Rules, and System Events.
|
||||
2. Click **Edit Rules** to change them, then **Save & Apply** to put them live (or **Cancel** to discard).
|
||||
3. Click **Reload Rules** to refresh from the current rule file without editing.
|
||||
|
||||
> After saving or reloading, the version number updates so you can confirm the change took effect.
|
||||
|
||||
## 🏷️ Journal / Vendor Types
|
||||
1. The **Journal / Vendor Types** panel lists any vendor-specific rule sets you've defined.
|
||||
2. Assign a type to an ATM's journal files so those files use that vendor's custom rules.
|
||||
3. If no type is assigned, the default rules apply to every ATM.
|
||||
|
||||
> If no vendor types are listed yet, you can add them in the rules file above.
|
||||
|
||||
## 🔄 Reparse Journals
|
||||
1. Use the **Reparse Journals** panel to re-process already-uploaded journal files with the current rules.
|
||||
2. Enter an **ATM ID** to reparse just that machine, or leave it blank to reparse all ATMs.
|
||||
3. Click the reparse button — HiveIQ tells you how many files were queued.
|
||||
|
||||
> Reparsing deletes the existing transactions for those files and rebuilds them from the original journals. Use it after you change the rules so past data reflects the update.
|
||||
@@ -0,0 +1,46 @@
|
||||
---
|
||||
module: transactions.processing-rules
|
||||
title: Journal Processing Rules
|
||||
tab: Overview
|
||||
order: 10
|
||||
audience: customer
|
||||
---
|
||||
|
||||
This screen controls how HiveIQ reads the raw activity logs coming off your ATMs and turns them into recognizable transactions and system events. Use it when you want to add a new transaction type, fine-tune how activity is labelled, or teach HiveIQ to flag a specific machine event.
|
||||
|
||||
There are two lists on this page: **Transaction Types** and **System Events**. Both work the same way — the rules are checked from top to bottom, and the **first rule that matches wins**, so the order matters.
|
||||
|
||||
## 🧾 Transaction Types
|
||||
Rules here decide how each customer transaction is labelled (for example WITHDRAWAL, DEPOSIT, or BALANCE).
|
||||
|
||||
**What you can do:**
|
||||
1. Click **+ Add Type** to create a new transaction label.
|
||||
2. Give it a **Type Name** (e.g. WITHDRAWAL).
|
||||
3. Optionally set **JPR Contains** — a word or phrase that must appear in the journal text for the rule to apply.
|
||||
4. Optionally set **Op Code Matches** — one or more operation codes (comma-separated) to match by code.
|
||||
5. Use the **↑ / ↓** arrows to move a rule up or down and change its priority.
|
||||
6. Use **Edit** to change an existing rule, or **Delete** to remove it.
|
||||
|
||||
> Leave **JPR Contains** blank to match any transaction content, and leave **Op Codes** blank to skip code matching.
|
||||
|
||||
## ⚙️ System Events
|
||||
Rules here watch for machine-level activity outside of a transaction — things like the network dropping, power cycling, or a cassette running low. Each match raises an event of the type you choose.
|
||||
|
||||
**What you can do:**
|
||||
1. Click **+ Add Event**.
|
||||
2. Enter a **Pattern** — the text to look for in the log (you can list alternatives separated by a `|`, e.g. `HOST CONNECTED|HOST RECONNECTED`).
|
||||
3. Pick an **Event Type** from the list (for example NETWORK_DISCONNECTED, POWER_OFF, ATM_OUT_OF_SERVICE).
|
||||
4. Reorder, **Edit**, or **Delete** rules the same way as transaction types.
|
||||
|
||||
## What you're looking at
|
||||
- **Order** — the priority of the rule; lower numbers are checked first.
|
||||
- **Type Name** — the label applied to matching transactions.
|
||||
- **JPR Contains** — the text that must appear for a transaction rule to match.
|
||||
- **Op Code Matches** — the operation code(s) a transaction rule matches on.
|
||||
- **Pattern** — the text HiveIQ searches for when detecting a system event.
|
||||
- **Event Type** — the kind of event raised when the pattern is found.
|
||||
|
||||
## 💾 Saving changes
|
||||
When you make a change, an **unsaved changes** notice appears. Click **Save & Apply** (in the header or at the bottom of the page) to put your rules into effect right away — no restart needed. Use **Reload** to discard your edits and load the last saved rules.
|
||||
|
||||
> Good to know: because rules are matched top to bottom, put your most specific rules near the top and your broad "catch-all" rules lower down.
|
||||
@@ -0,0 +1,40 @@
|
||||
---
|
||||
module: transactions.reparse
|
||||
title: Journal Reparse
|
||||
tab: Overview
|
||||
order: 10
|
||||
audience: customer
|
||||
---
|
||||
|
||||
Re-process uploaded journal files when transactions look wrong — for example duplicates, missing entries, or files that failed to read the first time. Use this after a fix has been applied so the affected files are read again and the transaction records rebuilt.
|
||||
|
||||
## 🗂️ Choose a Journal Type
|
||||
1. Use the **ATM Journals** tab for standard ATM journal files.
|
||||
2. Use the **TCR Journals** tab for teller cash recycler files.
|
||||
|
||||
> Each tab shows and re-processes only its own type of file.
|
||||
|
||||
## 📊 Check File Parse Status
|
||||
1. (Optional) Type an **ATM ID** in the filter box to look at one machine, then click **Refresh**.
|
||||
2. Review the coloured status pills for a quick count of how files stand, plus a **Total**.
|
||||
3. Scroll the table for per-file detail.
|
||||
|
||||
**What you're looking at**
|
||||
|
||||
- **ATM** — the machine the file came from.
|
||||
- **Date** — the journal date the file covers.
|
||||
- **Status** — where the file is: *Parsed* (done), *Pending* (waiting), *Parsing* (in progress), or *Error* (failed).
|
||||
- **Transactions** — how many transactions were read from that file.
|
||||
- **Error** — a short note when a file failed to process.
|
||||
|
||||
## 🔄 Trigger a Reparse
|
||||
1. (Optional) Enter an **ATM ID** to reparse just that machine. Leave it blank to reparse every ATM's files.
|
||||
2. Click **Reparse All**.
|
||||
3. Confirm in the pop-up — it tells you whether you're reparsing one ATM or all of them.
|
||||
4. You'll see how many files were queued (for example "Queued 12 of 12 files").
|
||||
|
||||
> Reparsing removes the current transactions for the selected files and reads them again from scratch. Reparsing all ATMs can take several minutes.
|
||||
|
||||
## 🕐 Good to Know
|
||||
- Processing runs in the background — files move through *Pending* → *Parsing* → *Parsed* on their own.
|
||||
- Turn on **Auto-refresh** (top right) to have the status update every few seconds, or click **Refresh** to check progress yourself.
|
||||
@@ -0,0 +1,38 @@
|
||||
---
|
||||
module: vault.cit-visits
|
||||
title: CIT Visits
|
||||
tab: Overview
|
||||
order: 10
|
||||
audience: customer
|
||||
---
|
||||
|
||||
A record of every Cash-in-Transit (CIT) service visit to your ATMs — what the CIT company added, removed, and left behind on each call. Use it to review recent visits and confirm the cash counts are correct.
|
||||
|
||||
## 🔍 Find the Visits You Need
|
||||
1. Open the **Filters** panel on the left (click the arrow to expand it).
|
||||
2. Filter by any of:
|
||||
- **ATM ID** — type to find visits for one machine.
|
||||
- **Vendor** — type to find visits by a CIT company.
|
||||
- **Status** — Pending, Confirmed, or Disputed.
|
||||
- **From / To** — narrow to a date range.
|
||||
3. Active filters show as tags above the table — click the **×** on a tag to remove just that one, or **Clear all** to reset.
|
||||
|
||||
> The pill next to the Filters title shows how many visits match.
|
||||
|
||||
## 📋 What You're Looking At
|
||||
Each row is one CIT service visit. The columns show:
|
||||
|
||||
- **ATM ID** — the machine that was serviced.
|
||||
- **Visit Date** — when the CIT company was on site.
|
||||
- **Vendor** — the CIT company that made the visit.
|
||||
- **Reference** — the CIT company's own reference number for the visit (if provided).
|
||||
- **Slots** — how many cassette slots were counted.
|
||||
- **Cash Added** — total cash loaded into the ATM.
|
||||
- **Cash Removed** — total cash taken out.
|
||||
- **Removals** — value of non-cash items removed (such as checks, deposits, or rejected notes).
|
||||
- **Status** — where the visit stands: **Pending** (awaiting review), **Confirmed** (counts verified), or **Disputed** (a discrepancy was flagged).
|
||||
|
||||
## 👀 Open a Visit
|
||||
Click any row to open the full visit — the per-cassette counts and item removals for that service call.
|
||||
|
||||
> **Good to know:** Use the pager at the top of the table to move through pages or change how many visits show at once.
|
||||
@@ -0,0 +1,38 @@
|
||||
---
|
||||
module: vault.dashboard
|
||||
title: Dashboard
|
||||
tab: Overview
|
||||
order: 10
|
||||
audience: customer
|
||||
---
|
||||
|
||||
Your at-a-glance view of Cash-in-Transit (CIT) activity across your fleet. Open the Dashboard when you want a quick read on recent servicing and how much cash has moved this year.
|
||||
|
||||
## 📊 What You're Looking At
|
||||
|
||||
Four summary cards sit across the top:
|
||||
|
||||
- **Visits This Month** — how many CIT service visits have been recorded so far this month.
|
||||
- **Pending Confirmation** — visits still waiting to be reviewed and confirmed (highlighted so they stand out).
|
||||
- **Cash Added YTD** — total cash added to ATMs by your CIT vendors this year.
|
||||
- **Removals YTD** — total value of items removed (checks, deposits, rejected notes) this year.
|
||||
|
||||
## 📋 Recent Visits
|
||||
|
||||
Below the cards is a table of the latest visits, with these columns:
|
||||
|
||||
- **ATM ID** — the machine that was serviced.
|
||||
- **Visit Date** — when the visit took place.
|
||||
- **Vendor** — the CIT company that made the call.
|
||||
- **Reference** — the vendor's reference number for the visit (shows a dash if none).
|
||||
- **Cash Added** — total cash added during the visit.
|
||||
- **Removals** — value of any items removed (shows a dash if nothing was removed).
|
||||
- **Status** — **Pending**, **Confirmed**, or **Disputed**.
|
||||
|
||||
## ✅ What You Can Do Here
|
||||
|
||||
1. Review the summary cards for a fast snapshot of the current month and year-to-date totals.
|
||||
2. Scan the Recent Visits table for the newest servicing activity.
|
||||
3. Click any row to open that visit's full detail, including per-cassette counts and removals.
|
||||
|
||||
> If no visits have been recorded yet, the table shows "No visits recorded yet." Keep an eye on the **Pending Confirmation** count — those visits still need your review.
|
||||
@@ -0,0 +1,38 @@
|
||||
---
|
||||
module: vault.import
|
||||
title: Import
|
||||
tab: Overview
|
||||
order: 10
|
||||
audience: customer
|
||||
---
|
||||
|
||||
Bring your CIT (Cash in Transit) visit data into HiveIQ by uploading a CSV file from your cash carrier. Use this screen whenever you receive a new cash-count file and want those visits recorded against your ATMs.
|
||||
|
||||
## 📥 Upload a File
|
||||
1. Drag and drop your CSV file onto the upload box, or click **Browse File** to pick it from your computer.
|
||||
2. Only `.csv` files are accepted — other file types are rejected.
|
||||
3. The import starts automatically and shows **Uploading…**, then appears at the top of the history list.
|
||||
|
||||
> The row updates on its own as it processes — no need to refresh. You'll see a message when it's complete.
|
||||
|
||||
## 📄 Download Template
|
||||
1. Click **↓ Download Template** in the top corner.
|
||||
2. This saves a sample CSV showing the exact column layout to fill in.
|
||||
|
||||
## 📖 CSV Format Reference
|
||||
Open the **CSV Format Reference** section on the screen for a quick reminder of the layout:
|
||||
- **Cassette rows** record each cassette slot — the ATM, visit date, vendor, reference, slot, denomination, cassette type (DISPENSER, RECYCLER, RETRACT, or MIX), and the opening, added, removed, and closing amounts.
|
||||
- **Removal rows** record non-cash items pulled from the machine — set the slot to `REMOVAL` and list the type (CHECK, DEPOSIT, or REJECTED_NOTE), the count, and the amount.
|
||||
|
||||
> Rows that share the same ATM, visit date, vendor, and reference are grouped together into a single visit.
|
||||
|
||||
## 📊 Import History
|
||||
The history table lists every file you've uploaded:
|
||||
- **Filename** — the file you sent.
|
||||
- **Imported** — when it was uploaded.
|
||||
- **By** — who uploaded it.
|
||||
- **Records** — how many visits were created from the file.
|
||||
- **Status** — **Processing** while it runs, **Completed** when finished, or **Failed** if something went wrong.
|
||||
- **Error** — a short reason shown only when an import fails.
|
||||
|
||||
> Use the paging controls below the table to move through older imports and change how many rows you see at a time.
|
||||
Reference in New Issue
Block a user