Fax from Share

Dokumentation für Modulversion 1.8.1 ab STARFACE 9.0.0.0

Produktbeschreibung

Mit dem STARFACE Modul „Fax from Share“ können .pdf Dateien als Fax versendet werden durch deren Ablage auf einer SSH- oder Windows-Freigabe. Das Modul erkennt automatisch neue .pdf Dateien und versendet diese als Fax und sortiert sie anschließend entsprechend auf der Freigabe um.

Anwendungsbeispiel

Diese Modul ermöglicht es, Nutzern eine einfache Möglichkeit zum Faxversand zur Verfügung zu stellen. Desweiteren können ERP Softwares beispielsweise Bestellbestätigungen als PDF Datei in eine Ablage legen, von der aus sie automatisch per Fax versendet werden.

Technische Voraussetzungen

  • ab STARFACE 9.0.0.0

  • Für dieses Modul stehen legacy Versionen ab STARFACE 8.0.0.5 zur Verfügung.

SSH-Server

  • SSH-Server, der durch die STARFACE Anlage erreichbar ist.

  • Benutzer mit den nötigen Rechten, um auf das gewählte Zielverzeichnis zugreifen zu können.

Windows Freigabe

  • Server mit windows Freigabe, der durch die STARFACE Anlage erreichbar ist.

  • Benutzer/Domänenbenutzer mit den entsprechenden Rechten, um auf das gewählte Zielverzeichnis zugreifen zu können.

Vorbereitung der IT-Umgebung:

  • Für den Betrieb dieses Moduls sind keine zusätzlichen Systeme erforderlich.

STARFACE-Konfiguration

  • Es muss vorab keine Konfiguration in der STARFACE vorgenommen werden.

Modulkonfiguration

Allgemein

allgemein
  • 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 Leveln "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".

Das Log aktualisiert sich nicht automatisch, sondern nur, wenn die entsprechende Schaltfläche betätigt wird.

XML-RPC

xml rpc

Dieser Tab wird systembedingt von der STARFACE Anlage generiert und kann vom Anwender ignoriert werden.

Faxeinstellungen

faxeinstellungen

Bestimmung des Empfängers

  • Modus:

    • Wähle den Modus („Dateiname“ oder „Auslesen“), mit dem das Modul verwendet werden soll. Detailiertere Infos finden sich im Punkt "Anwendung".

  • RegEx:

    • Konfigurieren Sie den regulären Ausdruck, nachdem in der .pdf Datei nach der Rufnummer gesucht werden soll. Standardmäßig ist der Wert

@@(.*?)@@
  • gesetzt, sprich das Modul sucht nach einer Nummer, die folgendmaßen in der .pdf Datei steht:

@@025159068599@@

Benutzer

Definiere unter "Faxbenutzer" den STARFACE Benutzer, durch den die Faxe vom Modul versendet werden sollen.

Der ausgewählte Benutzer muss in der STARFACE die entsprechenden Rechte zum Faxversand besitzen.

Gleichzeitig zu sendende Faxe

Um ein Blockieren der Amtsleitung zu verhindern kann hier festgelegt werden, wie viele Fax-Modems gleichzeitig zum Faxversand benutzt werden sollen. Hier ist die vom Provider festgelegte Anzahl der maximal verfügbaren Ausgehenden Leitungen zu beachten.

Wiederholungen

Sollte ein Fax nicht zugestellt werden können, z. B. weil die Gegenseite besetzt ist, kann der Versuch wiederholt werden. Hier kann die Anzahl der Wiederholungen festgelegt werden, sollte ein Sendevorgang fehlschlagen. Zwischen den einzelnen Wiederholungen pausiert das Modul zwischen 20 und 30 Sekunden.

Suchintervall

Definiere hier, in welchem Zeitintervall das Modul nach neuen .pdf Dateien sucht, die als Fax versendet werden sollen.

Netzwerkfreigabe

netzwerk freigabe

