Haruno Knowledge base

Signing in and roles

How an operator signs in, what each kind of operator can do, and what the sidebar and the status strip show.

  • Operator consoleAvailable

The operator console is where our team looks after the service. It shows real customers and real money, so it is only for operators. The pictures in this knowledge base use made-up names.

This page explains how to get in and who can do what. Each screen has its own page.

Signing in

The console opens on a box that asks for an Operator key.

The sign-in box of the operator console, with a field for the operator key and a Sign In button
  1. Type your own operator key.
  2. Press Sign In.

Things to know:

  • Every operator has their own key. A super admin creates it and shows it once. There is no screen in the console for creating operators.
  • A super admin can also disable an operator or change their role. There is no screen for that either. Either change signs the operator out, and they come back under the new role. The last super admin cannot be disabled or given another role.
  • The console does not keep your key. It keeps you signed in for a while instead. When that time runs out, the console shows the sign-in box again.
  • A few wrong keys in a row are refused for a short time.

The second step

An operator who has set up a second step on the Security page is asked for a code after the key. The box adds a Code field and says "Enter the 6-digit code from your authenticator, or one of your recovery codes." The key field is locked while you type the code.

If the service requires a second step of super admins, a super admin who has none sees only the Security page after signing in, until they set one up.

Three kinds of operator

KindWhat they can do
Super adminSees every page and can change things. Only a super admin sees Sync emails, Maintenance and Knowledge base.
ViewerReads the pages. Cannot change anything. Still sees customers' email addresses, usage and money.
Release publisherAn account made for the release process. It can read and set the Client version page, and nothing else.

Some buttons are hidden from a viewer. Others are shown, and a viewer who presses one is told that their role does not allow it. Nothing is changed.

Reading is recorded too

Changes are recorded with the name of the operator who made them. So is reading private data, such as a session's text or a customer's list of requests.

The sidebar

The sidebar on the left lists the pages. A viewer sees the same list without Sync emails, Maintenance and Knowledge base. On a narrow screen the sidebar hides behind a Menu button.

The sidebar of the operator console for a super admin, listing Sessions, Analytics, Web Search, Keys, Users, Waitlist, Organizations, Tiers, Promos, Subscriptions, Financials, Integrations, QuickBooks, Sync emails, Client version, Health, Maintenance, Knowledge base and Security
The sidebar for a viewer: the same list without Sync emails, Maintenance and Knowledge base, still ending with Security
PageWhat it is forWho can change things
SessionsLook at recent work, open one, stop oneSuper admin
AnalyticsUsage and cost over a periodRead only
Web SearchHow web searches ended, and which search services are usedSuper admin
KeysKeys and teams, their spend and budgetsSuper admin
UsersFind a customer, plan, credit, organization, deletionSuper admin
WaitlistFollow up on people who asked about HarunoSuper admin
OrganizationsOrganizations, members, seat plan, shared balanceSuper admin
TiersThe plans and their allowancesRead only
PromosPromo codesSuper admin
FinancialsIncome, cost and profitRead only
IntegrationsConnector versions for the Windows appSuper admin
QuickBooksWhich QuickBooks app and environment is in useRead only
Sync emailsSummaries of scheduled QuickBooks syncsSuper admin
Client versionWhich Windows app version customers getSuper admin and release publisher
HealthWhether the AI service works, and prepaid creditSuper admin
MaintenanceLogins for the public status pageSuper admin
Knowledge baseKeys to the internal knowledge baseSuper admin
SecurityYour own second step for signing inEvery operator, for their own account

The status strip

The row at the top of every page is the status strip. It starts with Overall, then shows one chip for each AI setting the service offers.

ColorMeaning
Green, healthyWorking
Amber, degradedWorking with more errors than usual
Red, unhealthyNot working
Grey, unknownNo reading yet. This is not a fault

The time on the right says how old the reading is. The strip updates itself every minute. If an update fails, it keeps the last good reading. The Health page has the detail.

Signing out

Sign Out is at the bottom of the sidebar. It ends all your sessions, on every computer where you are signed in, not only this one.

What a person in support or sales can ask an operator

  • "Is the service up right now?" The status strip answers it.
  • "Can you change this for the customer?" Ask who is a super admin. Only a super admin can change things, and a viewer cannot.

Last updated · PR #2944 · View this version on GitHub

