Zum Inhalt

Makro-API-Objekte

Sie können Makros mithilfe der Makro-API erstellen. Für die standardmäßige Verwendung in Makros stehen vier primäre Objekte zur Verfügung:

  • Session – der Haupteinstiegspunkt zum Host. Mit dem Session-Objekt stellen Sie eine Verbindung zum PresentationSpace-Objekt her, trennen die Verbindung zu diesem Objekt und gewähren Zugriff darauf.

  • PresentationSpace – stellt den Bildschirm dar und bietet zahlreiche allgemeine Funktionen wie das Abrufen und Festlegen der Cursorposition, das Senden von Daten an den Host und das Lesen auf dem Bildschirm. Dieses Objekt wird mit session.getPresentationSpace() abgerufen.

  • Wait – bietet eine einfache Möglichkeit, auf das Auftreten der verschiedenen Hoststatus zu warten, bevor weitere Daten gesendet oder auf dem Bildschirm gelesen werden. Sie können beispielsweise darauf warten, dass sich der Cursor an einer bestimmten Position befindet, dass Text an einer bestimmten Position des Bildschirms angezeigt wird oder einfach für eine festgelegte Zeit. Alle Aufrufe der Funktion 'Wait' erfordern das 'yield'-Schlüsselwort, das weiter unten beschrieben wird.

  • User Interface – automatisch in Ihrem Makro als die Variable „ui“ verfügbar. Es stellt die grundlegenden Funktionen der Benutzeroberfläche bereit. Mit diesem Objekt werden dem Benutzer Daten angezeigt oder Informationen abgefragt. Alle Aufrufe der Funktion 'ui' erfordern das yield-Schlüsselwort.

Alle verfügbaren Objekte

Die Liste der verfügbaren Objekte können Sie in der rechten Navigation unter „Auf dieser Seite“ anzeigen. (Möglicherweise müssen Sie Ihren Browser erweitern.)


Attribut

Verwenden Sie das Attribute-Objekt gemeinsam mit dem AttributeSet-Objekt zum Decodieren der Formatierungsinformationen in der Datenzelle.

Attribut Bedeutung
PROTECTED geschützte Datenzelle
MODIFIED geänderte Datenzelle
NUMERIC_ONLY Anfang einer ausschließlich numerischen Datenzelle
ALPHA_NUMERIC alphanumerische Datenzelle
HIGH_INTENSITY ob die Datenzelle Text mit hoher Intensität enthält
HIDDEN ob die Datenzelle ausgeblendeten Text enthält
PEN_DETECTABLE ob die Datenzelle von Stiften erkannt wird
ALPHA_ONLY ausschließlich alphanumerische Datenzelle
NUMERIC_SHIFT Anfang eines numerischen Umschaltfelds
NUMERIC_SPECIAL Datenzelle markiert den Anfang eines numerischen Sonderfelds
KATAKANA_SHIFT Abschnitt mit Katakana-Text
MAGNETIC_STRIPE Datenzelle markiert den Anfang eines Magnetstreifenfelds
SIGNED_NUMERIC_ONLY Datenzelle ist ein Feld für numerische Daten mit Vorzeichen
TRANSMIT_ONLY Datenzelle ist ein Feld nur für die Übertragung
FIELD_END_MARKER Datenzelle markiert das Ende eines geänderten Felds
FIELD_START_MARKER Datenzelle markiert den Anfang eines geänderten Felds
SPECIAL_EMPHASIS_PROTECTED geschütztes Feld mit besonderer Hervorhebung
TAB_STOP Datenzelle enthält einen Tabstopp
REVERSE Datenzelle wird in umgekehrter Darstellung angezeigt
BLINKING Datenzelle enthält blinkenden Text
RIGHT_JUSTIFIED Datenzelle markiert den Anfang eines rechts ausgerichteten Felds
LEFT_JUSTIFIED Datenzelle markiert den Anfang eines links ausgerichteten Felds
LOW_INTENSITY Datenzelle enthält Text mit niedriger Intensität
UNDERLINE Datenzelle enthält unterstrichenen Text
DOUBLE_BYTE Datenzelle enthält Doppelbyte-Text
COLUMN_SEPARATOR Datenzelle enthält ein Spaltentrennzeichen
BOLD Datenzelle enthält fett formatierten Text
DOUBLE_WIDTH Datenzelle enthält ein Feld mit doppelter Breite
DOUBLE_HEIGHT_TOP Datenzelle mit doppelter oberer Höhe
DOUBLE_HEIGHT_BOTTOM Datenzelle mit doppelter unterer Höhe
CONTROL_PAGE_DATA Datenzelle enthält Steuerungsseitendaten
RIGHT_COLUMN_SEPARATOR Datenzelle enthält ein rechtes Spaltentrennzeichen
LEFT_COLUMN_SEPARATOR Datenzelle enthält ein linkes Spaltentrennzeichen
UPPERSCORE Datenzelle enthält einen Überstrich
STRIKE_THROUGH Datenzelle enthält durchgestrichenen Text

AttributeSet

Mit dem AttributeSet-Objekt können Benutzer die in der Datenzelle enthaltenen Attribute decodieren. Das AttributeSet-Objekt gibt die im Attribute-Objekt definierten Werte zurück. Wenn sie gemeinsam verwendet werden, können Sie die Formatierungsinformationen aus der Datenzelle abrufen.

Methode Beschreibung
contains(attribute) Gibt an, ob der Satz das festgelegte Attribut (attribute) enthält.
Parameter
{Number} Zu prüfendes Attribut.
Rückgabe
{Boolean} „True“ (wahr), wenn das Attribut im Satz enthalten ist.
isEmpty() Gibt an, ob der Attributsatz leer ist.
Rückgabe
{Boolean} „True“ (wahr), wenn der Satz leer ist.
size() Gibt die Anzahl der in einem Satz enthaltenen Attribute an.
Rückgabe
{Number} Die Attributanzahl.
toArray() Konvertiert den internen Attributsatz in ein Array.
Rückgabe
{Number[]} Array mit den Werten der Attribute im Satz.
toString() Konvertiert den internen Attributsatz in eine Zeichenfolge.
Rückgabe
{String} Durch Leerzeichen getrennte Namen der im Satz enthaltenen Attribute.
forEach(callback, thisArg) Funktion zum Durchlaufen der einzelnen Elemente im Attributsatz.
Parameter
{forEachCallback} Callback zum Ausführen eines bestimmten Vorgangs. Wird gemeinsam mit dem Namen des jeweiligen Attributs im Satz aufgerufen.
{Object} thisArg Optionaler Verweis auf ein Kontextobjekt.
forEachCallback(string, object) Eine durch Benutzer bereitgestellte Rückruffunktion, mit der Sie das Verhalten bereitstellen. Wird als Rückrufparameter für 'forEach' verwendet.
Parameter
{String} Zeichenkettenname eines Attributs im Attributsatz.
{Object} thisArg Optionaler Verweis auf ein Kontextobjekt.

AutoSignOn

Methode Beschreibung
getPassTicket() Ruft ein Weiterleitungsticket ab, das für die Anmeldung bei einer Mainframe-Anwendung verwendet werden soll. Unter Verwendung verschiedener Anwendungskennungen können mehrere Weiterleitungstickets angefordert werden.
Parameter
{String} Anwendungs-ID, die dem Host mitteilt, für welche Anwendung die Anmeldung gilt.
Rückgabe
{Promise} Erfüllt mit Weiterleitungsticketschlüssel bzw. abgelehnt, wenn der Vorgang nicht ausgeführt werden kann. Das vom DCAS abgerufene Weiterleitungsticket kann nur mit der aktuellen Hostsitzung verwendet werden und ist für zehn Minuten gültig.
sendUserName() Wendet den im Weiterleitungsticket enthaltenen Benutzernamen auf das Feld an der aktuellen Cursorposition auf dem aktuellen Hostbildschirm an. Der Benutzername muss vor dem Passwort gesendet werden. Wenn Sie das Passwort zuerst senden, wird das Weiterleitungsticket ungültig, und Sie müssen ein neues Ticket anfordern.
Parameter
{String} Mit „getPassTicket“ abgerufener Weiterleitungsticketschlüssel (passTicketKey).
Rückgabe
{Promise} Erfüllt, wenn der Benutzername erfolgreich gesendet wurde. Wird abgelehnt, wenn der Vorgang fehlschlägt.
sendPassword() Wendet das im Weiterleitungsticket enthaltene Passwort auf das Feld an der aktuellen Cursorposition auf dem aktuellen Hostbildschirm an. Der Benutzername muss vor dem Passwort gesendet werden. Wenn Sie das Passwort zuerst senden, wird das Weiterleitungsticket ungültig, und Sie müssen ein neues Ticket anfordern.
Parameter
{String} Mit „getPassTicket“ abgerufener Weiterleitungsticketschlüssel (passTicketKey).
Rückgabe
{Promise} Erfüllt, wenn das Passwort erfolgreich gesendet wurde. Abgelehnt, wenn der Vorgang nicht ausgeführt werden kann.

Farbe

Farbkonstanten zur Verwendung für die Vordergrund- und Hintergrundfarben von DataCell-Objekten.

Farbe Beschreibung Numerischer Wert
BLANK_UNSPECIFIED Keine Farbe angegeben 0
BLUE Blau 1
GREEN Grün 2
CYAN Cyan 3
RED Rot 4
MAGENTA Magenta 5
YELLOW Gelb 6
WHITE_NORMAL_INTENSITY Weiß mit normaler Intensität 7
GRAY Grau 8
LIGHT_BLUE Hellblau 9
LIGHT_GREEN Hellgrün 10
LIGHT_CYAN Cyan (hell) 11
LIGHT_RED Hellrot 12
LIGHT_MAGENTA Magenta (hell) 13
BLACK Schwarz 14
WHITE_HIGH_INTENSITY Weiß mit hoher Intensität 15
BROWN Braun 16
PINK Rosa 17
TURQUOISE Türkis 18

ControlKey

Das ControlKey-Objekt definiert Konstanten zum Senden von Cursor-Steuertasten und Hostbefehlen mithilfe der sendKeys-Methode. Konstanten sind für die folgenden Hosttypen verfügbar:


IBM 3270

Schlüsselwort Beschreibung
ALTVIEW Alternative Ansicht
ATTN Abruf
BACKSPACE Rückschritt
BACKTAB Rücktabulator
CLEAR Löschen oder Bildschirminhalt löschen
CURSOR_SELECT Cursorauswahl
DELETE_CHAR Löschen, Zeichen löschen
DELETE_WORD Wort löschen
DEST_BACK Rückschritt mit Löschen
DEV_CANCEL Geräteabbruch
DOWN Cursor nach unten
DSPSOSI SO/SI anzeigen
DUP Feld duplizieren
END_FILE Feldende
ENTER Eingabe
ERASE_EOF Feldende löschen
ERASE_FIELD Feld löschen
ERASE_INPUT Eingabe löschen
FIELD_MARK Feldmarkierung
HOME Cursor Pos1
IDENT Ident
INSERT Einfügen
LEFT_ARROW Cursor nach links
LEFT2 Cursor um zwei Positionen nach links
NEW_LINE Neue Zeile
PA1 – PA3 PA1 – PA3
PF1 – PF24 PF1 – PF24
PAGE_DOWN Bild nach unten
PAGE_UP Bild nach oben
RESET Zurücksetzen, Terminal zurücksetzen
RIGHT2 Cursor um zwei Positionen nach rechts
RIGHT_ARROW Cursor rechts, rechts
SYSTEM_REQUEST Systemanforderung
TAB Tabulatortaste
UP Cursor nach oben

IBM 5250

Schlüsselwort Beschreibung
ALTVIEW Alternative Ansicht
ATTN Abruf
AU1 – AU16 AU1 – AU16
BACKSPACE Rückschritt
BACKTAB Rücktabulator
BEGIN_FIELD Feld beginnen
CLEAR Löschen oder Bildschirminhalt löschen
DELETE_CHAR Löschen, Zeichen löschen
DEST_BACK Rückschritt mit Löschen
DOWN Cursor nach unten
DSPSOSI SO/SI anzeigen
DUP Feld duplizieren
END_FILE Feldende
ENTER Eingabe
ERASE_EOF Feldende löschen
ERASE_FIELD Feld löschen
ERASE_INPUT Eingabe löschen
FIELD_EXT Feldende
FIELD_MINUS Feld Minus
FIELD_PLUS Feld Plus
FIELD_MARK Feldmarkierung
HELP Hilfeanforderung
HEXMODE Hexadezimalmodus
HOME Cursor Pos1
INSERT Einfügen
LEFT_ARROW Cursor nach links
NEW_LINE Neue Zeile
PA1 – PA3 PA1 – PA3
PF1 – PF24 PF1 – PF24
PAGE_DOWN Bild nach unten
PAGE_UP Bild nach oben
[print] Drucken
RESET Zurücksetzen, Terminal zurücksetzen
RIGHT_ARROW Cursor rechts, rechts
SYSTEM_REQUEST Systemanforderung
TAB Tabulatortaste
UP Cursor nach oben

VT

Schlüsselwort Beschreibung
BACKSPACE Rückschritt
BREAK Unterbrechungstaste
CLEAR Löschen oder Bildschirminhalt löschen
CURSOR_SELECT Cursorauswahl
DELETE_CHAR Löschen, Zeichen löschen
DOWN Cursor nach unten
EK_FIND Nt Suche bearbeiten
EK_INSERT Nt Einfügen bearbeiten
EK_NEXT Nt Nächster bearbeiten
EK_PREV Nt Vorheriger bearbeiten
EK_REMOVE Nt Löschen bearbeiten
EK_SELECT Nt Auswählen bearbeiten
END_FILE Feldende
ENTER Eingabe
F1 - F24 F1 - F24
HOLD Halten
HOME Pos1
INSERT Einfügen
KEYPAD_COMMA NtKomma
KEYPAD_DOT NtDezimal
KEYPAD_ENTER NtEingabe
KEYPAD_MINUS NtMinus
KEYPAD0 - KEYPAD9 Nt0 - Nt9
LEFT_ARROW Cursor nach links
PF1 - PF20 PF1 - PF20
PAGE_DOWN Bild nach unten
PAGE_UP Bild nach oben
RESET Zurücksetzen, Terminal zurücksetzen
RETURN Zurück, Wagenrücklauf
RIGHT_ARROW Cursor rechts, rechts
TAB Tabulatortaste
UDK16 – UDK20 Benutzertaste 6 – Benutzertaste 20
UP Cursor nach oben

UTS

Schlüsselwort Beschreibung
BACKSPACE Rückschritt
BACKTAB Rücktabulator
CHAR_ERASE Löscht Zeichen an der Cursorposition und erweitert den Cursor.
CLEAR_DISPLAY Bildschirminhalt löschen
CLEAR_EOD Bis zum Anzeigeende löschen
CLEAR_EOF Bis zum Feldende löschen
CLEAR_EOL Bis zum Zeilenende löschen
CLEAR_FCC Feldsteuerungszeichen löschen
CLEAR_HOME Bildschirminhalt löschen und Cursor Pos1
CONTROL_PAGE Blendet die Steuerungsseite ein oder aus
DELETE_LINE Löscht die Zeile, in der sich der Cursor befindet, und verschiebt die restlichen Zeilen um eine Zeile nach oben.
DELIN_LINE Löscht das Zeichen unterhalb des Cursors und verschiebt die restlichen Zeichen auf der Zeile nach links.
DELIN_PAGE Löscht das Zeichen unterhalb des Cursors und verschiebt die restlichen Zeichen auf der Seite nach links.
DOWN Verschiebt den Cursor um eine Zeile nach unten. Umbruch erfolgt am unteren Ende.
DUP_LINE Erstellt eine Kopie der aktuellen Zeile und überschreibt die nächste Zeile mit dem Duplikat.
END_FIELD Bewegt den Cursor an das Ende des aktuellen Felds.
END_PAGE Bewegt den Cursor an das Ende der aktuellen Seite.
EURO Fügt das Euro-Zeichen ein.
F1 - F22 Funktionstasten F1-F22
HOME Bewegt den Cursor an den Anfang der aktuellen Seite (Zeile 1, Spalte 1)
INSERT Wechselt zwischen dem Einfügemodus und dem Überschreibmodus.
INSERT_IN_LINE Fügt ein Leerzeichen an der Cursorposition ein und verschiebt die restlichen Zeichen auf der Zeile nach rechts. Das Zeichen in der äußeren rechten Spalte der Zeile wird verworfen.
INSERT_IN_PAGE Fügt ein Leerzeichen an der Cursorposition ein und verschiebt die restlichen Zeichen auf der Seite nach rechts. Das Zeichen in der äußeren rechten Spalte der jeweiligen Zeile wird verworfen.
INSERT_LINE Fügt eine neue Zeile an der Cursorzeile ein und verschiebt die restlichen Zeilen nach unten. Die letzte Zeile auf der Seite wird verworfen.
LEFT_ARROW Bewegt den Cursor um eine Position nach links und fügt ggf. einen Umbruch ein.
LOCATE_FCC Sucht nach dem nächsten Feldsteuerungszeichen auf dem Bildschirm.
MSG_WAIT Ruft Meldungen in der Warteschleife des Terminals ab.
RETURN Wagenrücklauf
RIGHT_ARROW Bewegt den Cursor um eine Position nach rechts und fügt ggf. einen Umbruch ein.
SOE Fügt das Zeichen für den Anfang des Eintrags ein.
START_OF_FIELD Bewegt den Cursor an den Feldanfang.
START_OF_LINE Bewegt den Cursor zur ersten Spalte der aktuellen Zeile.
TAB Bewegt den Cursor in die nächste Tabulatorposition auf dem Bildschirm.
TOGGLE_COL_SEP Ändert das Spaltentrennzeichen-Attribut.
TOGGLE_STRIKE_THRU Ändert das Durchstreichungs-Attribut in der aktuellen Datenzelle.
TOGGLE_UNDERLINE Ändert das Unterstreichungs-Attribut in der aktuellen Datenzelle.
TRANSMIT Überträgt die geänderten Felddaten an den Host.
UNLOCK Sendet die UNLOCK-Taste an den Host.
UP Bewegt den Cursor eine Zeile nach oben und fügt ggf. einen Umbruch ein.

DataCell

Das DataCell-Objekt stellt Informationen zu einer bestimmten Position auf einem Terminalbildschirm bereit.

