SYSAPI Utility

#### Search Results

Search

# SYSAPI Utility

Mit dem Dienstprogramm ("Utility") SYSAPI können Sie Anwendungsprogrammierschnittstellen (Application Programming Interfaces/APIs), die von Natural Add-on-Produkten (z.B. Entire Output Management) zur Verfügung gestellt werden, finden und testen.

Die API eines Natural Add-on-Produkts ist ein Natural-Subprogramm (katalogisiertes Objekt), das dazu benutzt wird, auf Daten zuzugreifen, eventuell Daten zu ändern oder Dienste auszuführen, die für ein Natural Add-on-Produkt oder eine Unterkomponente spezifisch sind.

Die API eines Natural Add-on-Produkts wird in der Natural Library und/oder in der Systemdatei geliefert, die für Objekte vorgesehen sind, welche für ein bestimmtes Natural Add-on-Produkt spezifisch sind. Anleitungen zur Verwendung der APIs eines Natural Add-on-Produkts sind in der Dokumentation des betreffenden Add-on-Produkts enthalten.

Die SYSAPI Utility bietet zu jeder API eines Natural Add-on-Produkts eine Funktionsbeschreibung, ein Beispiel-Programm und API-spezifische Schlüsselwörter.

Folgende Themen werden behandelt:

- Voraussetzungen

- SYSAPI Utility aufrufen und beenden

- Reservierte Schlüsselwörter

- SYSAPI Utility benutzen

#### Verwandtes Thema:

- SYSEXT Utility

## Voraussetzungen

- Das betreffende Natural Add-on-Produkt muss in Ihrer Umgebung installiert sein.

- Die Version des installierten Natural Add-on-Produkts muss die Funktionalität der SYSAPI Utility unterstützen.

## SYSAPI Utility aufrufen und beenden

Um die SYSAPI Utility aufzurufen:

- Geben Sie folgendes Systemkommando ein:

      SYSAPI

  Das Hauptmenü der SYSAPI Utility wird angezeigt. Es enthält eine Liste mit einem oder mehreren Natural Add-on-Produkten und zu jedem von ihnen eine oder mehrere zugehörige Gruppen von APIs.

  Jede Gruppe repräsentiert ein besonderes API-Merkmal, das für das Natural Add-on-Produkt verfügbar ist, und enthält Beispiel-Programme, die sich auf dieses Merkmal beziehen.

  Sie können eine Gruppe auswählen, um alle zugehörigen APIs in einem Untermenü anzuzeigen, siehe SYSAPI Utility benutzen.

Anmerkung
In der Kommandozeile Command können Sie ein beliebiges Natural-Systemkommando eingeben.

Um die SYSAPI Utility zu beenden:

- Drücken Sie PF3 oder PF12.

## Reservierte Schlüsselwörter

Reservierte Schlüsselwörter beziehen sich auf Meta-Informationen zu APIs, z.B. der Natural Add-on-Produkt-Version, in der eine API hinzugefügt worden ist. Reservierte Schlüsselwörter beginnen immer mit einem Plus-Zeichen (`+`):

Reserviertes Schlüsselwort | Beschreibung
--- | ---
+NEW-PROD-version | Eine API, die zu einem bestimmten Produkt in einer bestimmten Version hinzugefügt worden ist.
+MOD-PROD-version | Eine API, die zu einem bestimmten Produkt gehört und in einer bestimmten Version geändert worden ist.

## SYSAPI Utility benutzen

Nachdem Sie die SYSAPI Utility aufgerufen haben, können Sie eine bestimmte Gruppe von APIs auswählen, indem Sie ein beliebiges Zeichen in das entsprechende Eingabefeld eingeben oder indem Sie das Feld mit dem Cursor markieren. Das daraufhin angezeigte SYSAPI-Untermenü enthält eine alphabetisch sortierte Liste aller APIs der gewählten Gruppe.

Dieser Abschnitt beschreibt, wie Sie das Untermenü der SYSAPI Utility benutzen, z.B. um Auswahl- oder Suchkriterien einzugeben.

Folgende Themen werden behandelt:

- Bestandteile des SYSAPI-Untermenüs

- PF-Tasten

- Zeilenkommandos

### Bestandteile des SYSAPI-Untermenüs

Das SYSAPI-Untermenü enthält eine Liste mit alphabetisch sortierten APIs. Über den Spalten, die mit Interface und Description beschriftet sind, befinden sich Auswahlfelder, in denen Sie Auswahlkriterien eingeben können.

Die Eingabefelder für Schlüsselwörter können sowohl zur Schlüsselwortauswahl als auch zur Schlüsselwortsuche benutzt werden.

Die folgende Tabelle enthält eine ausführliche Beschreibung aller Bestandteile des SYSAPI-Untermenüs und Hinweise zu ihrer Benutzung:

