Knowledge base

Úvod

Tento článek obsahuje dokumentaci k doplňku Knowledge base (KB; oficiálně vydaném v únoru 2023, dostupném od verze 12.6 a vyšší), který je nástupcem staršího (nesouvisejícího) modulu - Knowledge base.

KB je nativně integrované řešení Easy Project s BlueSpice, které je postaveno na MediaWiki a vyvinuto naším technologickým partnerem Hallo Welt!. Jedná se o specializovanou aplikaci pro sdílení znalostí, která pracuje v součinnosti s funkcemi týmové spolupráce Easy Projectu.

Data z původního modulu lze do KB migrovat.

Zprovoznění KB

Z technického hlediska je KB samostatně běžící aplikace, která je úzce propojena s Easy Projectem. Protože jsme si uvědomovali možné potíže pro správce aplikace, zavázali jsme se, že to připravíme co nejplynulejší.

Cloud

Pro uživatele cloudu je celý proces automatický. Instance KB je automaticky vytvořena a připojena k vašemu Easy Projectu. Když se rozhodnete ji otestovat nebo začít používat v produkci, funguje to stejně jako u jakékoli jiné standardní funkce - doplněk se aktivuje (v nabídce Globálního menu najdete novou položku) a můžete jej začít ihned používat.

Server

Serverové řešení KB je poskytováno jako Docker image. Po jeho spuštění ve vaší infrastruktuře jej připojíte ke svému Easy Projectu prostřednictvím uživatelského rozhraní v administraci ER.

Přečtěte si prosím návod k instalaci v samostatném článku.

Zkušební verze

KB není k dispozici v běžných zkušebních aplikacích. Chcete-li ji vyzkoušet, obraťte se na svého obchodního zástupce nebo na Easy Podporu.

Živé demo

Existuje i sdílená demo aplikace dostupná na https://demo-kb.easysoftware.com/ (manager / easy848). Její data jsou sdílená a pravidelně resetována.

Administrace v Easy Projectu

Pro přístup k administraci KB přejděte do Administrace >> Moduly >> Knowledge base - Upravit

 

Nastavení poskytovatele BS oauth2 pro API

Tato část je určena pro obecné propojení mezi EP a KB. Jak bylo uvedeno výše, v Cloudu se generuje automaticky.

Kontrolní tlačítko by mělo být první věcí, kterou otestujete, pokud máte pocit, že KB nefunguje (například vyhledávání v KB nevrací výsledky). Důležité je také vždy kliknout na tlačítko v případě jakýchkoli změn v nastavení.

Nastavení poskytovatele oauth2 pro SSO

SSO se generuje automaticky v cloudovém i serverovém řešení. Jsou zde důležité informace pro případné ladění problémů s přístupem z EP do KB.

Aktualizace oprávnění v BS pro všechny uživatele

Tlačítko je určeno pouze pro specifické situace. Mechanismus, který za ním stojí, funguje automaticky.

Příklad: Když někomu v EP snížíte oprávnění z editace znalostí na čtení znalostí, může trvat delší minuty, než se tato změna promítne do KB. Pokud nechcete čekat na automatickou propagaci změny, stačí kliknout na toto tlačítko.

Role a práva

V Easy Projectu jsou nakonfigurovány tři úrovně přístupu.

V části Role a práva najdete sekci pro KB.

• Zobrazit články - Uživatel v roli s tímto právem může pouze číst stránky
• Spravovat články - Uživatel v roli s tímto právem je v KB "Editor", což znamená, že může vytvářet a upravovat stránky a má povoleny i další (neadministrátorské) operace.
• Administrátor v EP má také přístup k administraci KB.

Migrace z původní znalostní báze

Pokud jste nikdy nepoužívali původní verzi, můžete tuto kapitolu bez obav ignorovat.

Pokud používáte původní znalostní bázi a plánujete migraci na KB, znamená to, že máte nainstalované (aktivované) obě verze. V takovém případě najdete v Administrace >> Moduly >> Znalostní báze - Upravit, další sekci.

Co se stane po kliknutí na tlačítko:

1. Původní znalostní příspěvky jsou ověřeny, zda jsou bezproblémově migrovatelné
2. Bezproblémově migrovatelné příspěvky jsou migrovány
3. "Problematické" příspěvky jsou vypsány a ponechány na vašem rozhodnutí

Co znamená problematický?

Některé názvy stránek (název znalosti) které byly v původní KB povoleny, nejsou povoleny, nebo mají zvláštní význam. V důsledku toho by se při migraci buď transformovaly, nebo by se obsah migroval neočekávaným způsobem.

Podrobnosti o všech speciálních nebo nepovolených znacích názvů naleznete zde:

https://www.mediawiki.org/wiki/Manual:Page_title

https://www.mediawiki.org/wiki/Manual:%24wgLegalTitleChars

