close

Anmelden

Neues Passwort anfordern?

Anmeldung mit OpenID

API-Handbuch In diesem Handbuch erfahren Sie, wie Sie Faxe - GFI

EinbettenHerunterladen
API-Handbuch
In diesem Handbuch erfahren Sie, wie Sie Faxe programmatisch von
benutzerdefinierten oder anderen Anwendungen über die APISchnittstelle von GFI FaxMaker versenden können.
Die Informationen in diesem Dokument dienen ausschließlich Informationszwecken und werden in
der vorliegenden Form ohne (ausdrückliche oder stillschweigende) Haftung jeglicher Art
bereitgestellt, insbesondere ohne Gewährleistung der Marktgängigkeit, der Eignung für einen
bestimmten Zweck oder der Nichtverletzung von Rechten. GFI Software haftet nicht für etwaige
Schäden, einschließlich Folgeschäden, die sich aus der Nutzung dieses Dokuments ergeben. Die
Informationen stammen aus öffentlich zugänglichen Quellen. Trotz sorgfältiger Prüfung der Inhalte
übernimmt GFI keine Haftung für die Vollständigkeit, Richtigkeit, Aktualität und Eignung der
Daten. Des Weiteren ist GFI nicht für Druckfehler, veraltete Informationen und Fehler
verantwortlich. GFI übernimmt keine Haftung (ausdrücklich oder stillschweigend) für die
Richtigkeit oder Vollständigkeit der in diesem Dokument enthaltenen Informationen.
Nehmen Sie mit uns Kontakt auf, wenn Ihnen in diesem Dokument Sachfehler auffallen. Wir werden
Ihre Hinweise sobald wie möglich berücksichtigen.
Windows, Exchange, IIS, .NET, Internet Explorer, Outlook, SQL Server und Microsoft sind Marken
oder eingetragene Marken der Microsoft Corporation in den Vereinigten Staaten und anderen
Ländern.
Alle hier aufgeführten Produkte und Firmennamen sind Marken der jeweiligen Eigentümer.
GFI FaxMaker unterliegt dem urheberrechtlichen Schutz von GFI SOFTWARE LTD. - 1999–2012. GFI
Software LtdAlle Rechte vorbehalten.
Dokumentenversion: 1.2.1
Zuletzt aktualisiert (Monat/Tag/Jahr): 11/6/2012
Inhaltsverzeichnis
1 Einführung
1.1 Text-API und XMLAPI
1.2 Funktionsweise
2 Text-API
2.1 Aktivieren von Text-API in GFI FaxMaker
2.2 Erstellen von Text-APIs
3 XMLAPI
3.1 Aktivieren von XMLAPI in in GFI FaxMaker
3.2 Erstellen von XMLAPIs
3.3 XMLAPI-Felder und Parameter
3.4 Beispiel-XMLAPI
3.5 XMLAPI-Antwortdateien
4 Fehlerbehebung und Support
4.1 Einführung
4.2 Knowledge Base
4.3 Webforum
4.4 Technischen Support anfragen
4.5 Dokumentation
4
4
4
6
6
7
11
11
12
13
20
22
25
25
25
25
25
26
1 Einführung
1.1 Text-API und XMLAPI
Mit TextAPI und XMLAPI können Sie mit Text- oder XML-Dateien (APIs) Faxe verschicken. Sie können
Drittanbietersoftware so konfigurieren, dass APIs automatisch erstellt und mehrere Faxe gleichzeitig
gesendet werden. GFI FaxMaker überprüft dafür vorgesehene Ordner auf APIs und sendet die
entsprechenden Faxe.
Diese Ablaufautomatisierung lässt sich in den unterschiedlichsten Branchen und Anwendungen
einsetzen, z. B. im Gesundheitswesen, im Einzelhandel oder im Bankgewerbe. Sie können zum Beispiel
in Ihrer Rechnungsstellungssoftware ein Textberichtsformular für Kontoauszüge erstellen. Diesen
Bericht können Sie für jeden Kunden, der Ihrem Unternehmen Geld schuldet, in regelmäßigen
Abständen durchführen und im TextAPI-Ordner von GFI FaxMaker speichern. GFI FaxMaker sendet die
Auszüge dann automatisch an die vorgesehenen Empfänger.
HINWEIS:
XMLAPI kann auf die gleiche Weise verwendet werden, um SMS zu verschicken.
APIs müssen gemäß einer standardmäßigen Konvention formatiert werden, indem Felder und
Parameter verwendet werden, die GFI FaxMaker zur Verarbeitung der Faxe und SMS nutzen kann.
1.2 Funktionsweise
Abbildung 1: Funktionsweise von TextAPI und XMLAPI
Schritt
Beschreibung
Erstellen einer TextAPI oder XMLAPI Normalerweise wird eine Drittanbieteranwendung so konfiguriert, dass sie die TextAPIs oder XMLAPIs
automatisch erstellt. Achten Sie darauf, dass die erstellte Datei die in diesem Handbuch beschriebenen
Anforderungen an Parameter, Felder und sonstige Elemente von GFI FaxMaker erfüllt.
Speichern der API im Ordner TextAPI oder XMLAPI
Konfigurieren Sie die Ordner, aus denen die APIs entnommen werden sollen, in GFI FaxMaker. Speichern Sie
die erstellte API im entsprechenden Ordner.
GFI FaxMaker ruft die API ab
GFI FaxMaker fragt die konfigurierten Ordner in regelmäßigen Abständen nach APIs ab. *.txt-Dateien (TextAPI)
bzw. *.xml-Dateien (XMLAPI) werden abgerufen und verarbeitet.
GFI FaxMaker verarbeitet die Dateien und sendet das Fax/die SMS
GFI FaxMaker verarbeitet die abgerufenen APIs und sendet das Fax/die SMS entsprechend der in der API
angegebenen Felder und Parameter.
HINWEIS
Achten Sie vor dem Speichern der APIs im Sammelordner darauf, dass alle Anhänge und
Nachrichtendateien im richtigen Ordner gespeichert sind.
TextAPI – Speichern Sie alle Anhänge im TextAPI-Ordner.
XMLAPI – Speichern Sie Anhänge und/oder Nachrichtendateien im XMLAPI-Ordner
oder unter einem bestimmten Pfad (der in den XML-Parametern der API konfiguriert
wurde).
HINWEIS
Nachdem ein Fax mit XMLAPI versendet wurde, erstellt GFI FaxMaker eine
Antwortnachricht (*.status-Datei) im XMLAPI-Ordner mit Angaben zum Faxversand. Diese
kann von Benutzern, Administratoren oder Drittanbieteranwendungen zur Überwachung
des Faxversands verwendet werden. Weitere Informationen finden Sie unter XMLAPIAntwortdateien (Seite 22).
2 Text-API
TextAPI ist eine Funktion von GFI FaxMaker, die das Versenden von Faxen aus Textdateien heraus
ermöglicht. Diese Textdateien müssen gemäß einer standardmäßigen Konvention formatiert werden,
indem Felder und Parameter verwendet werden, die GFI FaxMaker zum Versenden von Faxen nutzen
kann. Speichern Sie TextAPIs in einem eigenen Ordner. GFI FaxMakerruft alle in diesem Ordner
gespeicherten TextAPIs ab und sendet ihren Inhalt als Fax.
So konfigurieren Sie TextAPI:
Erstellen Sie einen Ordern, auf den GFI FaxMaker zugreifen kann. In diesem Ordner speichern Sie
Ihre Textdateien für den Faxversand.
Aktivieren Sie die TextAPI-Funktion von GFI FaxMaker. Weitere Informationen finden Sie unter
Aktivieren von Text-API in GFI FaxMaker (Seite 6).
Erstellen Sie TextAPIs mithilfe von Feldern und Parametern, die von GFI FaxMaker akzeptiert
werden. Weitere Informationen finden Sie unter Erstellen von Text-APIs (Seite 7).
2.1 Aktivieren von Text-API in GFI FaxMaker
So aktivieren und konfigurieren Sie TextAPI:
1. Klicken Sie in der GFI FaxMaker-Konfiguration mit der rechten Maustaste auf Erweitert >
TextAPI/XMLAPI, und wählen Sie die Option Eigenschaften.
Screenshot 1: Aktivieren von TextAPI
2. Konfigurieren Sie auf der Registerkarte TextAPI die folgenden Optionen:
Tabelle 1: TextAPI-Optionen
Option
Beschreibung
Ordner nach
Textdateien
durchsuchen
Aktiviert TextAPI.
Ordner
Geben Sie den Ordner an, in dem die TextAPIs für die Verarbeitung durch GFI FaxMaker
gespeichert werden sollen.
Text mithilfe des
Deckblatts
formatieren
Wählen Sie das Deckblatt aus, das für TextAPI-Faxe verwendet werden soll. Weitere
Informationen über Deckblätter finden Sie im GFI FaxMaker zu Administrations- und
Konfigurationshandbuch.
3. Klicken Sie auf OK.
Nächster Schritt: Erstellen Sie XMLAPIs. Weitere Informationen finden Sie unter Erstellen von TextAPIs (Seite 7).
2.2 Erstellen von Text-APIs
Erstellen Sie, wenn Sie TextAPI verwenden, eine folgendermaßen strukturierte Textdatei (.txt):
Tabelle 2: Struktur der TextAPI-Datei
Zeile
Beschreibung
Erste
Zeile
Geben Sie die Faxnummer des Empfängers an und stellen Sie ihr zwei Doppelpunkte voran:
::Faxnummer
Beispiel:
::12345678
Andere Parameter können auch in folgendem Format eingefügt werden:
::Vorname, Firma, Nachname, Abteilung, E-Mail-Adresse, Faxnummer
Beispiel: Um ein Fax an Heinz Müller zu senden, der im Vertrieb der Firma Meier & Co. arbeitet und unter
der E-Mail-Adresse vertrieb@meier.com und der Faxnummer 12345678 zu erreichen ist, sieht diese Zeile
wie folgt aus:
::Heinz, Meier & Co., Müller, Vertrieb, vertrieb@meier.com, 12345678
Zweite
Zeile
(optional)
Geben Sie weitere Sendeoptionen an und stellen Sie auch diesen zwei Doppelpunkte voran. Beispiel:
::S=Preisliste
Trennen Sie einzelne Parameter durch Kommas voneinander. Beispiel:
::c=cover1,23:15,B=5
Weitere Informationen finden Sie unter Text-API-Sendeoptionen (Seite 7).
Sonstige
Zeilen
Geben Sie den Nachrichtentext für das Fax ein.
2.2.1 Text-API-Sendeoptionen
In der zweiten Zeile der TextAPI lassen sich verschiedene Sendeoptionen angeben.
HINWEIS
Es können auch mehrere Optionen angegeben werden. Trennen Sie einzelne Parameter
durch Kommas voneinander. Beispiel:
::s=Betreff,from=Peter,c=coverpage1,23:15,B=5
HINWEIS
Bei GFI FaxMaker müssen Sie nicht auf Groß- und Kleinschreibung achten. Parameter
können in Groß- oder Kleinbuchstaben angegeben werden.
Tabelle 3: TextAPI-Parameter
Sendeoptionen
Parameter
Beschreibung
Betreff
::S=Dies ist der Betreff
Geben Sie den Betreff des Faxes an. Dieser Text
wird im Feld <subject> auf dem Deckblatt
eingefügt. Ersetzen Sie den Text Dies ist
der Betreff durch den eigentlichen Betreff.
oder
::subject=Dies ist der Betreff
Absender
::fr=Name
oder
::from=Name
Mit diesem Parameter geben Sie den Namen
des Fax-Absenders an. Der angegebene Name
wird als Absendername zum Deckblatt
hinzugefügt. Ersetzen Sie Name durch den
Namen des Absenders.
HINWEIS
Wenn diese Angabe fehlt, hat
GFI FaxMaker keine Informationen über
den Absender und kann damit auch keinen
Sendebericht erstellen.
Anhang
::A=Dateiname
Geben Sie eine Datei an, die an das Fax
angehängt werden soll. Die Datei muss im
TextAPI-Sammelordner gespeichert werden
(dem Ordner, in dem auch die API gespeichert
ist). Ersetzen Sie „Dateiname“ durch den
Namen und die Dateinamenerweiterung der
Datei, die Sie anhängen möchten.
Beispiel: ::A=Faxanhang.txt
Wenn mehrere Dateien angehängt werden
sollen, muss der Befehl mehrmals angegeben
werden. Beispiel:
::A=Faxanhang.txt,A=disclaimer.txt
Priorität
Hohe Priorität
::p=high
Legt die Priorität (hoch oder niedrig) für den
Faxversand fest.
oder
::p=h
oder
::priority=high
oder
::priority=h
Niedrige Priorität
::p=low
oder
::p=l
oder
::priority=low
oder
::priority=l
Kostenstelle
::B=nnnn
oder
::billingcode=nnnn
Mit diesem Parameter geben Sie eine
Kostenstelle an, wenn GFI FaxMaker so
konfiguriert wurde, dass eine Kostenstelle
erfordert wird. Ersetzen Sie nnnn durch die
Kostenstelle.
Sendeoptionen
Parameter
Beschreibung
Zeitplan
::YYYY-MM-DD-hh:mm:ss
Geben Sie das Datum und die Zeit oder nur die
Zeit an, zu der das Fax gesendet werden soll.
Ersetzen Sie:
JJJJ – Jahr
oder
::hh:mm
MM – Monat
TT – Tag
hh – Stunde im 24-Stunden-Uhrzeitformat
mm – Minuten
ss – Sekunden
Beispiel: ::2012-04-21-16:05:00
Deckblatt
::C=Deckblattname
oder
::Coverpage=Deckblattname
Deckblattadressierung
::F=Deckblattadressierung
oder
::frontcover=Deckblattadressierung
Faxleitung
::line=n
oder
::l=n
Standardmäßig verwendet GFI FaxMaker das in
GFI FaxMaker konfigurierte Standard-Deckblatt.
Mit diesem Parameter können Sie ein Fax mit
einem bestimmten Deckblatt schicken.
Ersetzen Sie Deckblattname durch den Namen
des in GFI FaxMaker konfigurierten Deckblatts,
das Sie verwenden möchten.
Wenn Sie kein Deckblatt verwenden möchten,
können Sie den Parameter ::C=none
verwenden.
Mit diesem Parameter können Sie ein Fax mit
einer bestimmten Deckblattadressierung
schicken. Ersetzen Sie
Deckblattadressierung durch den Namen
der in GFI FaxMaker konfigurierten
Deckblattadressierung, die Sie verwenden
möchten.
Geben Sie diesen Parameter an, wenn das Fax
an eine bestimmte Faxleitung geschickt werden
soll. Ersetzen Sie n durch die in GFI FaxMaker
konfigurierte Faxleitungsnummer.
HINWEIS
Ist diese Leitung allerdings besetzt oder
nicht verfügbar, wird das Fax an eine
andere Leitung geschickt. Wenn das Fax
nur über eine bestimmte Leitung
gesendet werden soll, verwenden Sie den
folgenden Parameter:
::dl=n
Das Fax wird dann erst geschickt, wenn
diese Leitung verfügbar ist.
Auflösung
Hohe Auflösung
::H
oder
::high
Normale Auflösung
::N
oder
::normal
Mit diesem Parameter bestimmen Sie die
Auflösung des Faxes. Wählen Sie zwischen
hoher Auflösung (200 x 200 dpi) oder normaler
Auflösung (200 x 100 dpi).
Sendeoptionen
Parameter
Beschreibung
Kopfzeile
::fh=Kopfzeile
Mit dieser Option können Sie eine
personalisierte Kopfzeile angeben, die oben auf
der Faxseite zur Standard-Faxkopfzeile
hinzugefügt wird. Ersetzen Sie Kopfzeile
durch den gewünschten Text für die Kopfzeile.
oder
::faxheader=Kopfzeile
2.2.2 Text-API-Beispiel
::Heinz, Meier & Co., Müller, Vertrieb, vertrieb@meier.com, 12345678
::from=Klaus Schmidt,subject=Hallo Heinz,H,fh=Testfax
Hallo Heinz,
dies ist ein Testfax.
Mit freundlichen Grüßen
Paul
3 XMLAPI
XMLAPI ist eine Funktion von GFI FaxMaker, die das Versenden von Faxen aus XML-Dateien heraus
ermöglicht. Diese XML-Dateien müssen gemäß einer standardmäßigen Konvention formatiert werden,
indem Felder und Parameter verwendet werden, die GFI FaxMaker zum Versenden von Faxen nutzen
kann. Speichern Sie XMLAPIs in einem eigenen Ordner. GFI FaxMakerruft alle in diesem Ordner
gespeicherten XMLAPIs ab und sendet ihren Inhalt als Fax.
So konfigurieren Sie XMLAPI:
Erstellen Sie einen Ordern, auf den GFI FaxMaker zugreifen kann. In diesem Ordner speichern Sie
Ihre XML-Dateien für den Faxversand.
Aktivieren Sie die XMLAPI-Funktion von GFI FaxMaker. Weitere Informationen finden Sie unter
Aktivieren von XMLAPI in in GFI FaxMaker (Seite 11).
Erstellen Sie XMLAPIs mithilfe von Feldern und Parametern, die von GFI FaxMaker akzeptiert
werden. Weitere Informationen finden Sie unter Erstellen von XMLAPIs (Seite 12).
3.1 Aktivieren von XMLAPI in in GFI FaxMaker
So aktivieren und konfigurieren Sie TextAPI:
1. Klicken Sie in der GFI FaxMaker-Konfiguration mit der rechten Maustaste auf Erweitert >
TextAPI/XMLAPI, und wählen Sie die Option Eigenschaften.
Screenshot 2: Aktivieren von TextAPI
2. Wählen Sie auf der Registerkarte XMLAPI den Ordner, in dem die XMLAPIs gespeichert werden
sollen.
3. Klicken Sie auf OK.
4. Starten Sie den Message Transfer Agent-Dienst von GFI FaxMaker neu. Laden Sie den GFI FaxMakerMonitor und klicken Sie auf der Registerkarte Message Transfer Agent auf Neustart.
Nächster Schritt: Erstellen Sie XMLAPIs. Weitere Informationen finden Sie unter Erstellen von XMLAPIs
(Seite 12).
3.2 Erstellen von XMLAPIs
Wenn Sie XMLAPI verwenden, erstellen Sie eine XML-Datei (.xml) mit den Parametern zum Senden des
Faxes/der SMS. Alle XMLAPI-Parameter sollten sich in einem XML-Container <faxmakerdata>
befinden. Die Daten sollten dann folgendermaßen in drei separaten Containern enthalten sein:
Tabelle 4: XMLAPI-Feldcontainer
XMLAPIContainer
Beschreibung
<fields>
Geben Sie in diesem Container Eigenschaften für den Faxversand, wie Betreff, Anhänge und
Nachrichtendatei, an. Weitere Informationen finden Sie unter Nachrichtenfelder (Seite 13).
<sender>
Geben Sie in diesem Container die Absenderangaben an. Weitere Informationen finden Sie unter
Absenderfelder (Seite 16).
<recipients>
Geben Sie in diesem Container die Empfängerangaben an.
Fax – Weitere Informationen finden Sie unter Faxempfänger-Felder (Seite 17).
SMS – Weitere Informationen finden Sie unter SMS-Empfängerfelder (Seite 19).
HINWEIS
Eine XML-Kopfzeile ist ebenfalls erforderlich. Sie lautet normalerweise:
<?xml version="1.0" encoding="utf-8"?>
3.2.1 Beispiel-XMLAPI
<?xml version="1.0" encoding="utf-8"?>
<faxmakerdata>
<fields>
<subject>Dies ist Ihr Faxbetreff</subject>
<bodyfile type="text/plain">c:\temp\bodyfile.txt</bodyfile>
<attachment>c:\temp\document.txt</attachment>
</fields>
<sender>
<emailaddress>user@senderdomain.com</emailaddress>
</sender>
<recipients>
<fax>
<recipient>
<faxnumber>+1 800 6565</faxnumber>
</recipient>
</fax>
</recipients>
</faxmakerdata>
Dieses Handbuch enthält eine vollständige Beispiel-XMLAPI. Weitere Informationen finden Sie unter
Beispiel-XMLAPI (Seite 20).
3.3 XMLAPI-Felder und Parameter
In diesem Abschnitt werden die in XMLAPI unterstützten Felder und Parameter beschrieben.
Nachrichtenfelder
Absenderinformationen
Faxempfänger-Informationen
SMS-Empfängerinformationen
3.3.1 Nachrichtenfelder
Geben Sie im Container <fields> die folgenden Informationen ein:
Tabelle 5: Nachrichtenfelder und Parameter
Betreff
Zeitplan
XMLPfad
\faxmakerdata\fields\subject
Typ
Zeichenfolge
Disposition
Optional
Details
Geben Sie den Betreff des Faxes an.
Beispiel
<subject>Dies ist ein Faxbetreff</subject>
XMLPfad
\faxmakerdata\fields\schedule
Typ
Zeichenfolge
Disposition
Optional
Details
Geben Sie das Datum und die Zeit an, zu der das Fax gesendet werden soll.
Machen Sie die Angabe in folgendem Format:
JJJJ-MM-TT-HH:mm:ss
Ersetzen Sie:
JJJJ – Jahr
MM – Monat
TT – Tag
hh – Stunde im 24-Stunden-Uhrzeitformat
mm – Minuten
ss – Sekunden
Priorität
Beispiel
<schedule>2012-10-10-08:15:00</schedule>
XMLPfad
\faxmakerdata\fields\priority
Typ
Zeichenfolge
Disposition
Optional
Details
Legen Sie die Priorität für die Nachricht fest. Zulässige Werte sind:
low
normal
high
veryhigh
Beispiel
<priority>high</priority>
Kostenstelle
Auflösung
XMLPfad
\faxmakerdata\fields\billingcode
Typ
Zeichenfolge
Disposition
Optional. Nur erforderlich, wenn Kostenstelle aktiviert ist.
Details
Legt die Absender-Kostenstelle für die Nachricht fest.
Beispiel
<billingcode>25</billingcode>
XMLPfad
\faxmakerdata\fields\resolution
Typ
Zeichenfolge
Disposition
Optional
Details
Mit diesem Parameter bestimmen Sie die Auflösung des Faxes. Zulässige Werte
sind:
Normal (200 x 100 dpi)
High (200 x 200 dpi)
Deckblatt
Beispiel
<resolution>high</resolution>
XMLPfad
\faxmakerdata\fields\coverpage
Typ
Zeichenfolge
Disposition
Optional
Details
Standardmäßig wird die Fax mit dem in GFI FaxMaker konfigurierten StandardDeckblatt geschickt. Mit diesem Parameter können Sie ein Fax mit einem
bestimmten Deckblatt schicken. Geben Sie das zu verwendende Deckblatt ein.
Sie haben dazu folgende Möglichkeiten:
Name des Deckblatts wie konfiguriert in GFI FaxMaker.
Dateiname eines unter <GFI FaxMakerInstallationsordner>\Coverpage gespeicherten Deckblatts. Zum
Beispiel generic.htm.
Deckblattadressierung
Beispiel
<coverpage>Firma</coverpage>
XMLPfad
\faxmakerdata\fields\frontcovernote
Typ
Zeichenfolge
Disposition
Optional
Details
Standardmäßig wird die Fax mit der in GFI FaxMaker konfigurierten StandardDeckblattadressierung geschickt. Mit diesem Parameter können Sie ein Fax mit
einer bestimmten Deckblattadressierung schicken. Geben Sie die zu
verwendende Deckblattadressierung ein. Sie haben dazu folgende
Möglichkeiten:
Name der Deckblattadressierung wie konfiguriert in GFI FaxMaker.
Dateiname einer unter <GFI FaxMakerInstallationsordner>\Coverpage gespeicherten
Deckblattadressierung. Zum Beispiel MyCovernote.htm.
Faxleitung
Beispiel
<frontcovernote>Briefkopf</frontcovernote>
XMLPfad
\faxmakerdata\fields\faxline
Typ
Nummer
Disposition
Optional
Details
Verwenden Sie diesen Parameter, wenn das Fax an eine bestimmte Faxleitung
geschickt werden soll. Geben Sie die in GFI FaxMaker konfigurierte
Faxleitungsnummer ein.
HINWEIS
Ist diese Leitung allerdings besetzt oder nicht verfügbar, wird das Fax an
eine andere Leitung geschickt. Wenn das Fax nur über eine bestimmte
Leitung gesendet werden soll, verwenden Sie das folgende Attribut:
demandline=”true”
Beispiel
<faxline demandline="true">3</faxline>
SMS-Leitung
XMLPfad
\faxmakerdata\fields\smsline
Typ
Nummer
Disposition
Optional
Details
Verwenden Sie diesen Parameter, wenn die SMS an eine bestimmte SMSLeitung geschickt werden soll. Geben Sie die in GFI FaxMaker konfigurierte SMSLeitungsnummer ein.
HINWEIS
Ist diese Leitung allerdings besetzt oder nicht verfügbar, wird die SMS an
eine andere Leitung geschickt. Wenn die SMS nur über eine bestimmte
Leitung gesendet werden soll, verwenden Sie das folgende Attribut:
demandline=”true”
Kopfzeile
Eindeutige ID
TextAPI
Beispiel
<smsline demandline="true">3</smsline>
XMLPfad
\faxmakerdata\fields\faxheader
Typ
Zeichenfolge
Disposition
Optional
Details
Geben Sie eine personalisierte Kopfzeile an, die oben auf der Faxseite zur
Faxkopfzeile hinzugefügt wird.
Beispiel
<faxheader>Dies ist eine Faxkopfzeile</faxheader>
XMLPfad
\faxmakerdata\fields\uid
Typ
Zeichenfolge [max. 255 Zeichen]
Disposition
Optional
Details
Geben Sie eine Kennung an, die zur Markierung der Nachricht verwendet wird.
Die Eindeutigkeit dieser Kennung legt die Person fest, die die Nachricht
erstellt. Es sind maximal 255 Zeichen möglich.
Beispiel
<uid>3a5a90s7de3g20k9y4d5e7e6fse28se5e097</uid>
XMLPfad
\faxmakerdata\fields\textapi
Typ
Zeichenfolge
Disposition
Optional
Details
Wird zur Angabe einer einzelnen Zeile mit TextAPI-Befehlen verwendet
(einschließlich Präfix „::“). Dieses Feld kann mehrfach angegeben werden.
Beispiel
<textapi>::billingcode=25,line=3</textapi>
Nachrichtentext-Datei
XMLPfad
\faxmakerdata\fields\bodyfile
Typ
Vollständiger Pfad oder Dateiname
Disposition
Optional
Details
Der Inhalt der Datei wird als Nachrichtentext auf dem Fax-Deckblatt
verwendet.
Geben Sie den vollständigen Pfad der Datei ein oder nur den Dateinamen, wenn
die Nachrichtentext-Datei im Deckblatt-Ordner gespeichert ist:
<GFI FaxMaker-Installationsordner>\Coverpage.
HINWEIS 1
Wenn der vollständige Pfad eingegeben wird, wird die Datei nach der
Verarbeitung gelöscht.
HINWEIS 2
Wenn Sie XMLAPI zum Senden von SMS verwenden, muss dieses Feld
angegeben werden und der Inhalt dieser Datei wird als SMS-Nachricht
verwendet.
Geben Sie den Dateityp an. Verwenden Sie eines der folgenden Attribute:
type="text/html" – Geben Sie dieses Attribut an, wenn der
Nachrichtentext im HTML-Format vorliegt.
type="text/rtf" – Geben Sie dieses Attribut an, wenn der
Nachrichtentext im RTF-Format vorliegt.
type="text/plain" – Geben Sie dieses Attribut an, wenn der
Nachrichtentext im TXT-Format vorliegt.
Wenn kein Dateityp-Attribut angegeben wird, wird die Nachricht als einfacher
Text eingegeben.
Anhang
Beispiel
<bodyfile type="text/plain">c:\temp\bodyfile.txt</bodyfile>
XMLPfad
\faxmakerdata\fields\attachment
Typ
Vollständiger Pfad oder Dateiname
Disposition
Optional (max. 60 Anhänge)
Details
Hängt den Inhalt der angegebenen Datei an die Faxnachricht an.
Geben Sie den vollständigen Pfad der Datei ein oder nur den Dateinamen, wenn
die Nachrichtentext-Datei im selben Ordner wie die XMLAPI gespeichert ist.
HINWEIS
Wenn der vollständige Pfad eingegeben wird, wird die Datei nach der
Verarbeitung gelöscht.
Beispiel
<attachment>c:\temp\document.doc</attachment>
HINWEIS
Es muss entweder ein Anhang oder eine Fax-Nachrichtentext-Datei angegeben werden.
3.3.2 Absenderfelder
Geben Sie im Container <sender> die folgenden Absenderinformationen ein:
Tabelle 6: Absenderfelder und Parameter
Vorname
XMLPfad
\faxmakerdata\sender\firstname
Typ
Zeichenfolge
Disposition
Optional
Details
Legt den Vornamen des Absenders fest.
Beispiel
<firstname>Heinz</firstname>
Nachname
Firma
Abteilung
Telefonnummer
E-Mail-Adresse
XMLPfad
\faxmakerdata\sender\lastname
Typ
Zeichenfolge
Disposition
Optional
Details
Legt den Nachnamen des Absenders fest.
Beispiel
<lastname>Müller</lastname>
XMLPfad
\faxmakerdata\sender\company
Typ
Zeichenfolge
Disposition
Optional
Details
Legt den Firmennamen des Absenders fest.
Beispiel
<company>Firmenname</company>
XMLPfad
\faxmakerdata\sender\department
Typ
Zeichenfolge
Disposition
Optional
Details
Legt die Abteilung des Absenders fest.
Beispiel
<department>Vertrieb</department>
XMLPfad
\faxmakerdata\sender\voicenumber
Typ
Zeichenfolge
Disposition
Optional
Details
Legt die Telefonnummer des Absenders fest.
Beispiel
<voicenumber>+1(800)1234 5678</voicenumber>
XMLPfad
\faxmakerdata\sender\emailaddress
Typ
Zeichenfolge
Disposition
Erforderlich
Details
Legt die E-Mail-Adresse des Absenders fest.
Beispiel
<emailaddress>hmüller@meinefirma.com</emailaddress>
3.3.3 Faxempfänger-Felder
Geben Sie im Container <recipient> die Empfängerinformationen ein. Fügen Sie für Faxe einen
<fax>-Container und einen <recipient>-Container hinzu.
Beispiel:
<recipients>
<fax>
<recipient>
<faxnumber>+1 800 1234 5678</faxnumber>
</recipient>
</fax>
</recipients>
HINWEIS
Ein Fax kann auch an mehrere Empfänger gesendet werden. Weitere Informationen
finden Sie unter Senden eines Fax an mehrere Empfänger (Seite 18).
Geben Sie weitere Parameter in den Feldern im <recipient>-Container wie folgt ein:
Tabelle 7: Faxempfänger-Felder und Parameter
Vorname
Nachname
Firma
Abteilung
Faxnummer
Telefonnummer
E-Mail-Adresse
XMLPfad
\faxmakerdata\recipients\fax\recipient\firstname
Typ
Zeichenfolge
Disposition
Optional
Details
Legt den Vornamen des Empfängers fest.
Beispiel
<firstname>Thomas</firstname>
XMLPfad
\faxmakerdata\recipients\fax\recipient\lastname
Typ
Zeichenfolge
Disposition
Optional
Details
Legt den Nachnamen des Empfängers fest.
Beispiel
<lastname>Bauer</lastname>
XMLPfad
\faxmakerdata\recipients\fax\recipient\company
Typ
Zeichenfolge
Disposition
Optional
Details
Legt den Firmennamen des Empfängers fest.
Beispiel
<company>Faxempfänger-Firma GmbH</company>
XMLPfad
\faxmakerdata\recipients\fax\recipient\department
Typ
Zeichenfolge
Disposition
Optional
Details
Legt die Abteilung des Empfängers fest.
Beispiel
<department>Marketing</department>
XMLPfad
\faxmakerdata\recipients\fax\recipient\faxnumber
Typ
Zeichenfolge
Disposition
Erforderlich
Details
Legt die Faxnummer des Empfängers fest.
Beispiel
<faxnumber>+1(800)8765 4321</faxnumber>
XMLPfad
\faxmakerdata\recipients\fax\recipient\voicenumber
Typ
Zeichenfolge
Disposition
Optional
Details
Legt die Telefonnummer des Empfängers fest.
Beispiel
<voicenumber>+1(800)8765 4444</voicenumber>
XMLPfad
\faxmakerdata\recipients\fax\recipient\emailaddress
Typ
Zeichenfolge
Disposition
Optional
Details
Legt die E-Mail-Adresse des Empfängers fest.
Beispiel
<emailaddress>hmüller@faxempfänger-firma.com</emailaddress>
Senden eines Fax an mehrere Empfänger
Ein Fax kann auch an mehrere Empfänger gesendet werden. Dazu müssen Sie mehrere
<recipient>...</recipient>-Container erstellen. Beispiel:
<recipients>
<fax>
<recipient>
<firstname>Bernd</firstname>
<faxnumber>+1 800 1111 1111</faxnumber>
</recipient>
<recipient>
<firstname>Heinz</firstname>
<faxnumber>+1 800 2222 2222</faxnumber>
</recipient>
</fax>
</recipients>
3.3.4 SMS-Empfängerfelder
Geben Sie im Container <recipient> die Empfängerinformationen ein. Fügen Sie für SMS einen
<sms>-Container und einen <recipient>-Container hinzu.
Beispiel:
<recipients>
<sms>
<recipient>
<smsnumber>+1 800 1234 5678</smsnumber>
</recipient>
</sms>
</recipients>
HINWEIS
Eine SMS kann auch an mehrere Empfänger gesendet werden. Weitere Informationen
finden Sie unter Senden einer SMS an mehrere Empfänger (Seite 20).
Geben Sie weitere Parameter in den Feldern im <recipient>-Container wie folgt ein:
Tabelle 8: SMS-Empfänger-Felder und Parameter
Vorname
Nachname
Firma
XMLPfad
\faxmakerdata\recipients\sms\recipient\firstname
Typ
Zeichenfolge
Disposition
Optional
Details
Legt den Vornamen des Empfängers fest.
Beispiel
<firstname>Thomas</firstname>
XMLPfad
\faxmakerdata\recipients\sms\recipient\lastname
Typ
Zeichenfolge
Disposition
Optional
Details
Legt den Nachnamen des Empfängers fest.
Beispiel
<lastname>Bauer</lastname>
XMLPfad
\faxmakerdata\recipients\sms\recipient\company
Typ
Zeichenfolge
Disposition
Optional
Details
Legt den Firmennamen des Empfängers fest.
Beispiel
<company>SMS-Empfänger-Firma GmbH</company>
Abteilung
SMS-Nummer
Telefonnummer
E-Mail-Adresse
XMLPfad
\faxmakerdata\recipients\sms\recipient\department
Typ
Zeichenfolge
Disposition
Optional
Details
Legt die Abteilung des Empfängers fest.
Beispiel
<department>Marketing</department>
XMLPfad
\faxmakerdata\recipients\sms\recipient\smsnumber
Typ
Zeichenfolge
Disposition
Erforderlich
Details
Legt die SMS-Nummer des Empfängers fest.
Beispiel
<smsnumber>+1(800)8765 4321</smsnumber>
XMLPfad
\faxmakerdata\recipients\sms\recipient\voicenumber
Typ
Zeichenfolge
Disposition
Optional
Details
Legt die Telefonnummer des Empfängers fest.
Beispiel
<voicenumber>+1(800)8765 4444</voicenumber>
XMLPfad
\faxmakerdata\recipients\sms\recipient\emailaddress
Typ
Zeichenfolge
Disposition
Optional
Details
Legt die E-Mail-Adresse des Empfängers fest.
Beispiel
<emailaddress>hmüller@smsempfänger-firma.com</emailaddress>
Senden einer SMS an mehrere Empfänger
Eine SMS kann auch an mehrere Empfänger gesendet werden. Dazu müssen Sie mehrere
<recipient>...</recipient>-Container erstellen. Beispiel:
<recipients>
<sms>
<recipient>
<firstname>Heinz</firstname>
<smsnumber>+1 800 1111 1111</smsnumber>
</recipient>
<recipient>
<firstname>Bernd</firstname>
<smsnumber>+1 800 2222 2222</smsnumber>
</recipient>
</sms>
</recipients>
3.4 Beispiel-XMLAPI
In diesem Abschnitt finden Sie XMLAPI-Beispiele.
Fax – Beispiel einer Fax-XMLAPI
SMS – Beispiel einer SMS-XMLAPI
3.4.1 Beispiel einer Fax-XMLAPI
HINWEIS
In diesem Beispiel werden zwei andere Dateien verwendet:
Anhang: Ein Anhang mit dem Namen mswordfile.doc, die unter C:\temp\ gespeichert
ist.
Nachrichtendatei: Eine einfache Textdatei mit dem Namen nachricht.txt, die unter
C:\temp\ gespeichert ist.
Diese Dateien werden von C:\temp\ gelöscht, wenn das Fax von GFI FaxMaker abgerufen
wurde.
<?xml version="1.0" encoding="utf-8"?>
<faxmakerdata>
<fields>
<subject>Dies ist der Faxbetreff</subject>
<schedule>2012-10-10-08:15:00</schedule>
<priority>high</priority>
<billingcode>25</billingcode>
<resolution>high</resolution>
<coverpage>Firma</coverpage>
<frontcovernote>Briefkopf</frontcovernote>
<faxline demandline="true">3</faxline>
<faxheader>Dies ist der Text für die Kopfzeile</faxheader>
<bodyfile type="text/plain">c:\temp\bodyfile.txt</bodyfile>
<attachment>c:\temp\mswordfile.doc</attachment>
<uid>3a5a90s7de3g20k9y4d5e7e6fse28se5e097</uid>
</fields>
<sender>
<firstname>Heinz</firstname>
<lastname>Müller</lastname>
<company>MeineFirma GmbH</company>
<department>Vertrieb</department>
<faxnumber>1234 5678</faxnumber>
<voicenumber>9876 5432</voicenumber>
<emailaddress>hmüller@meinefirma.com</emailaddress>
</sender>
<recipients>
<fax>
<recipient>
<firstname>Thomas</firstname>
<lastname>Bauer</lastname>
<company>Bauer & Co.</company>
<department>Marketing</department>
<faxnumber>1122 3344</faxnumber>
<voicenumber>5566 7788</voicenumber>
<emailaddress>tbauer@bauer.com</emailaddress>
</recipient>
</fax>
</recipients>
</faxmakerdata>
3.4.2 Beispiel einer SMS-XMLAPI
HINWEIS
In diesem Beispiel wird eine andere Datei verwendet: nachricht.txt, die unter C:\temp\
gespeichert ist und den Text der SMS-Nachricht enthält.
Diese Datei wird von C:\temp\ gelöscht, wenn die SMS von GFI FaxMaker abgerufen
wurde.
<?xml version="1.0" encoding="utf-8"?>
<faxmakerdata>
<fields>
<bodyfile type="text/plain">c:\temp\bodyfile.txt</bodyfile>
</fields>
<sender>
<emailaddress>hmüller@meinefirma.com</emailaddress>
</sender>
<recipients>
<sms>
<recipient>
<smsnumber>+1 800 2222 2222</smsnumber>
</recipient>
</sms>
</recipients>
</faxmakerdata>
3.5 XMLAPI-Antwortdateien
Nach der Verarbeitung einer XMLAPI erstellt GFI FaxMaker eine Antwortdatei im XMLAPI-Ordner,
anhand der der Faxversand überprüft werden kann. Die Antwortdatei hat die Erweiterung *.status.
Drittanbieter-Tools lassen sich so konfigurieren, dass sie diesen Ordner abfragen und den Status
gesendeter Faxe automatisch abrufen.
HINWEIS
Beim Versenden von SMS wird keine Antwortdatei erstellt.
Screenshot 3: Beispiel für eine XMLAPI-Antwortnachricht
Die Antwortnachricht enthält die folgenden XML-Container:
Tabelle 9: Antwortnachrichten-Container
Container
Beschreibung
<fax>...</fax>
Container für jeden Faxversand. Wenn eine XML API-Datei mehrere Empfänger
enthält, wird für jeden Empfänger ein <fax>-Container erstellt, der alle
Angaben für den jeweiligen Versand enthält.
<errorcode>...</errorcode>
Gibt den Fehlercode für den Faxversand zurück. Bei einem erfolgreichen
Faxversand lautet der Fehlercode 0.
<description>...</description>
Enthält den Sendebericht für erfolgreiche bzw. fehlgeschlagene
Faxversendungen. Dieser enthält wichtige Parameter für das Fax.
Container
Beschreibung
<uid>...</uid>
Wenn in der XMLAPI eine eindeutige ID (uid) bestimmt wurde, wird dieser
Container erstellt.
<faxfile>...</faxfile>
Enthält den vollständigen Pfad zur Faxbilddatei.
<recipient>...</recipient>
Zeigt die Faxnummer an, an die das Fax gesendet wurde.
4 Fehlerbehebung und Support
4.1 Einführung
In diesem Kapitel wird erklärt, wie bei der Installation von GFI FaxMaker auftretende Probleme
behoben werden können. Die wichtigsten verfügbaren Informationsquellen zum Beheben dieser
Probleme lauten wie folgt:
Dieses Handbuch – die meisten Probleme können Sie mithilfe der Informationen in diesem
Abschnitt lösen.
Artikel aus der GFI Knowledge Base
Webforum
Technischer Support von GFI
4.2 Knowledge Base
GFI pflegt ein umfangreiches Knowledge Base-Repository, in dem Lösungen für die häufigsten
Probleme bei der Installation beschrieben sind. Wenn die Informationen in diesem Handbuch nicht
ausreichen, um Ihre Installationsprobleme zu lösen, schlagen Sie bitte in der Knowledge Base nach.
Die Knowledge Base enthält immer die aktuelle Liste der Fragen, die an den technischen Support
gerichtet wurden, sowie die neuesten Patches. Zur Knowledge Base gelangen Sie über folgende URLAdresse: http://kb.gfi.com/.
4.3 Webforum
Über das GFI-Webforum erhalten Sie technischen Support von Benutzer zu Benutzer. Zum Webforum
gelangen Sie über folgende URL-Adresse: http://forums.gfi.com/.
4.4 Technischen Support anfragen
Wenn Sie mit keiner der oben angegebenen Ressourcen Ihre Probleme beheben können, wenden Sie
sich bitte an das technische Supportteam von GFI. Füllen Sie dazu ein Online-Support-Formular aus,
oder rufen Sie an.
Online: Füllen Sie das Anfrageformular für den Support aus, und befolgen Sie genau die
Anweisungen auf dieser Seite, um Ihre Support-Anfrage unter folgendem Link zu übermitteln:
http://support.gfi.com/supportrequestform.asp.
Telefon: Die korrekte Telefonnummer für den technischen Support Ihrer Region finden Sie unter:
http://www.gfi.com/company/contact.htm.
HINWEIS
Halten Sie bitte Ihre Kundennummer bereit, wenn Sie sich an den technischen Support
wenden. Ihre Kundennummer entspricht der Online-Kontonummer, die Sie bei der ersten
Registrierung Ihrer Lizenzschlüssel im GFI-Kundenbereich unter folgendem Link erhalten
haben: http://customers.gfi.com.
Für die Beantwortung Ihrer Anfrage benötigt GFI in Abhängigkeit von Ihrer Zeitzone maximal
24 Stunden.
4.5 Dokumentation
Wenn dieses Handbuch Ihren Erwartungen nicht entspricht oder Sie der Meinung sind, dass die
Dokumentation verbessert werden kann, senden Sie uns bitte eine E-Mail an: documentation@gfi.com.
USA, KANADA UND ZENTRAL- SOWIE SÜDAMERIKA
15300 Weston Parkway, Suite 104 Cary, NC 27513, USA
Telefon: +1 (888) 243-4329
Fax: +1 (919) 379-3402
ussales@gfi.com
GROSSBRITANNIEN UND IRLAND
Magna House, 18-32 London Road, Staines-upon-Thames, Middlesex, TW18 4BP, UK
Telefon: +44 (0) 870 770 5370
Fax: +44 (0) 870 770 5377
sales@gfi.com
EUROPA, MITTLERER OSTEN UND AFRIKA
GFI House, San Andrea Street, San Gwann, SGN 1612, Malta
Telefon: +356 2205 2000
Fax: +356 2138 2419
sales@gfi.com
AUSTRALIEN UND NEUSEELAND
83 King William Road, Unley 5061, South Australia
Telefon: +61 8 8273 3000
Fax: +61 8 8273 3099
sales@gfiap.com
Document
Kategorie
Internet
Seitenansichten
4
Dateigröße
1 151 KB
Tags
1/--Seiten
melden