を使用してアプリケーションを作成 する ServiceNow SDK

  • リリースバージョン: Yokohama
  • 更新日 2025年01月30日
  • 所要時間:7分
  • スコープ対象のアプリケーションを作成する して、 ServiceNow SDKを使用してソースコードで開発します。

    始める前に

    必要なロール:admin

    このタスクについて

    この手順では、ServiceNow SDK コマンドラインインターフェイス (CLI) を使用します。コマンドラインツールから「 now-sdk --help 」と入力すると、使用可能なコマンドとグローバルオプションに関する情報を取得できます。コマンドとそのパラメーターに関する追加情報を取得するには、コマンドと --help または -h を入力します。たとえば、now-sdk auth --help などです。CLI の詳細については、「 ServiceNow SDK CLI」を参照してください。

    手順

    1. アプリケーションを追加するディレクトリから、システム上のコマンドラインツールを開きます。
    2. create コマンドを使用して、プロンプトのガイド付きセットに従ってアプリケーションを作成します。
      now-sdk create
      注:
      create コマンドでパラメーターを手動で指定する場合は、--interactive パラメーターを false に設定し、必要なスコープ名とアプリケーション名パラメーターを指定します。詳細については、「 ServiceNow SDK CLI 」トピックの create コマンドを参照してください。
    3. 次の一連のプロンプトに応答します。
      表 : 1. create コマンドの対話型プロンプト
      プロンプト 説明
      インスタンスに接続 インスタンスに対して認証を行い、アプリケーションの作成時に指定したアプリケーションスコープが有効であることを検証するかどうかを示すオプション。
      • はい:スコープ名は、アプリケーションがローカルに作成される前に検証されます。
      • いいえ:スコープ名は作成中に検証されないため、インスタンスに展開する前にスコープ名が有効であることを確認する必要があります。
      インスタンス認証情報 インスタンスに対して認証する認証情報を作成または選択するためのオプション。認証情報を追加するには、次の手順を実行します。
      1. [ 新しい資格情報の追加] を選択します。
      2. 次の一連のプロンプトに応答します。
        • アプリケーション展開のターゲットホスト: <インスタンス URL>
        • インスタンスで認証するユーザー名: <username>
        • インスタンスで認証するパスワード: <password>
        • 認証情報のエイリアス: <alias>

      認証情報を既に設定している場合は、既存のエイリアスおよび関連付けられたインスタンスのリストから認証情報を選択できます。

      ServiceNow アプリケーションの名前 アプリケーションの名前。
      NPM パッケージ名 package.json ファイルで使用されるアプリケーションパッケージの名前。

      パッケージ名は、NPM パッケージの命名基準に準拠している必要があります。

      sys_appに関連付けられた説明 アプリケーションの簡単な説明。
      スコープ名 アプリケーションのスコープ。

      スコープ名はインスタンス上で一意で、x_<prefix> で始まり、18 文字以下である必要があります。詳細については、「名前空間識別子」を参照してください。

      プロジェクトテンプレート モジュールで JavaScript と TypeScript のどちらを使用するかを指定するオプション。このオプションは、 package.json ファイルと now.config.json ファイルの構成を決定し、TypeScript プロジェクトの tsconfig.json ファイルを追加します。
      • JavaScript: アプリケーションは、src/server ディレクトリからモジュールに.jsファイルをビルドするように構成されています。
      • タイプスクリプト: アプリケーションは、src/server ディレクトリからモジュールに.tsファイルをビルドするように設定されています。
      FluentまたはJSモジュールのプロジェクト構造ですか? デフォルトのアプリケーション構成を決定するアプリケーションのタイプ。
      • ぺらぺら: デフォルトのアプリケーション構成は、 ServiceNow Fluent、JavaScript モジュール、およびサードパーティライブラリを使用するように設定されます。
      • モジュール: デフォルトのアプリケーション構成は、JavaScript モジュールとサードパーティライブラリのみを使用するように設定されています。
      アプリケーションにサンプルテーブルを追加しますか? (Add a sample table to the application?) アプリケーションでサンプルテーブルを作成するためのオプション。
      • はい: <scope>_to_do という名前のサンプルテーブルが作成されます。
      • いいえ:サンプルテーブルはアプリケーションに作成されません。
      アプリケーションをすぐに展開しますか? 作成直後にアプリケーションをインスタンスに展開するオプション。
      • はい:アプリケーションが正常に作成された場合、インスタンスに展開されます。オフラインの場合、アプリケーションは展開されません。
      • いいえ:アプリケーションはローカルに作成されますが、インスタンスには展開されません。アプリケーションをビルドして後でインスタンスに展開する必要があります。詳細については、「ServiceNow SDK でアプリケーションをビルドして展開する」を参照してください。
      $ now-sdk create
      [now-sdk] Bootstrapping a new ServiceNow application project...
      ==========================================
      
      Create nowSDK Application
      
      ==========================================
      
      ? Connect to an instance (helps ensure the created app is valid)?  yes
      [now-sdk] Listing all credentials: 
      ? Instance credentials:  Add new credentials
      ? Target host for application deployment https://<instance>.service-now.com
      [now-sdk] Authenticating to instance "https://<instance>.service-now.com".
      ? The username to authenticate with the instance admin
      ? The password to authenticate with the instance
      [now-sdk] Attempting to log into instance https://<instance>.service-now.com as admin.
      [now-sdk] Successfully authenticated to instance https://<instance>.service-now.com.
      [now-sdk] Storing credentials for instance "https://<instance>.service-now.com" with alias undefined.
      ? Alias for these credentials devuser2
      [now-sdk] Successfully stored credentials for instance "https://<instance>.service-now.com" with alias undefined.
      ? Name of ServiceNow Application:  My Example App
      ? NPM package name:  my-example-app
      ? Description associated with sys_app:  A custom ServiceNow application
      ? Scope name:  x_snc_myexapp
      ? Project template:  Javascript
      ? Fluent or JS Module project structure?  Fluent
      ? Add a sample table to the application?  yes
      ? Deploy application immediately?  yes

    タスクの結果

    デフォルトのアプリケーション構造を持つスコープ対象のアプリケーションは、ローカルで使用できます。 アプリケーション構造の詳細については、「ソースコードでアプリケーションをビルドする」トピックの「アプリケーションの構造」セクションを参照してください。

    アプリケーションがビルドされ、インスタンスに展開されている場合、CLI はアプリケーションへの URL を返します (例: https://myinstance.service-now.com/sys_app.do?sys_id=<sysID>)。

    次のタスク

    Visual Studio CodeServiceNow Fluent を使用したソースコードでのアプリケーションの開発、カスタム JavaScript モジュールの作成、またはサードパーティライブラリの追加を開始します。