Konvertieren Sie eine vorhandene bereichsbezogene Anwendung, um die Entwicklung im Quellcode mit zu unterstützen ServiceNow SDK.

Vorbereitungen

Verwenden Sie ServiceNow SDK Dient zur Authentifizierung bei ServiceNow Instanz. Weitere Informationen finden Sie unter Authentifizierung bei einem ServiceNow Instanz mit ServiceNow SDK.

Erforderliche Rolle: Administrator

Warum und wann dieser Vorgang ausgeführt wird

Vorhandene bereichsbezogene Anwendungen, die nicht mit erstellt wurden ServiceNow IDE Oder ServiceNow SDK Muss konvertiert werden, um die Entwicklung im Quellcode zu unterstützen. Durch das Konvertieren einer Anwendung werden die erforderlichen Dateien und Verzeichnisse für die Entwicklung im Quellcode hinzugefügt. Sie können auswählen, ob vorhandene Anwendungsmetadaten in konvertiert werden sollen ServiceNow Fluent Code. Die Anwendung wird in der Instanz erst geändert, wenn Sie sie erstellen und in der Instanz installieren.

Bei diesem Verfahren wird verwendet ServiceNow SDK Befehlszeilenschnittstelle (CLI). Geben Sie in einem Befehlszeilentool ein Now-sdk --help Um Informationen zu den verfügbaren Befehlen und globalen Optionen zu erhalten. Um zusätzliche Informationen zu einem Befehl und seinen Parametern zu erhalten, geben Sie den Befehl und ein --help Oder -H . Beispiel: Now-sdk-Authentifizierung –-help . Weitere Informationen zur CLI finden Sie unter ServiceNow SDK CLI.

Prozedur

  1. Erstellen Sie ein lokales Verzeichnis für Ihre Anwendung.
  2. In Visual Studio Code, Öffnen Sie das Verzeichnis.
  3. Öffnen Sie im Anwendungsverzeichnis ein integriertes Terminalfenster.
  4. Konvertieren Sie eine vorhandene bereichsbezogene Anwendung mit aus einer Instanz oder einem lokalen Verzeichnis Init Befehl.

    Mit --von Parameter: Geben Sie eine sys_ID einer Anwendung auf der Instanz oder einen Pfad zu einem lokalen Verzeichnis an, das eine Anwendung enthält, die zur Unterstützung der Entwicklung im Quellcode konvertiert werden soll.

    npx @servicenow/sdk init --from <sys_id or path>
    Zum Beispiel:
    npx @servicenow/sdk init --from aadfdd904748a6500ff14ee4316d4369
    Hinweis: Mit npx Befehl installiert ServiceNow SDK In Ihrem Anwendungsverzeichnis anstelle von global.
  5. Geben Sie an der Eingabeaufforderung einen Namen für das in verwendete Anwendungspaket ein Package.JSON Datei.

    Der Paketname muss den Paketbenennungsstandards des Node Package Manager (NPM) entsprechen.

    Im folgenden Beispiel wird eine Anwendung aus der Instanz heruntergeladen und mit ihrer sys_ID konvertiert
    $ npx @servicenow/sdk init --from aadfdd904748a6500ff14ee4316d4369
[now-sdk] Bootstrapping a new ServiceNow application project...
[now-sdk] Please provide the missing required fields:
? NPM package name:  example-app
[now-sdk] Access Token has expired, refreshing token
[now-sdk] Downloading application package for aadfdd904748a6500ff14ee4316d4369 from https://myinstance.service-now.com
[now-sdk] Unzipping downloaded package...
[now-sdk] Successfully downloaded and unzipped application aadfdd904748a6500ff14ee4316d4369
[now-sdk] Summary of downloaded metadata files
Metadata: 13 (Total: 13)
  Copied To Metadata Directory::
    1. dictionary/x_snc_example_app_mytable.xml
    2. package_inventory.csv
    3. sys_app_aadfdd904748a6500ff14ee4316d4369.xml
    4. update/sys_db_object_7030a5d04748a6500ff14ee4316d4338.xml
    5. update/sys_dictionary_x_snc_example_app_mytable_null.xml
    6. update/sys_documentation_x_snc_example_app_mytable__en.xml
