拡張ポイントを使用してアプリケーション機能を拡張する
拡張ポイントを使用して、元のアプリケーションコードを変更せずにアプリケーションの機能を拡張します。選択した ServiceNow AI Platform アプリケーションで利用可能な既存の拡張ポイントを使用することも、独自のインスタンスでカスタムアプリケーションを開発するときに拡張ポイントを追加することもできます。
拡張ポイントの使用
拡張ポイントを使用すると、アプリケーションコードのコアコンポーネントを実際に変更することなくカスタマイズを統合できます。拡張ポイントを使用すると、カスタムコードをアプリケーションコードに直接埋め込んだ場合に、アップグレード後によく発生するカスタムコードのインタラクションが壊れるのを防ぐことができます。
アプリケーションコードに埋め込まれた拡張ポイントは、データをカスタムコードに渡すアウトポイントとして、そして返される結果を処理するインポイントとして機能します。アプリケーションを作成する場合、返されるデータまたはオブジェクトは、拡張ポイントに定義した要件に準拠している必要があります。
拡張ポイントのタイプ
- スクリプト拡張ポイント
- JavaScript 関数とオブジェクトクラスを格納するサーバーサイドスクリプトインクルードの拡張ポイント。スクリプトインクルード、およびアプリケーションおよびカスタムコードにスクリプト化された拡張ポイントを実装する方法については、以下を参照してください。
- UI 拡張ポイント
- HTML 拡張などのサーバー側 UI マクロで使用される拡張ポイント。
UI マクロは、ユーザーインターフェイスに追加できる個別のスクリプト化されたコンポーネントです。これらを使用すると、ページを直接変更する必要なく、カスタムコンテンツを UI ページに追加できます。たとえば、UI マクロを使用して、KB 記事が表示される標準の ナレッジベース ビュー (kb_view) の UI ページにヘッダーとフッターを追加できます。
UI マクロ、およびアプリケーションおよびカスタムコードに UI 拡張ポイントを実装する方法については、以下を参照してください。 - クライアント拡張ポイント
- クライアント側 UI スクリプトで使用される拡張ポイント。通常はフォームの変更に使用されます。
UI スクリプトを使用すると、クライアント側 JavaScript を再利用可能な形式にパッケージ化できます。これは、スクリプトインクルードにサーバー側 JavaScript を格納する方法と似ています。UI スクリプトを作成し、それらをクライアントスクリプト、他のクライアント側スクリプトオブジェクト、および HTML コードから実行できます。
UI スクリプト、およびアプリケーションおよびカスタムコードでクライアント拡張ポイントを実装する方法については、以下を参照してください。
拡張ポイントを使用してカスタマイズを処理する場合は、カスタムデータまたは機能をアプリケーションに統合するための定義済みの構造を作成します。カスタムサーバーサイドスクリプトインクルード、HTML 拡張などの UI マクロ、およびクライアントサイド UI スクリプトはすべてアプリケーションコードの外部にあり、指定された拡張ポイントでのみアプリケーションコードとやり取りします。
アプリケーションコード
- 標準アプリケーションコード
- ServiceNow AI Platformを構成する標準またはベースアプリケーションコード。事前定義された拡張ポイントは、 カスタマーサービス管理 (CSM) や フィールドサービス管理 (FSM) などの特定のアプリケーションに既に埋め込まれています。事前定義された拡張ポイントを含む ServiceNow AI Platform アプリケーションの詳細については、以下を参照してください。
アプリケーション 拡張ポイントトピック コーチング コーチングの問題の解決 継続的改善管理 他のアプリケーションによる改善 カスタマーサービス管理 (CSM) カスタマーサービス管理 (CSM) の拡張ポイント カスタムユーザーロールの作成 変更管理との CSM 統合 インシデント管理との CSM 統合 問題管理との CSM 統合 要求管理との CSM 統合 フィールドサービス管理 (FSM) フィールドサービス管理 (FSM) の拡張ポイント ナレッジ管理 ナレッジ管理での拡張ポイントの使用 オーケストレーション クライアントソフトウェアディストリビューション拡張ネットワーク クライアントソフトウェアディストリビューションと一緒にインストールされる内容 パスワードリセット パスワードリセットスクリプトインクルード - 社内開発のエンタープライズ向けカスタムアプリケーション
- 拡張ポイントを追加して、アプリケーションの機能を変更または拡張するために使用されるカスタムアーティファクトの登録を処理できます。開発者は、カスタムコードを作成するときに、特定のカスタムアーティファクトを特定の拡張ポイントに登録またはペアリングします。拡張ポイントを追加すると、ベースコードを変更することなく、将来のカスタマイズを統合できます。
アプリケーションコードでの拡張ポイントの作成
企業用に作成した社内で開発されたアプリケーションを、必要に応じて適切にカスタマイズ、結合、およびアップグレードできるようにする必要があります。拡張ポイントを使用すると、コアコンポーネントを編集せずにアプリケーションの機能とユーザーインターフェイスを変更できます。拡張ポイントを使用すると、機能拡張のための高度に定義された構造も作成されます。
- カスタムスクリプトインクルード、UI マクロ、または UI スクリプトに対応するために、アプリケーションコード内の拡張ポイントを配置する場所を特定します。
- 決定 拡張ポイントのコンテンツと構造。この定義では、カスタマイズの構成方法、アプリケーションコードとのやり取りの方法、および拡張ポイントでカスタマイズによって返されるデータを処理する方法について説明します。
- 拡張ポイントを作成し、そのカスタムインターフェイスを定義します。これはスクリプト化された拡張ポイントの例です。
- アプリケーションコード内で、データまたはオブジェクトをカスタマイズに送信でき、データが返される特定の場所を指定します。
- GlideScriptedExtensionPoint - スコープ指定 メソッドを呼び出すアーティファクト (スクリプトインクルード、UI マクロ、UI スクリプトなど) を作成します。このメソッドは、登録されたカスタムアーティファクトがアプリケーションコードで実行される拡張ポイントを識別します。
デバッグとログ記録の有効化
拡張ポイントを作成するときは、デバッグとログ記録も有効にする必要があります。デバッグとログ記録は、拡張ポイントを使用したカスタムアーティファクトの使用に関連する問題を特定して修正するのに役立ちます。デバッガーを有効にすると、スクリプトインクルード、UI マクロ、または UI スクリプトにブレークポイントを設定できます。ログを確認すると、次の詳細を確認できます。
- 拡張ポイントがアクティブな拡張インスタンスを検出したとき (検出された拡張インスタンスの合計数と各拡張インスタンスが検出された時刻を含む)。
- 拡張ポイントが拡張インスタンスを実行するタイミング (実行されたカスタムアーティファクトの合計数と各実行時間を含む)。また、実行に失敗した合計数と、各拡張インスタンスが失敗した時刻も含まれます。
拡張ポイントに対するカスタムアーティファクトの登録
アプリケーションをカスタマイズする場合は、サーバーサイドスクリプトインクルード、UI マクロ、クライアントサイド UI スクリプトなどのカスタムアーティファクトを使用して、基本機能を拡張します。カスタムアーティファクトを設計およびビルドするには、次のタスクを実行します。
- 作成している特定のタイプのカスタムアーティファクトに適した利用可能な拡張ポイントのリストを確認します。
- これらのリストには、作成した拡張ポイントと、 ServiceNow AI Platform 機能に埋め込まれている事前定義された拡張ポイントが含まれます。
- 各リストには、カスタムアーティファクトを呼び出すアプリケーションコード内の拡張ポイントに関する情報と、その拡張ポイントに返すデータまたはオブジェクトが含まれています。
- 拡張ポイントを選択します。
- カスタムアーティファクトを構造化する方法を決定します。構造は、拡張ポイントの説明に基づいている必要があります。説明には、カスタムコードでアーティファクトを使用するための要件と、アーティファクトがベースアプリケーションコード内のどこに配置されるかが含まれます。
- 選択した拡張ポイントに対して登録する際に、カスタムアーティファクトとコードを作成します。登録を通じて、拡張ポイント定義をカスタムアーティファクトでの実装にリンクする拡張インスタンスレコードを作成します。
登録されたカスタムアーティファクトの処理方法
- API 呼び出しで拡張ポイントを使用して、それに対して登録されているカスタムアーティファクトを決定します。
- 登録されたカスタムアーティファクトに適切なデータまたはオブジェクトを送信します。
- 各カスタムアーティファクトから返された出力を収集します。
- 返された結果を処理してベースアプリケーションに組み込みます。