MobileFirst-Artefakte über die MobileFirst-CLI verwalten

Übersicht

IBM Mobile Foundation stellt eine Befehlszeilenschnittstelle (CLI) für den Entwickler bereit (Befehl mfpdev) bereit, über die Client- und Serverartefakte ohne großen Aufwand verwaltet werden können.
Mit der CLI können Sie Cordova-basierte Anwendungen verwalten, die das MobileFirst-Cordova-Plug-in verwenden, sowie native Anwendungen, die das native MobileFirst-SDK verwenden.

Zudem können Sie Adapter in lokalen oder fernen MobileFirst-Server-Instanzen erstellen, registrieren und verwalten und Projekte über die Befehlszeile, über REST-Services oder über die MobileFirst Operations Console verwalten.

Die mfpdev-Befehle können im interaktiven Modus oder im Direktmodus ausgeführt werden. Im interaktiven Modus geben Sie den Befehl ohne Optionen ein und werden dann aufgefordert, Antworten einzugeben. Im Direktmodus geben Sie den vollständigen Befehl mit Optionen ein. Es gibt keine Eingabeaufforderung. Die Eingabeaufforderungen sind, soweit anwendbar, vom Kontext der Zielplattform für die App abhängig, der an dem Verzeichnis erkennbar ist, in dem Sie den Befehl ausführen. Über die Taste mit dem Aufwärts- oder dem Abwärtspfeil auf Ihrer Tastatur können Sie durch die Auswahloptionen navigieren. Wenn die gewünschte Auswahl hervorgehoben und mit vorangestelltem Zeichen “>” angezeigt wird, drücken Sie die Eingabetaste.

In diesem Lernprogramm erfahren Sie, wie die Befehlszeilenschnittstelle (mfpdev) installiert und für die Verwaltung von MobileFirst-Server-Instanzen, Anwendungen und Adaptern verwendet wird.

Weitere Informationen zur SDK-Integration in Cordova-Anwendungen und nativen Anwendungen enthalten die Lernprogramme der Kategorie SDK der Mobile Foundation hinzufügen.

Fahren Sie mit folgenden Abschnitten fort:

• Voraussetzungen
• MobileFirst CLI installieren
• Liste der CLI-Befehle
• Interaktiver Modus und Direktmodus
• MobileFirst-Server-Instanzen verwalten
• Anwendungen verwalten
• Adapter verwalten und testen
• Hilfreiche Befehle
• Befehlszeilenschnittstelle aktualisieren und deinstallieren

Voraussetzungen

Die MobileFirst CLI ist als NPM-Paket in der NPM-Registry verfügbar.

Stellen Sie sicher, dass in der Entwicklungsumgebung Node.js und NPM für die Instalation von NPM-Paketen installiert sind.
Folgen Sie für die Installation von Node.js den Anweisungen auf nodejs.org.

Führen Sie den Befehl node -v aus, um sich zu vergewissern, dass Node.js ordnungsgemäß installiert wurde.

node -v
v6.11.1

Hinweis: Die unterstützte Mindestversion von Node.js ist Version 4.2.3. Aufgrund der schnellen Entwicklung bei den Node- und NPM-Paketen besteht die Möglichkeit, dass die MobileFirst-CLI nicht mit allen verfügbaren Versionen von Node und NPM, einschließlich der jeweils neuesten Version, vollständig funktioniert.

Stellen Sie für eine ordnungsgemäße Funktionsweise der MobileFirst-CLI bis einschließlich iFix-Version 8.0.2018040312 sicher, dass Node auf dem Stand von Version 6.11.1 und NPM auf dem Stand von Version 3.10.10 ist.

Ab der iFix-Version 8.0.2018100112 der MobileFirst-CLI können Sie Node Version 8.x oder 10.x verwenden.

MobileFirst CLI installieren

Führen Sie für die Installation der Befehlszeilenschnittstelle den folgenden Befehl aus:

npm install -g mfpdev-cli --no-optional

Wenn Sie die CLI-ZIP-Datei über das Download-Center der MobileFirst Operations Console heruntergeladen haben, verwenden Sie den folgenden Befehl:

npm install -g <path-to-mfpdev-cli.tgz>

• Sie können die CLI ohne die optionalen Abhängigkeiten installieren. Fügen Sie in dem Fall das Attribut --no-optional hinzu (npm install -g --no-optional Pfad_zu_mfpdev-cli.tgz).

Führen Sie zur Überprüfung der Installation den Befehl mfpdev ohne Argumente aus. Der Befehl gibt den folgenden Hilfetext aus:

NAME
     IBM MobileFirst Foundation Command Line Interface (CLI).

SYNOPSIS
     mfpdev <command> [Optionen]

DESCRIPTION
     The IBM MobileFirst Foundation Command Line Interface (CLI) is a command-line
     for developing MobileFirst applications. The command-line can be used by itself, or in conjunction
     with the IBM MobileFirst Foundation Operations Console. Some functions are available from  
     the command-line only and not the console.

     For more information and a step-by-step example of using the CLI, see the IBM Knowledge Center for
     your version of IBM MobileFirst Foundation at

          https://www.ibm.com/support/knowledgecenter.
    ...
    ...
    ...

Liste der CLI-Befehle

Interaktiver Modus und Direktmodus

Alle Befehle können im interaktiven Modus oder im Direktmodus ausgeführt werden. Im interaktiven Modus werden Sie zur Eingabe der erforderlichen Parameter aufgefordert und es werden einige Standardwerte verwendet. Im Direktmodus müssen die Parameter zusammen mit dem auszuführenden Befehl angegeben werden.

Beispiel:

mfpdev server add im interaktiven Modus:

? Enter the name of the new server definition: mydevserver
? Enter the fully qualified URL of this server: http://mydevserver.example.com:9080
? Enter the MobileFirst Server administrator login ID: admin
? Enter the MobileFirst Server administrator password: *****
? Save the admin password for this server?: Yes
? Enter the context root of the MobileFirst administration services: mfpadmin
? Enter the MobileFirst Server connection timeout in seconds: 30
Verifying server configuration...
The following runtimes are currently installed on this server: mfp
Server profile 'mydevserver' added successfully.

Im Direktmodus würde dieser Befehl wie folgt aussehen:

mfpdev server add mydevserver --url http://mydevserver.example.com:9080 --login admin --password admin --setdefault

Die korrekte Syntax für einen Befehl im Direktmodus können Sie mit dem Befehl mfpdev help <Befehl> ermitteln.

MobileFirst-Server-Instanzen verwalten

Mit dem Befehl mfpdev server <option> können Sie die verwendeten Instanzen von MobileFirst Server verwalten. Mindestens eine Serverinstanz muss als Standardinstanz aufgelistet sein. Der Standardserver wird immer verwendet, wenn kein anderer Server angegeben ist.

Serverinstanzen auflisten

Führen Sie den folgenden Befehl aus, um die zur Verfügung stehenden MobileFirst-Server-Instanzen aufzulisten:

mfpdev server info

Standardmäßig wird automatisch ein lokales Serverprofil erstellt und von der CLI als Standard verwendet.

Neue Serverinstanz hinzufügen

Wenn Sie eine weitere lokale oder ferne MobileFirst-Server-Instanz verwenden, können Sie sie zur Liste der verfügbaren Instanzen hinzufügen. Verwenden Sie dazu den folgenden Befehl:

mfpdev server add

Folgen Sie den Eingabeaufforderungen, um den Servernamen, die Server-URL und die Berechtigungsnachweise (Benutzer und Kennwort) anzugeben.
Wenn Sie beispielsweise einen MobileFirst Server hinzufügen möchten, der in einem IBM Cloud-Service “Mobile Foundation” ausgeführt wird, verwenden Sie den folgenden Befehl:

$ mfpdev server add
? Enter the name of the new server profile: MyBluemixServer
? Enter the fully qualified URL of this server: https://mobilefoundation-7abcd-server.mybluemix.net:443
? Enter the MobileFirst Server administrator login ID: admin
? Enter the MobileFirst Server administrator password: *****
? Save the administrator password for this server?: Yes
? Enter the context root of the MobileFirst administration services: mfpadmin
? Enter the MobileFirst Server connection timeout in seconds: 30
? Make this server the default?: Yes
Verifying server configuration...
The following runtimes are currently installed on this server: mfp
Server profile 'MyBluemixServer' added successfully. 

• Ersetzen Sie die vollständig qualifizierte URL des Servers (“fully qualified URL of this server”) durch Ihre eigene.

Serverinstanzen bearbeiten

