Skip to content

Documentation

Nx Powertoys (NxPT) is a localhost web UI that extends NX Witness administration: camera credentials, server inventory, Rule Groups, timers, schedules, Timelapse capture, and User Rosters.

Start here after install — same topics as the in-app Welcome page, curated for the public site.

First-time setup

New install? Begin with the Install guide, then connect on the Status page (Digest Authentication required).

Guides

Guide Use when
Features What each module does
Pricing Licences and channel
Screenshots UI walkthrough + YouTube
FAQ Common questions
Install Windows / Linux install and first connect
User guide Config, timers, User Roster notes, logging, troubleshooting
Scheduling examples Cron expressions for schedules
Release notes What changed per Publish

Downloads Contact / activate

Module map

Status & connection

Monitor health, NX credentials, licence groups, Soft Trigger migrate, database maintenance.

Camera passwords

Centralized view/export of camera credentials across the system.

Rule Groups

Named sets of NX Event Rules — enable/disable together; Soft Triggers for ARM/DISARM.

Timers & schedules

Duration timers and cron schedules that target Rule Groups, Timelapses, or User Rosters.

Timelapse

Scheduled hi/low-res snapshots to local NX storage — Licence Group 2.

User Roster

Apply desired login enable/disable for named User sets — Licence Group 3.

Product overview

Nx Powertoys enhances NX server administration with tools that sit outside the regular NX roadmap: credentials, automation, scheduled capture, and login roster apply.

Key capabilities

  • Camera password management — centralized view and HTML export
  • Server information — OS / platform details for servers in the system
  • Rule Groups — group Event Rules and apply desired enabled states
  • Timers — duration-based Start/Stop style automation with Soft Triggers
  • Schedules — cron-driven targets (Rule Groups, Timelapses, User Rosters)
  • Timelapse — scheduled still capture to local NX storage + gallery/archives
  • User Roster — push stored desired isEnabled per member (not NX User Groups)

Compatibility

NX Witness 5.1.4.38717+ (hive-capable). See Install for OS and Digest Authentication requirements.

Status and NX connection

The Status page is the hub for health and connection. Other modules need a working NX session.

Connection setup

Setting Typical value
NX server port 7001 (default API)
Username NX Administrator
Password That user's password

Digest Authentication

The NX Administrator used by NxPT must have Digest Authentication enabled. Without it, many API calls fail (rules, passwords, and more).

Enable it in NX Client: System Administration → Users → select admin → enable Digest Authentication → save.

What Status shows

  • Connected / Not connected — reachability and auth
  • Licence status — which Licence Groups are active (1 Rule Groups stack, 2 Timelapse, 3 User Roster)
  • Soft Trigger bind drift / migrate when Hardware ID or API shape changes
  • Database backup / restore / purge controls

Connection troubleshooting

  • NX server running and reachable from the NxPT host
  • Port correct (usually 7001)
  • Username / password correct
  • Digest Authentication enabled on that user

More: User guide — Troubleshooting.

Camera passwords

Centralized credentials for cameras on the connected NX system.

Includes

  • Usernames and passwords
  • Vendor / manufacturer
  • Camera names
  • Optional thumbnails
  • Export camera list to HTML

Security

Treat exports as secrets. Restrict who can open the Passwords page (NxPT login) and where HTML exports are stored.

Server list

Inventory of NX servers in the system: name, OS platform/variant/version, online status, server ID. Useful for inventory, version checks, and maintenance planning.

Rule Groups

Rule Groups are named collections of NX Event Rules. Applying a group sets each member’s desired enabled state. Soft Triggers can ARM/DISARM groups from the NX Client.

Typical workflow

  1. In NX Client rules editor, comment rules you want NxPT to list
  2. In NxPT → Rule Groups → New / Edit
  3. Include commented rules; set desired State per member
  4. Apply directly, or let NxPT create Soft Trigger / Generic Event wiring

Practices

  • Prefer commented rules so the picker stays focused
  • Name groups clearly (e.g. Perimeter_Arm, Office_Disarm)
  • Test Soft Triggers after Hardware ID / host changes (use Status migrate when prompted)

Timers

Timers are duration-based automation: start a window, optionally retrigger, fire linked Rule Groups / events, create Soft Triggers for Start/Stop style control.

Common uses: presence windows, temporary ignore rules, timed enable/disable.

See also User guide — Timers.

Schedules

Schedules use standard cron: minute hour day month day-of-week.

Example Meaning
0 8 * * 1-5 Weekdays 08:00
0 12 1 * * 1st of month at noon
*/15 * * * * Every 15 minutes
0 8 * * 0 Sundays 08:00

Creating a schedule

  1. Schedules → New Schedule
  2. Unique name
  3. Cron expression
  4. Optional skip count
  5. Select targets — Rule Groups, Timers, Timelapses, and/or User Rosters
  6. Save; use Apply Now to test

Full cron catalog: Scheduling examples.

Timelapse

Timelapse captures scheduled stills from selected cameras to local NX storage. Config and timing are separate: define a Timelapse (storage + cameras), then attach it as a schedule target.

Setup

  1. Timelapse page — choose storage and cameras (immutable Timelapse ID)
  2. Schedules — new schedule with cron (e.g. */15 * * * *)
  3. Target type Timelapse — select your Timelapse
  4. Save → Apply Now to verify a capture

Snapshots land under paths like:

{storage}/timelapse/{timelapseId}/{camera}/hi|low/{timestamp}.jpg

Gallery / archives / export live on the Timelapse gallery page in the app.

Licence Group 2

Timelapse requires Licence Group 2. Check Status for availability.

User Roster

A User Roster is a named bag of NX Users. Apply pushes each member’s stored desired login isEnabled (mixed enable/disable in one apply).

This is not an NX Witness User Group (permissions/roles).

Workflow

  1. User Roster → New — roster id (no spaces), pick eligible Users (local / ldap / cloud; not temporaryLocal)
  2. Set desired enabled/disabled per member
  3. Apply now, or attach as a Schedule target

Protected Users

Site owners, administrators (best-effort), and the NxPT service user are never disabled by roster apply and stay out of the member picker.

More: User guide — User Roster.

Licence Group 3

User Roster requires Licence Group 3.

Advanced

  • Recent Actions Log — session-scoped log of significant applies (UI and schedule-driven); see User guide
  • Debug / logging config — Status / logging pages for deeper traces
  • Port — default 8080; auto-increments by 10 if busy; Linux config under /opt/nxpt/etc/config.json
  • Licensing — perpetual, Hardware ID bound; activate via Contact

Troubleshooting (quick)

Symptom Check
Cannot connect NX up, port, network, credentials
Auth failures Digest Authentication on the admin user
Features missing Licence Group on Status; NxPT login
API errors NX version ≥ 5.1.4.38717
Slow / stuck Host load, debug logs, disk for DB/timelapse

Full checklist: User guide — Troubleshooting · Contact