Abhängigkeiten werden mit heruntergeladen ServiceNow SDK

Laden Sie Anwendungsabhängigkeiten und TypeScript-Definitionen aus einer Instanz für IntelliSense und die Validierung von Skripts und herunter ServiceNow FluentCode.

Während des gesamten Entwicklungsprozesses sollten Sie Abhängigkeiten und TypeScript-Definitionen aus einer Instanz herunterladen, um die Codierung für diese Abhängigkeiten in einer Anwendung zu unterstützen.

Zum Herunterladen aller Skripts und ServiceNow FluentAbhängigkeiten für eine Anwendung können Sie verwenden Abhängigkeiten Befehl ohne Parameter. Geben Sie bei Bedarf auch das Anwendungsverzeichnis und den Authentifizierungsalias an.

now-sdk dependencies [--directory <package path>] [--auth <alias>]

Herunterladen ServiceNow FluentAnwendungsabhängigkeiten

Laden Sie TypeScript-Definitionen für Abhängigkeiten in anderen Anwendungsbereichen herunter, um IntelliSense-Unterstützung und -Validierung zu erhalten ServiceNow FluentCode.

Vorbereitungen

Fügen Sie Ihrem lokalen System mit eine Anwendung hinzu ServiceNow SDK. Weitere Informationen finden Sie unter Anwendungen werden mit hinzugefügt ServiceNow SDK.

Erforderliche Rolle: Administrator

Warum und wann dieser Vorgang ausgeführt wird

Dieses Verfahren verwendet ServiceNow SDKBefehlszeilenschnittstelle (CLI). Geben Sie in einem Befehlszeilentool ein Now-sdk --help Zum Abrufen von Informationen zu den verfügbaren Befehlen und globalen Optionen. 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. In Visual Studio Code, Öffnen Sie Ihr bereichsbezogenes Anwendungsverzeichnis.
2. In Now.config.JSON Datei, fügen Sie die Elemente hinzu, von denen Ihre Anwendung abhängt, in Abhängigkeiten Objekt.

   Die Abhängigkeiten Objekt hat die folgende Struktur. Sie müssen den Anwendungsbereich und den Abhängigkeitstyp und Namen oder sys_IDs angeben. Nur Tabellen und Rollen können anhand des Namens angegeben werden. Sie können einen Platzhalter verwenden ( * ), um alle Elemente aus einer angegebenen Tabelle und einem angegebenen Bereich hinzuzufügen.

   "dependencies": {
       "<scope>": {
         "<type>": ["<sys_id or name>"],
         ...
       },
       ...
   }

   Zum Beispiel:

   {
     "dependencies": {
       "global": {
         "tables": ["incident", "problem"],
         "roles": ["admin"],
         "sys_script_client": ["fa776f6d97700100f309124eda2975bc"]
       },
       "x_custom": {
         "tables": ["custom_table"],
         "sys_security_acl": "*",
       }
     }
   }

3. Speichern Sie die Änderungen.
4. Öffnen Sie im Anwendungsverzeichnis ein integriertes Terminalfenster.
5. Laden Sie Abhängigkeiten der Anwendung mit herunter Abhängigkeiten Befehl.

   now-sdk dependencies --auth <alias> --fluent-only

   Hinweis:

   Wenn Sie auch Skriptabhängigkeiten herunterladen möchten, schließen Sie aus --Fluent-only Parameter.

   Die Abhängigkeiten Befehl lädt die in angegebenen Abhängigkeiten herunter Now.config.JSON Datei und generiert TypeScript-Definitionen für sie in @Types/servicenow/Fluent Verzeichnis mit .d.now.ts Dateierweiterung. Beim Erstellen der Anwendung werden diese Dateien nicht wie Quellcodedateien kompiliert.

Nächste Maßnahme

Sie können Abhängigkeiten in referenzieren ServiceNow FluentDateien, die verwenden #Now:{Scope}/{category} Subpfad-Importformat. Zum Beispiel:

// Import roles from global scope
import { role as globalRole } from '#now:global/security'

// Import roles from custom app scope  
import { role as xExampleAppRole } from '#now:x_example_app/security'

// Use in ACLs, flows, etc.
Acl({
    $id: Now.ID['my_acl'],
    type: 'record',
    table: 'incident',
    operation: 'read',
    roles: [globalRole.admin, xExampleAppRole.xExampleAppCool],
})

Ihre Anwendung Package.JSON Datei muss Folgendes enthalten Importe Konfiguration dazu:

