Chat now with support
Chat with Support

Identity Manager 9.3 - API-Entwicklungshandbuch

Über dieses Handbuch Grundlagen der API-Entwicklung Beispiele und Hilfe – Software Development Kit Eigene APIs implementieren ImxClient-Kommandozeilenprogramm

check-translations

Sucht nach Beschriftungen (mehrsprachige Texte) mit fehlenden Übersetzungen in einem bestimmten Ordner und dessen Unterordnern.

Parameter

Anmeldeparameter:

  • /conn <Name der Datenbankverbindung>: Legt die Datenbank fest, mit der Sie sich verbinden möchten.

  • /dialog <Name der Dialog-Authentifikation>: Legt die Dialog-Authentifikation fest.

Pflichtparameter:

  • /path <Pfad zum Ordner>: Legt fest, welcher Ordner geprüft werden soll.

Optionale Parameter:

  • /conndialog <Option>: Legt fest, ob ein Anmeldedialog für die Datenbankverbindung angezeigt werden soll. Die folgenden Optionen sind möglich:

    • off: Es wird kein Anmeldedialog angezeigt. Wenn keine Verbindung zur Datenbank besteht, wird versucht eine Verbindung herzustellen.

    • show: Ein Anmeldedialog wird angezeigt (auch wenn bereits eine Verbindung zur Datenbank besteht) und die Verbindung wird durch die neue ersetzt.

    • fallback: (Standardwert) Wenn eine Verbindung zur Datenbank besteht, wird diese verwendet. Wenn keine Verbindung zur Datenbank besteht, wird versucht eine Verbindung herzustellen.

  • /factory <Name des Zielsystems>: Legt das Zielsystem für die Verbindung fest. Geben Sie diesen Parameter an, wenn Sie eine Verbindung zum Anwendungsserver aufbauen möchten. Beispiel: QBM.AppServer.Client.ServiceClientFactory, QBM.AppServer.Client

Verwandte Themen

compile-api

Kompiliert die API. Dabei werden folgende Schritte ausgeführt:

  • Validieren der API-Definition

  • Kompilieren einer TypeScript-API-Client-Bibliothek

  • Erstellen eines DialogAEDS-EP-Objekts in der Datenbank für jeden API-Endpunkt

Parameter

Anmeldeparameter:

  • /conn <Name der Datenbankverbindung>: Legt die Datenbank fest, mit der Sie sich verbinden möchten.

  • /dialog <Name der Dialog-Authentifikation>: Legt die Dialog-Authentifikation fest.

Optionale Parameter:

  • /factory <Name des Zielsystems>: Legt das Zielsystem für die Verbindung fest. Geben Sie diesen Parameter an, wenn Sie eine Verbindung zum Anwendungsserver aufbauen möchten. Beispiel: QBM.AppServer.Client.ServiceClientFactory, QBM.AppServer.Client

  • -N: Verhindert das Speichern in der Datenbank.

  • /modules <Modul1,Modul2,...>: Legt fest, welche Module aufgenommen werden sollen. Wenn Sie hier nichts angeben, werden alle Module aufgenommen. Geben Sie die Namen der Module kommasepariert ein.

  • /clientmodules <Modul1,Modul2,...>: Legt fest, für welche Module API-Code generiert werden soll. Wenn Sie hier nichts angeben, wird für alle Module API-Code generiert. Geben Sie die Namen der Module kommasepariert ein.

  • /packagename <Name>: Legt den API-Client-Paketnamen fest. Der Standardwert ist imx-api.

  • /copyapi <Pfad zum Ordner>: Legt fest, wohin die Datei imx-api.tgz kopiert werden soll.

  • /nowarn <Fehler1,Fehler2,...>: Legt fest, welche Fehler beim Kompilieren ignoriert werden sollen. Geben Sie die Codes der Warnungen kommasepariert ein.

  • /warnaserror <Fehler1,Fehler2,...>: Legt fest, welche Warnungen beim Kompilieren als Fehler angezeigt werden sollen. Geben Sie die Codes der Warnungen kommasepariert ein.

  • /endpointdef {Dateiname}: Legt fest, dass die Liste der API-Endpunkte in eine Datei geschrieben wird, anstatt DialogAEDS-Objekte zu erstellen.

Verwandte Themen

compile-app

Führt die HTML-Paketkompilierung aus.