Methode Beschreibung
getPosition() Gibt die Position dieser Datenzelle auf dem Bildschirm zurück.
Rückgabe
{Position} Position dieser Datenzelle auf dem Bildschirm.
getChar() Ruft das mit der Zelle verknüpfte Zeichen ab.
Rückgabe
{String} Das mit der Zelle verknüpfte Zeichen.
getAttributes() Gibt die für diese Datenzelleninstanz angegebene Attributgruppe zurück. Siehe AttributeSet.
Rückgabe
{AttributeSet} Attributsatz für diese Datenzelleninstanz.
getForegroundColor() Gibt die Vordergrundfarbe für diese Datenzelle gemäß der Definition im Color-Objekt zurück.
Rückgabe
{Number} Vordergrundfarbe für diese Datenzelle. Die Farbe wird im Color-Objekt definiert.
getBackgroundColor() Gibt die Hintergrundfarbe für diese Datenzelle gemäß der Definition im Color-Objekt zurück.
Rückgabe
{Number} Hintergrundfarbe für diese Datenzelle. Die Farbe wird im Color-Objekt definiert.
toString Konvertiert die interne Datenzelle in eine Zeichenfolge.
Rückgabe
{String} Die Zeichenkettendarstellung einer Datenzelle.
isFieldDelimiter() Testet, ob die Zelle ein Feldtrennzeichen darstellt.
Rückgabe
{Boolean} „True“ (wahr), wenn diese Zelle ein Feldtrennzeichen darstellt, ansonsten „False“ (falsch).

Dimension

Stellt die Größe des Bildschirms oder des Bildschirmbereichs dar.

Methode Beschreibung
Dimension(rows,cols) Erstellt eine neue Dimension-Instanz.
Parameter
{Number} rows Bildschirmzeilendimension
{Number} cols Bildschirmspaltendimension

Field

Verwenden Sie das Field-Objekt gemeinsam mit FieldList, um die auf dem Bildschirm in einem Feld enthaltenen Informationen abzurufen.

Methode Beschreibung
getAttributes() Gibt die für diese Feldinstanz angegebene Attributgruppe zurück. Siehe AttributeSet.
Rückgabe
{AttributeSet} Der Attributsatz für dieses Feld.
getForegroundColor() Gibt die Vordergrundfarbe des Felds zurück.
Rückgabe
{Number} Vordergrundfarbe für dieses Feld. Diese Werte werden im Color-Objekt definiert.
getBackgroundColor() Gibt die Hintergrundfarbe des Felds zurück.
Rückgabe
{Number} Hintergrundfarbe für dieses Feld. Diese Werte werden im Color-Objekt definiert.
getStart() Gibt die Anfangsposition des Felds zurück. Die Anfangsposition ist die Position des ersten Zeichens im Feld. Einige Hosttypen verwenden eine Zeichenposition zum Speichern von Feldebenenattributen. In diesem Fall wird die Attributposition nicht als Anfangsposition betrachtet.
Rückgabe
{Position} Anfangsposition des Felds.
Fehlerrückgabe
{RangeError} Für Felder mit einer Länge von null.
getEnd() Gibt die Endposition des Felds zurück. Die Endposition ist die Position im Darstellungsbereich mit dem letzten Zeichen des Felds.
Rückgabe
{Position} Endposition des Felds.
Fehlerrückgabe
{RangeError} Für Felder mit einer Länge von null.
getLength() Gibt die Länge des Felds zurück. Bei Hosttypen, die zum Speichern der Feldattribute eine Zeichenposition verwenden, ist die Feldattributposition nicht in der Feldlänge enthalten.
Rückgabe
{Number} Länge des Felds.
getDataCells() Ruft die Datenzellen ab, die dieses Feld bilden. Siehe DataCell.
Rückgabe
{DataCell[]} Datenzellen, die dieses Feld bilden.
getText() Ruft den Text aus dem Feld ab.
Rückgabe
{String} Feldtext.
setText() Legt den Feldtext fest. Bei bestimmten Hosttypen wie VT wird der Text sofort an den Host übertragen. Bei anderen Hosttypen wiederum wird der Text erst dann an den Host übertragen, wenn die AID-Taste aufgerufen wird. Wenn der Text kürzer als das Feld ist, wird er im Hostfeld platziert, und der Rest des Felds wird gelöscht. Wenn der Text länger als das Hostfeld ist, wird so viel Text wie möglich im Feld platziert.
Parameter
{String} Text, der im Feld gesetzt wird.
Fehlerrückgabe
{Error} Wenn das Feld geschützt ist.
clearField() Löscht das aktuelle Feld emulationsspezifisch.
Fehlerrückgabe
{Error} Wenn das Feld geschützt ist oder Löschen nicht unterstützt wird.
getPresentationSpace() Ruft den PresentationSpace ab, der dieses Feld erstellt hat.
Rückgabe
{PresentationSpace} Übergeordnetes Element dieser Feldinstanz.
toString() Erstellt eine benutzerfreundliche Beschreibung des Felds.
Rückgabe
{String} Eine von Benutzern lesbare Darstellung des Felds.

FieldList

Verwenden Sie das FieldList-Objekt gemeinsam mit dem Field-Objekt zum Abrufen von Feldlisteninformationen.

Methode Beschreibung
getPresentationSpace() Ruft den PresentationSpace ab, der dieses Feld erstellt hat.
Rückgabe
{PresentationSpace} Übergeordnetes Element dieser Feldinstanz.
findField(position, text, direction) Gibt das Feld mit dem angegebenen Text zurück. Der Suchvorgang beginnt an der angegebenen Position und verläuft vorwärts oder rückwärts. Wenn sich die Zeichenfolge über mehrere Felder erstreckt, wird das Feld zurückgegeben, das die Startposition enthält. Wenn vorwärts gesucht wird, findet kein Umbruch bis zum oberen Ende des Bildschirms statt. Wenn rückwärts gesucht wird, findet kein Umbruch bis zum unteren Ende des Bildschirms statt.
Parameter
{Position} Position, an der die Suche beginnen soll. Siehe Objekt „Position“.
{String} Der Text, nach dem gesucht werden soll (optional). Wenn nicht angegeben, wird das nächste Feld rechts von oder unterhalb der angegebenen Position zurückgegeben.
{Number} Richtung der Suche (optional). Verwenden Sie PresentationSpace. SearchDirection-Konstanten für diesen Parameter. Zum Beispiel: PresentationSpace.SearchDirection.FORWARD oder PresentationSpace.SearchDirection.BACKWARD. Wenn nicht angegeben, wird vorwärts gesucht.
Rückgabe
{Field} Enthält die Zeichenkette oder Null, wenn kein Feld, das die vorgegebenen Kriterien erfüllt, gefunden wird.
Fehlerrückgabe
{RangeError} Wenn die Position außerhalb des Wertebereichs liegt.
get(index) Ruft das Feld am vorgegebenen Index ab.
Parameter
{Number} Index in der Feldliste.
Rückgabe
{Field} Feld am angegebenen Index.
Fehlerrückgabe
{RangeError} Wenn der Index außerhalb des Wertebereichs liegt.
isEmpty() Gibt an, ob die Feldliste leer ist.
Rückgabe
{Boolean} „True“ (wahr), wenn die Liste leer ist.
size() Gibt die Anzahl der in der Liste enthaltenen Felder an.
Rückgabe
{Number} Die Feldanzahl.
toString() Erstellt eine benutzerfreundliche Beschreibung der Feldliste.
Rückgabe
{String} Eine von Benutzern lesbare Darstellung der Feldliste.

FileTransfer

Verwenden Sie das FileTransfer-Objekt, um Dateien aufzulisten und zwischen dem Hostsystem und dem Client zu übertragen.

Die Dateiübertragungs-API von Host Access for the Cloud abstrahiert die in verschiedenen Hostdateiimplementierungen verwendeten Benennungskonventionen für Dateipfade. Verwenden Sie das Format für URL- oder Linux-Dateisystempfade, wenn Sie die von der API verwendeten Pfade formatieren. Beispiel: /stamm/verzeichnis/datei.

Alle spezifischen Regeln in den jeweiligen Hostsystemen müssen berücksichtigt werden, z. B. zulässige Zeichen oder Namenlängen.

Hinweis

Browser enthalten erhebliche Sicherheitseinschränkungen in Bezug auf die Möglichkeit der Interaktion zwischen JavaScript und Clientdateisystemen.

Methode Beschreibung
getHostFileListing(remotePath)() Fordert eine Liste der Hostdateien an. Wenn remotePath nicht angegeben ist, wird eine Dateiliste für das aktuelle Remotearbeitsverzeichnis angezeigt.
Parameter
{String} (optional) Wenn dieser Wert angegeben ist, wird die Dateiliste für den angegebenen Remotepfad abgerufen. Wenn kein Wert angegeben wird, wird die Dateiliste für das aktuelle Remotearbeitsverzeichnis abgerufen.
Rückgabe
{Promise} Wird in ein Array von HostFile-Objekten aufgelöst, die in remoteName enthalten sind. Wird abgelehnt, wenn der Remotepfad nicht gelesen werden kann.
sendFile(localFile, remoteName) Sendet die angegebene Datei an den Host.
Parameter
{File} JavaScript-Dateiobjekt, das auf die zu sendende lokale Datei verweist.
{String} (optional) Vollständiger Remotedateiname entsprechend der Zulässigkeit im Remotesystem (Unix, Windows, MVS, VAX).
Rückgabe
{Promise} Wird mit einem HostFile-Objekt erfüllt, das die erfolgreich gesendete Datei darstellt. Wird abgelehnt, wenn beim Senden der Datei ein Fehler aufgetreten ist.
getDownloadURL(remoteName) Erstellt einen Link zum Herunterladen einer Datei von einem Hostsystem.
Parameter
{String} Vollständiger Remotedateiname entsprechend der Zulässigkeit im Remotesystem (Unix, Windows, MVS, VAX).
Rückgabe
{URL} URL, die zum Abrufen der Datei vom Host Access for the Cloud-Sitzungsserver verwendet werden kann.
setTransferOptions(options) Legt Übertragungsoptionen für die aktuelle FileTransfer-Sitzung fest. Die Übertragungsoptionen werden auf alle zukünftigen Übertragungen angewendet, bis die Sitzung entweder beendet oder durch einen anderen Aufruf von setTransferOptions überschrieben wird.
Parameter
{JSON} Siehe FileTransferOptions für zulässige Namen und Werte.
Rückgabe
{Promise} Wird erfüllt, wenn der Aufruf abgeschlossen wird. Wird abgelehnt, wenn beim Festlegen der Optionen ein Fehler aufgetreten ist.
cancel() Bricht die aktuelle laufende Übertragung ab.
Parameter
{String} Vollständiger Remotedateiname entsprechend der Zulässigkeit im Remotesystem (Unix, Windows, MVS, VAX).
Rückgabe
{Promise} Wird erfüllt, wenn der Aufruf abgeschlossen wird. Wird abgelehnt, wenn während des Abbruchs der Übertragung ein Fehler aufgetreten ist.

FileTransferFactory

Ein fileTransferFactory-Objekt ist für alle Makros verfügbar. Wenn Dateiübertragungen für die Sitzung konfiguriert sind, können Sie mithilfe dieses Objekts einen Verweis auf ein FileTransfer-Objekt abrufen.

Methode Beschreibung
getIND$File() Gibt ein FileTransfer-Objekt für die Interaktion mit dem konfigurierten Ind$File-Typ für die Sitzung zurück.
Rückgabe
{FileTransfer}
Fehlerrückgabe
{Error} Wenn die Sitzung nicht für IND$File-Übertragungen konfiguriert wurde.

FileTransferOptions

Spezifikation des FileTransferOptions-Objekts. Beispiel:
`fileTransfer.setTransferOptions({ transferMethod : 'ascii' });```

Methode Beschreibung
transferMethod {String}Zulässige Werte:
  • ‘ascii’
  • ‘Binär’

HostFile

Ein HostFile-Objekt stellt eine Datei auf dem Hostdateisystem dar.

Methode Beschreibung
getName() Ruft den Dateinamen ab..
Rückgabe
{String} Der Dateiname.
getParent() Ruft das übergeordnete Element dieser Hostdatei ab..
Rückgabe
{String} Übergeordnetes Element dieser Hostdatei. Je nach Hosttyp handelt es sich dabei um ein unterschiedliches Element. Auf einem TSO-Host ist dies beispielsweise der Name des Katalogs, in dem sich die Datei befindet.
getSize() Die Bytegröße der Datei..
Rückgabe
{Number} Die Größe der Datei in Byte.
getType() Der Typ der dargestellten Datei..
Rückgabe

HostFileType

Das HostFileType-Objekt definiert Konstanten zum Festlegen des Typs eines HostFile-Objekts.

Wert Beschreibung
FILE Stellt eine Datei auf dem Hostsystem dar.
DIR Stellt ein Verzeichnis auf dem Hostsystem dar.
UNKNOWN Stellt eine Hostdatei unbekannten Ursprungs dar.

OIA

Operatorinformationsfeld-Oberfläche (OIA, Operator Information Area ). Das OIA-Objekt gibt Werte zurück, die im OIAStatus-Objekt definiert sind.

Methode Beschreibung
getStatus () Gibt den Satz der aktivierten Statusflaggen zurück. Siehe StatusSet.
Rückgabe
{StatusSet} Statussatz, der die Statusinformationen enthält.
getCommErrorCode() Gibt den Fehlercode zur aktuellen Kommunikation zurück.
Rückgabe
{Number} Code des aktuellen Kommunikationsfehlers. Wenn kein Fehlercode vorhanden ist, lautet der Wert 0.
getProgErrorCode() Gibt den Fehlercode zum aktuellen Programm zurück..
Rückgabe
{Number} Code des aktuellen Programmfehlers. Wenn kein Fehlercode vorhanden ist, lautet der Wert 0.

OIAStatus

OIAStatus Beschreibung
CONTROLLER_READY Controller bereit
A_ONLINE Online mit einer Nicht-SNA-Verbindung
MY_JOB Verbunden mit einer Hostanwendung
OP_SYS Verbunden mit einer SSCP-Verbindung (SNA)
UNOWNED Nicht angeschlossen
TIME Tastatur gesperrt
SYS_LOCK Systemsperre nach AID-Taste
COMM_CHECK Kommunikationsprüfung
PROG_CHECK Programmprüfung
ELSEWHERE Tastenfolge an Cursorposition ungültig
FN_MINUS Funktion nicht verfügbar
WHAT_KEY Tastenfolge ungültig
MORE_THAN Zu viele Zeichen wurden im Feld eingegeben
SYM_MINUS Eingegebenes Symbol nicht verfügbar
INPUT_ERROR Operator-Eingabefehler (nur 5250)
DO_NOT_ENTER Nicht eingeben
INSERT Cursor im Einfügemodus
GR_CURSOR Cursor im Grafikmodus
COMM_ERR_REM Erinnerung Kommunikationsfehler
MSG_WAITING Anzeige für Nachricht vorhanden
ENCRYPT Sitzung ist verschlüsselt
NUM_FIELD Ungültiges Zeichen in einem Feld für numerische Daten

Position

Methode Beschreibung
Position(row,col) Erstellt eine neue Position-Instanz.
Parameter
{Number} row Koordinate der Bildschirmzeile.
{Number} col Koordinate der Bildschirmspalte.

PresentationSpace

Verwenden Sie das PresentationSpace-Objekt zur Interaktion mit dem Terminalbildschirm. Zu den verfügbaren Interaktionen zählen das Einrichten und Abrufen der Cursorposition, das Senden von Tasten und das Lesen von Text.

Methode Beschreibung
getCursorPosition() Gibt eine Position-Instanz zurück, die die aktuelle Cursorposition darstellt. Eine Sitzung ohne Verbindung hat die Cursorposition 0,0.
Rückgabe
{Position} Aktuelle Cursorposition.
setCursorPosition(position) Bewegt den Hostcursor an die angegebene Zeilen- und Spaltenposition. Bei einigen Hosts wie VT werden die Cursorbewegungen durch den Host eingeschränkt.
Parameter
{Position} Position Neue Cursorposition.
Rückgabe
Keine.
Fehlerrückgabe
{RangeError} Wenn die Position auf dem aktuellen Bildschirm nicht gültig ist.
isCursorVisible() Testet, ob der Cursor aktuell im Präsentationsbereich angezeigt wird. Wenn die Sitzung nicht verbunden ist, wird der Cursor als nicht sichtbar betrachtet.
Rückgabe
{Boolean} „True“ (wahr), wenn der Cursor sichtbar ist. 'False', wenn der Cursor nicht angezeigt wird.
sendKeys(keys) Überträgt eine Textzeichenkette oder ControlKey an der aktuellen Cursorposition im Präsentationsbereich an den Host. Wenn sich der Cursor nicht an der gewünschten Position befindet, verwenden Sie zunächst die setCursorPosition-Funktion.
Die Textzeichenkette kann eine beliebige Anzahl an Zeichen und ControlKey-Objekten enthalten.
Ein Beispiel: "meinname" + ControlKey.TAB + "meinpass" + ControlKey.ENTER überträgt eine Benutzer-ID, tabuliert zum nächsten Feld, überträgt ein Passwort und sendet dann die Eingabetaste.
Um eine eckige Klammer zu übertragen, geben Sie die Klammern doppelt ein ([[ oder ]]).
Parameter
{String} keys Text und/oder Steuertasten, der/die übertragen werden soll(en).
getText(start,length) Gibt eine Zeichenfolge zurück, die einen linearen Bereich des Präsentationsbereichs darstellt. Wenn Zeilengrenzen auftreten, werden keine Zeichen für neue Zeilen eingefügt.
Parameter
{Position} start Position, ab der Text abgerufen werden soll.
{Number} length Maximale Anzahl an Zeichen, die zurückgegeben werden sollen. Wenn durch den Längenparameter (length) die letzte Position des Präsentationsbereichs überschritten wird, werden nur die Zeichen bis zur letzten Position zurückgegeben.
Rückgabe
{String} Zeichenkette, die einen linearen Bereich des Präsentationsbereichs darstellt, der leer sein kann, wenn die Sitzung nicht verbunden ist.
Fehlerrückgabe
{RangeError} Wenn die Position oder Länge auf dem aktuellen Bildschirm ungültig ist.
getSize() Ruft die Abmessungen des Bildschirms als Dimension-Objekt ab.
Rückgabe
{Dimension} Enthält die Anzahl an Zeilen und Spalten. Die Bildschirmgröße beträgt [row:0, col:0], wenn die Sitzung nicht verbunden ist.
getDataCells(start, length) Gibt DataCell-Instanzen zurück, bei denen das erste Mitglied für die durch den Startparameter angegebene Position gedacht ist. Die maximale Anzahl an DataCell-Instanzen in der Liste wird durch den Längenparameter angegeben.
Parameter
{Position} start Die erste Position auf dem Hostbildschirm, auf dem DataCell-Instanzen abgerufen werden sollen. Siehe Position.
{Number} length Maximale Anzahl an DataCell-Instanzen, die abgerufen werden sollen. Wenn die Länge nicht angegeben ist, werden DataCell-Instanzen von der Startposition bis zum Ende des Bildschirms zurückgegeben.
Rückgabe
{DataCell[]} Instanzen, die leer sein können, wenn die Sitzung nicht verbunden ist. Wenn die Position nicht angegeben ist, werden alle DataCell-Instanzen zurückgegeben. Wenn die Länge nicht angegeben ist, werden DataCell-Instanzen von der Startposition bis zum Ende des Bildschirms zurückgegeben.
Fehlerrückgabe
{RangeError} Wenn „start“ oder „length“ außerhalb des Wertebereichs liegt.
getFields() Gibt eine Liste der Felder im Präsentationsbereich zurück. Wenn der Hosttyp keine Felder unterstützt oder der aktuelle Bildschirm nicht formatiert wurde, ist der Rückgabewert immer eine leere Liste. Siehe FieldList.
Rückgabe
{FieldList} Liste der vom Host definierten Felder im Präsentationsbereich.