{
  "imports": {
    "#now:*": "./@types/servicenow/fluent/*/index.js"
  }
}

Herunterladen Modul und Skriptabhängigkeiten

Laden Sie TypeScript-Definitionen für herunter Modul und Skriptabhängigkeiten, um IntelliSense-Unterstützung und -Validierung für Glide-APIs und Skripteinbindungen zu erhalten.

Vorbereitungen

Fügen Sie Ihrem lokalen System mit eine Anwendung hinzu ServiceNow SDK. Weitere Informationen finden Sie unter Anwendungen werden mit hinzugefügt ServiceNow SDK.

Erforderliche Rolle: Administrator

Warum und wann dieser Vorgang ausgeführt wird

Dieses Verfahren verwendet ServiceNow SDKBefehlszeilenschnittstelle (CLI). Geben Sie in einem Befehlszeilentool ein Now-sdk --help Zum Abrufen von Informationen zu den verfügbaren Befehlen und globalen Optionen. 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. In Visual Studio Code, Öffnen Sie Ihr bereichsbezogenes Anwendungsverzeichnis.
2. Öffnen Sie im Anwendungsverzeichnis ein integriertes Terminalfenster.
3. Laden Sie Abhängigkeiten für Skripts in der Anwendung mit herunter Abhängigkeiten Befehl.

   now-sdk dependencies --auth <alias> --type-defs-only

   Hinweis:

   Wenn Sie auch Anwendungsabhängigkeiten herunterladen möchten, schließen Sie aus --type-defs-only Parameter.

   Die Abhängigkeiten Befehl lädt Typdefinitionen für alle Glide-APIs herunter, scannt die Module und Skripts in Ihrer Anwendung und erstellt Typdefinitionen für die von ihnen verwendeten Skripteinbindungen. Typdefinitionen werden in hinzugefügt @Types/servicenow Verzeichnis. Um andere Typdefinitionen hinzuzufügen, können Sie sie manuell erstellen. Weitere Informationen finden Sie unter Fügen Sie Typdefinitionen für APIs hinzu.

4. In src/Fluent Verzeichnis, erstellen Sie ein tsconfig.server.json Datei für serverseitige Skripts.
   In Einbeziehen Objekt: Fügen Sie die Typdefinitionen ein, die Sie für serverseitige Glide-APIs heruntergeladen haben ( glide.server.d.ts ) Und Skripteinbindungen ( script-includes.server.d.ts ).

   {
     "compilerOptions": {
       "lib": [
         "ES2021"
       ],
       "noEmit": true,
       "checkJs": false,
       "allowJs": true,
       "noEmitHelpers": true,
       "esModuleInterop": false,
       "module": "None",
       "types": []
     },
     "include": [
       "./**/*.server.js",
       "../../@types/servicenow/*.server.d.ts",
     ]
   }

5. In src/Fluent Verzeichnis, erstellen Sie ein Tsconfig.Client.JSON Datei für clientseitige Skripts.
   In Einbeziehen Objekt: Fügen Sie die Typdefinitionen ein, die Sie für clientseitige Glide-APIs heruntergeladen haben ( Glide.Client.tt.t ).

   {
     "compilerOptions": {
       "target": "ES6",
       "lib": [
         "DOM",
         "ES6"
       ],
       "checkJs": false,
       "allowJs": true,
       "noEmit": true,
       "noEmitHelpers": true,
       "esModuleInterop": false,
       "module": "None",
       "types": []
     },
     "include": [
       "./**/*.client.js",
       "../../@types/servicenow/*.client.d.ts",
     ]
   }

6. In src/Fluent Verzeichnis, erstellen Sie ein Tsconfig.JSON Datei.
   Hinweis:

   Dies Tsconfig.JSON Datei ist getrennt von Tsconfig.JSON Datei, die für Anwendungen verwendet wird, die TypeScript zum Erstellen von JavaScript-Modulen verwenden.

   In Referenzen Objekt, fügen Sie die Pfade zu hinzu tsconfig.server.json Und Tsconfig.Client.JSON Dateien.

   {
     "files": [],
     "references": [
       {
         "path": "./tsconfig.server.json"
       },
       {
         "path": "./tsconfig.client.json"
       }
     ]
   }

7. Speichern Sie die Änderungen.

Ergebnisse

Mit dieser Konfiguration können Sie verwenden .Server.js Dateierweiterung für serverseitige Skripts und .Client.js Dateierweiterung für clientseitige Skripts und Unterstützung für Typahead während der Entwicklung.