ServiceNow SDKを使用してアプリケーションを作成または変換する

  • リリースバージョン: Xanadu
  • 更新日 2024年08月01日
  • 所要時間:5分
  • ServiceNow SDK を使用してソースコードで開発するには、スコープ対象のアプリケーションを作成するか、既存のアプリケーションを変換します。

    始める前に

    npm を使用して ServiceNow SDK をインストールまたはアップグレードします。詳細については、「ServiceNow SDK をインストールする」または「ServiceNow SDK のアップグレード」を参照してください。

    必要なロール:admin

    このタスクについて

    この手順では、ServiceNow SDK コマンドラインインターフェイス (CLI) を使用します。コマンドと使用可能なパラメーターの詳細については、「ServiceNow SDK CLI」を参照してください。

    手順

    1. アプリケーションを追加するディレクトリから、システム上のコマンドラインツールを開きます。
    2. ServiceNow SDK を開始します。
      now-sdk
      ServiceNow SDK は、使用可能なコマンドに関する情報を返します。
      ヒント:
      コマンドに関する追加情報を取得するには、そのコマンドと --help または -h パラメーターを入力します。たとえば、now-sdk auth --help などです。
    3. 非本番 ServiceNow インスタンスに対して認証します。
      インスタンスは Xanadu リリースである必要があります。
      1. auth コマンドでエイリアスを使用して、ユーザー認証情報を保存します。
        now-sdk auth save [<alias>] [--host <instance url>] [--username <admin username>]

        認証情報は、システムのデバイスキーチェーンまたは認証情報マネージャーに保存されます。

        このエイリアスをデフォルトのエイリアスとして設定するには、--default または -d パラメーターをコマンドに追加します。

        例:
        now-sdk auth save devuser1 --host https://myinstance.service-now.com --username user1 --default
      2. プロンプトで、パスワードを入力します。
    4. スコープ対象のアプリケーションを作成するか、既存のアプリケーションを ServiceNow SDK で使用できるように変換します。
      オプションステップ
      スコープ対象のアプリケーションの作成
      1. create コマンドを使用して、一連のガイド付きプロンプトに従ってアプリケーションを作成します。
        now-sdk create <scopeName> --interactive
        例:
        now-sdk create x_snc_example --interactive
        注:
        スコープ名はインスタンス上で一意で、x_<prefix> で始まり、12 文字以下である必要があります。詳細については、「名前空間識別子」を参照してください。
      2. 次のプロンプトに応答します。
        • スコープ対象のアプリケーションの名前:<application name>
        • sys_app に関連付けられた説明 (Description associated with sys_app): <description>
        • プロジェクトテンプレート?TypeScript または JavaScript を選択
        • NPM パッケージ名:<package name>
        • アプリケーションにサンプルテーブルを追加しますか? (Add a sample table to the application?)[Yes/No]
        • Fluent または JS モジュールのプロジェクト構造を作成しますか?Fluent または Module を選択します

          このオプションは、アプリケーションで ServiceNow Fluent モジュールと JavaScript モジュールとサードパーティライブラリを使用するか (fluent)、JavaScript モジュールとサードパーティライブラリのみを使用するか (module) に基づいて、デフォルトのアプリケーション構造を決定します。

      既存アプリケーションの変換 convert コマンドを使用して、インスタンスから既存のスコープ対象のアプリケーションを変換します。
      now-sdk convert <scopeName> <packageName> --projectType <type>

      --projectType パラメーターを使用して、作成するアプリケーションのタイプを指定します。 このオプションは、アプリケーションで ServiceNow Fluent モジュールと JavaScript モジュールとサードパーティライブラリを使用するか (fluent)、JavaScript モジュールとサードパーティライブラリのみを使用するか (module) に基づいて、デフォルトのアプリケーション構造を決定します。

      例:
      now-sdk convert x_snc_example example-app --projectType fluent

      アプリケーションを変換すると、 ServiceNow SDK をローカルで使用するために必要なファイルとディレクトリが追加され、プロジェクトの種類に応じて ServiceNow Fluent アプリケーションメタデータがソースコードまたは XML ファイルとしてダウンロードされます。インスタンス上のアプリケーションは変更されません。

    タスクの結果

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

    アプリケーションがビルドされ、インスタンスに展開されている場合、CLI はアプリケーションへの URL を返します (例: https://myinstance.service-now.com/sys_app.do?sys_id=<sysID>)。作成時にインスタンスでアプリケーションをビルドおよび登録しないことを選択した場合、ビルドおよび登録するまでアプリケーションはインスタンスに展開されません。詳細については、「ServiceNow SDK でアプリケーションをビルドして展開する」を参照してください。

    次のタスク

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