SYSEXT ユーティリティを使用すると、ローカル Windows 環境、あるいは Windows、UNIX、OpenVMS、またはメインフレームプラットフォームに配置されているリモート環境の現在のシステムライブラリ SYSEXT に含まれている Natural アプリケーションプログラミングインターフェイス(API)を検索し、テストできます。
Natural API は Natural サブプログラム(カタログ化オブジェクト)で、データにアクセスして必要に応じて変更したり、Natural に固有のサービス、サブコンポーネント、またはサブ製品を実行したりする場合に使用します。 Natural API の目的は、情報を取得または変更したり、Natural ステートメントではアクセスできないサービスを使用したりすることです。
SYSEXT ユーティリティには、各 Natural API について、機能説明、1 つのプログラム例、および API に固有のキーワードがあります。
次の図に、SYSEXT で提供されている、API をテストし、実装するための Natural オブジェクトおよび主な機能の概要を示します。
このセクションでは、次のトピックについて説明します。
関連トピック:
「Application Programming Interfaces」 - 『Natural Security』ドキュメント
「SYSAPI - Natural アドオン製品の API」 - 『ユーティリティ』ドキュメント
[プラグインの有効化]オプションを選択する必要があります。 このオプションは、デフォルトで選択されています。 詳細については、『Natural スタジオの使用』ドキュメントの「オプションの設定」で「ワークスペースオプション」を参照してください。
各 Natural API に提供されている一般的な Natural オブジェクトのタイプは、次のセクションでリストされています。 特定の API で必要となる追加オブジェクトは、リストされていません。
API のすべての関連オブジェクトは、システムファイル FNAT のライブラリ SYSEXT に含まれています。
次のテーブルで、nnnn は、API に割り当てられている 4 桁の数字です。 相互に関連しているすべての API オブジェクトには、識別番号が付いています。
オブジェクト名 | 説明 |
---|---|
USRnnnnN | 指定された機能を実行する API サブプログラム(カタログ化オブジェクト)。 |
USRnnnnP |
API の効果のテストに使用できるプログラム例(ソースオブジェクト)。 プログラム例によって、対応するサブプログラム USRnnnnN が呼び出されます。 |
USRnnnnT |
対応する API の説明が含まれているテキストオブジェクト。 API と API に関連するキーワードの目的、機能、および呼び出し規則について説明します。 |
注意:
ソースオブジェクトの EXT-XML1 と EXT-XML2 は変更しないでください。 これらは、SYSEXT ユーティリティの設定に必須で、Software AG 内部でのみ使用されます。
このセクションでは、SYSEXT ユーティリティの呼び出しおよび終了手順について説明します。
SYSEXT を呼び出すには
次のシステムコマンドを入力します。
SYSEXT
または:
メニューの を選択します。
SYSEXT を呼び出すと、SYSEXT ユーティリティのプラグインが有効になり、次の例に示すように、ルートノードが[SYSEXT - Application Programming Interfaces]の[SYSEXT Utility]ウィンドウが表示されます。
SYSEXT を再スタートするには
Natural セッションの進行中に SYSEXT を再スタートする場合は、前述の呼び出し方法の代わりに、ツールバーで次のアイコンを選択します。
このアイコンは、SYSEXT を最初に呼び出した後に、SYSEXT ユーティリティのプラグインが有効になると表示されます。
SYSEXT を終了するには
ウィンドウを閉じる Windows の標準機能を選択します。
このセクションでは、[SYSEXT Utility]ウィンドウのツリービューに含まれるノードと項目について説明します。
すべてのツリーノードを展開すると、ツリーは次の例のようになります。
各 Natural API は、その API に関連するプログラム例、説明、およびキーワードを含む API ノードで表されます。 API ノード名は、API サブプログラム名(USRnnnnN)およびその機能の簡単な説明で構成されています。 API ノードは API 名でソートされます。
API ノードには、次の項目があります。
項目 | 説明 |
---|---|
Keywords | API に関連するすべてのキーワード。 「SYSEXT ユーティリティ機能の実行」の「Select Keyword」および「List All Keywords」も参照してください。 |
Description | API の説明が含まれているテキストオブジェクト(USRnnnnT)。 API と API に関連するキーワードの目的、機能、および呼び出し規則について説明します。 |
Example Program | API を呼び出す方法を示すプログラム例(ソースオブジェクト USRnnnnP)。 |
SYSEXT ユーティリティの機能を使用すると、API 固有のテキストオブジェクト(説明)に対する操作、プログラム例、キーワードの指定による現在のタスクに関連する API の検索などを実行できます。
オブジェクト操作には、リスト、開く、実行などの機能があります。これらは標準機能に対応し、テキストタイプまたはプログラムタイプの Natural オブジェクトのメンテナンスや実行に使用できます。 これらの機能を実行するには、各オブジェクトに関連付けられたコンテキストメニューを使用します。 これらの機能の詳細については、『Natural スタジオの使用』ドキュメントの関連するセクションを参照してください。
以下のセクションでは、次のトピックについて説明します。
この機能を使用すると、キーワードで API をリストできます。
キーワードで API をリストするには
ルートノード[SYSEXT - Application Programming Interfaces]を選択してコンテキストメニューを開き、 を選択するか、または Shift キーを押したまま K キーを押します。
[Select Keyword]ウィンドウが表示されます。
次の例に示すように、ドロップダウンリストからキーワードを選択します。
ボタンを選択します。
選択したキーワードのルートノード[SYSEXT - Application Programming Interfaces with Keyword]が表示されます。
次のキーワード *LANGUAGE
の例に示すように、指定したキーワードが適用されるすべての API のノードが表示されます。
必要に応じて、[Select Keyword]ウィンドウでアスタリスク(*
)を選択し、すべての API ノードの表示(デフォルト設定)に戻ります。
この機能を使用すると、現在のシステム環境で使用可能な API のキーワードがすべてリストされます。
すべての API キーワードをリストするには
ルートノード[SYSEXT - Application Programming Interfaces]を選択してコンテキストメニューを開き、 を選択するか、または Shift キーを押したまま A キーを押します。
ルートノード[SYSEXT - All Keywords of Application Programming Interfaces]が表示された別のウィンドウ[All Keyword]が表示されます。
次の例のように、すべてのキーワードのリストが表示されます。
この機能を使用すると、現在のライブラリ SYSEXT に含まれているオブジェクトのデータを使用して、ツリービューの API 情報が更新されます。 この更新は、API の説明またはキーワードが変更されたり、テキストオブジェクトが削除されたりした場合にのみ必要となります。
注意:
ソースオブジェクトの EXT-XML1 と EXT-XML2 は変更しないでください。 これらは、SYSEXT ユーティリティの設定に必須で、Software AG 内部でのみ使用されます。
API 情報を更新するには
ルートノード[SYSEXT - Application Programming Interfaces]を選択してコンテキストメニューを開き、 を選択するか、または Shift キーを押したまま R キーを押します。
[Refresh]ウィンドウが表示されます。
メインフレームのリモート環境にアクセスする場合は、マップ環境設定にパラメータ SORT
を次に示すように指定する必要があります。
SORT=(WRKSIZE=50)
サーバーのマッピングの詳細については、『SPoD を使用したリモート開発』ドキュメントの「リモート開発環境へのアクセス」を参照してください。 SORT
の詳細については、Natural for Mainframes の『パラメータリファレンス』を参照してください。
更新を確定するには
ボタンを選択し、操作を中止するには を選択します。ライブラリ SYSEXT に含まれている API を 1 つ使用する場合、次の選択肢があります。
ライブラリ SYSEXT をアプリケーションの steplib として定義します(推奨)。
選択したサブプログラムをシステムファイル FNAT のライブラリ SYSTEM にコピーします(推奨)。
選択したサブプログラムをアプリケーションの任意の steplib にコピーします。
選択したサブプログラムをアプリケーションライブラリにコピーします。
選択肢 1 には、Natural インストールのアップグレード時に API に固有のアクティビティの必要がないという利点があります。
選択肢 2 には(選択肢 3 および 4 と比べて)、すべての API が 1 つのライブラリにあるという利点があります。 Natural インストールをアップグレードする場合は、アップグレードする必要がある API のライブラリを 1 つ確認するだけで済みます。