Jitterbit-Befehlszeilenschnittstelle

Einführung

Die Jitterbit-Befehlszeilenschnittstelle (jbcli) ist ein Befehlszeilentool für die Interaktion mit Citizen Integrator-Rezepten. bei Harmony angemeldet über das jbcli können Sie Ihr eigenes Rezeptrepository verwalten, indem Sie es herunterladen, Validieren, Hochladen, Aktualisieren, Generieren, Bereitstellen oder Löschen von Rezeptmetadaten und Design Studio Jitterpaks.

Die Abschnitte auf dieser Seite beschreiben die Installation und Verwendung des jbcli.

Installieren Sie die Jitterbit-Befehlszeilenschnittstelle

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

1. Geben Sie diesen Befehl in einer Eingabeaufforderung ein, um zu installieren jbcli mithilfe des Node.js Node Package Manager (NPM):

   $ npm install -g jbcli
   

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

   $ jbcli version
   1.4.1
   

Verwenden jbcli Befehle

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

$ jbcli <entity> <action> [options]

Version überprüfen

Überprüft, welche Version von jbcli Sie verwenden. Die Versionsnummer wird zurückgegeben, mit der aktuellen jbcliVersion wird 1.4.1.

$ jbcli version
<version>

Melden Sie sich an

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

Verwenden Sie die Option --password <myHarmonyPassword>um Ihr Passwort über die Befehlszeile weiterzugeben:

$ jbcli login --email <username> --password <password> --host <host>
User <username> authenticated successfully into <host>.

NA

$ jbcli login --email <username> --host https://citizen.jitterbit.net
Password:
User <username> authenticated successfully into https://citizen.jitterbit.net.

EMEA

$ jbcli login --email <username> --host https://citizen.jitterbit.eu
Password:
User <username> authenticated successfully into https://citizen.jitterbit.eu.

APAC

$ jbcli login --email <username> --host https://citizen.jitterbit.cc
Password:
User <username> authenticated successfully into https://citizen.jitterbit.cc.

Aus Konto abmelden

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

$ jbcli logout
User <myHarmonyUsername> logged out.

Auflisten von Benutzerorganisationen

Listet die Organisationen auf, deren Mitglied Sie sind. Die IDs und Namen der für Sie verfügbaren Organisationen werden zurückgegeben.

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

Auflisten von Benutzerumgebungen

Listet die Umgebungen in der aktuellen Organisation auf. Die IDs und Namen der für Sie verfügbaren Umgebungen werden zurückgegeben.

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

Abrufen von Eigenschaften

Ruft den einem bestimmten Schlüssel zugewiesenen Wert ab. Der Schlüssel und sein Wert werden zurückgegeben.

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

Mit diesem Befehl können Sie feststellen, welche Organisation oder Umfeld die Standardeinstellung ist.

• Mit dem Schlüssel defaultOrgId um zu sehen, welche Organisation die Standardorganisation ist. Die ID der Standardorganisation wird zurückgegeben.

  $ jbcli config get defaultOrgId
  defaultOrgId: orgId
  

• Mit der Taste defaultEnvId um zu sehen, welche Umfeld die Standardumgebung ist. Die ID der Umfeld lautet zurückgegeben.

  $ jbcli config get defaultEnvId
  defaultEnvId: envId
  

Festlegen von Eigenschaften

Legt Schlüssel und Werte fest. Die Schlüssel und ihre Werte werden zurückgegeben.

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

Mit diesem Befehl können Sie beispielsweise die Standardorganisation oder Umfeld überschreiben. Beachten Sie, dass die Schlüssel

defaultOrgId Und defaultEnvId sind schreibgeschützt und können nicht geändert werden, da sie durch das Jitterbit eines Benutzers definiert werden Konto. Sie können jedoch die Organisation oder Umfeld festlegen, die vom jcli Befehle und überschreiben die defaultOrgId Und defaultEnvId Wird bei der Interaktion mit Citizen Integrator-Rezepten über das jbcli.

• Um eine Organisation festzulegen, verwenden Sie die Taste orgId mit der ID für die gewünschte Organisation, die Sie unter Benutzerorganisationen auflisten erhalten haben. Die festgelegte Organisations-ID wird zurückgegeben.

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

• Um eine Umfeld einzustellen, verwenden Sie die Taste envId durch die ID der gewünschten Umfeld, die Sie erhalten von Benutzerumgebungen auflisten. Die eingestellte Umfeld-ID wird zurückgegeben.

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

Wenn die Organisation und/oder Umfeld nicht über diesen Befehl festgelegt werden, orgIdund/oder envId wird standardmäßig auf defaultOrgId Und defaultEnvId.

Alle Rezepte auflisten

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

Ein Rezept besteht aus zwei Teilen: einem Design Studio Jitterpak (JPK) und einer JSON-Metadatendatei, die die Schritte eines Benutzer müssen das Rezept mit Citizen Integrator konfigurieren. (Siehe Citizen Integrator - Rezept konfigurieren.)

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

In der zurückgegebenen Liste der Rezepte wird Rezepten, die öffentlich und für alle Benutzer verfügbar sind, ein Sternchen (*) vorangestellt. Rezepten, die privat und nur für Personen innerhalb Ihrer Organisation verfügbar sind, wird kein Sternchen vorangestellt.

Holen Sie sich ein bestimmtes Rezept und speichern Sie das Jitterpak lokal

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

$ jbcli recipe get <id> [--savejpk <location>]
-- recipe JSON --
Jitterpak saved to <location>.

