Chat now with support
Chat with Support

Identity Manager 8.2 - API Designer Benutzer-und Entwicklungshandbuch

Der API Designer Grundlagen der API-Entwicklung Beispiele und Hilfe – Software Development Kit Schnellstart – Eine API erstellen Arbeiten mit dem API Designer
API Designer starten Projekttypen Benutzeroberfläche Globale Einstellungen Datenbankobjekte Änderungen kennzeichnen Suchen und Ersetzen Mehrsprachige Texte Datenbankabfragen verwalten Tabreiter verwalten Layouts verwalten Änderungshistorie anzeigen (Befehlsliste) Lesezeichen API kompilieren Versionen verwalten (Kompilierungszweige) API testen C#-Projekte mit dem API Designer verbinden
API-Projekte API-Dateien API Server ImxClient-Kommandozeilenprogramm

ImxClient-Kommando-Übersicht

In den nachfolgenden Kapiteln erhalten Sie eine Liste aller ImxClient-Kommandos, die Sie ausführen können.

Verwandte Themen

help

Zeigt die Liste der zulässigen Befehle an.

Parameter

Um Hilfe zu bestimmten Befehlen anzuzeigen, übergeben Sie zusätzlich den entsprechenden Befehl als Parameter.

Beispiel: help fetch-files

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, auf die verbunden werden soll.

  • /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 <Zielsystem>: Legt das Zielsystem für die Verbindung fest. Geben Sie diesen Parameter an, wenn Sie eine Verbindung zum Anwendungsserver aufbauen möchten.

  • /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.

  • /branch <ID des Kompilierungszweiges>: Speichert das kompilierte Ergebnis unter einem Kompilierungszweig ab. Sie müssen zusätzlich den Parameter -D angeben.

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

  • -N: Verhindert das Speichern in der Datenbank.

  • /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

compile-api

Kompiliert die API und speichert das Ergebnis in der Datenbank.

Parameter

Anmeldeparameter:

  • /conn <Name der Datenbankverbindung>: Legt die Datenbank fest, auf die verbunden werden soll.

  • /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

  • /solution <Pfad zur Solution-Projektdatei>: Legt fest, welches Solution-Projekt genutzt werden soll. Wenn Sie diesen Parameter nicht angeben, wird ein Datenbankprojekt verwendet.

  • /mode <Kompiliermodus>: Legt den Modus der Kompilierung fest:

    • normal: Führt eine komplette Kompilierung (Standardmodus) aus.

    • nostore: Assemblies werden nicht in der Datenbank gespeichert.

    • nocompile: Erstellt nur C#-Code. Die Kompilierung wird nicht ausgeführt.

    • nocodegen: Führt nur die Kompilierung aus. Es wird kein C#-Code generiert.

  • -E: Aktiviert erweiterte Prüfungen.

  • -D: Die Kompilierung wird als Debug-Kompilierung ausgeführt.

  • /csharpout <Pfad zum Ordner>: Legt fest, wo die C#-Dateien gespeichert werden sollen.

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

  • /copyapidll <Pfad zu einer API-DLL>: Legt fest, welche API-DLL-Datei verwendet werden soll. Die Parameter /solution und /branch werden ignoriert, wenn Sie diesen Parameter verwenden.

  • /branch <ID des Kompilierungszweiges>: Speichert das kompilierte Ergebnis unter einem Kompilierungszweig ab. Sie müssen zusätzlich den Parameter -D angeben.

  • /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.

Verwandte Themen
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating