Jitterbit-Befehlszeilen-Schnittstelle für Citizen Integrator-Rezepte für Jitterbit Design Studio

Einführung

Die Jitterbit-Befehlszeilen-Schnittstelle (jbcli) ist ein Befehlszeilenwerkzeug zur Interaktion mit Citizen Integrator-Rezepten. Sobald Sie sich über das jbcli bei Harmony angemeldet haben, können Sie Ihr eigenes Rezept-Repository verwalten, indem Sie Rezeptmetadaten und Design Studio Jitterpaks herunterladen, validieren, hochladen, aktualisieren, generieren, bereitstellen oder löschen.

Die Abschnitte auf dieser Seite beschreiben, wie Sie das jbcli installieren und verwenden.

Installieren der Jitterbit-Befehlszeilen-Schnittstelle

Laden Sie die Node.js JavaScript-Laufzeitumgebung v6.x oder höher von https://nodejs.org/en/download/ herunter und installieren Sie sie.

1. Geben Sie diesen Befehl an einer Eingabeaufforderung ein, um jbcli mit dem Node.js Node Package Manager (NPM) zu installieren:

   $ npm install -g jbcli
   

2. Verwenden Sie diesen Befehl, um zu überprüfen, ob jbcli installiert wurde und korrekt läuft:

   $ jbcli version
   1.4.1
   

Verwenden von jbcli-Befehlen

Um jbcli zu verwenden, führen Sie seine Befehle von einer Eingabeaufforderung aus. Dies ist das allgemeine Befehlsformat, wobei der Text zwischen spitzen Klammern durch Werte ersetzt wird und der Text in eckigen Klammern optional ist, wobei die Eingabeaufforderung durch $ dargestellt wird:

$ jbcli <entity> <action> [options]

Version überprüfen

Überprüft, welche Version von jbcli Sie verwenden. Die Versionsnummer wird zurückgegeben, wobei die aktuelle jbcli-Version 1.4.1 ist.

$ jbcli version
<version>

Anmelden

Meldet sich bei jbcli mit Ihren Harmony-Anmeldeinformationen an. Die erforderliche host-Option hängt von der Region ab (eine der NA, EMEA oder APAC), mit der Ihre Organisation verbunden ist (siehe Meine Region finden). Eine Nachricht bestätigt die erfolgreiche Authentifizierung.

Verwenden Sie die Option --password <myHarmonyPassword>, um Ihr Passwort in der Befehlszeile zu übergeben:

$ jbcli login --email <username> --password <password> --host <host>
Benutzer <username> erfolgreich in <host> authentifiziert.

NA

$ jbcli login --email <username> --host https://citizen.jitterbit.net
Passwort:
Benutzer <username> erfolgreich in https://citizen.jitterbit.net authentifiziert.

EMEA

$ jbcli login --email <username> --host https://citizen.jitterbit.eu
Passwort:
Benutzer <username> erfolgreich in https://citizen.jitterbit.eu authentifiziert.

APAC

$ jbcli login --email <username> --host https://citizen.jitterbit.cc
Passwort:
Benutzer <username> erfolgreich in https://citizen.jitterbit.cc authentifiziert.

Abmelden

Meldet Sie von jbcli ab. Eine Nachricht bestätigt die erfolgreiche Abmeldung.

$ jbcli logout
Benutzer <myHarmonyUsername> abgemeldet.

Benutzerorganisationen auflisten

Listet die Organisationen auf, in denen Sie Mitglied sind. Die IDs und Namen der Organisationen, die Ihnen zur Verfügung stehen, werden zurückgegeben.

$ jbcli org list
[orgId1] orgName1
[orgId2] orgName2
...

Benutzerumgebungen auflisten

Listet die Umgebungen in der aktuellen Organisation auf. Die IDs und Namen der Umgebungen, die Ihnen zur Verfügung stehen, werden zurückgegeben.

$ jbcli env list
[envId1] envName1
[envId2] envName2
...

Eigenschaften abrufen

Erhält den Wert, der einem bestimmten Schlüssel zugewiesen ist. Der Schlüssel und sein Wert werden zurückgegeben.

$ jbcli config get <key>
<key>: <assignment>

Dieser Befehl kann verwendet werden, um zu sehen, welche Organisation oder Umgebung die Standardorganisation ist.

• Verwenden Sie den Schlüssel defaultOrgId, um zu sehen, welche Organisation standardmäßig ist. Die ID der Standardorganisation wird zurückgegeben.

  $ jbcli config get defaultOrgId
  defaultOrgId: orgId
  

• Verwenden Sie den Schlüssel defaultEnvId, um zu sehen, welche Umgebung standardmäßig ist. Die ID der Standardumgebung wird zurückgegeben.

  $ jbcli config get defaultEnvId
  defaultEnvId: envId
  

Set properties

Setzt Schlüssel und Werte. Die Schlüssel und deren Werte werden zurückgegeben.

jbcli config set <key1>=<assignment1> <key2>=<assignment2> ...
<key1>=<assignment1> set
<key2>=<assignment2> set
...