Session

Bei dem Session-Objekt handelt es sich um den Hauptzugriffspunkt für die Interaktion mit dem Host. Es enthält Funktionen zum Herstellen und Trennen einer Verbindung und zum Abrufen des PresentationSpace-Objekts.

Methode Beschreibung
connect() Stellt die Verbindung zum konfigurierten Host her. Verwenden Sie ggf. wait.forConnect(), um die Makroausführung zu blockieren, bis die Verbindung hergestellt wurde.
Rückgabe
Keine
disconnect() Trennt die Sitzung zum konfigurierten Host. Verwenden Sie ggf. wait.forDisconnect(), um die Makroausführung zu blockieren, bis die Verbindung hergestellt wurde.
Rückgabe
Keine
isConnected() Gibt an, ob eine Verbindung zum Host besteht.
Rückgabe
{Boolean} „True“ (wahr), wenn die Hostverbindung hergestellt wurde, „False“ (falsch), wenn keine Verbindung hergestellt wurde.
getPresentationSpace() Gewährt Zugriff auf die PresentationSpace-Instanz für diese Sitzung.
Rückgabe
{PresentationSpace} Instanz, die dieser Sitzung zugeordnet ist.
getDeviceName() Gibt für eine verbundene Sitzung den Gerätenamen zurück und gibt für eine getrennte Sitzung oder Sitzung ohne Gerätenamen eine leere Zeichenkette zurück.
Rückgabe
{String} Der Name des verbundenen Geräts.
getType() Gibt den Typ der Hostsitzung zurück. Weitere Informationen finden Sie unter SessionType.
Rückgabe
{String} Der Typ der Hostsitzung.
setDeviceName() Bietet eine Möglichkeit, in einer Sitzungsinstanz den Gerätenamen zu ändern.
Parameter
{String} name Gerätename, der bei der Herstellung einer Verbindung zu einem Host verwendet werden soll.
Fehlerrückgabe
{Error} Wenn während einer hergestellten Sitzung versucht wurde, den Gerätenamen festzulegen.
getOIA() Bietet Zugriff auf die OIA-Instanz für diese Sitzung.
Rückgabe
{OIA} Mit dieser Sitzung verknüpfte OIA-Instanz.

SessionType

Konstanten zum Identifizieren des Hosttyps, zu dem die Verbindung hergestellt wird. Siehe Session-Objekt.

Hosttyp Beschreibung
IBM_3270 IBM 3270-Terminalsitzung
IBM_5250 IBM 5250-Terminalsitzung
VT VT-Sitzung

StatusSet

Mit dem StatusSet-Objekt können Sie den Status des OIA-Objekts decodieren. Das StatusSet-Objekt gibt die im OIAStatus-Objekt definierten Werte zurück. Wenn sie gemeinsam verwendet werden, können Sie die Statusinformationen aus dem OIA-Objekt abrufen.

Methode Beschreibung
contains(statusFlag) Ermittelt, ob der Satz die angegebene Statusflagge aus OIAStatus-Konstanten enthält.
Parameter
{Number} statusFlag Zu überprüfender Status.
Rückgabe
{Boolean} „True“ (wahr), wenn die Statusflagge im Satz vorhanden ist.
isEmpty() Gibt an, ob der Statussatz leer ist.
Rückgabe
{Boolean} „True“ (wahr), wenn der Satz leer ist.
size() Gibt die Anzahl der in dem Satz enthaltenen Statuskennzeichen an.
Rückgabe
{Number} Die Statusanzahl.
toArray() Konvertiert den internen Statussatz in ein Array.
Rückgabe
{Object []} Array mit den Statusflaggen im Satz.
toString() Konvertiert den internen Statussatz in eine Zeichenfolge.
Rückgabe
{String} Durch Leerzeichen getrennte Namen der im Satz enthaltenen Statusflaggen.
forEach(callback, thisArg) Funktion zum Durchlaufen der einzelnen Elemente im Statussatz.
Parameter
{forEachCallback} Callback zum Ausführen eines bestimmten Vorgangs. Wird gemeinsam mit dem Namen des jeweiligen Status im Satz aufgerufen.
forEachCallback(string, thisArg) Eine durch Benutzer bereitgestellte Callback-Funktion, mit der Sie das Verhalten bereitstellen. Wird als Callback-Parameter für „forEach“ verwendet.
Parameter
{String} string Der Name eines Status im Statussatz.
{Object} thisArg Optionaler Verweis auf ein Kontextobjekt.

User Interface

Das UI-Objekt stellt Funktionen zur Interaktion mit dem Benutzer sowie zur Abfrage und Anzeige von grundlegenden Informationen bereit. Das UI-Objekt ist in Ihrem Makro automatisch als ui-Variable verfügbar.

Hinweis

Wichtig: Allen UI-Funktionen muss das yield-Schlüsselwort voranstehen. Dadurch kann das Makro die Ausführung blockieren, bis die Bedingungen der UI-Funktion erfüllt wurden.
[parameter] kennzeichnet einen optionalen Parameter.

