botserver/docs/src/chapter-04-gbui/how-to/README.md

12 KiB

How To... Tutorials

📖 Step-by-Step Guides for General Bots Suite

Clear instructions for common tasks, inspired by classic computer manuals


┌─────────────────────────────────────────────────────────────────────────┐
│                                                                         │
│    ╔═══════════════════════════════════════════════════════════════╗    │
│    ║                                                               ║    │
│    ║   ██╗  ██╗ ██████╗ ██╗    ██╗    ████████╗ ██████╗            ║    │
│    ║   ██║  ██║██╔═══██╗██║    ██║    ╚══██╔══╝██╔═══██╗           ║    │
│    ║   ███████║██║   ██║██║ █╗ ██║       ██║   ██║   ██║           ║    │
│    ║   ██╔══██║██║   ██║██║███╗██║       ██║   ██║   ██║           ║    │
│    ║   ██║  ██║╚██████╔╝╚███╔███╔╝       ██║   ╚██████╔╝    ██╗    ║    │
│    ║   ╚═╝  ╚═╝ ╚═════╝  ╚══╝╚══╝        ╚═╝    ╚═════╝     ╚═╝    ║    │
│    ║                                                               ║    │
│    ╚═══════════════════════════════════════════════════════════════╝    │
│                                                                         │
│                   Your Guide to General Bots Suite                      │
│                                                                         │
└─────────────────────────────────────────────────────────────────────────┘

About These Tutorials

These tutorials are designed like the classic computer manuals of the early 1990s — clear, numbered steps with visual diagrams showing exactly what to do. Each tutorial follows the same format:

  • Objective — What you'll accomplish
  • Time Required — How long it takes
  • Prerequisites — What you need before starting
  • Steps — Numbered instructions with screenshots
  • Troubleshooting — Common problems and solutions
  • Next Steps — What to learn next

🚀 Getting Started

Tutorial Description Time
Create Your First Bot Set up a working bot from scratch 10 min
Your First Conversation Talk to your bot and understand responses 5 min
Understanding the Interface Navigate the Suite like a pro 10 min

💬 Chat & Conversations

Tutorial Description Time
Ask Questions Effectively Get better answers from your AI assistant 5 min
Use Voice Input Talk instead of type 3 min
Create Chat Shortcuts Set up quick commands 10 min
Export Conversations Save chat history for reference 5 min

📁 File Management (Drive)

Tutorial Description Time
Upload Your First File Add documents to Drive 3 min
Organize with Folders Create a logical file structure 10 min
Share Files Securely Grant access to team members 5 min
Search for Documents Find files instantly 5 min

📚 Knowledge Base

Tutorial Description Time
Add Documents to Knowledge Base Teach your bot from files 15 min
Import a Website Crawl and learn from web pages 10 min
Create FAQ Responses Define question-answer pairs 15 min
Manage Collections Organize knowledge by topic 10 min

🔧 BASIC Dialogs

Tutorial Description Time
Write Your First Dialog Create a simple conversation script 20 min
Use HEAR and TALK Gather and display information 10 min
Store User Information Remember data between conversations 15 min
Call External APIs Connect to web services 20 min
Send Automated Messages Schedule broadcasts and reminders 15 min

📱 Messaging Channels

Tutorial Description Time
Connect WhatsApp Set up WhatsApp Business integration 30 min
Configure Email Enable email conversations 15 min
Set Up SMS Add text message support 15 min
Embed Web Chat Add chat to your website 10 min

📊 Analytics & Monitoring

Tutorial Description Time
View Bot Statistics Understand usage metrics 10 min
Monitor Live Sessions Watch conversations in real-time 10 min
Create Custom Reports Build dashboards for insights 20 min
Export Analytics Data Download metrics for external analysis 10 min

🎨 Customization

Tutorial Description Time
Change Your Bot's Theme Customize colors and appearance 10 min
Add a Custom Logo Brand your bot interface 5 min
Create Custom Cards Design rich message layouts 20 min
Modify the Welcome Message Personalize the first interaction 5 min

🏢 Templates

Tutorial Description Time
Install the CRM Template Set up customer relationship management 20 min
Use the HR Template Deploy employee self-service 15 min
Configure Compliance Bot Enable privacy request handling 25 min
Build from Template Customize a template for your needs 30 min

🔒 Security & Administration

Tutorial Description Time
Set Up User Authentication Enable secure login 20 min
Configure Permissions Control who can do what 15 min
Enable Audit Logging Track all system activities 10 min
Backup Your Bot Protect your configuration and data 15 min

🐛 Troubleshooting

Tutorial Description Time
Debug Dialog Errors Fix common BASIC script problems 15 min
Resolve Connection Issues Troubleshoot network problems 10 min
Fix Knowledge Base Gaps Improve bot answers 20 min
Performance Optimization Make your bot faster 15 min

Quick Reference Card

┌─────────────────────────────────────────────────────────────────────────┐
│                        QUICK REFERENCE CARD                             │
├─────────────────────────────────────────────────────────────────────────┤
│                                                                         │
│  KEYBOARD SHORTCUTS                                                     │
│  ─────────────────                                                      │
│  Ctrl + Enter ........ Send message                                     │
│  Ctrl + K ............ Quick command palette                            │
│  Ctrl + / ............ Toggle voice input                               │
│  Ctrl + N ............ New item (context-aware)                         │
│  Ctrl + S ............ Save current work                                │
│  Escape .............. Close dialog/panel                               │
│                                                                         │
│  COMMON BASIC KEYWORDS                                                  │
│  ────────────────────                                                   │
│  TALK "message" ...... Display message to user                          │
│  HEAR variable ....... Wait for user input                              │
│  SET BOT MEMORY ...... Store bot-wide data                              │
│  GET USER MEMORY ..... Retrieve user-specific data                      │
│  USE KB "name" ....... Activate knowledge base                          │
│  SEND MAIL ........... Send email notification                          │
│                                                                         │
│  WHERE TO GET HELP                                                      │
│  ─────────────────                                                      │
│  • Type "help" in Chat for assistance                                   │
│  • Press F1 anywhere for context help                                   │
│  • Visit community.pragmatismo.com for forums                           │
│  • Email support@pragmatismo.com for enterprise support                 │
│                                                                         │
└─────────────────────────────────────────────────────────────────────────┘

Tips for Following Tutorials

Before You Start

  1. Bookmark this page — You'll return to it often
  2. Have the Suite open — Follow along step-by-step
  3. Take notes — Write down customizations you make
  4. Don't skip steps — Each step builds on the previous

While Following Steps

  1. Read the entire step first — Then perform the action
  2. Match the screenshots — If your screen looks different, stop and check
  3. Use exact values — Type what the tutorial shows, then customize later
  4. Check results — Verify each step worked before moving on

If Something Goes Wrong

  1. Don't panic — Most problems have simple solutions
  2. Re-read the step — You may have missed something
  3. Check Troubleshooting — Each tutorial has a help section
  4. Ask for help — The Chat assistant can guide you

Icon Legend

Throughout these tutorials, you'll see these indicators:

Icon Meaning
💡 Tip — Helpful suggestion to work more efficiently
⚠️ Warning — Important caution to avoid problems
📝 Note — Additional information or context
Checkpoint — Verify your progress before continuing
🔧 Configuration — Settings you may need to adjust

Version Information

These tutorials are written for:

  • General Bots Suite version 5.0+
  • Browser: Chrome, Firefox, Safari, or Edge (latest versions)
  • Last Updated: 2025

If you're using an older version, some screens may look different.


"The best way to learn is to do."

Start with Create Your First Bot