Dashboard

The SBN-Search Dashboard is the browser console for an SBN-Search server. Open https://<server>:9095 (or the port chosen during installation) from any workstation that can reach the server, and sign in with the password set by the installer. The user name is fixed as admin; the password can be changed on the Account tab. Tabs run across the top of every page, and the header carries the product version and the sign-out button.

The Search tab appears once the PostgreSQL connection is configured or indexing is running.

Dashboard

The landing tab opens with a single health verdict: Search is healthy (with the number of installations indexed), Search is working, with warnings, or Search needs attention. Below the verdict, each problem is listed in plain English with the fix beside it; a healthy server lists nothing to act on. The verdict follows the index contents and the indexer's cycle timing, so it reads Search is healthy as soon as the search copy holds installations, including while the first full reindex is still running; the installation count grows until the reindex finishes, and progress shows on the Index tab. The conditions it reports are described in Troubleshooting.

The System cards give the database status and version, process CPU and memory, free space on the database drive, database size and current connection count. The Insights section expands to show rolling metrics with a range picker (1 minute, 1 hour, 24 hours, 7 days), latest values and time-series charts. Leave Insights collapsed for a quick health check; open it when you need evidence of a trend.

Search

Runs a live search the way a caller would. Every result is scoped to the acting user, so what you see is exactly what that user would see.

• Search box - the term to look up.
• Max rows - the largest number of results to return.
• s#us or userid - search as a specific user, applying that user's access.
• Dealers - further restrict - narrow the search within the acting user's access. Leave blank to use that user's full access.
• Advanced - separate fields for installation, contact, alarm ID, work order and service ticket.

Results show as a Table or as raw JSON (what a caller such as APIEngine receives), with match counts and elapsed time. Recent queries lists the last searches; click one to re-run it. The request example panel builds ready-to-copy commands; paste in an API key and the examples show the exact request an external caller sends.

Index

Controls indexing from the SBN Data Server into the search copy. What the tab shows depends on the node's role.

On the leader (every single-server installation):

• Indexing - turn indexing on or off. Turning it on for the first time builds the full search copy; after that each cycle picks up changed installations. Turning it off stops after the current batch.
• Run Reindex rebuilds the search copy from the SBN Data Server. Run Delta runs one change pass now.
• Status, Leader, Last error, Current step and a progress bar. During a rebuild the bar tracks progress through all installations; when idle it reports the number of installations indexed.
• Batch size (rows/tick) and Tick interval (seconds) - how many installations each cycle processes and how often a cycle runs. Press Save settings to apply.
• Clear processed rows from the change tracker - on by default. After each cycle, sbn-search deletes the change-tracker rows it has processed. Turn it off while an ElasticSearch search is still running against the same database, so that indexer stays in charge of emptying the tracker; turn it on once sbn-search is the only search, otherwise nothing empties the tracker and every cycle re-reads the whole outstanding set. Press Save settings to apply.

The box at the top of the tab shows this node's name and role, for example Node: <name> (Leader). A leader has no Request leadership button.

On a follower (a farm node that is not the leader): the tab names the leader node, links to its Dashboard, and offers Request leadership to move indexing to this node. That button is the only control a follower has on this tab.

API Keys

Lists the API keys that callers such as APIEngine present when they search. A key authenticates a caller without sharing the administrator sign-in, can be limited to the capabilities and dealers it needs, and can be switched off at any time.

Creating an API key

Use the + button to open the editor and fill in:

• Name - a label that identifies the caller, for example "APIEngine - production".
• Capabilities - what the key may do (below).
• Dealers - All dealers or Only selected.

The key's value is shown once, when it is created or rotated. It cannot be displayed again. Copy it straight into the caller's settings or a secrets manager, and treat it like a password.

Capabilities

Grant only what a caller needs. APIEngine needs only Search.

Dealer scope

A key's dealer scope only narrows what the acting user may see. All dealers applies no extra limit, so each user still sees only their own dealers' installations. Only selected additionally excludes every dealer outside the list.

Managing existing keys

Each key's row offers Edit (name, capabilities, dealers), Rotate (issue a new value with the same access; the old value stops working immediately), Disable or Enable, and Delete. Coordinate a rotate or delete with whatever uses the key, since it starts failing at once.

Farm

Lists the nodes in a multi-server farm, which node is the leader, and each node's state. From here you can add a node, enable or disable one, remove one, and designate the leader. A single-server installation has one node.

Throttling

Limits how much search work the server accepts at once, so heavy concurrency queues and slows down instead of overloading the machine:

• Max concurrent searches - searches that run at the same time; the rest queue.
• Max queue wait (ms) - how long a queued search waits for a free slot before it is refused as busy.
• Statement timeout (ms) - the longest a single search may run.
• Broad-term guard - a search term that would match a very large share of installations returns a "refine your search" notice instead of results.

Recommend Settings inspects the host, shows the facts it used and the recommended figures, and Apply copies them into the form for review. Saved settings take effect immediately, with no restart.

Indexing is limited separately, by the Index tab's batch size and tick interval.

Logs

Shows recent log lines from this server, filterable by level. Live log lines, including the indexing activity lines, need the Innovative NATS service; without it the tab explains that logging is to files only. Log file locations are in Troubleshooting.

Connectivity

Holds the connections SBN-Search makes, on two sub-tabs. Each has its own Save button and a Test Connection button that reports reachability without saving.

SBN Data Server

The source SBN-Search indexes from. Fields: Platform, Datasource, Port, Default Database (normally sbnpro), Username, Password, Charset and Timeout (s).

Use SMART SBN (always read from the Primary server) - when ticked, SBN-Search finds the primary SBN Data Server itself. Tick it wherever the primary server can change, so indexing never reads from a standby.

PostgreSQL

Where SBN-Search keeps its search copy. Fields: Server, Port, Timeout (s), Username, Password and Database. The installer fills this in for the shared Innovative PostgreSQL service; change it only to point at a different PostgreSQL server, and restart the SBN-Search service afterwards.

Account

Settings for this Dashboard, on two sub-tabs:

• SMTP - the mail server SBN-Search sends through.
• Account & Security - the contact email address, and the change-password form, which asks for the current password and the new one twice (at least 6 characters).

The Dashboard's displayed name can be changed from the pencil icon beside the title in the header.