Zum Beispiel kann dieser Befehl verwendet werden, um die Standardorganisation oder -umgebung zu überschreiben. Beachten Sie, dass die Schlüssel defaultOrgId und defaultEnvId schreibgeschützt sind und nicht geändert werden können, da sie durch das Jitterbit-Konto eines Benutzers definiert sind. Sie können jedoch die Organisation oder Umgebung festlegen, die von den jcli-Befehlen verwendet wird, und die defaultOrgId und defaultEnvId überschreiben, die beim Interagieren mit Citizen Integrator-Rezepten über das jbcli verwendet werden.

• Um eine Organisation festzulegen, verwenden Sie den Schlüssel orgId mit der ID der gewünschten Organisation, die Sie aus List user organizations erhalten haben. Die festgelegte Organisations-ID wird zurückgegeben.

  $ jbcli config set orgId=<orgId>
  orgId:<orgId> gesetzt
  

• Um eine Umgebung festzulegen, verwenden Sie den Schlüssel envId mit der ID der gewünschten Umgebung, die Sie aus List user environments erhalten haben. Die festgelegte Umwelt-ID wird zurückgegeben.

  $ jbcli config set envId=<envId>
  envId:<envId> gesetzt
  

Wenn die Organisation und/oder Umgebung nicht über diesen Befehl festgelegt werden, wird orgId und/oder envId auf die defaultOrgId und defaultEnvId zurückgesetzt.

List all recipes

Listet alle Citizen Integrator-Rezepte auf, die Ihnen zur Verfügung stehen. Optional können Sie die Liste auf nur die Rezepte beschränken, die privat für Ihre Organisation sind (in Klammern angezeigt). Die ID, der Name und der Autor jedes Rezepts werden zurückgegeben.

Ein Rezept besteht aus zwei Teilen: einem Design Studio Jitterpak (JPK) und einer JSON-Metadatendatei, die die Schritte bereitstellt, die ein Benutzer durchlaufen muss, um das Rezept mit dem Citizen Integrator zu konfigurieren. (Siehe Citizen Integrator - Rezept konfigurieren.)

$ jbcli recipe list [--private]
[id1] name1 by author1 (organization1)
* [id2] name2 by author2 (organization2)
...

In der Liste der zurückgegebenen Rezepte werden Rezepte, die öffentlich und für alle Benutzer verfügbar sind, mit einem Sternchen (*) versehen. Rezepte, die privat sind und nur für Personen innerhalb Ihrer Organisation verfügbar sind, haben kein Sternchen.

Ein bestimmtes Rezept abrufen und das Jitterpak lokal speichern

Gibt die JSON-Metadaten für ein bestimmtes Citizen Integrator-Rezept zurück und speichert (optional) das zugehörige Jitterpak an einem angegebenen Ort.

$ jbcli recipe get <id> [--savejpk <location>]
-- Rezept JSON --
Jitterpak in <location> gespeichert.

Sie können das zugehörige Jitterpak eines Rezepts lokal speichern, wenn Sie ein Jitterpak aus einem vorhandenen Rezept referenzieren oder verwenden möchten. Wenn Sie bereits mit einem Rezept und Jitterpak begonnen haben, aber entscheiden, dass Sie erweiterte Anpassungen im Design Studio vornehmen möchten, verwenden Sie dies, um das Jitterpak herunterzuladen.

Um die Metadaten für das Rezept lokal zu speichern, können Sie sie aus der Eingabeaufforderung kopieren und als JSON-Datei speichern. Wenn Sie ein neues Rezept erstellen und mit einem ähnlichen Rezept als Beispiel beginnen möchten, können Sie diesen Befehl verwenden, um die JSON-Metadaten eines Rezepts zu speichern.

Ein Rezept validieren

Validiert die JSON-Metadaten für ein lokales Citizen Integrator-Rezept. Sie sollten diesen Befehl vor dem Hochladen eines Rezepts verwenden, um sicherzustellen, dass es gültig ist.

jbcli recipe validate --recipe <recipeLocation>
Rezept ist gültig.

Ein neues Rezept und Jitterpak hochladen

Lädt ein neues Citizen Integrator-Rezept hoch.

Sie können wählen, ob Sie ein neues Jitterpak und optional die JSON-Metadaten (mit der Option --recipe) hochladen möchten. Damit ein bestimmtes Rezept funktioniert, müssen sowohl das Jitterpak als auch die JSON-Metadaten hochgeladen werden, sie müssen jedoch nicht gleichzeitig hochgeladen werden. Standardmäßig ist ein hochgeladenes Rezept privat für Ihre Organisation.

jbcli recipe upload --jpk <jpkLocation> [--recipe <recipeLocation>]
Rezept hochgeladen, zugewiesene ID <id>, und kann unter <location> gefunden werden.

Aktualisieren eines vorhandenen Rezepts und Jitterpaks

Aktualisiert ein vorhandenes Rezept für Bürgerintegratoren.

jbcli recipe update <id> --jpk <jpkLocation> [--recipe <recipeLocation>]
Rezept mit ID <id> aktualisiert.

