Frappe
Diese Kapitel bedient alle DocTypes welche sich im "frappe Core" befinden.
GitHub: https://github.com/frappe/frappe
- Änderungen von der Plattform in das eigene App Repository schreiben
- Developermode
- Serverskript (Server Script)
- Clientskript (Client Script)
- Sprache (Language)
- Datei (File)
- Systemverwaltung (System Settings)
- Kommunikation (Communication)
- Verlauf der Route (Route History)
- Benutzergruppe (User Group)
- Sitzungsstandardeinstellungen (Session Default Settings)
- Workflow
- Benutzer (User)
- Modulprofil (Module Profile)
- Modul (Module)
- Kommentar (Comment)
- Geplantes Jobprotokoll ( Scheduled Job Log)
- Geplanter Auftragstyp ( Scheduled Job Type)
- Rollengenehmigung Seite und Bericht (Role Permission for Page and Report)
- Anhänge (Attachments)
Änderungen von der Plattform in das eigene App Repository schreiben
Einleitung
Es ist sinnvoll einige Änderungen über die Plattform zu machen und diese nicht als Änderungen im git Repository selbst durchzuführen.
Achtung, wir greifen hier in das System ein. Vorsicht ist geboten! |
Voraussetzungen
- ssh Zugriff auf den eigenen Server
- Zugang zum Konto "Administrator" auf der eigenen Platform
- einen Git Account zum eigenen Repository
- eine eigene App
Änderungen über die Plattform
Mit den entsprechenden Rechten können wir auf der eigenen Plattform Änderungen durchführen. Hier muss berücksichtigt werden wie man diese Änderungen macht und wo diese gespeichert werden, damit diese nicht beim nächsten Update einfach überschrieben werden.
Im wesentlichen können wir an zwei Stellen Änderungen im System über die Plattform vornehmen.
- aus der Listenansicht des entsprechenden DocTyps
- im DocTyp selbst aus der DocType List
1 ist für die allermeisten Änderungen geeignet.
2 Hier können wir auch Änderungen an z.B. Tabellen machen und auch mehr verändert als in 1.
Das Repository abgleichen und beschreiben
Wenn Felder aus ERPNext manipuliert werden sollen ist folgender Weg zu empfehlen:
falls nicht geschehen, vorher config für „comiiter“ anpassen.
-
über shell alle Ordner unterhalb von frappe benche mit „chown -R frappe:frappe *“
-
Developermode auf Server setzen
-
als Administrator anmelden
-
Issue über Listansicht anpassen (customize)
-
Felder ändern und DocType mit button Update aktualisieren
-
hit button „Export Customizations“
-
über shell in app Ordner wechseln (z.B. apps\it_management
-
„git status“ um änderungen zu sehen
-
„git add –all“ um Änderungen hinzuzufügen
-
„git commit -m „Änderungskommentar“
-
„git push“ um Änderungen an repository zu senden.
Verwandte Artikel
Verwandte Artikel erscheinen hier basierend auf den Stichwörtern, die Sie auswählen. Klicken Sie, um das Makro zu bearbeiten und Stichwörter hinzuzufügen oder zu ändern.
|
Developermode
Bitte strickt vermeiden dies auf Produktiv System anzuschalten!
Einleitung
Damit tieferliegende Änderungen auf der Plattform durchgeführt werden können ist es notwendig, dass eine Einstellung in der Konfiguration gesetzt wird. Dies ist auch notwendig wenn Änderungen als angemeldet mit dem Konto "Administrator" durchgeführt werden wollen.
Developermode aktivieren
Wir gehen per SSH auf unseren Server und wechseln in den Ordner
home/frappe/frappe-bench
Dort tragen wir folgenden Befehl ein
sudo bench --site [site name] set-config developer_mode 1
Wobei [site name]der Name unserer Seite ist.
Developermode deaktivieren
Wir gehen per SSH auf unseren Server und wechseln in den Ordner
home/frappe/frappe-bench
Dort tragen wir folgenden Befehl ein
sudo bench --site [site name] set-config developer_mode 0
Wobei [site name]der Name unserer Seite ist.
https://github.com/frappe/bench/wiki/Stopping-Production-and-starting-Development
Serverskript (Server Script)
Einleitung
Um ERPNext noch stärker zu erweitern können
https://www.google.com/search?client=firefox-b-d&q=frappe+serverskript
https://docs.erpnext.com/docs/v13/user/manual/en/customize-erpnext/server-script
Clientskript (Client Script)
Einleitung
Diese Code-Erweiterungen können dazu genutzt werden über die Browser-Sitzung die Oberfläche von ERPNext zu manipulieren. Sie können in ganz unterschiedlicher Weise eingesetzt werden.
https://frappeframework.com/docs/v13/user/en/desk/scripting/client-script
Sprache (Language)
Einleitung
In ERPNext gibt es den DocType Sprache. Dieser wird vorwiegend dazu genutzt um selbige als Verlinkung in anderen DocTypes zu verwenden und ist somit ZieldocType für eine Verknüpfung.
Im DocType Sprache sind folgende Felder gepflegt:
Drucksprache
Die Sprache wird in einem Feld Drucksprache (Print Language) verlinkt. Diese bestimmt in Stammdaten ( ein Beispiel Vertrieb -> Kunde ) welche Sprache als Standard in den Druckformaten der Transaktionen zu den Stammdaten verwendet werden. Diese vererben sich. Ändern wir die Sprache auf dem Transaktionsweg wird sie entsprechend in die Zukunft mitvererbt. (Schaubild folgt)
Vererbung der Drucksprache bei Transaktionen
Ein Lead wir automatisch mit einer voreingestellten (noch nicht klar wo dies geschieht) Drucksprache angelegt. Diese kann (1) geändert werden.
Wird ein vererbendes Dokument per Create Button angelegt, so wird die Print Language mitvererbt.
Weiterführende Links
Datei (File)
Einleitung
Datei ist ein Core-DocType des frappe Frameworks. Es bietet uns eine rudimentäre Dateiverwaltung innerhalb unserer ERPNext Systems.
Alle Dateien die in irgend einer Weise in das System geladen werden wie z.B. über Anhänge in eingehenden E-Mails oder aber das hochladen von Profil-Bildern generiert Einträge dieses Typs.
All diese Dateien finden wir auf dem Server unter dem Pfad sites/sitename/public/files
und FIXME (Private Pfad).
Als Anwender im System finden Datei unter Werkzeuge -> Datein
Öffnen wir die Listenansicht sehen wir diese
Dateien können in Ordner und Unterordnern liegen.
Ist Privat
Das ändern dieser Einstellung kann zu weitreichende Probleme in der Darstellung von Bildern systemweit führen.
Nicht gesetzt
Bleibt dieses häkchen leer ist das Bild auf unsere Webseite öffentlich zugänglich. Die Datei befindet sich im Pfad
/files/
Dies ist dann sinnvoll, wenn wir die Bilder auf unserer Webseite verwenden wollen.
Häkchen gesetzt
Setzen wir das Häkchen ändert sich der Pfad in /private/files/
/private/files/dateiname.dateiendung
Alle dateien, welche nicht für die Öffentlichkeit bestimmt sind sollten daher immer das Häkchen "Ist Privat" gesetzt haben!
Dateigröße, Datei-URL, Ist Ordner
- Hier zeigt uns das System die GRöße der Datei in FIXME
- In diesem Feld sehen wir den Pfad der Datei in unserem System.
- Der DocType Datei ist in einer Baumstruktur. Die Knoten der Struktur sind in diesem Fall Ordner. Dies wird über dieses Häkchen bestimmt.
1. Dateigröße
Die Datei ist dann immer dann 0 wenn sie mehrmals im System abgelegt ist. Das System dedupliziert hier.
2. Datei-URL
In diesem Fall /files/Punkt4.png der gesamte Pfad wäre dann z.B. https://phamos.eu/files/Punkt4.png
3. Ist Ordner
Im Standard gibt es in ERPNext zwei Ordner in Datei. Diese sind Attachments und Home. Attachments ist ein Unterordner von Home.
Home
In Home finden wir alle Dateien welche nach Anmeldung im System hochgeladen wurden. Dazu gehören Bilder von Mitarbeitern, Anhänge an Vorgängen und anderen DocTypes.
Hier gibt es Ausnahmen!
Attachments
Attachments ist ein Unterordner von Home
Alle Dateien die via E-Mail (Kommunikation) in das System gelangen oder aus diesem versendet wurden werden in diesen Ordner gelegt.
Hier gilt es einiges zu berücksichten!
Systemverwaltung (System Settings)
Einleitung
Hier können wir Systemweite Einstellungen vornehmen. Dazu gehören Einstellungen zu Zahlen und Datenvormaten, E-Mailsignaturen, Sicherheitseinstellungen zu Passwörtern und Anmeldemöglichkeiten. Weiter geht es um Backups und Einstellungen zu DocTpes.
Hier wird aufgeschlüsselt wie sich die E-Mail Einstellungen im E-Mailpostfach eingeht.
Mehr zu E-Mailsignaturen finden wir hier: https://handbuch.tueit.de/books/erpnext-benutzerhandbuch/page/e-mailsignatur-hinzufugen
https://handbuch.tueit.de/books/erpnext-benutzerhandbuch/page/send-via-erpnext
(Document Naming)
Kommunikation (Communication)
Einleitung
E-Mail ist das führende Kommunikationsmittel in allen Geschäftslichen Bereichen. Auch ERPNext nutzt an vielen Stellen E-Mail. Das geht von E-Mailbenachrichtigungen wie eine Erinnerung an einen Termin oder den Versand eines wöchentlichen Berichts bestimmter Information an eine oder mehrere Personen des Unternehmens.
Ein- und Ausgehende E-Mails werden in ERPNext im DocType Kommunikation abgelegt. Dieser DocTypes ist Teil des frappe Frameworks und wird in ERPNext lediglich mitverwendet.
Zwar kann ERPNext auch eingehende E-Mails verarbeiten und könnte auch als E-Mailpostfach genutzt werden, doch raten wir hiervon klar ab.
Beispiel: Was passiert mit meiner E-Mail wenn ich mein ERPNext Passwort zurückgesetzt habe?
Anhänge
Empfängt das System eine E-Mail mit Anhängen werden diese im linken Menü-Band angezeigt:
Alle Anhänge die via E-Mail in unser System gelangen werden automatisch als "Ist Privat" markiert. Diese sind dann unter dem Pfad
/private/files/dateiname.dateiendung
zu finden. Alle Anhänge werden im Ordner Attachment abgelegt.
Mehr zum Thema Anhänge und Datei finden wir hier.
Status
Ansichten
Dem DocType Kommunikation eigen ist die "Inbox View". Diese Ansicht kann als E-Mail-Client verstanden werden
Spam
Müll
Wird eine E-Mail in den Papierkorb verschoeben landet sie an diesem Ort.
E-Mails bearbeiten
Öffnen wir die Kommunikation haben wir folgende Möglichkeiten der Manipulation
Schließen
Setzt den Status der E-Mail auf Geschlossen.
Verknüpfen (Relink)
Die Kommunikation wird dann im Verlauf des entsprechenden DocTypes verknüpft
E-Mail im Verlauf des Doctypes
Leider funktioniert an dieser Stelle die Übersetzung nicht richtig. So finden wir den richtigen DocType nur über die Eingabe in englischer Sprache: Übersetzungsproblem im Relink Pop-Up
Antworten
Aktionen
Allen antworten
Damit beantworten wir die E-Mail und inkludieren alle Adressaten welche im Feld Von und CC eingetragen sind
Weiterleiten
Öffnet ein Pop-Up zum weiterleiten der E-Mail Kommunikation
dies kann falsch übersetzt sein mit "Nach Vorne"
Als ungelesen/gelesen markieren
Abhängig vom Häkchen können wir hier gelesen oder ungelesen setzen.
Bewegen
Hiermit können wir die E-Mail in ein anderes, in ERPNext eingebundenes, E-Mail-Konto verschieben.
Als Spam markieren
Markiert die E-Mail als Spam
Das System erstellen dazu dann einen Eintrag vom DocType E-Mail-Regel (Email Rule)
Um diese Einstellung rückgängig zu machen, sprich den E-Mailregel zu löschen werden Administratoren-Rechte benötigt.
In den Papierkorb verschieben
Verschiebt die E-Mail in den Papierkorb
Erstellen/Create/Make
Eine Kommunikation vom Typ E-Mail kann der Antoß zu einem Prozess sein. Wir können die E-Mail in folgende DocTypes umwandeln
- Kontakt
- Lead
- Chance
- Anfrage
Kontakt
Erstellen aus dem Absender der E-Mail den DocType Kontakt.
Lead
Aus der E-Mail wird ein Lead erstellt. Dabei wird der Absendename der E-Mail als Name der Person im Lead eingesetzt und die Absender E-Mailadresse als E-Mailadresse. Beim erstellen des Leads wird ein gleichnamiger Kontakt erstellt.
Chance
Hier können wir aus der E-Mail eine Chance erstellen.
Ist der Absender der E-Mail als Kontakt hinterlegt und z.B. mit einem Lead oder Kunden verknüpft werden diese Daten automatisch in der Anfrage eingetragen.
Anfrage
Weist der Inhalt der E-Mail auf ein Problem technischer Natur hin können wir darauf eine Anfrage erstellen.
Ist der Absender der E-Mail als Kontakt hinterlegt und z.B. mit einem Lead oder Kunden verknüpft werden diese Daten automatisch in der Anfrage eingetragen.
E-Mail beantworten
Beantworten wir eine E-Mail über den Button Antworten ändert sich der Status auf beantwortet.
Signatur Fußzeile
Die E-Mailfußzeile kann an diversten Orten eingestellt werden.
Verlauf der Route (Route History)
Einleitung
Das System macht einen Mitschnitt der Pfade die angemeldete Anwender des Systems gehen. Dies eine Core-Funktion des frappe Framework.
Benutzergruppe (User Group)
Einleitung
Um mehrere Benutzer mit einer Erwähnung in den Kommentaren zu Benachrichtigen, können wir seid Version 13 in ERPNext Benutzergruppe erstellen in welchen wir eine Vielzahl an Anwendern unseres Systems bündelt können.
Zu lesen:
Benutzergruppe erstellen
Die Benutzergruppe muss über die Suche gefunden werden.
Erstellen einer Anwendergruppe.
Benutzergruppe verwenden
Wie von den Erwähnungen von Einzelanwendern gewohnt nutzen wir auch Benutzergruppe. Mit einem angeführten "@" gefolgt vom Namen der Gruppe. Die Gruppen sind mit einem entsprechenden Symbol gekennzeichnet.
Erwähnung einer Anwendergruppe.
Sitzungsstandardeinstellungen (Session Default Settings)
Einleitung
Hiermit können wir Grundeinstellung für die Sitzung einzelner Anwender vornehmen. Welche Felder zur Auswahl stehen werden durch einen Administrator bestimmt.
Die Möglichkeiten die hier existieren kollidieren ggf. mit Einstellungen auf allen Einstellungs-Seiten, daher sollten wir uns mit diesen vorher auseinander setzen bevor wir hier etwas verändern. Das sind
- Systemverwaltung
- Allgemeine Voreinstellungen
- Einstellungen zu den Modulen
- uvm.
Sitzungsstandards einstellen
Als Anwender des Systems kann ich nur die mir vorgegebenen Felder so füllen wie es unsere Berechtigungen erlauben. Wollen wir die Felder erweitern müssen wir mit einem Administrator unseres Systems sprechen.
Beispiele
Standard Lager setzen
Um ein Lager als Standart zu setzten (bei mehreren Unternehmen) kann man dies über die Sessiondefault(Sitzungsstandart) einrichten.
Dort angekommen können über die Settings verschiedenste Doctypes als Standart eingesetzt werden.
Nach dem Abspeichern kann nun der Benutzer ein Standardlager für sein "Profil" (Session/Sitzung) eingerichtet werden.
Wichtig: Bei mehreren Company muss auch immer die richtige Company angewählt werden.
Workflow
Einleitung
Quellen & Referenzen
https://docs.erpnext.com/docs/v13/user/manual/en/setting-up/workflows
Benutzer (User)
Einleitung
Dieser DocType ist teil des frappe Cores und wird dazu verwendet, dass sich Personen an unserem ERPNext-System anmelden können. Diese Personen können Mitarbeiter, Kunden, Bewerber, Lieferanten uvm. sein.
Benutzer sind in unterschiedliche Typen unterteilt. Dies hat einen starken Einfluss darauf wie sie mit unserem System interagieren können.
Benutzername ändern
https://docs.erpnext.com/docs/v12/user/manual/en/setting-up/articles/rename-user
Basic Info
Rollen
Hier können wir eine oder mehrere Rollen auswählen. Nutzen wir die Rollenprofile; diese sind Vorlagen; können wir keine zusätzlichen Rollen auf dieser Ebene wählen sondern sie immer über die Rollenprofile ändern.
Dies kann ggf. Auswirkungen auf anderen Benutzer haben und ungewünschte Änderungen in den Berechtigungen hervorufen!
Mehr Informationen
Hier können wir weitere Informationen zum Benutzer für den internen Gebrauch festhalten
Kennwort ändern
Hier lässt sich das Passwort des Nutzers überschreiben. Er wird über die Änderung nicht Benachrichtigt. Der Benutzer selbst kann sein Passwort auch über eine E-Mailanfrage bei der Anmeldung zurücksetzen.
Dokument folgen
Die Auswahl ist
- Stündlich
- Täglich
- Wöchentlich
In diesem Abschnitt stellen wir ein wie ein Benutzer vom System benachrichtigt wird und auf welche E-Mailpostfächer er Zugriff haben soll. In den verknüpften Postfächern sehen wir, ob wir das Postfach auch zum Versenden von E-Mails gebrauchen können. Ob das so ist wird im E-Mail-Konto selbst eingestellt.
Diese Signatur ist beim erstellen einer E-Mail dem Benutzer sichtbar und kann bei Bedarf geändert werden:
Benachrichtigungen für E-Mail-Threads senden
Häkchen | Auswirkung |
Ja | Wir erhalten E-Mails vom System wenn an E-Mail-Threads in denen wir eine Rolle spielen eine neue E-Mail eingeht. |
Nein | Wir erhalten keine E-Mails aus E-Mail-Threads. |
Schick mir eine Kopie der ausgehenden E-Mails
Häkchen | Auswirkung |
Ja |
Beim erstellen einer E-Mail ist angegeben, dass wir in Kopie (CC) gesetzt werden. |
Nein | Das Häkchen im E-Mail-Dialog ist nicht automatisch gesetzt. |
Das Benutzerkonto kann durch andere im Kommentar-Feld per @ ausgewählt werden
Benutzer E-Mails
Hier können wir dem Benutzerkonto E-Mail-Konten freigeben welche er dann im System verwendet darf.
Module zulassen
Sicherheitseinstellungen
Benutzertyp
Drittpartei-Authentifizierung
API-Zugriff
Modulprofil (Module Profile)
Einleitung
Das Modulprofil ist eine voreingestellt Sammlung von Modulberechtigungen welches wir im DocType Anwender einstellen können. Anwender nehmen die Module vor allem auf dem Desk in Form der linken Leiste des Systems war.
Diese Module werden nur dann angezeigt, wenn wir sie der Anwender-Stammdatei freigeben. Dies können wir einzeln machen, oder aber über ein voreingestelltes Modulprofil.
Modulauswahl in der Stammdatei Anwender.
Nicht alle Module haben auch eine Präsenz im linken Menü!
Nutzen wir Modulprofile können wir keine zusätzlichen Module einzeln einstellen. Um Änderungen vorzunehmen müssen wir entweder ein neues spezisches Modulprofil erstellen oder aber kein Modulprofil erstellen und die Module einzeln setzen.
DocTypes
Befor wir dies einstellen sollten wir uns mit Berechtigungen im Allgemeinen und dem Doctype Anwender beschäftigen.
Modulprofil erstellen
Modul (Module)
Einleitung
Modulprofile
Module können in Modulprofilen zusammengefasst werden um für bestimmte Anwender eine voreingestellte Auswahl an Modulen festzulegen.
Quellen & Verweise
Kommentar (Comment)
Einleitung
Auf fas allen DocTypes finden wir am unteren Ende den Abschnitt Einen Kommentar hinzugügen (hier in grün). Das Feld kann für mehrere Zwecke eingesetzt werden. Wir können dort neben einfachen Kommentaren, auf welche wir hier auf dieser Seite näher eingehen, weiter Funktionen verwenden. Dazu mehr hier: "Link zur Seite mit Mention, E-Mail verfassen".
Kommentare selbst sind ein eigener DocType im System!
Kommentare werden chronologisch im Verlauf eines jeden DocTypes angezeigt (hier in rot)
Kommentarart
Deutsch | Englisch | Erklärung |
Kommentar | ||
Wie | ||
Info | ||
Bezeichnung | ||
Workflow | ||
Erstellt | ||
Gebucht | ||
Abgesagt | ||
Aktualisiert | ||
Gelöscht | ||
Zugewiesen | ||
Auftrag abgeschlossen | ||
Anhang | ||
Anlage entfernt | ||
gemeinsam genutzt | ||
Nicht geteilt | ||
Bot | ||
Relinked | ||
Bearbeiten |
Kommentar E-Mail
E-Mailadresse der Person die den Kommentar erstellt hat
Betreff
Kommentar von
Klartextname der Person die den Kommentar erstellt hat
Veröffentlicht
Bestimmen ob der Kommentar öffentlich auf unserer Webseite zu sehen ist.
gelesen
Referenz-Dokumententyp
Link zum Typ DocType der im Feld Refernezname eindeutig genannt wird.
Referenzname
Name des Dokuments an welchem der Kommentar gemacht wurde.
Link DocType
Link Name
Vorschau
Geplantes Jobprotokoll ( Scheduled Job Log)
Einleitung
Geplanter Auftragstyp ( Scheduled Job Type)
Einleitung
Rollengenehmigung Seite und Bericht (Role Permission for Page and Report)
Einleitung
1. Rolle anwenden auf
Auswahl | Erklärung |
Seite | Hierzu gehören Seiten wie der Rollen-Berechtigungs-Manager oder der "Print Format Builder" |
Bericht | Das sind die Standard-Berichte des Systems wie die Bilanz, Lagerbuch, Rohgewinn etc. |
2. Bericht oder Seite
Hier können wir die Seite oder Bericht auswählen abhängig unserer vorherigen Auswahl in 1.
3. Rollen erlauben
Hier könenn wir die Rolle auswählen welche Zugang zur Seite oder Bericht bekommen soll.
4. Auf Standardeinstellungen zurücksetzen
Hier können wir alle Änderungen entfernen und den Standard wiederherstellen. Alle gesetzten Einstellungen werden entfernt.
Die neu eingestellte Rolle wird im Bericht selbst nicht dargestellt:
Anhänge (Attachments)
Einleitung
In ERPNext können wir an fast jeden DocType Anhänge hinzufügen. Weiter werden Anhänge in manchen Fällen, wie beim Erhalt einer E-Mail automatisch angelegt und können dann in einem anderen Dokument verlinkt werden.
Automatisch Anhänge liegen immer im Ordner Attachments.
Arten des Anhangs
Durchsuchen und hochladen
Hier mit einem macOS.
Bereits hochgeladene Datei anhängen
Einen Web Link nutzen
400 Bad Request
Dieser Fehler tritt auf, wenn "%%20" im Dateinamen auftritt. In diesem Fall ist im Dateinamen einer PDF ein "%" mit vorangehendem und nachfolgendem Leerzeichen. Das Leerzeichen wird als "%20" formatiert und führt dann mit dem Prozentzeichen im Namen zu "%%20" welches vom Webserver nicht verarbeitet werden kann.
Quelle: https://kinsta.com/de/wissensdatenbank/400-bad-request/
Private und öffentliche Anhänge
In fast allen DocTypes finden wir Anhänge im linken Menü Band:
Schauen wir hier genauer hin, sehen wir ein Schloss auf der linken Seite des Anhangs:
Das Schloss kann offen oder geschlossen sein:
Diese Schlösser können geklickt werden.
Klicken wir auf ein Bild auf welches wir keine Berechtigung haben bekommen wir einen Fehler:
Habe ich die Berechtigung kann ich das Bild über einen Klick auf das Schloss öffnen:
Das setzen als Privat (Schloss "zu" und "Alle als privat setzen") hat keine Auswirkung darauf, ob ich ein Bild öffnen kann oder nicht. Bilder die durch einen anderen User hochgeladen wurden können nicht geöffnet werden!