V praxi je příkladem speciálního funkčního znaku lomítko "/", například titulek: Jak vytvořit/upravit úkol. V KB představuje "/" oddělovač podstránek. To by znamenalo, že při migraci by se importovala stránka: Jak vytvořit a její podstránka upravit úkol. Což rozhodně není to, co očekáváte nebo chcete. V takovém případě byste raději upravili název znalostního příspěvku na Jak vytvořit nebo upravit úkol.

Po úpravě názvu znovu klikněte na tlačítko Ověřit a migrovat, tato stránka již nebude uvedena jako problematická, ale bude přímo migrována.

Dalším příkladem jsou jednoduše nepovolené znaky, jako například ">" nebo "&", které mohou být migrací odstraněny nebo nahrazeny. Záleží na konkrétní situaci. I tyto názvy doporučujeme spíše změnit než importovat bez ověření.

Migrovat správně validované články

Pokud některé znalosti neprošli validací, máte možnost zmigrovat alespoň ty zbylé - přesně na to slouží toto tlačítko.

Během procesu nezapomeňte zkontrolovat migraci, abyste zajistili správný výsledek.

Přistupování do KB

KB je ze strany Easy Project přístupná přes různá místa.

Globální menu

Stejně jako do mnoha jiných funkcí lze i do KB vstoupit prostřednictvím nabídky Globální menu. Najdete ji v sekci Přídavné moduly. Kliknutím sem se dostanete na hlavní stránku KB.

Horní panel

Stejně jako původní verze má i KB ve všudypřítomné horní liště, widget pro vyhledávání. Ikona je trochu jiná, aby nedošlo k záměně v přechodném období, kdy můžete mít aktivované obě KB.

Stačí vyhledat klíčové slovo. Po kliknutí na výsledek budete přesměrováni na článek v aplikaci KB.

Toto vyhledávání prohledává veškerý indexovaný obsah v KB.

Související články o úloze

Pokud má úkol související články, získáte k nim přístup přímo z detailu úlohy. Vyhledávání dostupné v této sekci prohledává pouze názvy článků, nikoli celý obsah.

Práce v KB

Protože KB je samostatná aplikace, má také vlastní uživatelskou příručku, která je k dispozici na adrese: https://knowledge-base.easysoftware.com .

Příručka je sama o sobě implementovanou instancí. Skládá se ze 4 hlavních knih a provede vás prvními kroky a seznámí vás s nejdůležitějšími organizačními a administrativními oblastmi. Nezapomeňte, že s implementací komplexního systému sdílení znalostí není třeba spěchat. Postupujte krok za krokem, abyste nejprve plně pochopili základní logiku, než ji zavedete ve své organizaci.

Datové vztahy Easy Project + KB

Easy Project obsahuje projekty a úkoly (velmi zjednodušeně řečeno), KB obsahuje články (opět zjednodušená formulace). Podívejme se, jak se vzájemně prolínají.

Úkol - článek

Nejpřirozenější vazba, která každého napadne, je mezi nejpoužívanějšími entitami.

Na každém úkolu najdete sekci pro vyhledávání článků, abyste je mohli jedním kliknutím propojit. Toto vyhledávání prochází pouze názvy článků, nikoli celý obsah.

Zrušení odkazu se provádí jako obvykle tlačítkem Zrušit odkaz

Takto to vypadá ze strany článku.

 

Projekt - článek

Znalostní články lze propojit s projekty ze strany KB

Vložený článek na nastavitelné stránce

Zajímavou možností je vložení článku do libovolného typu přizpůsobitelné stránky v Easy Projectu, například na Projektovém Dashboardu.

Widget se nazývá Článek ze znalostí. Stačí vyhledat článek, vybrat jej a stránku uložit. Toto vyhledávání prohledá veškerý indexovaný obsah v KB.

Stránka vyhledávání v textovém editoru

Při psaní textu v komentářích k úkolu, popisu, historii projektu, widgetu apod. můžete použít symbol § k vyvolání vyhledávání článku v rámci KB, který bude pak odkazován ve vašem textu (podobně jako symbol @ pro vyhledávání uživatelů).

Upozornění: Z bezpečnostních důvodů budou vyhledávány pouze Namespace označené jako veřejné nebo používající globální oprávnění. Tyto nastavení lze nalézt na následujícím odkazu: /wiki/Special:NamespaceAccess

Profesionální implementace

V souladu se standardy robustních podnikových systémů může být KB dodávána i se specializovaným konzultantem, který vás provede implementací odrážející specifika vaší organizace. O této možnosti se informujte u svého obchodního zástupce nebo na Easy Podpoře.

Společnost Easy Software může bez váhání doporučit profesionální implementaci na základě vlastních zkušeností s touto službou, kterou nám poskytl náš partner, autor aplikace.