History (1 version)
  1. Internal knowledge base for staff: site, reader keys, assistant, 197 pages and the PR rule (#2944)
    What changed
    @@ -0,0 +1,105 @@
    +---
    +title: Signing in and roles
    +summary: How an operator signs in, what each kind of operator can do, and what the sidebar and the status strip show.
    +feature: ops-console
    +covers:
    +  - web/monitoring/components/AuthGate.tsx
    +  - web/monitoring/components/AuthPage.tsx
    +  - web/monitoring/components/MonitoringSidebar.tsx
    +  - web/monitoring/components/Shell.tsx
    +  - web/monitoring/components/ModelStatusChips.tsx
    +  - web/monitoring/lib/http.ts
    +  - server-dotnet/src/Haruno.Server/Auth/AdminAuthService.cs
    +  - server-dotnet/src/Haruno.Server/Controllers/AdminAuthController.cs
    +---
    +
    +The operator console is where our team looks after the service. It shows real customers and real money, so it is only for operators. The pictures in this knowledge base use made-up names.
    +
    +This page explains how to get in and who can do what. Each screen has its own page.
    +
    +## Signing in
    +
    +The console opens on a box that asks for an **Operator key**.
    +
    +<Shot src="/m/78c5745e71f0-ops-sign-in-dark.png" alt="The sign-in box of the operator console, with a field for the operator key and a Sign In button" />
    +
    +1. Type your own operator key.
    +2. Press **Sign In**.
    +
    +Things to know:
    +
    +- Every operator has their own key. A super admin creates it and shows it once. There is no screen in the console for creating operators.
    +- A super admin can also disable an operator or change their role. There is no screen for that either. Either change signs the operator out, and they come back under the new role. The last super admin cannot be disabled or given another role.
    +- The console does not keep your key. It keeps you signed in for a while instead. When that time runs out, the console shows the sign-in box again.
    +- A few wrong keys in a row are refused for a short time.
    +
    +### The second step
    +
    +An operator who has set up a second step on the [Security](/ops/console/security/) page is asked for a code after the key. The box adds a **Code** field and says "Enter the 6-digit code from your authenticator, or one of your recovery codes." The key field is locked while you type the code.
    +
    +If the service requires a second step of super admins, a super admin who has none sees only the Security page after signing in, until they set one up.
    +
    +## Three kinds of operator
    +
    +| Kind | What they can do |
    +|---|---|
    +| **Super admin** | Sees every page and can change things. Only a super admin sees **Sync emails**, **Maintenance** and **Knowledge base**. |
    +| **Viewer** | Reads the pages. Cannot change anything. Still sees customers' email addresses, usage and money. |
    +| **Release publisher** | An account made for the release process. It can read and set the Client version page, and nothing else. |
    +
    +Some buttons are hidden from a viewer. Others are shown, and a viewer who presses one is told that their role does not allow it. Nothing is changed.
    +
    +<Callout variant="info" title="Reading is recorded too">
    +Changes are recorded with the name of the operator who made them. So is reading private data, such as a session's text or a customer's list of requests.
    +</Callout>
    +
    +## The sidebar
    +
    +The sidebar on the left lists the pages. A viewer sees the same list without **Sync emails**, **Maintenance** and **Knowledge base**. On a narrow screen the sidebar hides behind a **Menu** button.
    +
    +<Shot src="/m/a225e270dada-ops-sidebar-super-admin-dark.png" alt="The sidebar of the operator console for a super admin, listing Sessions, Analytics, Web Search, Keys, Users, Waitlist, Organizations, Tiers, Promos, Subscriptions, Financials, Integrations, QuickBooks, Sync emails, Client version, Health, Maintenance, Knowledge base and Security" />
    +
    +<Shot src="/m/91d88f38adec-ops-sidebar-viewer-dark.png" alt="The sidebar for a viewer: the same list without Sync emails, Maintenance and Knowledge base, still ending with Security" />
    +
    +| Page | What it is for | Who can change things |
    +|---|---|---|
    +| [Sessions](/ops/activity/sessions/) | Look at recent work, open one, stop one | Super admin |
    +| [Analytics](/ops/activity/analytics/) | Usage and cost over a period | Read only |
    +| [Web Search](/ops/activity/web-search/) | How web searches ended, and which search services are used | Super admin |
    +| [Keys](/ops/system/keys/) | Keys and teams, their spend and budgets | Super admin |
    +| [Users](/ops/customers/users/) | Find a customer, plan, credit, organization, deletion | Super admin |
    +| [Waitlist](/ops/customers/waitlist/) | Follow up on people who asked about Haruno | Super admin |
    +| [Organizations](/ops/customers/organizations/) | Organizations, members, seat plan, shared balance | Super admin |
    +| [Tiers](/ops/customers/tiers/) | The plans and their allowances | Read only |
    +| [Promos](/ops/customers/promos/) | Promo codes | Super admin |
    +| [Financials](/ops/customers/financials/) | Income, cost and profit | Read only |
    +| [Integrations](/ops/releases/integrations/) | Connector versions for the Windows app | Super admin |
    +| [QuickBooks](/ops/releases/quickbooks/) | Which QuickBooks app and environment is in use | Read only |
    +| [Sync emails](/ops/releases/sync-emails/) | Summaries of scheduled QuickBooks syncs | Super admin |
    +| [Client version](/ops/releases/client-version/) | Which Windows app version customers get | Super admin and release publisher |
    +| [Health](/ops/system/health/) | Whether the AI service works, and prepaid credit | Super admin |
    +| [Maintenance](/ops/system/maintenance-accounts/) | Logins for the public status page | Super admin |
    +| [Knowledge base](/ops/system/knowledge-base-readers/) | Keys to the internal knowledge base | Super admin |
    +| [Security](/ops/console/security/) | Your own second step for signing in | Every operator, for their own account |
    +
    +## The status strip
    +
    +The row at the top of every page is the status strip. It starts with **Overall**, then shows one chip for each AI setting the service offers.
    +
    +| Color | Meaning |
    +|---|---|
    +| Green, healthy | Working |
    +| Amber, degraded | Working with more errors than usual |
    +| Red, unhealthy | Not working |
    +| Grey, unknown | No reading yet. This is not a fault |
    +
    +The time on the right says how old the reading is. The strip updates itself every minute. If an update fails, it keeps the last good reading. The [Health](/ops/system/health/) page has the detail.
    +
    +## Signing out
    +
    +**Sign Out** is at the bottom of the sidebar. It ends all your sessions, on every computer where you are signed in, not only this one.
    +
    +## What a person in support or sales can ask an operator
    +
    +- "Is the service up right now?" The status strip answers it.
    +- "Can you change this for the customer?" Ask who is a super admin. Only a super admin can change things, and a viewer cannot.