Inhaltsübersicht

Das Produkt enthält fünf APIs. Diese dienen zum Senden und Abrufen von Nachrichten aus anderen Anwendungen.
Eine Quelldatei mit Programmbeispielen steht zur Verfügung, siehe Kapitel Programmbeispiele.

XSBMGTM

Dieses API wird zum Erstellen von GSM Text-Nachrichten verwendet.
Beispiele für die Verwendung dieses API finden Sie im Beispielprogramm EXP001.

Achtung: Bei Verwendung dieses APIs wird dringend empfohlen, eigene Programme basierend auf den Quellen in der Datei EXPSRC aufzubauen. Am besten geht man so vor, dass man zunächst die Funktionen der Programme EXP001.003 durch Senden der Kurzbefehle ZI und ZO und Beantwortung der ZO Nachricht testet.

Parameter:

Benutzer-ID
Die Benutzer-ID in der Benutzerdatei für den Empfänger der Nachricht. Dieses Feld sollte frei bleiben, wenn eine GSM-Nummer angegeben wurde.

GSM-Nummer
Die GSM-Nummer des Empfängers. Die Nummer muss in internationalem Format eingegeben werden. Dieses Feld steht nur für die Lizenzarten UO und UB zur Verfügung. Es sollte frei bleiben, wenn eine Benutzer-ID angegeben wurde.

Nachrichtentext
Der zu sendende Nachrichtentext.

Alarmruf senden
Alarmruf senden. Geben Sie 0 für nein an, 1 für ja.

Nachrichtenart
Geben Sie auf Wunsch ein alphanumerisches Zeichen ein. Das Zeichen wird von GSMText gespeichert, aber nicht verarbeitet. Es kann über Query zur Selektion von Nachrichten aus der Logdatei verwendet werden. Reservierte Werte sind S und U (bitte nicht benutzen).

Anfrage beantworten
Geben Sie auf Wunsch 1 an, wenn eine Antwort angefragt werden soll. Dann wird beim Versenden der Nachricht dem Nachrichtentext eine Beantwortungs-Zeichenfolge angehängt.

Gültigkeitszeitraum, Stunden
Geben Sie auf Wunsch an, wie viele Stunden eine Antwortanfrage gültig bleiben soll. Ist dieser Zeitraum abgelaufen, erscheint für diese Nachricht in der Spalte „Beantworten" im Sendeprotokoll *EXPIRED. Dieses Feld ist nur aktiv, wenn das Feld Anfragebeantwortung auf 1 seht.

Gültigkeitszeitraum, Minuten
Funktioniert im Zusammenhang mit dem vorhergehenden Feld.

Antwortprogramm Bibliothek
Der Name der Bibliothek, in der das Programm zur Beantwortungsverarbeitung gespeichert ist. Dieses Feld ist nur aktiv, wenn im Feld Anfrage beantworten eine 1 eingetragen ist.

Antwortprogramm Name
Der Name des Beantwortungsverarbeitungprogramms. Dieses Feld ist nur aktiv, wenn das Feld Anfrage beantworten auf 1 gestellt ist.

Antwortprogramm Ausführung
Kennzeichen I (immediately) veranlasst die sofortige Ausführung der Antwortfunktion nach Empfang der SMS, während bei Verwendung von D (delayed) die Funktion über den Befehl RUNGSMTRPP gestartet wird (sequentiell über eine Warteschlange).

Benutzerdaten
Die Benutzerdaten sind zusammen mit der Nachricht gespeichert und werden nicht vom Produkt verarbeitet. Sie können mit dem XRTVGT4-API abgerufen werden.

Nicht anzeigen SMS im Log
Mit Kennzeichen 1 können Sie die Anzeige des Nachrichtentextes in der Protokolldatei unterdrücken.

Laufende Nummer
Die laufende Nummer wird zugewiesen, wenn das API läuft. Speichern Sie ihn Ihrer Anwendung, wenn Sie die Nachricht später auffinden wollen.

Rückgabecode
Der Rückgabecode, der das Ergebnis der Nachrichtenvorlage anzeigt.

0 Nachrichtenvorlage erfolgreich beendet.
9 Unspezifizierter Fehler.

XRTVGT4

Dieses API dient zum Auffinden von Informationen über Nachrichten im Empfangsprotokoll oder im Sendeprotokoll.

Parameter:

Quell-Systemname
Der Name des Systems, das die Nachricht erstellt hat.

Laufende Nummer
Laufende Nummer der Nachricht. Diese Nummer bekommen Sie bei der Vorlage einer Nachricht mit dem XSBMGTM-API für abgehende Nachrichten. Bei eingehenden Nachrichten kann laufende Nummer als Parameter in der -Befehlskette angegeben werden.

Formatname
Verwenden Sie für Nachrichten im Sendeprotokoll SND010, für Nachrichten im Empfangsprotokoll RCV010.

Rückgabecode
Folgende Codes können zurückgegeben werden:

0 Nachricht erfolgreich abgerufen.
1 Nachricht nicht gefunden.
8 Falscher Formatname angegeben.
9 Programmfehler.

Empfängervariable
Die Formate SND010 und RCV010 stehen in der Quelldatei GSMTEXT/EXPSRC zur Verfügung.

XTRVGTM

Dieses API wurde in Version 3 von GSMText für den gleichen Zweck wie XRTVGT4 verwendet. Es wird nur noch aus Kompatibilitätsgründen unterstützt.

XTRVVAL

Dieses API wird verwendet um Informationen aktueller und vorheriger Sensorleseoperationen zu empfangen.

Parameter:

1 Sensorkurzname Input Char(3)
2 Folgenummer Input Packed(3,0)
3 Formatname Input Char(6)
4 Returncode Output Char(1)
5 Empfängewert Output Char(*)

Sensorkurzname
Der Kurzname aus dem *SENSOR Checkpoint

Folgenummer
Die Folgenummer des Sensors wen mehrere Sensoren den gleichen Kurznamen haben. Falls nicht angegeben wird der Wert des ersten Sensors mit dem Kurznamen zurückgegeben.

Formatname
Verwenden Sie den Wert VAL0000

Returncode
Die folgenden Werte können zurückgegeben werden:

1 API Aufruf war erfolgreich
-1 API Aufruf war nicht erfolgreich

Empfängerwert
Das Format VAL000 ist verfügbar in der Quellteildatei GSMTEXT/EXPSRC

XCLRGMO

Wenn dieses Programm läuft, werden alle aktiven Checkpoints sofort ausgeführt. Jeder Fehler wird protokolliert