... and 7 more

[now-sdk] Successfully converted application.
[now-sdk] Install the required dependencies with your preferred package manager before running "$now-sdk build".
          Ex: Run "npm install" if using npm.

    Die Anwendung ist lokal mit der Standardanwendungsstruktur verfügbar und unterstützt die Entwicklung im Quellcode. Vorhandene Anwendungsmetadaten werden in heruntergeladen Metadaten Verzeichnis. Informationen zur Anwendungsstruktur finden Sie unter Anwendungsstruktur Abschnitt des Themas „Anwendungen im Quellcode erstellen“.

  6. Installieren Sie die erforderlichen Drittparteiabhängigkeiten mit Ihrem bevorzugten Paketmanager.
    Wenn Sie beispielsweise Node Package Manager (npm) verwenden, führen Sie aus npm-Installation .
  7. (Wahlweise) Transformieren Sie vorhandene Anwendungsmetadaten (XML) in ServiceNow Fluent Code mit Transformieren Befehl.

    Mit --von Parameter, geben Sie einen Pfad zu einem lokalen Verzeichnis oder einer lokalen Datei an, das Metadaten-XML enthält, in die umgewandelt werden soll ServiceNow Fluent Code.

    now-sdk transform [--from <path>] [--directory <package path>] [--preview <flag>] [--auth <alias>]
    Tipp: Sie können festlegen --Preview Parameter auf „wahr“, um eine Vorschau der transformierten anzuzeigen ServiceNow Fluent Code aus der Befehlszeile, ohne die Änderungen zu speichern.
    Zum Beispiel:
    now-sdk transform --from metadata/update --auth devuser1
    Anwendungsmetadaten sind in definiert ServiceNow Fluent Code in src/Fluent/generiert Verzeichnis und aus dem angegebenen Verzeichnis entfernt.
    Hinweis: Eine begrenzte Anzahl von Metadatentypen, z. B. Metadaten-Snapshots [sys_metadata_Link] und UX-Assets [sys_ux_lib_Asset], kann nicht als dargestellt werden ServiceNow Fluent Code und werden nicht transformiert. Diese Metadatentypen bleiben als Metadaten-XML-Dateien im Metadaten Verzeichnis Ihrer Anwendung.
  8. Erstellen Sie die Anwendung mit Erstellen Befehl. 
    now-sdk build
  9. (Wahlweise) Aktualisieren Sie die Anwendung in der -Instanz mit Installieren Befehl. 
    now-sdk install --auth <alias>

Ergebnis

Die konvertierte Anwendung wird Ihrem lokalen Verzeichnis mit den erforderlichen Dateien und Verzeichnissen hinzugefügt, um die Entwicklung im Quellcode zu unterstützen. Wenn Sie die Anwendung erfolgreich installiert haben, wird sie in der Instanz aktualisiert. Weitere Informationen zum Installieren von Anwendungen finden Sie unter Erstellen Sie und Installieren Eine Anwendung mit ServiceNow SDK. Nach der Installation einer konvertierten Anwendung wird Paket-JSON Das Feld des anwenderdefinierten Anwendungsdatensatzes [sys_App] enthält den Pfad zu Package.JSON Datei für die Anwendung.

Neue Anwendungsmetadaten, die nach der Konvertierung einer Anwendung hinzugefügt wurden, werden in automatisch in Quellcode umgewandelt src/Fluent/generiert Verzeichnis, wenn Sie verwenden Transformieren Befehl. Wenn Metadaten in der lokalen Anwendung sowohl als XML- als auch als Quellcode vorhanden sind, hat die XML-Version bei der Installation auf der Instanz Vorrang.

Nächste Maßnahme

In Visual Studio Code, Beginnen Sie mit der Entwicklung Ihrer Anwendung im Quellcode mit ServiceNow Fluent, Schreiben anwenderdefinierter JavaScript-Module oder Hinzufügen von Bibliotheken von Drittanbietern.