adocWP/markdown-beispielprojekt/stepbystep.md

Schritt-fuer-Schritt-Anleitung

Diese Seite beschreibt die konkrete Einrichtung und Konfiguration des Moduls.

Im Konfigurationsbereich wird die imperative Form verwendet. Ein direktes "Du" wird vermieden. Wenn der Nutzer nicht direkt angesprochen wird, wird die neutrale Form verwendet.

Vorbereitung der IT-Umgebung

• Infrastruktur fuer den Betrieb des Moduls aufsetzen und konfigurieren.
• Falls noetig, Voraussetzungen in Partnersystemen herstellen.
• Zugangsdaten, API-Schluessel oder Netzwerkfreigaben vorbereiten.

Konfiguration der Drittsysteme

Beschreibe hier, welche Einstellungen in Drittsystemen vorgenommen werden muessen.

• Einstellung 1
• Einstellung 2
• Einstellung 3

STARFACE-Konfiguration

Menuepunkt

Tab

Bildkonvention: Dateiname = Tab-Ueberschrift. Bei STARFACE-Konfigurationen wird das Praefix sf_ verwendet.

Unterpunkt

• Einstellungen beschreiben, die an der STARFACE selbst vorgenommen werden, zum Beispiel am STARFACE-internen Adressbuch oder am Netzwerk.
• Wenn keine STARFACE-Konfiguration erforderlich ist: "Es muss vorab keine Konfiguration in der STARFACE vorgenommen werden."

Modulkonfiguration

Allgemein

Bildkonvention: Dateiname = Tab-Ueberschrift.

Name

Waehle hier den Namen der Modulinstanz. Dieser Name sollte moeglichst beschreibend vergeben werden. Ein guter Ausgangspunkt ist der Name des Moduls. Sollen mehrere Instanzen desselben Moduls aktiv sein, muss fuer jede Instanz ein einmaliger Name vergeben werden.

Beschreibung

Dieses Feld bietet Raum fuer eine detailliertere Dokumentation der Instanz. Hier kann beispielsweise dokumentiert werden, auf welche Nutzer oder Gruppen das Modul zugreift.

Logdatei

Jedes Modul informiert in den Levels ERROR, WARN, INFO, DEBUG und TRACE in verschiedenen Abstufungen ueber Prozesse, die im Modulbetrieb ablaufen. Falls ein Fehler auftritt, besteht hier die Moeglichkeit, die Logdatei zu speichern. Standardeinstellung ist das Level INFO.

Hinweis: Das Log aktualisiert sich nicht automatisch, sondern nur, wenn die entsprechende Schaltflaeche betaetigt wird.

Konfiguration

Unterpunkt in Tab

Auf einzelne Punkte eingehen

Beschreibe hier die konkrete Einstellung.

Hinweis: In den meisten Faellen werden Rufnummern in das Format 00492515906850 normalisiert. In Ausnahmefaellen koennen aber auch Formate wie +492515906850 oder 02515906850 signalisiert werden. Daher wird grundsaetzlich die Verwendung von Wildcards bei der Quellrufnummer empfohlen, zum Beispiel *2515906850.

Legende

• ? - Platzhalter fuer eine Ziffer
• * - Platzhalter fuer eine, mehrere oder keine Ziffern

Abschlusspruefung

• Modulinstanz speichern.
• Modul aktivieren.
• Funktion mit einem realistischen Szenario testen.
• Logdatei pruefen.
• Dokumentierte Voraussetzungen und bekannte Probleme gegenpruefen.