Knowledge

Artikel und Anleitungen

MarktplatzInhalte und DokumenteVersion 0.1.0manifest

Wofür sie gedacht ist ​

A wiki of articles arranged in a tree, with draft, published and archived states and tags. Visibility is a label: there are no row-level permissions yet, so everyone with access to the app reads every article.

Was das Paket leistet und was nicht ​

A wiki: articles arranged in a tree through a parent article, with a draft, published, archived flow, a visibility setting and tags. Visibility is a label for the UI and for people to respect; the platform has no row-level permissions yet, so everyone with the Knowledge groups can read every article.

Modelle ​

knowledge_article ​

An article of the knowledge base

Lesegruppe: knowledge.user. Schreibgruppe: knowledge.user.

FeldArtDatenklassePersonenbezogene DatenGruppeAgenten sehenBeschreibung
titletextnoneneinknowledge.userim KlartextArticle title
parent_idref → knowledge_articlenoneneinknowledge.userim KlartextThe article this one is nested under; empty for a top-level article
bodylongtextnoneneinknowledge.userim KlartextArticle content (Markdown)
visibilityselect (private, workspace, public)noneneinknowledge.userim KlartextWho the article is meant for: private, workspace, public
tagstextnoneneinknowledge.userim KlartextComma-separated tags, for example onboarding,hr
author_nametextpublic_directoryjaknowledge.usermaskiertName of the author
sequencenumbernoneneinknowledge.userim KlartextOrder among its siblings, lowest first
published_ondatenoneneinknowledge.userim KlartextDay the article was published (YYYY-MM-DD)
stateselect (draft, published, archived)noneneinknowledge.userim KlartextArticle status: draft, published, archived

Workflows ​

knowledge_article ​

AktionBewegtWer sie ausführen darfFreigabe
knowledge_article.publishstate: draft → publishedknowledge.managernein
knowledge_article.unpublishstate: published → draftknowledge.managernein
knowledge_article.archivestate: published → archivedknowledge.managernein

Berechtigungsgruppen ​

Von dieser App verwendete Gruppen:

  • knowledge.manager
  • knowledge.user

Freigabeschritte ​

Kein Schritt dieser App braucht eine Freigabe, abgesehen vom Löschen von Datensätzen.

Was Agenten tun können und was nicht ​

Ein Agent kann Datensätze dieser App lesen, durchsuchen, anlegen und aktualisieren sowie Aktionen ausführen, die keine Freigabe brauchen, und zwar innerhalb der Berechtigungsgruppen seines Tokens.

Diese Schritte kann er nur vorschlagen, und eine Person muss sie freigeben: knowledge_article.delete.

Personenbezogene Daten werden als Platzhalter maskiert: knowledge_article.author_name.

Abhängigkeiten ​

Keine.

Installation ​

Installieren Sie sie in der App Customize (Marktplatz) oder über die Kommandozeile:

bash
obop modules install-from knowledge

Erfordert eine Datenbank und Administratorrechte.

Selbst bauen ​

Der Modulleitfaden zeigt, wie Apps wie diese geschrieben werden