Bestandteil | Erklärung | Verwendung
--- | --- | ---
Cmd | Eingabefeld für ein Zeilenkommando, das Sie zu einer API ausführen können. Siehe Zeilenkommandos. | Geben Sie ein Zeilenkommando ein, z.B.:
`K` | Alle bei der angegebenen API relevanten Schlüsselwörter auflisten.
Interface | Der Name des API-Subprogramms. | Geben Sie einen Stern (`*`) oder ein mit einem Stern eingegrenztes Präfix ein
Description | Kurzbeschreibung des Verwendungszwecks der API. | Geben Sie eine Zeichenkette ein, z.B.:
`printer` | Alle APIs mit einer Beschreibung auflisten, die die Zeichenkette `printer` oder `Printer` enthält.
Keywords | Alle Schlüsselwörter auflisten oder ein Schlüsselwort als Auswahlkriterium eingeben. Maximale Eingabe: zwei Schlüsselwörter. | Siehe Schlüsselwort-Suche oder Schlüsselwort-Auswahl.
And/Or | Geben Sie die logische Bedingung an, mit der mehrere Schlüsselwörter verknüpft werden sollen: `A` (And) oder `O` (Or). `A` ist die Standardeinstellung. | Geben Sie `A` oder `O` ein. Siehe auch Schlüsselwort-Auswahl.
Command | Kommandozeile zur Eingabe von Natural-Systemkommandos. | Geben Sie ein Natural-Systemkommando ein.

Anmerkung
Wenn ein Natural-Add-on-Produkt für eine zusätzliche Sprache lokalisiert worden ist, können Sie die Sprache in Ihren Profilparameter-Einstellungen angeben, siehe ULANG - Benutzersprache in der Parameter-Referenz-Dokumentation. Als Ergebnis enthält die für dieses Produkt zurückgegebene Liste APIs für die Sprache, die Sie angegeben haben.

Schlüsselwort-Suche

- Geben Sie im Feld Keyword einen Stern (`*`) oder ein mit einem Stern (`*`) eingegrenztes Präfix ein, z.B.:

      L*

  Als Ergebnis der Suche erscheint ein Menü, in dem Schlüsselwörter angezeigt werden, die mit `L` beginnen (Beispiel):

               Search for Keywords

        Mark Keyword
        ---- L*__________________
          _  LIST
          _  LOG
          _  LOGGING
          _  LOGICAL

  Um ein bestimmtes Schlüsselwort als Auswahlkriterium auszuwählen, können Sie in dem entsprechenden Eingabefeld in der Spalte Mark ein beliebiges Zeichen eingeben. Als Ergebnis wird eine Liste aller APIs, die dieses Auswahlkriterium erfüllen, angezeigt.

  Anmerkung:
  Die Benutzung der Schlüsselwort-Suche in beiden Eingabefeldern resultiert in zwei Menüs, die nacheinander verarbeitet und angezeigt werden.

Schlüsselwort-Auswahl

1. Geben Sie ein vollständiges Schlüsselwort ein. Sie können Schlüsselwörter auch in beiden Eingabefeldern eingeben, z.B.:

       USER

   und

       LOG

2. Wählen Sie die logische Bedingung, mit der mehrere Schlüsselwörter verknüpft werden sollen:

   `A` (And) oder `O` (Or).

   Je nach angegebener logischer Verknüpfung erhalten Sie entweder eine Liste aller APIs mit dem Schlüsselwort `USER` und dem Schlüsselwort `LOG` (And) oder eine Liste aller APIs mit dem Schlüsselwort `USER` oder dem Schlüsselwort `LOG` (Or).

### PF-Tasten

Sie können die folgenden, mit Funktionen belegten PF-Tasten benutzen:

PF-Taste | Name | Funktion
--- | --- | ---
PF1 | Help | Anzeige der kontextabhängigen Hilfe. Zu jedem Eingabefeld ist ein spezifischer Hilfetext vorhanden. In anderem Kontext, zum Beispiel in der Kommandozeile, wird ein allgemeiner Hilfetext angezeigt.
PF2 | Reset | Die Inhalte aller Auswahlfelder werden gelöscht und die Liste der APIs wird zurückgesetzt.
PF3 | Exit | Beenden der SYSAPI Utility oder Verlassen des aktuellen Menüs oder Fensters.
PF6 | -- | Zum Anfang der Liste blättern.
PF7 | - | Eine Seite nach oben blättern.
PF8 | + | Eine Seite nach unten blättern.
PF9 | ++ | Zum Ende der Liste blättern.
PF12 | Canc | SYSAPI Utility oder das aktuelle Menü oder Fenster verlassen.

### Zeilenkommandos

Zeilenkommandos werden verwendet, um Objektoperationen durchzuführen. Sie können ein Zeilenkommando in der Spalte Cmd neben der gewünschten API eingeben. Für eine Liste der gültigen Zeilenkommandos können Sie ein Fragezeichen (`?`) eingeben oder PF1 drücken.

Folgende Zeilenkommandos stehen zur Verfügung:

Zeilen- kommando | Funktion
--- | ---
`K` | Schlüsselwörter auflisten, die für die angegebene API relevant sind.
`T` | Falls Text-Objekt verfügbar sind: Beschreibung der entsprechenden API anzeigen. Andernfalls benutzen Sie das Zeilenkommando `L`, um das Beispiel-Programm wegen einer Beschreibung anzuzeigen.
`L` | Beispiel-Programm anzeigen (`LIST`).
`E` | Beispiel-Programm bearbeiten (`EDIT`).
`X` | Beispiel-Programm ausführen (`EXECUTE`).
`.` | Zum SYSAPI-Hauptmenü zurückkehren.

### On this page

- Voraussetzungen
- SYSAPI Utility aufrufen und beenden
- Reservierte Schlüsselwörter
- SYSAPI Utility benutzen