Wenn Sie die Details einer registrierten Serverinstanz bearbeiten möchten, führen Sie den folgenden Befehl aus. Folgen Sie den interaktiven Eingabeaufforderungen und wählen Sie den zu bearbeitenden Server aus. Geben Sie dann die zu aktualisierenden Informationen an.

mfpdev server edit

Verwenden Sie folgenden Befehl, um einen Server als Standardserver festzulegen:

mfpdev server edit <Servername> --setdefault

Serverinstanzen entfernen

Wenn Sie eine Serverinstanz aus der Liste registrierter Server entfernen möchten, führen Sie den folgenden Befehl aus:

mfpdev server remove

Wählen Sie den Server in der interaktiven Liste aus.

MobileFirst Operations Console öffnen

Wenn Sie die Konsole des registrierten Standardservers öffnen möchten, führen Sie den folgenden Befehl aus:

mfpdev server console

Wenn Sie die Konsole eines anderen Servers öffnen möchten, geben Sie den Servernamen als Befehlsparameter an:

mfpdev server console <Servername>

Apps und Adapter von einem Server entfernen

Wenn Sie alle bei einem Server registrierten Apps und Adapter entfernen möchten, führen Sie den folgenden Befehl aus:

mfpdev server clean

Wählen Sie an der interaktiven Eingabeaufforderung den zu bereinigenden Server aus.
Die Serverinstanz wird in einen bereinigten Zustand (d. h. einen Server ohne implementierte Apps oder Adapter) versetzt.

Anwendungen verwalten

Mit dem Befehl mfpdev app können Anwendungen, die mit dem MobileFirst-Platform-SDK erstellt wurden, verwaltet werden.

Anwendung in einer Serverinstanz registrieren

Eine Anwendung muss bei einem MobileFirst Server registriert sein, um ausgeführt werden zu können.
Führen Sie im Stammordner eines App-Projekts den folgenden Befehl aus, um die App zu registrieren:

mfpdev app register

Dieser Befehl kann im Standardverzeichnis einer Cordova-, Android-, iOS- oder Windows-Anwendung ausgeführt werden.
Er verwendet für die folgenden Schritte den Standardserver und die Standardlaufzeit:

• Registrierung einer Anwendung bei einem Server
• Generierung einer Standarddatei mit Clienteigenschaften für die Anwendung
• Aufnahme der Serverinformationen in die Clienteigenschaftendatei

Bei einer Cordova-Anwendung aktualisiert dieser Befehl die Datei config.xml.
Bei einer iOS-Anwendung aktualisiert dieser Befehl die Datei mfpclient.plist.
Bei einer Android- oder Windows-Anwendung aktualisiert dieser Befehl die Datei mfpclient.properties.

Verwenden Sie die folgende Syntax, wenn Sie eine App bei einem anderen als dem Standardserver und einer vom Standard abweichenden Laufzeit registrieren möchten:

mfpdev app register <Server> <Laufzeit>

Für Windows-Plattformen muss der Befehl mit dem Argument -w <Plattform> angegeben werden. Hier steht <Plattform> für eine Liste der zu registrierenden Windows-Plattformen. Die einzelnen Plattformen sind jeweils durch ein Komma getrennt. Gültige Werte sind windows,windows8 und windowsphone8.

mfpdev app register -w windows8

Anwendung konfigurieren

Wenn eine Anwendung registriert wird, werden serverbezogene Attribute zur Konfigurationsdatei der Anwendung hinzugefügt.
Sie können die Werte dieser Attribute mit folgendem Befehl ändern:

mfpdev app config

Dieser Befehl zeigt eine interaktive Liste mit Attributen an, die geändert werden können, und fordert Sie zur Eingabe neuer Werte für die Attribute auf.
Welche Attribute angezeigt werden, hängt von der jeweiligen Plattform ab (iOS, Android, Windows).

Verfügbare Konfigurationen:

• Angabe von Serveradresse und Laufzeit für die zu registrierende Anwendung

  Beispielanwendungsfall: Sie möchten eine Anwendung bei einem MobileFirst Server mit einer bestimmten Adresse registrieren. Die Anwendung soll aber auch in der Lage sein, eine Verbindung zu einer anderen Serveradresse herzustellen, z. B. zu einem DataPower-Gerät.

  1. Führen Sie mfpdev app register aus, um die Anwendung bei der erforderlichen MobileFirst-Server-Adresse zu registrieren.
  2. Führen Sie mfpdev app config aus und passen Sie den Wert der Eigenschaft server an die Adresse des DataPower-Geräts an. Sie können den Befehl auch im Direktmodus ausführen: mfpdev app config server http(s)://Server-IP-Adresse_oder_Hostname:Port.

• Festlegung des öffentlichen Schlüssels für die direkte Aktualisierung
• Festlegung der Standardpsrache für die Anwendung. (Die Standardsprache ist Englisch (en).)
• Festlegung, ob der Kontrollsummentest für Webressourcen aktiviert werden soll
• Angabe der Dateierweiterungen, die beim Kontrollsummentest für Webressource ignoriert werden sollen

Cordova-Anwendung voranzeigen

Die Webressourcen einer Cordova-Anwendung können in einem Browser vorangezeigt werden. Das Voranzeigen einer Anwendung beschleunigt die Entwicklung, da keine Emulatoren und Simulatoren der nativen Plattform verwendet wreden müssen.

Vor Ausführung des Befehls “preview” müssen Sie das Projekt vorbereiten. Fügen Sie dazu die Variable wlInitOptions hinzu. Führen Sie die folgenden Schritte aus:

1. Fügen Sie die Variable wlInitOptions zur Haupt-JavaScript-Datei hinzu. Bei einer Standard-Cordova-App ist das die Datei index.js.

   var wlInitOptions = {
      mfpContextRoot:'/mfp', // "mfp" ist das Standardkontextstammverzeichnis von MobileFirst Server
      applicationId:'com.sample.app' // Durch eigenen Wert ersetzen
   };
   

2. Registrieren Sie die App mit folgendem Befehl erneut:

   mfpdev app register
   

3. Führen Sie den folgenden Befehl aus:

   cordova prepare
   

4. Zeigen Sie eine Vorschau der Cordova-Anwendung an. Führen Sie dazu im Stammordner der Cordova-Anwendung den folgenden Befehl aus:

   mfpdev app preview
   

Sie werden aufgefordert, die Plattform für die Vorschau und die Art der Vorschau auszuwählen. Zur Auswahl stehen die beiden Optionen MBS und Browser.

• MBS - Mobile Browser Simulator. Bei Auswahl dieser Option wird ein mobiles Gerät in einem Browser simuliert. Gleichzeitig wird eine rudimentäre Cordova-API-Simulation für Karmera, Dateiupload, Geoortung und anderes bereitgestellt. Hinweis: Den Cordova-Browser können Sie nicht mit der Option MBS verwenden.
• Browser - Einfache Darstellung in einem Browser. Bei Auswahl dieser Option werden die Webressourcen der Cordova-Anwendung als normale Browser-Webseite dargestellt.

Weitere Einzelheiten zu den Vorschauoptionen enthält das Lernprogramm zur Cordova-Entwicklung.

Direkte Aktualisierung von Webressourcen

Die Webressourcen einer Cordova-App wie HTML-, CSS- und JS-Dateien im Ordner www können mithilfe des MobileFirst-Foundation-Features für direkte Aktualisierung aktualisiert werden, ohne dass die App neu auf dem mobilen Gerät installiert werden muss.

Weitere Einzelheiten zur Funktionsweise der direkten Aktualisierung enthält das Lernprogramm Direkte Aktualisierung in Cordova-Anwendungen.

Wenn Sie neue Webressourcen für die Aktualisierung einer Cordova-Anwendung senden möchten, führen Sie folgenden Befehl aus:

mfpdev app webupdate

Dieser Befehl packt die aktualisierten Webressourcen zu einer ZIP-Datei und lädt diese Datei auf den registrierten Standard-MobileFirst-Server hoch. Sie finden die gepackten Webressourcen im Ordner [Stammorder_des_Cordova-Projekts]/mobilefirst/.

Wenn Sie die Webressourcen an eine andere Serverinstanz senden möchten, geben Sie mit dem Befehl den Servernamen und die Laufzeit an:

mfpdev app webupdate <Servername> <Laufzeit>

Mit dem Parameter –build können Sie die ZIP-Datei mit den gepackten Webressourcen generieren, ohne die Datei auf einen Server hochzuladen:

mfpdev app webupdate --build