Sie können wählen, ob Sie ein vorhandenes Jitterpak und optional die JSON-Metadaten (mit der Option --recipe) aktualisieren möchten. Damit ein bestimmtes Rezept funktioniert, müssen sowohl das Jitterpak als auch die JSON-Metadaten hochgeladen werden, aber sie müssen nicht zur gleichen Zeit hochgeladen werden. Standardmäßig ist ein hochgeladenes Rezept privat für Ihre Organisation.

Rezepte, die von Jitterbit bereitgestellt und der Öffentlichkeit zur Verfügung gestellt werden, können nur von Jitterbit aktualisiert oder bearbeitet werden. Wenn Sie ein vorhandenes öffentliches Rezept bearbeiten möchten, holen Sie sich die JSON und das Jitterpak, bearbeiten Sie die Dateien lokal und laden Sie sie als Ihr eigenes neues Rezept mit dem Befehl Ein neues Rezept und Jitterpak hochladen erneut hoch.

Löschen eines vorhandenen Rezepts und Jitterpaks

Löscht ein vorhandenes Rezept für Bürgerintegratoren, das noch nicht bereitgestellt wurde. Um mehrere Rezepte zu löschen, fügen Sie zusätzliche Rezept-IDs hinzu, die durch Leerzeichen getrennt sind. Sowohl das Jitterpak als auch die JSON-Metadaten werden gelöscht.

jbcli recipe delete <id> [<id> ...]
Rezept mit ID <id> [<id> ...] gelöscht.

Rezepte, die von Jitterbit bereitgestellt und der Öffentlichkeit zur Verfügung gestellt werden, können nur von Jitterbit gelöscht werden. Sie können nur die Rezepte löschen, die Sie erstellt haben. Wenn Sie der Administrator einer Organisation sind, können Sie alle Rezepte löschen, die zu Ihrer Organisation gehören.

Generieren eines Rezepts und/oder einer Konfigurationsdatei

Verwendet mit einem bereitgestellten Jitterpak, um ein Skelett-Rezept für den Citizen Integrator zu generieren, das als Rezeptvorlage verwendet werden kann.

jbcli recipe generate --jpk <location> [--recipeonly | --cfgonly]
[Rezept gespeichert in <location>.]
[Konfigurationsdatei gespeichert in <location>.]

Der Befehl führt zur Erstellung von zwei Dateien: <project-name>-recipe.json und <project-name>-configure.json. Um nur eine dieser Dateien zu generieren, fügen Sie die entsprechende Option hinzu (--recipeonly oder --cfgonly).

Die Rezeptdatei ist eine Vorlage für ein Rezept, das Sie dann in einem Texteditor öffnen können, um Felder wie die Beschreibung auszufüllen.

Die Konfigurationsdatei ist eine Vorlage für die Datei, die der Befehl Rezept bereitstellen erwartet, die die tatsächlichen Werte der Felder enthält, die normalerweise in der Weboberfläche des Citizen Integrators angezeigt werden. Es wird erwartet, dass Sie die Konfigurationsdatei mit Werten ausfüllen und dann den Befehl Rezept bereitstellen verwenden, um das Rezept bereitzustellen.

Rezept bereitstellen

Stellt ein Rezept für den Citizen Integrator bereit. Sie müssen eine Rezept- und eine Konfigurationsdatei bereitstellen (siehe Rezept und/oder Konfigurationsdatei generieren). Die bereitgestellte Rezept-ID wird zurückgegeben.

Beim Bereitstellen eines Rezepts wird jeder Aktionsschritt des Rezepts ausgeführt, ähnlich dem Bereitstellungsprozess über die Weboberfläche des Citizen Integrators.

jbcli recipe deploy <ID> --cfg <location>
Rezept bereitgestellt, ID <id>.

Bereitgestellte Rezepte auflisten

Listet die bereitgestellten Rezepte des Citizen Integrators auf. Sie können entweder alle bereitgestellten Rezepte anzeigen oder (optional) die Liste auf eine bestimmte Umgebung beschränken, indem Sie die Umgebungs-ID übergeben. Die ID, der Name und der Autor jedes bereitgestellten Rezepts werden zurückgegeben.

jbcli deployed-recipe list [--environment <envID>]
[id1] name1 by author1
[id2] name2 by author2
...

List Benutzerumgebungen

Bereitstellung aufheben und ein bereitgestelltes Rezept löschen

Hebt die Bereitstellung eines bereitgestellten Citizen Integrator-Rezepts auf und löscht es. Um mehrere Rezepte bereitzustellen und zu löschen, fügen Sie zusätzliche Rezept-IDs hinzu, die durch Leerzeichen getrennt sind. Sowohl das Jitterpak als auch die JSON-Metadaten werden gelöscht.

jbcli deployed-recipe delete <id> [<id>...]
Bereitgestelltes Rezept mit der ID <id> [<id>...] gelöscht.

Rezepte, die von Jitterbit bereitgestellt und der Öffentlichkeit zugänglich gemacht werden, können nur von Jitterbit gelöscht werden. Sie können nur die Rezepte löschen, die Sie erstellt haben. Wenn Sie der Administrator einer Organisation sind, können Sie alle Rezepte löschen, die zu Ihrer Organisation gehören.