Sie können das zugehörige Jitterpak eines Rezepts lokal speichern, wenn Sie ein Jitterpak aus einem vorhandenen Rezept verwenden möchten. Rezept. Wenn Sie bereits mit einem Rezept und Jitterpak begonnen haben, aber entscheiden, dass Sie erweiterte Anpassungen vornehmen möchten Verwenden Sie dies im Design Studio, 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 Wenn Sie ein neues Rezept erstellen und mit einem ähnlichen Rezept als Beispiel beginnen möchten, können Sie mit diesem Befehl ein JSON-Metadaten des Rezepts.

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 ist gültig.

jbcli recipe validate --recipe <recipeLocation>
Recipe is valid.

Laden Sie ein neues Rezept und Jitterpak hoch

Lädt ein neues Citizen Integrator-Rezept hoch.

Sie können ein neues Jitterpak und optional die JSON-Metadaten hochladen (mithilfe des --recipe Option). Damit ein bestimmtes Rezept funktioniert, müssen Sie sowohl die Jitterpak- als auch die JSON-Metadaten hochgeladen haben, aber sie müssen nicht gleichzeitig hochgeladen werden. Standardmäßig ist ein hochgeladenes Rezept für Ihre Organisation privat.

jbcli recipe upload --jpk <jpkLocation> [--recipe <recipeLocation>]
Recipe uploaded, assigned ID <id>, and can be found at <location>

Aktualisieren Sie ein vorhandenes Rezept und Jitterpak

Aktualisiert ein vorhandenes Citizen Integrator-Rezept.

jbcli recipe update <id> --jpk <jpkLocation> [--recipe <recipeLocation>]
Recipe with ID <id> updated.

Sie können ein vorhandenes Jitterpak und optional die JSON-Metadaten aktualisieren (mithilfe des --recipe Option). Damit ein bestimmtes Rezept funktioniert, müssen Sie sowohl die Jitterpak- als auch die JSON-Metadaten hochgeladen haben, aber sie müssen nicht gleichzeitig hochgeladen werden. Standardmäßig ist ein hochgeladenes Rezept für Ihre Organisation privat.

Von Jitterbit bereitgestellte und öffentlich zugängliche Rezepte können nur von Jitterbit aktualisiert oder bearbeitet werden. Wenn Sie ein vorhandenes öffentliches Rezept bearbeiten möchten, rufen Sie das JSON und Jitterpak ab, bearbeiten Sie die Dateien lokal und laden Sie sie mit dem Befehl Neues Rezept und Jitterpak hochladen als Ihr eigenes neues Rezept erneut hoch.

Löschen eines vorhandenen Rezepts und Jitterpak

Löscht ein vorhandenes Citizen Integrator-Rezept, das noch nicht bereitgestellt wurde. Um mehrere Rezepte zu löschen, fügen Sie weitere hinzu Rezept-IDs durch Leerzeichen getrennt. Sowohl das Jitterpak als auch die JSON-Metadaten werden gelöscht.

jbcli recipe delete <id> [<id> ...]
Recipe with ID <id>`[<ID> ...] `deleted.

Von Jitterbit bereitgestellte und öffentlich zugängliche Rezepte können nur von Jitterbit gelöscht werden. Sie können nur die Rezepte löschen, die Sie selbst erstellt haben. Wenn Sie der Administrator einer Organisation sind, können Sie alle Rezepte löschen, die zu Ihrer Organisation gehören.

Generieren Sie ein Rezept und/oder eine Konfigurationsdatei

Wird mit einem bereitgestellten Jitterpak verwendet, um ein Skelettrezept für Citizen Integrator zu generieren, das als Rezeptvorlage verwendet werden kann.

jbcli recipe generate --jpk <location> [--recipeonly | --cfgonly]
[Recipe saved to <location>.]
[Configure file saved to <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, was enthält die tatsächlichen Werte der Felder, die normalerweise innerhalb der Citizen Integrator-Weboberfläche angezeigt werden. Sie Von Ihnen wird erwartet, dass Sie die Konfigurationsdatei mit Werten füllen und dann die Funktion Ein Rezept bereitstellen verwenden Befehl um das Rezept einsetzen.

Bereitstellen eines Rezepts

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

Beim Bereitstellen eines Rezeptes wird jeder Aktionsschritt des Rezeptes ausgeführt, ähnlich dem Bereitstellungsprozess aus dem Citizen Integrator Weboberfläche.

jbcli recipe deploy <ID> --cfg <location>
Recipe deployed, ID <id>.

Auflisten bereitgestellter Rezepte

Listet die bereitgestellten Citizen Integrator-Rezepte auf. Sie können entweder alle bereitgestellten Rezepte anzeigen oder (optional) die Liste auf eine bestimmte Anzahl von Rezepten beschränken. Umfeld durch Übergeben der Umfeld-ID. Für jedes bereitgestellte Rezept werden die ID, der Name und der Autor zurückgegeben.

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

Benutzerumgebungen auflisten

Aufheben der Bereitstellung und Löschen eines bereitgestellten Rezepts

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

jbcli deployed-recipe delete <id> [<id>...]
Deployed recipe with ID <id>`[<ID>…] `deleted.

Von Jitterbit bereitgestellte und öffentlich zugängliche Rezepte können nur von Jitterbit gelöscht werden. Sie können nur die Rezepte löschen, die Sie selbst erstellt haben. Wenn Sie der Administrator einer Organisation sind, können Sie alle Rezepte löschen, die zu Ihrer Organisation gehören.