Das Kommando führt die folgenden Schritte aus:

  1. Ausführen des Kommandos npm install im Anwendungsordner

  2. Ausführen des Kommandos npm run build im Packet-Ordner

  3. Erstellen des Ergebnisses im Unterordner dist
    Das Ergebnis wird in einer ZIP-Datei in der Datenbank gespeichert.

Parameter

Anmeldeparameter:

  • /conn <Name der Datenbankverbindung>: Legt die Datenbank fest, mit der Sie sich verbinden möchten.

  • /dialog <Name der Dialog-Authentifikation>: Legt die Dialog-Authentifikation fest.

Optionale Parameter:

  • /conndialog <Option>: Legt fest, ob ein Anmeldedialog für die Datenbankverbindung angezeigt werden soll. Die folgenden Optionen sind möglich:

    • off: Es wird kein Anmeldedialog angezeigt. Wenn keine Verbindung zur Datenbank besteht, wird versucht eine Verbindung herzustellen.

    • show: Ein Anmeldedialog wird angezeigt (auch wenn bereits eine Verbindung zur Datenbank besteht) und die Verbindung wird durch die neue ersetzt.

    • fallback: (Standardwert) Wenn eine Verbindung zur Datenbank besteht, wird diese verwendet. Wenn keine Verbindung zur Datenbank besteht, wird versucht eine Verbindung herzustellen.

  • /factory <Name des Zielsystems>: Legt das Zielsystem für die Verbindung fest. Geben Sie diesen Parameter an, wenn Sie eine Verbindung zum Anwendungsserver aufbauen möchten. Beispiel: QBM.AppServer.Client.ServiceClientFactory, QBM.AppServer.Client

  • /workspace <Pfad zum Arbeitsverzeichnis>: Legt das Arbeitsverzeichnis fest. In diesem Ordner liegt die Anwendung, die kompiliert werden soll. Dieser Ordner enthält normalerweise die Datei package.json der Anwendung. Wenn Sie hier nichts angeben, wird das aktuelle Verzeichnis verwendet.

  • /app <Name der Anwendungsprojekts>: Legt fest, welches Anwendungsprojekt kompiliert werden soll. Wenn Sie hier nichts angeben, werden alle Anwendungsprojekte kompiliert.

  • -D: Führt die Debug-Kompilierung aus.

  • -S: Überspringt die Ausführung des Kommandos npm install im Anwendungsordner.

  • -P: Verhindert das Bauen von Bibliotheken im Anwendungsordner.

  • /copyto <Dateipfad>: Speichert das Ergebnis der Kompilierung als ZIP-Dateien in einem Ordner.

  • /exclude <Modulname>: Lässt Pakete eines Moduls bei der Kompilierung aus (beispielsweise AOB).

Verwandte Themen

connect

Baut eine Datenbankverbindung auf. 

Sollte bereits eine Datenbankverbindung bestehen, wird diese geschlossen und anschließend eine neue aufgebaut.

Parameter

Anmeldeparameter:

  • /conn <Name der Datenbankverbindung>: Legt die Datenbank fest, mit der Sie sich verbinden möchten.

  • /dialog <Name der Dialog-Authentifikation>: Legt die Dialog-Authentifikation fest.

Optionale Parameter:

  • /conndialog <Option>: Legt fest, ob ein Anmeldedialog für die Datenbankverbindung angezeigt werden soll. Die folgenden Optionen sind möglich:

    • off: Es wird kein Anmeldedialog angezeigt. Wenn keine Verbindung zur Datenbank besteht, wird versucht eine Verbindung herzustellen.

    • show: Ein Anmeldedialog wird angezeigt (auch wenn bereits eine Verbindung zur Datenbank besteht) und die Verbindung wird durch die neue ersetzt.

    • fallback: (Standardwert) Wenn eine Verbindung zur Datenbank besteht, wird diese verwendet. Wenn keine Verbindung zur Datenbank besteht, wird versucht eine Verbindung herzustellen.

  • /factory <Name des Zielsystems>: Legt das Zielsystem für die Verbindung fest. Geben Sie diesen Parameter an, wenn Sie eine Verbindung zum Anwendungsserver aufbauen möchten. Beispiel: QBM.AppServer.Client.ServiceClientFactory, QBM.AppServer.Client

Verwandte Themen
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating