SYSAPI ユーティリティは、Entire Output Management などの Natural アドオン製品のアプリケーションプログラミングインターフェイス（API）を検索し、テストするために使用します。 このユーティリティは、Windows ローカル環境、または Windows、UNIX、OpenVMS、メインフレームプラットフォーム上のリモート環境のいずれかで実行できます。
Natural アドオン製品の API は、データへのアクセスやデータの変更、またはアドオン製品やサブコンポーネントに固有のサービスの実行に使用される Natural サブプログラム（カタログ化オブジェクト）です。
Natural アドオン製品の API は、特定の Natural アドオン製品に固有のオブジェクト用に提供される Natural ライブラリやシステムファイル内に用意されています。 Natural アドオン製品の API の使用方法については、各アドオン製品のドキュメントを参照してください。
SYSAPI ユーティリティでは、Natural アドオン製品の API ごとに、機能説明、1 つのプログラム例、API 固有のキーワードが提供されています。
次のトピックについて説明します。
適切な Natural アドオン製品がサイトにインストールされている必要があります。
インストールされている Natural アドオン製品のバージョンで SYSAPI ユーティリティ機能がサポートされている必要があります。
［プラグインの有効化］オプションを選択する必要があります。 このオプションは、デフォルトで選択されています。 詳細については、『Natural スタジオの使用』ドキュメントの「オプションの設定」で「ワークスペースオプション」を参照してください。
このセクションでは、SYSAPI ユーティリティの呼び出しと終了の手順について説明します。
SYSAPI を呼び出すには
次のシステムコマンドを入力します。
SYSAPI
SYSAPI を呼び出すと、SYSAPI ユーティリティのプラグインが有効になり、SYSAPI ユーティリティウィンドウが開いて、次の例に示すようにルートノード［SYSAPI - APIs of Natural Natural Add-on Products］が表示されます。
SYSAPI を再スタートするには
現在の Natural セッション中に SYSAPI を再スタートするには、すでに説明した方法でスタートするのではなく、ツールバーの次のアイコンを選択します。
このアイコンは、SYSAPI を最初に呼び出し、SYSAPI ユーティリティのプラグインが有効になった後に表示されます。
SYSAPI を終了するには
ウィンドウを閉じる Windows の標準機能を選択します。
このセクションでは、［SYSAPI utility］ウィンドウのツリー構造およびツリービューに含まれるノードと項目について説明します。
ツリーの一番上にあるルートノード［SYSAPI - APIs of Natural Add-on-Products］から、次のノード階層を展開できます。
サイトにインストールされている Natural アドオン製品には、それぞれ独自のノードがあります。このノードには、下位の API グループノードが 1 つ以上含まれています。
API グループノードは、それぞれ親ノードの Natural アドオン製品に提供されている特定の API 機能を表しています。 1 つの API グループノードに、特定の機能に関連するすべての API ノードが含まれています。
API ノード名は、API サブプログラム名およびその機能の簡単な説明で構成されています。 API ノードは API 名でソートされます。
API ノードには次の API 固有の項目があります。
| 項目 | 説明 |
|---|---|
| キーワード | API に関連するすべてのキーワード。 「キーワードの選択」および「すべてのキーワードのリスト」も参照してください。 |
| 説明 | API の説明が含まれているテキストオブジェクトまたはプログラム。 API と API に関連するキーワードの目的、機能、および呼び出し規則について説明します。 |
| プログラム例 | API を呼び出す方法を示すプログラム例またはサブプログラム例。 |
SYSAPI ユーティリティを使用してキーワードを指定すると、API 固有のテキストオブジェクト（説明）に対する操作、プログラム例、API グループに対する機能（現在のタスクに関連する API の検索など）を実行できます。
オブジェクト操作には、リスト、開く、実行などの機能があります。これらは標準機能に対応し、テキストタイプまたはプログラムタイプの Natural オブジェクトのメンテナンスや実行に使用できます。 これらの機能を実行するには、各オブジェクトに関連付けられたコンテキストメニューを使用します。 これらの機能の詳細については、『Natural スタジオの使用』ドキュメントの関連するセクションを参照してください。
次のセクションでは、API グループに対して実行できる機能について説明します。
この機能は、選択した API グループの中で、指定したキーワードが適用されるすべての API ノードをリストするときに使用します。
キーワードで API をリストするには
Natural アドオン製品の API グループノードを選択してコンテキストメニューを開き、［Select Keyword］を選択するか、Shift キーを押したまま K キーを押します。
［Select Keyword］ウィンドウが表示されます。
ドロップダウンリストボックスから、SYSEXT ユーティリティのドキュメントの［Select Keyword］ウィンドウ例に示されているように、キーワードを選択します。
［OK］ボタンを選択します。
選択した API グループのノード名にキーワードが表示されます。
API グループノードを展開します。
選択した API グループに対して、指定したキーワードが該当するすべての APIノードがリストされます。 このウィンドウは、SYSEXT ユーティリティの対応するウィンドウに似ています。SYSEXT ユーティリティのドキュメントの例を参照してください。
必要に応じて、［Select Keyword］ウィンドウでアスタリスク（*）を選択し、API グループノードで使用可能なすべての API ノードのリストに戻ります。
この機能は、選択した API グループで使用可能なすべてのキーワードをリストするときに使用します。
API グループのすべてのキーワードをリストするには
API グループノードを選択してコンテキストメニューを開き、［List All Keywords］を選択するか、Shift キーを押したまま A キーを押します。
［All Keywords］ウィンドウが表示され、ルートノードに Natural アドオン製品の名前および選択した API グループの名前が表示されます。
このウィンドウは、SYSEXT ユーティリティの［All Keywords］ウィンドウに似ています。SYSEXT ユーティリティのドキュメントにある例を参照してください。
ルートノードを展開します。
選択した API グループで使用可能なすべてのキーワードがリストされます。 キーワードノードを展開し、そのキーワードが適用されるすべての API ノードを表示できます。
この機能は、現在の SYSAPI 環境設定を更新します。 例えば、Natural アドオン製品でその API の説明およびキーワードに対して複数の言語がサポートされている場合、言語コード（システム変数 *LANGUAGE）を変更して、API の説明およびキーワードを別の言語に変更できます。
SYSAPI 環境設定を変更するには
ルートノード［SYSAPI - APIs of Natural Add-on Products］を選択してコンテキストメニューを開き、［Refresh］を選択するか、Shift キーを押したまま R キーを押します。
［Refresh］ウィンドウが表示されます。
更新を確定するには［OK］ボタンを選択し、操作を中止するには［CANCEL］を選択します。