SSH-Server

  • SSH-Server:

    • Definiere hier die IP-Adresse oder den DNS-Namen des SSH-Servers.

  • SSH-Port:

    • Gebe hier den Port an, über den die Kommunikation zum SSH-Server laufen soll (Standardwert: 22).

  • SSH-Benutzer/Passwort:

    • Definiere hier den Benutzer mit entsprechenden Lese- und Schreibrechten auf das gewählte Zielverzeichnis.

  • SSH-Zielverzeichnis:

    • Wähle hier das Zielverzeichnis aus, in dem das Modul arbeiten soll.

Das Zielverzeichnis muss bereits existieren und es muss der absolute Pfad angegeben werden.

Windows Freigabe

  • Host:

    • Definiere hier die IP-Adresse oder den DNS-Namen des Servers mit der Windows Freigabe.

  • Benutzername/Passwort:

    • Gebe hier den Nutzer/Domänennutzer mit dem entsprechenden Schreibrecht auf das Zielverzeichnis an.

  • Domäne:

    • Definiere hier die Domäne oder Arbeitsgruppe.

  • Freigabe:

    • Definiere hier den Namen der Windows/SMB-Freigabe.

  • Unterverzeichnis:

    • Gebe hier das Zielverzeichnis an, in das die Aufzeichnung exportiert werden soll. Existiert das Verzeichnis nicht, wird es automatisch erstellt.

CSV Log Export

csv log export

Mit der Checkbox "Log Export Aktivieren" besteht die Möglichkeit, ein Log aller, vom Modul behandelten Faxe erstellen zu lassen. Gebe hierzu auch die "E-Mail" Adresse an, an die das Log verschickt werden soll. Das Log listet tabellarisch den Zeitpunkt, Status, Empfänger und den Dateinamen der versendeten Faxe auf.

Diese Funktion setzt eine funktionierende STARFACE E-Mailkonfiguration vorraus. STARFACE empfiehlt diese Einstellung bei jeder Anlage vorzunehmen.

Im Abschnitt "Intervall" kann ein wiederkehrender Zeitpunkt für den Logversand spezifiziert werden.

Anwendungshinweise

Das Modul legt in der gewählten Freigabe / Verzeichnis drei Unterordner an: „spool“, „sent“ und „failed“. Diese Verzeichnisse dürfen nicht gelöscht werden. Wenn das Modul nach neuen Dateien sucht, werden diese in den Ordner „spool“ verschoben. Wenn eine Datei versendet wurde, wird sie in den Ordner „sent“ verschoben. Wenn eine Datei nicht versendet werden konnte, wird sie in den Ordner „failed“ verschoben. Der Anwender legt die zu versendende .pdf Datei in die konfigurierte Freigabe bzw. in das konfigurierte Verzeichnis, dort wird sie entsprechend vom Modul bearbeitet.

Modus Dateiname

Die Faxnummer wird anhand des Dateinamens der .pdf Datei ermittelt. Der Dateiname muss folgendem Format entsprechen: „beliebigerName_zielRufnmmer.pdf“, z. B. „testfax_025159068599.pdf“.

Modus Auslesen

Die Faxnummer wird aus der .pdf Datei ausgelesen. Um den richtigen Text zu finden, muss eine Regular Expression angegeben werden. Bitte beachte, dass das bei einigen PDF-Dokumenten nicht funktioniert, z. B. wenn die PDF-Datei von einem Scanner erzeugt wurde und nur Bild-, aber keine Textdaten enthält.

Dateien, die aktuell in Bearbeitung, also im Ordner „spool“ sind, finden sich auch lokal auf der STARFACE im Ordner /var/tmp/fax-from-share. Von dort werden sie versendet. Wenn das Modul deaktiviert wird, wird der aktuell laufende FaxJob noch beendet sowie die Datei auf dem Share verschoben und lokal gelöscht. Wenn sich beim Neustart des Moduls noch lokal ungesendete Dateien befinden, werden neue FaxJobs aus ihnen erzeugt und dann versendet.

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!

Versionshinweis

  • 1.8.1

    • Bugfix

      • Aus dem Dateinamen wurde die Uhrzeit anstatt die Zielrufnummer ausgelesen

Download

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.