Wenn Sie ein erstelltes Paket hochladen möchten, verwenden Sie den Parameter –file:

mfpdev app webupdate --file mobilefirst/com.ibm.test-android-1.0.0.zip

Die Ressoucen können zusätzlich mit dem folgenden Befehl verschlüsselt werden:

mfpdev app webencrypt

Dieser Befeh lgibt an, dass eine verschlüsselte Version des Inhalts aus dem Plattformverzeichnis wwww für die Implementierung auf mobilen Geräten erstellt wird. Diese Option ist nur für die Plattformen iOS und Android verfügbar.

MobileFirst-Anwendungskonfiguration mit Pull und Push übertragen

Wenn eine MobileFirst-Anwendung bei einem MobileFirst Server registriert ist, kann ein Teil der Anwendungskonfiguration in der MobileFirst-Server-Konsole geändert werden. Die so geänderte Konfiguration kann dann mittels Pull vom Server zur Anendung übertragen werden. Verwenden Sie dazu den folgenden Befehl:

mfpdev app pull

Es ist auch möglich, die Anwendungskonfiguration lokal zu ändern, und die Änderungen per Push mit folgendem Befehl zum MobileFirst Server zu übertragen:

mfpdev app push

Beispiel: In der MobileFirst Operations Console können Sie Bereiche Sicherheitsüberprüfungen zuordnen und diese Änderung dann mihilfe einer Pull-Operation zum Server übertragen. Verwenden Sie dazu den obigen Befehl. Die heruntergeladene ZIP-Datei wird im Projektordner [Stammverzeichnis]/mobilefirst gespeichert und kann später mit dem Befehl mfpdev app push auf einen anderen MobileFirst Server hochgeladen werden. Diese Wiederverwendung bereits erstellter Konfigurationen ermöglicht eine rasche Konfiguration und Einrichtung.

Adapter verwalten und testen

Adapter können mit dem Befehl mfpdev adapter verwaltet werden.

Weitere Informationen zu Adaptern enthalten die Lernpgoramme der Kategorie Adapter.

Adapter erstellen

Verwenden Sie den folgenden Befehl, um einen neuen Adapter zu erstellen:

mfpdev adapter create

Folgen Sie den Eingabeaufforderungen uind geben Sie den Namen, den Typ und die Gruppen-ID des Adapters an.

Adapterbuild erstellen

Führen Sie im Stammordner des Adapters den folgenden Befehl aus, um einen Adapterbuild zu erstellen:

mfpdev adapter build

Mit diesem Befehl wird im Ordner **/target** eine Datei .adapter erstellt.

Adapter implementieren

Mit dem folgenden Befehl wird der Adapter im Standardserver implementiert:

mfpdev adapter deploy

Verwenden Sie für die Implementierung auf einem anderen Server den folgenden Befehl:

mfpdev adapter deploy <Servername>

Adapter in der Befehlszeile aufrufen

Ein implementierter Adapter kann in der Befehlszeile aufgerufen werden, um sein Verhalten zu testen. Verwenden Sie dazu den folgenden Befehl:

mfpdev adapter call

Sie werden aufgefordert, den Adapter, die Prozedur und die zu verwendenden Parameter anzugeben. Die Befehlsausgabe ist die Antwort der Adapterprozedur.

Weitere Informationen enthält das Lernprogramm Adapter testen und debuggen.

Hilfreiche Befehle

Verwenden Sie den folgenden Befehl, um für die CLI (mfpdev) Vorgaben wie den Standardbrowser und den Standardvorschaumodus festzulegen:

mfpdev config

Wenn Sie die Hilfetexte für alle mfpdev-Befehle sehen möchten, verwenden Sie den folgenden Befehl:

mfpdev help

Mit dem folgenden Befehl wird eine Liste mit Informationen zu Ihrer Umgebung generiert:

mfpdev info

Mit folgendem Befehl können Sie die Version der CLI (mfpdev) ausgeben:

mfpdev -v

Befehlszeilenschnittstelle aktualisieren und deinstallieren

Führen Sie den folgenden Befehl aus, um die Befehlszeilenschnittstelle zu aktualisieren:

npm update -g mfpdev-cli

Führen Sie den folgenden Befehl aus, um die Befehlszeilenschnittstelle zu deinstallieren:

npm uninstall -g mfpdev-cli