Methode Beschreibung
prompt(message,[defaultAnswer], [mask]) Fordert den Benutzer zur Eingabe von Informationen in der Benutzeroberfläche auf.
Parameter
{String} message Titel, der dem Benutzer angezeigt werden soll. Standard: leere Zeichenkette.
{String} defaultAnswer Standardantwort, die verwendet werden soll, wenn der Benutzer keine andere Zeichenkette angibt. Standard: leere Zeichenkette.
{Boolean} mask Gibt an, ob die Eingabeaufforderung ausgeblendet werden soll (wie bei einem Passwort).
Rückgabe
{Promise} Erfüllt, wenn der Benutzer das Dialogfeld schließt. Bei „OK“ wird eine Benutzereingabe zurückgegeben, „Abbrechen“ ergibt Null.
message([message]) Zeigt eine Meldung auf der Benutzeroberfläche an.
Parameter
{String} message Meldung, die dem Benutzer angezeigt werden soll. Standard: leere Zeichenkette.
Rückgabe
{Promise} Erfüllt, wenn der Benutzer das Meldungsfenster schließt.

Wait

Verwenden Sie das wait-Objekt, um auf einen bestimmten Sitzungs- oder Bildschirmstatus zu warten. Sie können beispielsweise darauf warten, dass der Cursor an einer bestimmten Position gefunden wird oder Text an einer bestimmten Position vorhanden ist, bevor Sie mit dem Ausführen des Makros fortfahren.

Wait-Funktionen werden häufig zusammen mit asynchronen Funktionen wie connect() oder sendKeys() verwendet.

Hinweis

Alle Funktionen unterstützen Timeoutwerte als optionale Parameter und verwenden einen standardmäßigen Timeoutwert von 10 Sekunden (10000 ms).
Wichtig: Allen wait-Funktionen muss das yield-Schlüsselwort voranstehen. Dadurch kann das Makro die Ausführung blockieren, bis die Bedingungen der wait-Funktion erfüllt wurden.
[parameter] kennzeichnet einen optionalen Parameter.

Methode Beschreibung
setDefaultTimeout(timeout) Legt den standardmäßigen Timeoutwert für alle Funktionen fest.
Parameter
{Number} Standardmäßiger Timeoutwert für alle wait-Funktionen in Millisekunden.
Rückgabe
{None}
Fehlerrückgabe
{RangeError} Wenn der angegebene Timeoutwert kleiner als null ist.
forConnect([timeout]) Wartet auf das Abschließen einer Verbindungsanforderung.
Parameter
{Number} In Millisekunden.
Rückgabe
{Promise} Erfüllt, wenn die Sitzung bereits verbunden wurde oder die Verbindung zustande kommt. Wird abgelehnt, wenn die Wartezeit überschritten wurde.
forDisconnect([timeout]) Wartet auf das Abschließen einer Anforderung zur Trennung einer Verbindung.
Parameter
{Number} Timeout in Millisekunden.
Rückgabe
{Promise} Erfüllt, wenn die Verbindung der Sitzung bereits getrennt wurde oder endgültig getrennt wird. Wird abgelehnt, wenn die Wartezeit überschritten wurde.
forFixedTime([timeout]) Wartet ohne Bedingungen für eine festgelegte Zeit. Die Zeit wird in Millisekunden (ms) angegeben..
Parameter
{Number} Timeout in Millisekunden.
Rückgabe
{Promise} Nach dem Verstreichen der Zeit erfüllt.
forScreenChange([timeout]) Wartet auf eine Änderung des Hostbildschirms. Diese Funktion gibt eine Rückmeldung, wenn eine Bildschirmaktualisierung erkannt wird. Sie bietet keine Informationen über die Anzahl nachfolgender Aktualisierungen, die möglicherweise bis zur vollständigen Aktualisierung des Bildschirms erfolgen. Es empfiehlt sich, wiederholt zu warten, bis der Bildschirminhalt mit einem bekannten Endkriterium übereinstimmt.)
Parameter
{Number} Timeout in Millisekunden.
Rückgabe
{Promise} Erfüllt, wenn der Bildschirm geändert wurde. Wird abgelehnt, wenn die Wartezeit überschritten wurde.
forCursor(position, [timeout]) Wartet darauf, dass der Cursor die angegebene Position erreicht.
Parameter
{Position} Gibt die Zeile und Spalte an.
Rückgabe
{Promise} Erfüllt, wenn sich der Cursor bereits an der angegebenen Stelle befindet oder wenn er endgültig dort positioniert ist. Abgelehnt, wenn das Timeout überschritten wurde.
forText(text, position, [timeout]) Wartet auf Text an einer bestimmten Position auf dem Bildschirm.
Parameter
{String} Zu erwartender Text.
{Position} Gibt die Zeile und Spalte an.
{Number} Timeout in Millisekunden.
Rückgabe
{Promise} Erfüllt, wenn der Text bereits an der angegebenen Position ist oder sobald er dort positioniert ist. Abgelehnt, wenn das Timeout überschritten wurde.
Fehlerrückgabe
{RangeError} Wenn die Position ungültig ist.
forHostPrompt(text, column,[timeout]) Wartet auf eine Eingabeaufforderung in einer bestimmten Spalte auf dem Bildschirm.
Parameter
{String} text Zu erwartende Aufforderung.
{Position} column Spalte, in der der Cursor erwartet wird.
{Number} timeout Timeout in Millisekunden.
Rückgabe
{Promise} Erfüllt, wenn die Bedingungen bereits erfüllt sind oder nachdem sie endgültig erfüllt werden. Abgelehnt, wenn das Timeout überschritten wurde.
Fehlerrückgabe
{RangeError} Wenn die Spalte außerhalb des Wertebereichs liegt.
forHostSettle([settleTime],[timeout]) HINWEIS: wait.forHostSettle sollte nur verwendet werden, wenn andere gezieltere Wartefunktionen nicht ausreichen.
Überwacht eingehende Bildschirmdaten und löst „settleTime ms“ nach der letzten Aktualisierung und Entsperren der Tastatur auf. Diese Funktion ist nützlich, wenn Daten in mehreren Paketen ankommen und Sie sicher sein möchten, dass der gesamte Bildschirm empfangen wurde, bevor Sie fortfahren.
Parameter
{Number} Zeit, für die nach der letzten Aktualisierung gewartet werden soll, um sicherzustellen, dass weitere Daten nicht unerwartet ankommen. Der Standardwert ist 200 Millisekunden.
{Number} Timeout in Millisekunden.
Rückgabe
{Promise} Erfüllt, wenn die Wartezeit nach Erhalt der letzten Bildschirmaktualisierung verstrichen ist und die Tastatur entsperrt ist.