// Doku Workflow:
// Im ersten Durchgang Doku schreiben, als PDF Exportieren und Seitenumbrüche kontrollieren. Umbrüche im Paragraphen vermeiden
// Inhaltliche Plausibilität prüfen
// Schreibweisen und gängige Rechtschreibfehler und Syntax prüfen
= Testdoku
:imagesdir: ../images
:date: 01.01.2025
:revision: X.X.X vXXX ab Starface 9.0.0.0
//(Ab hier soll im idealfall aus SAP kommen)
== Dokumentation für Modulversion X.X.X ab STARFACE 9.0.0.0
== Produktbeschreibung
// Schreibstil ist hier die neutrale Form
* Idealfall SAP Schnittstelle, Produktbeschreibung, vertrieblicher Input
* Produktbild rechts einfügen und *verweis auf den Shop*
== Anwendungsbeispiel
* Beispiel, wofür das Modul in der Praxis verwendet (im Zweifel mit DN absprechen)
== Technische Voraussetzungen
* *ab STARFACE 9.0.0.0*
* Für dieses Modul stehen legacy Versionen ab STARFACE 7.0.0.2 zur Verfügung.
* Cloud anforderungen bsp. SSH-Tunnel
* Anforderungen an Drittsysteme/Anbieter
* Optionale anfdorderungen für bestimmte Funktionen
* Anforderungen für Hardware
* getestet mit Versionierung X von externer Software/API
//Dieser Bereich wird in Abstimmung mit Devs, Vertrieb und Support bei Bedarf eingefügt.
// === (Technische Limitierung(en))
// * Welche technischen Faktoren gibt es, die die Modulfunktion einschränken (Maximale Importzahl usw.)
== Vertriebsmodell(e)
* Kauf/Inkl. SPV
* Managed Service
* ...
//== Modulvarianten
//* Modulvarianen für verschiedene Drittsysteme (z.b Google bei AKI, XML-Monitoring, ...)
//(Bis hier soll im idealfall aus SAP kommen)
//Seitenumbruch
<<<
// Schreibstil ab hier ist das "imparative-DU", ein direktes Du ist zu vermeiden, wird der Nutzer nicht direkt angesprochen verwenden wir die neutrale Form (man). "Du", "Dich", "Dein", ... schreiben wir GROß!
// Benutzung von TIP: und WARNING: - Tip ist immer, wenn man zusätzliche Infos bereitstellt, die aber keinen direkten Einfluss auf die Funktion des Moduls haben. Mit WARNING: Werden in der Regel besonders kritische Punkte (Fallstricke) bei der Konfiguration des Moduls hervorgehoben.
== Vorbereitung der IT-Umgebung:
* Infrastruktur für den Betrieb des Moduls aufsetzen und konfigurieren (ggf. Exkurs in die Partnersysteme)
=== Konfiguration der Drittsysteme
* Was muss an Drittsystemen eingestellt werden
== STARFACE-Konfiguration
=== Menüpunkt
==== Tab
image:sf_tab1.png[]
//Namenskonvention für Bilder: Dateiname = Tab-Überschrift, bei SF Konfiguration mit dem Präfix "sf_"
===== Unterpunkt
* Einstellungen, die an der STARFACE selber vorgenommen werden (z.b am SF Internen Adressbuch oder am Netzwerk etc.)
* Es muss vorab keine Konfiguration in der STARFACE vorgenommen werden.
== Modulkonfiguration
=== Allgemein
image::allgemein.png[]
//Namenskonvention für Bilder: Dateiname = Tab-Überschrift, bei SF Konfiguration mit dem Präfix "sf_"
* *Name*
** Wähle hier den Namen der Modulinstanz. Dieser Name sollte möglichst beschreibend vergeben werden, ein guter Ausgangspunkt ist der Name des Moduls. Sollen mehrere Instanzen des selben Moduls aktiv sein, muss für jede Instanz ein einmaliger Name vergeben werden.
* *Beschreibung*
** Dieses Feld bietet Raum für eine detailliertere Dokumentation der Instanz. Hier kann beispielsweise dokumentiert werden, auf welche Nutzer/Gruppen das Modul zugreift.
* *Logdatei*
** Jedes Modul informiert in den Levels "ERROR, WARN, INFO, DEBUG, TRACE" in den jeweils verschiedenen Abstufungen über Prozesse, die im Modulbetrieb ablaufen. Falls ein Fehler auftritt hat man hier die Möglichkeit, die Logdatei zu speichern. Standardeinstellung ist das Level "INFO".
TIP: Das Log aktualisiert sich nicht automatisch, sondern nur, wenn die entsprechende Schaltfläche betätigt wird.
=== Konfiguration
image::konfiguration.png[]
//Namenskonvention für Bilder: Dateiname = Tab-Überschrift, bei SF Konfiguration mit dem Präfix "sf_"
==== Unterpunkt in Tab
* *Auf einzelne Punkte eingehen*
** Text
TIP: In den meisten Fällen werden die Rufnummern in das Format 00492515906850 normalisiert. Es können in Ausnahmefällen aber auch Formate wie +492515906850 oder 02515906850 signalisiert werden. Daher empfehlen wir grundsätzlich die Verwendung von Wildcards bei der Quellrufnummer, also zum Beispiel *2515906850.
* Legende:
** ? - Platzhalter für eine Ziffer
** * - Platzhalter für eine, mehrere oder keine Ziffer/n
== Bekannte Probleme
* Bei diesem Modul liegen keine bekannten Probleme vor.
* Problem entdeckt? Schicke eine E-Mail an support@o-byte.com, um Fehler zu melden!
ODER
* Problem1:
** Problem schildern
*** Lösung anbieten
//== FAQ
//* Wenn von einem Modul sehr viele Supportanfragen zum gleichen Thema kommen, kann man das hier abhandeln und so ggf. viele unnötige Supportfälle vermeiden
== Versionshinweis
* Versionsnummer
** *Bugfix:*
*** Welcher Fehler wurde behoben?
** *Neue Funktion:*
*** Welche neue Funktion wurde eingebaut?
// Beim Bugfix immer daran denken, ggfs. den "Bekannte Probleme" Bereich zu editieren.
== Download
=== Modul testen:
* Für dieses Modul steht kein Testzeitraum von 14 Tagen zur Verfügung. Das Modul wird erst mit Kauf aktiv. Unser Vertriebsteam hilft gerne weiter unter vertrieb@o-byte.com.
*ODER*
Bitte achte beim Download auf die Kompatibilität zur STARFACE Version!
Mit Klick auf den Downloadlink einer Modulversion öffnen sich ein Fenster mit Installationshinweisen und ein Pop-up-Fenster.
=== Modul testen:
* Wir stellen unser Modul 14 Tage kostenfrei zum Testen zur Verfügung.
* Nach dem Kauf oder Update: Mit E-Mail-Adresse verifizieren. Für die Inbetriebnahme/das Update ist kein Lizenzschlüssel nötig.
* Wir stellen das Modul als .sfm Datei zur Verfügung.
*ODER*
Bitte achte beim Download auf die Kompatibilität zur STARFACE Version!
Mit Klick auf den Downloadlink einer Modulversion öffnen sich ein Fenster mit Installationshinweisen und ein Pop-up-Fenster.
* Kostenfreies Modul laden: Bitte trage deine Mailadresse ein, stimme der Datenschutzbestimmung zu und klicke auf „Download“. Der Downloadlink wird per Mail zur Verfügung gestellt.
* Nach dem Kauf oder Update: Mit E-Mail-Adresse verifizieren. Für die Inbetriebnahme/das Update ist kein Lizenzschlüssel nötig.
* Wir stellen das Modul als .sfm Datei zur Verfügung.
++++
++++