DBestChatBot.Umbraco 1.2.0

DBestChatBot for Umbraco

Adds the DBestChatBot AI assistant to an Umbraco site and keeps it up to date with the site's own data.

Supported: Umbraco 10, 11, 12 and 13 (.NET 6, 7 and 8), and Umbraco 17 and newer (.NET 10). One package covers both; NuGet picks the right build for your site. Umbraco 14 to 16 are not supported yet.

Get your site token

Create a DBestChatBot account at https://dbestchatbot.com, then ask us for an Umbraco site token at https://dbestchatbot.com/contact. The token starts with ums_.

Install (one time, about 10 minutes)

1. Add the package to the web project:

   dotnet add package DBestChatBot.Umbraco
   

2. Add the site token you received from DBestChatBot to appsettings.json:

   "DBestChatBot": {
     "SiteToken": "ums_..."
   }
   

3. Deploy. That's it. Which chatbot appears on which pages, and what is synced, is managed from the DBestChatBot dashboard.

What it does

• Chat widget: adds one <script> tag before </body> on public pages that have a chatbot assigned. Never on /umbraco.
• Read-only sync (every 6 hours by default):
  • table and column names (no data) so the right tables can be chosen;
  • the published page tree (names, URLs, page types, 3 levels);
  • only the tables and columns chosen in the dashboard.
• It only ever runs SELECT queries. It never writes to your database.

Control which pages show the chat

Which pages show the chat is set in the DBestChatBot dashboard, by path: the whole site, or only the sections you choose. Three ways to keep it off a page, strongest first:

1. Site owner, in appsettings.json. Pages listed here never show the chat, whatever the dashboard says:

   "DBestChatBot": {
     "SiteToken": "ums_...",
     "ExcludedPaths": [ "/checkout", "/members" ]
   }
   

   Each entry covers that page and every page below it.

2. Editors, in the Umbraco backoffice. Add a Toggle (true/false) property with the alias hideChatbot to your document types (or a shared composition). Tick it on a page to hide the chat there and on every page below it. Use a different alias with "HideProperty": "yourAlias".

3. DBestChatBot dashboard. Switch the chat on for the whole site or for sections, and off for pages inside them (for example on for /austin-west, off for /austin-west/register). Changes reach the site within 15 minutes, no redeploy.

To try it on one page only, add "Sync": false as well: the package then only shows the chat and reads nothing from your database.

Safety

• Nothing runs during page requests except an in-memory lookup for the widget.
• All network and database work happens in a background task. Any failure is logged and retried; it can never stop the site or a page from loading.
• Columns whose names contain password, hash, salt, token, secret, email, phone, mobile, birth, card, IBAN and similar are never sent, whatever the dashboard asks for. Binary columns are never sent.
• In a load-balanced setup, data sync runs only on the scheduling server.

Optional settings

"DBestChatBot": {
  "SiteToken": "ums_...",
  "Enabled": true,             // master switch
  "Widget": true,              // show the chat widget
  "Sync": true,                // read-only data sync
  "SyncIntervalHours": 6,
  "AllowedTables": [],         // when set, ONLY these tables can ever be read
  "BlockedColumns": [],        // extra column-name fragments that must never leave the site
  "ExcludedPaths": [],         // pages (and everything below) that never show the chat
  "HideProperty": "hideChatbot" // true/false property editors tick to hide the chat; "" turns it off
}

Uninstall

Remove the package reference (or set "Enabled": false) and deploy.