chore: scaffold Outlook VSTO Add-in for EspoCRM
Initial repo scaffold for a Windows VSTO/COM Outlook Add-in (C#/.NET FW 4.8) that integrates Outlook desktop with EspoCRM via the existing MailRouter v1.2.0 endpoint (POST /api/v1/MailRouter/file). Includes: - Solution + 4 csproj projects (host, Core, UI, Tests) under src/ - VSTO host project stub (ThisAddIn.cs, requires VS 2022 + Office workload to fully resolve) - Core/UI/Tests as SDK-style net48 projects (NuGet: Polly, System.Text.Json, Serilog, CommunityToolkit.Mvvm, xUnit, Moq, FluentAssertions) - .gitea/workflows/build.yml for Windows runner CI (publish/sign placeholders) - docs/ARCHITECTURE.md (component diagram, threading model, per-feature flow) - docs/ONBOARDING.md (Hebrew lawyer-facing install guide) Server-side already in place: MailRouter v1.2.0 — see plan ~/.claude/plans/resilient-sauteeing-feather.md for the 6-week implementation plan. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This commit is contained in:
@@ -0,0 +1,64 @@
|
||||
# התקנת OutlookAddin — מדריך לעו"ד
|
||||
|
||||
## מה זה התוסף?
|
||||
|
||||
תוסף ל-Outlook שמאפשר לתייק מיילים ל-EspoCRM ישירות מתוך Outlook, בלי להעתיק/להדביק או להגדיר BCC.
|
||||
|
||||
## דרישות
|
||||
|
||||
- Windows 10 או Windows 11
|
||||
- Outlook desktop (Microsoft 365 / Office 2021 / Office 2019)
|
||||
- חיבור אינטרנט
|
||||
- API key אישי ב-EspoCRM (תקבל מהאדמין)
|
||||
|
||||
## התקנה (5 דקות)
|
||||
|
||||
1. סגור את Outlook לגמרי (`File → Exit`, או יציאה דרך System Tray).
|
||||
2. פתח את הלינק: **https://platform.dev.marcus-law.co.il/outlook-addin/setup.exe**
|
||||
3. לחץ "Install" בחלונית שתיפתח.
|
||||
4. ההתקנה תיגמר תוך 30 שניות. אם רואים שגיאת "Unknown Publisher" — פנה לאדמין (חסר אישור הצוות).
|
||||
5. פתח את Outlook. תראה ב-Ribbon תפריט חדש בשם "EspoCRM".
|
||||
|
||||
## הגדרה ראשונית
|
||||
|
||||
1. בפעם הראשונה ש-Outlook ייפתח, ייפתח חלון "ברוך הבא ל-EspoCRM Add-in".
|
||||
2. **כתובת השרת** — מולא מראש: `https://crm.prod.marcus-law.co.il`
|
||||
3. **שם משתמש** — כתובת המייל שלך (לדוגמה `chaim@marcus-law.co.il`).
|
||||
4. **API Key** — הדבק את ה-key שקיבלת מהאדמין (נראה כמו `a1b2c3d4e5f6...`).
|
||||
5. לחץ "Test Connection". סימן ✓ ירוק = הכל עובד.
|
||||
6. לחץ "Save & Continue".
|
||||
|
||||
## שימוש יומיומי
|
||||
|
||||
### תיוק מייל לתיק
|
||||
- בחר מייל אחד או יותר ברשימה.
|
||||
- לחץ "**File to EspoCRM**" ב-Ribbon.
|
||||
- חפש את שם התיק או הלקוח, בחר, לחץ "File".
|
||||
- המייל יקבל קטגוריה צבעונית "Filed: <שם>" בעמודת הצבע ב-Outlook.
|
||||
|
||||
### מי הלקוח?
|
||||
- כשפותחים מייל, סיידבר ימני יופיע עם פרטי הלקוח/התיק (אם קיים ב-EspoCRM).
|
||||
- לחץ "Open in EspoCRM" כדי לעבור ישירות לתיק.
|
||||
|
||||
### כתיבת מייל חדש מתוך תיק
|
||||
- ב-EspoCRM, פתח תיק → לחץ "Email this case".
|
||||
- Outlook ייפתח עם כתובת + נושא ממולאים אוטומטית.
|
||||
|
||||
### סנכרון אוטומטי של תיקייה
|
||||
- לחץ "**Settings**" ב-Ribbon → טאב "Folders".
|
||||
- סמן את התיקיות שאתה רוצה לנטר (לדוגמה Inbox/Smith Family).
|
||||
- בחר "Auto-file when confident" או "Notify only".
|
||||
- מיילים שייכנסו לתיקיות האלו יסומנו/יתויקו אוטומטית.
|
||||
|
||||
## בעיות נפוצות
|
||||
|
||||
| בעיה | פתרון |
|
||||
|---|---|
|
||||
| Ribbon "EspoCRM" לא מופיע | File → Options → Add-ins → לוודא ש-MarcusLaw.OutlookAddin פעיל |
|
||||
| "401 Unauthorized" | API key לא נכון או הוחלף — פנה לאדמין |
|
||||
| "EspoCRM unreachable" | בדוק חיבור לאינטרנט; המיילים יישמרו בתור ויתויקו כשהחיבור יחזור |
|
||||
| Outlook איטי אחרי התקנה | סגור וטען מחדש את Outlook |
|
||||
|
||||
## דיווח על בעיה
|
||||
|
||||
ב-Settings → טאב "Diagnostics" → לחץ "Send Diagnostic Logs". יווצר קובץ zip ב-`%TEMP%`. שלח אותו לאדמין.
|
||||
Reference in New Issue
Block a user