// module reference
ntools
A grab bag of Niagara utilities: SMS and voice alarm recipients (Twilio-backed), alarm routing managers, history batch tools, a site checker, and a set of px widgets (gauges, maps, status icons).
Why the prefix is not always the same
A bog does not store the module name on every component. It stores a short prefix, and binds that prefix to a module once, like this:
<p n="SMSRecipient" h="27b7" m="sbsmi=ntools" t="sbsmi:SMSRecipient">The prefix comes from the module's preferred symbol, which has changed
between builds — kvg and sbsmi have both been
used — and two modules that want the same symbol get told apart per file. So
searching a bog for the text ntools will miss components, and
searching for a prefix will find the wrong ones. The binding has to be
resolved. That is what the tool on this site does.
Types in the station database
These are components that live in the station tree, so they are in the bog and the tool can remove them.
| Type | Seen in a bog as | What it is |
|---|---|---|
SMSRecipient |
kvg:SMSRecipient sbsmi:SMSRecipient |
Alarm recipient that sends SMS. Lives under the AlarmService and is linked from alarm classes. |
VoiceRecipient |
kvg:VoiceRecipient sbsmi:VoiceRecipient |
Alarm recipient that places a voice call. |
BasicAlarmRoutingManager |
kvg:BasicAlarmRoutingManager sbsmi:BasicAlarmRoutingManager |
Simple alarm routing manager component. |
AdvancedAlarmRoutingManager |
kvg:AdvancedAlarmRoutingManager sbsmi:AdvancedAlarmRoutingManager |
Schedule/site-aware alarm routing manager. |
AdvancedAlarmSiteConfig |
kvg:AdvancedAlarmSiteConfig sbsmi:AdvancedAlarmSiteConfig |
Per-site configuration for the advanced routing manager. |
AlarmPartsToString |
kvg:AlarmPartsToString sbsmi:AlarmPartsToString |
Formats alarm fields into a string for messaging. |
AddHistories |
kvg:AddHistories sbsmi:AddHistories |
Batch-adds history extensions across many points. |
AddHistoriesJobService |
kvg:AddHistoriesJobService sbsmi:AddHistoriesJobService |
Job service backing AddHistories. |
SiteChecker |
kvg:SiteChecker sbsmi:SiteChecker |
Periodic station health/consistency check. |
WaveCam |
kvg:WaveCam sbsmi:WaveCam |
Camera image proxy component with its own servlet. |
Types in graphics and views
These live in .px files or are referenced as view ords, not in
the station database. Removing components from a bog does not touch them, and
they will still be broken afterwards. Fix them in Workbench.
| Type | Seen as | What it is |
|---|---|---|
CircularGauge |
kvg:CircularGauge sbsmi:CircularGauge |
Px widget: circular gauge. |
LinearGauge |
kvg:LinearGauge sbsmi:LinearGauge |
Px widget: linear gauge. |
GMapsWidget |
kvg:GMapsWidget sbsmi:GMapsWidget |
Px widget: Google Maps embed. |
GMapsWidgetBuild |
kvg:GMapsWidgetBuild sbsmi:GMapsWidgetBuild |
Px widget: Google Maps builder variant. |
GmapsWidget |
kvg:GmapsWidget sbsmi:GmapsWidget |
Older lower-case spelling of GMapsWidget. |
StaticIconWidget |
kvg:StaticIconWidget sbsmi:StaticIconWidget |
Px widget: static icon. |
StatusIconWidget |
kvg:StatusIconWidget sbsmi:StatusIconWidget |
Px widget: status-driven icon. |
CSSButtonWidget |
kvg:CSSButtonWidget sbsmi:CSSButtonWidget |
Px widget: CSS-styled button. |
SMSWidget |
kvg:SMSWidget sbsmi:SMSWidget |
Px widget: SMS recipient editor. |
VoiceWidget |
kvg:VoiceWidget sbsmi:VoiceWidget |
Px widget: voice recipient editor. |
EmailWidget |
kvg:EmailWidget sbsmi:EmailWidget |
Px widget: email recipient editor. |
WaveCamWidget |
kvg:WaveCamWidget sbsmi:WaveCamWidget |
Px widget: WaveCam image display. |
AlarmRoutingManagerWidget |
kvg:AlarmRoutingManagerWidget sbsmi:AlarmRoutingManagerWidget |
Px widget: alarm routing manager view. |
BasicAlarmRoutingManagerWidget |
kvg:BasicAlarmRoutingManagerWidget sbsmi:BasicAlarmRoutingManagerWidget |
Px widget: basic routing manager view. |
AdvancedAlarmRoutingManagerWidget |
kvg:AdvancedAlarmRoutingManagerWidget sbsmi:AdvancedAlarmRoutingManagerWidget |
Px widget: advanced routing manager view. |
UserSiteMatrixWidget |
kvg:UserSiteMatrixWidget sbsmi:UserSiteMatrixWidget |
Px widget: user/site permission matrix. |
VirtualPointExtViewWidget |
kvg:VirtualPointExtViewWidget sbsmi:VirtualPointExtViewWidget |
Px widget: virtual point extension view. |
Common questions
What is the ntools Niagara module?
A grab bag of Niagara utilities: SMS and voice alarm recipients (Twilio-backed), alarm routing managers, history batch tools, a site checker, and a set of px widgets (gauges, maps, status icons).
Why does my station say the type kvg:SMSRecipient cannot be resolved?
That type belongs to the ntools module. The station was built on a host with ntools installed and is now running somewhere it is not. Either install the module, or remove the components that use it.
How do I remove ntools from a station without Workbench?
Open the .bog with the tool on this site. It removes every ntools component and any link left pointing at one, entirely in your browser, and gives you a report of what was taken out.
Your options
- Install the module. If you can get the jar and you are licensed to run it, this is the least disruptive path — nothing in the station changes.
- Remove the components. Use the tool on this site. The station loses that functionality but it will start and run.