servchan/tools/README.md
jmcqueen c2e98d105e Initial commit: ServChan Webex bot for ServiceChannel work orders.
ServiceChannel webhook processor, proposal approval cards, attachment auto-post,
CollabSupport commands, and Docker deployment configuration.

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-08-24 15:12:08 -04:00

37 lines
No EOL
1.7 KiB
Markdown

# ServChan Tools
This directory contains standalone operational and data utility scripts used alongside (or historically with) the main ServChan Webex bot.
These scripts are **not** part of the runtime bot. They are one-off or scheduled tools for device management, data enrichment, and troubleshooting in the retail environment.
## Directory Layout
- **appleTV/** — Apple TV / AirPlay device discovery and Meraki enrichment scripts + sample data.
- **optisign/** — Optisign digital signage device status queries (GraphQL).
- **fixWiredTV/** — One-time remediation scripts for wired Apple TV / display issues (Meraki port flapping + MDM commands).
- **meraki/** — (Reserved) Meraki-specific enrichment or client data tools.
- `convert.js` — General data conversion helper.
## Important Notes
- Most of these scripts read from `../config/config.json` (the same file used by the bot).
- Many were written iteratively and may have hardcoded values or be in varying states of maintenance.
- Several functions that these scripts previously performed locally (especially AV/device status for stores) have moved to the remote CollabSupport service that the main bot now calls for `/avStatus` and similar commands.
- Large CSV/JSON outputs are often generated here and may be gitignored or cleaned periodically.
## Running
```bash
cd tools/appleTV
node appleTV.js # or appleTV-enhanced.js
```
Same pattern for the others. They are plain Node.js scripts (ESM or CJS — check the shebang/import style of each file).
## Future
As the main ServChan bot and its supporting remote services mature, some of these tools may be retired or folded into scheduled jobs / the remote CollabSupport API.
---
**Last organized**: 2026-05-28 during ServChan base cleanup refactor.