SYSEXT ユーティリティを使用すると、現在のシステムライブラリ SYSEXT に含まれている Natural アプリケーションプログラミングインターフェイス(API)を検索し、テストできます。
Natural API は Natural サブプログラム(カタログ化オブジェクト)で、データにアクセスして必要に応じて変更したり、Natural に固有のサービス、サブコンポーネント、またはサブ製品を実行したりする場合に使用します。 Natural API の目的は、情報を取得または変更したり、Natural ステートメントではアクセスできないサービスを使用したりすることです。
「SYSEXT ユーティリティ- Natural アプリケーションプログラミングインターフェイス」ドキュメントでは、次のトピックについて説明します。
「Natural ユーザー出口」 - 『オペレーション』ドキュメント
「Application Programming Interfaces」 - 『Natural Security』ドキュメント
「Application Programming Interfaces」 - 『Natural SAF Security』ドキュメント
「SYSAPI - Natural アドオン製品の API」 - 『ユーティリティ』ドキュメント
SYSEXT ユーティリティには、各 Natural API について、機能説明、1 つのプログラム例、および API に固有のキーワードがあります。
次の図に、SYSEXT で提供されている、API をテストし、実装するための Natural オブジェクトおよび主な機能の概要を示します。
各 Natural API に提供されている一般的な Natural オブジェクトのタイプは、次のセクションでリストされています。 特定の API で必要となる追加オブジェクトは、リストされていません。
API のすべての関連オブジェクトは、システムファイル FNAT のライブラリ SYSEXT に含まれています。
次のテーブルで、nnnn は、API に割り当てられている 4 桁の数字です。 相互に関連しているすべての API オブジェクトには、識別番号が付いています。
オブジェクト名 | 説明 |
---|---|
USRnnnnN | 指定された機能を実行する API サブプログラム(カタログ化オブジェクト)。 |
USRnnnnP |
API の効果のテストに使用できるプログラム例(ソースオブジェクト)。 プログラム例によって、対応するサブプログラム USRnnnnN が呼び出されます。 |
USRnnnnT |
対応する API の説明が含まれているテキストオブジェクト。 API と API に関連するキーワードの目的、機能、および呼び出し規則について説明します。 テキストオブジェクトを表示するには、行コマンド テキストオブジェクトを検索するには、キーワードを指定します。「SYSEXT ユーティリティ機能の実行」の「キーワード検索」を参照してください。 |
このセクションでは、SYSEXT ユーティリティの呼び出しおよび終了手順について説明します。
SYSEXT を呼び出すには
次のシステムコマンドを入力します。
SYSEXT
次の例のような SYSEXT ユーティリティ画面が表示され、使用可能な Natural API がすべてリストされます。
13:11:42 ***** NATURAL SYSEXT UTILITY ***** 2005-08-01 User SAG - Menu - Library SYSEXT Cmd Source Interface Comment Prod _ USR0010P USR0010N Get 'SYSPROF' Information NAT _ USR0011P USR0011N Information about logical file NAT _ USR0020P USR0020N Read any error text from FNAT / FUSER NAT _ USR0040P USR0040N Get type of last error NAT _ USR0050P USR0050N Get 'SYSPROD' Information NAT _ USR0060P USR0060N Copy LFILE definition from 'FNAT' to 'FUSER' NAT _ USR0070P USR0070N Default Editor Profile 'SYSTEM' NAT _ USR0080P USR0080N Handle Type/Name of Editor Contents NAT _ USR0100P USR0100N Control LRECL NVS _ USR0120P USR0120N Read Natural Short Error Message NAT _ USR0210P USR0210N Save, cat or stow NATURAL object NAT _ USR0220P USR0220N Read Natural Long Error Message NAT _ USR0320P USR0320N Read User Short Error Message from FNAT or FUSER NAT _ USR0330P USR0330N Read Natural Object Directory NAT Keyword .. ________________ Command ===> Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8---PF9---PF10--PF11--PF12--- Help Exit -- + Canc |
このリストは、プログラム例の名前(USRnnnnP)によってソートされます。 必要に応じて、PF8 キーを押してリストを下方にスクロールしたり、PF7 キーを押してリストの先頭に戻ったりできます。
SYSEXT を終了するには
SYSEXT ユーティリティ画面で PF3 キーまたは PF12 キーを押します。
または:
コマンド行にピリオド(.
)または EXIT
を入力します。
次の表に、SYSEXT ユーティリティ画面に表示されるフィールドおよび列とその説明を示します。
列 | 説明 |
---|---|
Cmd | テキストオブジェクトまたはプログラム例で実行される行コマンドの入力フィールド。「SYSEXT ユーティリティ機能の実行」の「行コマンド」を参照してください。 |
Source | API の呼び出しに使用できるプログラム例の名前(ソースオブジェクト USRnnnnP)。 |
Interface | API サブプログラム USRnnnnN の名前。 |
Comment | API の目的の概要。 |
Prod |
API の影響を受ける Natural( 例: |
Keyword | API に関連したキーワードの入力フィールド。「SYSEXT ユーティリティ機能の実行」の「キーワード検索」を参照してください。 |
SYSEXT ユーティリティの機能を使用すると、テキストオブジェクトに対する操作、および SYSEXT ユーティリティ画面の API リストで参照されるプログラム例を実行できます。 また、キーワード検索機能を使用して、API のリストを短くしたり、API に対して使用可能なすべてのキーワードをリストしたりすることもできます。
以下のセクションでは、次のトピックについて説明します。
行コマンドを使用すると、オブジェクト操作を実行できます。 行コマンドは、目的の API の横の[Cmd]列に入力します。 この列に疑問符(?
)を入力すると、有効な行コマンドがリストされます。
SYSEXT ユーティリティ画面では、次の行コマンドを使用できます。
行コマンド | 機能 |
---|---|
E |
プログラム例 USRnnnnP を編集します。 |
L |
プログラム例 USRnnnnP をリストします。 |
R |
プログラム例 USRnnnnP を実行します。 |
X |
プログラム例 USRnnnnP を実行します。 |
D |
対応する API の説明のテキストオブジェクト USRnnnnT をリストします。 API と API に関連するキーワードの目的、機能、および呼び出し規則について説明します。 |
K |
指定されている API に関連するキーワードをリストします。 |
. |
SYSEXT ユーティリティを終了します。 |
キーワードは、現在のタスクに関連した Natural API の検索に役立ちます。 キーワード検索機能を使用すると、キーワードで API をリストしたり、特定の API に関連したキーワードをリストしたりできます。
キーワードで API をリストするには
次のいずれかの方法を選択します。
キーワードを 1 つ入力します。
SYSEXT ユーティリティ画面の[Keyword]フィールドにキーワードを入力し、Enter キーを押します。
指定したキーワードを適用するすべての API が表示されます。
有効なキーワードのリストからキーワードを 1 つ選択します。
SYSEXT ユーティリティ画面の[Keyword]フィールドにアスタリスク(*
)を入力し、Enter キーを押します。
次の例に示すように、[List Keywords]ウィンドウに、すべての API に使用可能なキーワードがすべてリストされます。
必要に応じて、PF8 キーを押してキーワードのリストを下方にスクロールしたり、PF7 キーを押してリストの先頭に戻ったりできます。
目的のキーワードの横にある[M]列に任意の文字を入力して、Enter キーを押します。
または[Direct]フィールドに目的のキーワードを入力して、Enter キーを押します。
指定したキーワードを適用するすべての API が表示されます。
有効なキーワードのリストから複数のキーワードを選択します。
SYSEXT ユーティリティ画面の[Keyword]フィールドにアスタリスク(*
)を入力し、Enter キーを押します。
次の例に示すように、[List Keywords]ウィンドウに、すべての API に使用可能なキーワードがすべてリストされます。
必要に応じて、PF8 キーを押してキーワードのリストを下方にスクロールしたり、PF7 キーを押してリストの先頭に戻ったりできます。
目的のキーワードの横にある[M]列にアスタリスク(*
)を入力して、Enter キーを押します。
次の例のような[Keyword]ウィンドウが表示され、選択した最初のキーワード(この例では *LANGUAGE
)が適用されるすべての API がリストされます。
11:08:58 ***** NATURAL SYSEXT UTILITY ***** 2005-11-10 User SAG - Menu - Library SYSEXT Cm +--------List Keywords---------+ +--------Keyword *LANGUAGE--------+ Prod _ ! ! ! ! NAT _ ! M Keyword ! ! Object ! NAT _ ! _ *DATX ! ! USR0020P ! NAT _ ! _ *ERROR-NR ! ! USR0120P ! NAT _ ! _ *ERROR-TA ! ! USR0320P ! NAT _ ! * *LANGUAGE ! ! USR1027P ! NAT _ ! _ *LEVEL ! ! USR1030P ! NAT _ ! _ *STEPLIB ! ! USR2034P ! NAT _ ! * *TIMESTMP ! ! USR3320P ! NVS _ ! _ *TIMX ! ! ! NAT _ ! _ ABEND ! ! ! NAT _ ! ! ! ! NAT _ ! Direct ... ________________ ! ! ! R NAT _ ! ! ! ! NAT +------------------------------+ +---------------------------------+ Keyword .. *_______________ Command ===> Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8---PF9---PF10--PF11--PF12--- Help Exit -- + Canc |
Enter キーを押して、選択した次のキーワード(この例では *TIMESTMP
)の[Keyword]ウィンドウを開きます。
Enter キーまたは PF3 キーを押して、[List Keywords]ウィンドウに戻ります。
PF3 キーを押してすべてのウィンドウを終了し、SYSEXT ユーティリティ画面に戻ります。
特定のAPI に関連するキーワードをリストするには
目的の API の横に行コマンド K
を入力します。 次の例に示すように、指定した API の[Keywords]ウィンドウが表示され、この API に関連するキーワードがすべてリストされます。
11:24:27 ***** NATURAL SYSEXT UTILITY ***** 2005-11-10 User SAG - Menu - Library SYSEXT Cmd Source Interface Comment Prod K USR0010P USR0010 +--Keywords for USR0010P--+ NAT _ USR0011P USR0011 ! ! file NAT _ USR0020P USR0020 ! DBID ! FNAT / FUSER NAT _ USR0040P USR0040 ! ENVIRONMENT ! NAT _ USR0050P USR0050 ! FILE ! NAT _ USR0060P USR0060 ! FNAT ! m 'FNAT' to 'FUSER' NAT _ USR0070P USR0070 ! FNR ! YSTEM' NAT _ USR0080P USR0080 ! FUSER ! r Contents NAT _ USR0100P USR0100 ! SYSPROF ! NVS _ USR0120P USR0120 ! ! Message NAT _ USR0210P USR0210 ! ! object NAT _ USR0220P USR0220 ! ! essage NAT _ USR0320P USR0320 +-------------------------+ sage from FNAT or FUSER NAT _ USR0330P USR0330N Read Natural Object Directory NAT Keyword .. ________________ Command ===> Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8---PF9---PF10--PF11--PF12---; |
必要に応じて、PF8 キーを押してリストを 1 ページ下方にスクロールします。 リストの先頭に移動するには、PF7 キーを押します。
ライブラリ SYSEXT に含まれている API を 1 つ使用する場合、次の選択肢があります。
ライブラリ SYSEXT をアプリケーションの steplib として定義します(推奨)。
選択したサブプログラムをシステムファイル FNAT のライブラリ SYSTEM にコピーします(推奨)。
選択したサブプログラムをアプリケーションの任意の steplib にコピーします。
選択したサブプログラムをアプリケーションライブラリにコピーします。
選択肢 1 には、Natural インストールのアップグレード時に API に固有のアクティビティの必要がないという利点があります。
選択肢 2 には(選択肢 3 および 4 と比べて)、すべての API が 1 つのライブラリにあるという利点があります。 Natural インストールをアップグレードする場合は、アップグレードする必要がある API のライブラリを 1 つ確認するだけで済みます。
次の SYSEXT ユーティリティで使用できる Natural アプリケーションプログラミングインターフェイス(API)のリストには、全般的な情報のみが示されています。 API の現在のステータスについては、システムコマンド SYSEXT を実行します。
リストの列は、SYSEXT ユーティリティ画面に表示される列と対応しています。 列の詳細については、「SYSEXT ユーティリティ画面」を参照してください。
Natural リモートプロシージャコール(RPC)に適用される API の使用の詳細については、『Natural リモートプロシージャコール』ドキュメントの「Natural RPC で使用するアプリケーションプログラミングインターフェイス」を参照してください。
インターフェイス | コメント | 製品 |
---|---|---|
USR0010N | SYSPROF 情報の取得 | NAT |
USR0011N | 論理ファイルに関する情報 | NAT |
USR0020N | FNAT / FUSER からエラーテキストを読み取り | NAT |
USR0040N | 最後のエラーのタイプを取得 | NAT |
USR0050N | SYSPROD 情報の取得 | NAT |
USR0060N | LFILE 定義を FNAT から FUSER へコピー | NAT |
USR0070P | デフォルトエディタプロファイル SYSTEM | NAT |
USR0080N | エディタの内容のタイプ/名前を処理 | NAT |
USR0100N | LRECL の制御 | NVS |
USR0120N | Natural ショートエラーメッセージの読み取り | NAT |
USR0210N | Natural オブジェクトの保存、カタログ、STOW | NAT |
USR0220N | Natural ロングエラーメッセージの読み取り | NAT |
USR0320N | FNAT または FUSER からユーザーショートエラーメッセージを読み取り | NAT |
USR0330N | Natural オブジェクトディレクトリの読み取り | NAT |
USR0340N | Natural バッファプールインターフェイス | NAT |
USR0341N | Natural バッファプールインターフェイス | NAT |
USR0350N | 現在記録中のフラグの読み取り | NAT |
USR0360N | ユーザーショートエラーメッセージの変更 | NAT |
USR0400N | 検索された UPDATE の影響を受ける行数 | NDB |
USR0420N | FUSER からユーザーロングエラーメッセージを読み取り | NAT |
USR0421N | FUSER 上のユーザーロングエラーメッセージの更新 | NAT |
USR0500N | ウィンドウのタイトルバーの文字列を表示 | NAT |
USR0600N | プログラムレベル情報の表示 | NAT |
USR0610N | DB エラー情報の表示 | NAT |
USR0620N | 文字列の変換 | NAT |
USR0622N | エラーカウンターのリセット | NAT |
USR1002N | Natural 環境パラメータの保存と復元 | NAT |
USR1005N | 一部の Natural システムパラメータに関する情報 | NAT |
USR1006N | スキップシーケンシャル処理のサポート | NVS |
USR1007N | ワークファイル/出力ファイル割り当ての表示 | NAT |
USR1009N | *TIMESTMP を数値変数に変換 | NAT |
USR1011N | ワイルドカード/アスタリスクのチェック(ショート) | NAT |
USR1012N | エラーのダイナミック部分 :1: の読み取り | NAT |
USR1013N | 現在の文字セットの表示 | NAT |
USR1014N | *** 行の計算機能 *** | NAT |
USR1016N | コピーコードのエラーレベルの表示 | NAT |
USR1017N | CATALL コールを CATALL コントロールリストに追加 | NAT |
USR1018N | ダイナミック OPEN | NVS |
USR1019N | SYSBUS 情報の取得 | NAT |
USR1020N | ユーザーショートエラーメッセージを FUSER に追加 | NAT |
USR1021N | ワイルドカード/アスタリスクのチェック(ロング) | NAT |
USR1022N | データベースのタイプ | NAT |
USR1023N | 日時変数の変換 | NAT |
USR1024N | CATALL の結果の読み取り | NAT |
USR1025N | 複数の steplib の処理 | NAT |
USR1026N | RETURN 情報の表示 | NAT |
USR1027N | ユーザーショートエラーメッセージの検索 | NAT |
USR1028N | ビット/バイトの変換 | NAT |
USR1029N | Natural オブジェクトのタイプの取得 | NAT |
USR1030N | 言語コードの変換 | NAT |
USR1031N | オブジェクト名のチェック | NAT |
USR1032N | カタログされた Natural オブジェクトのリスト(タイプを併記) | NAT |
USR1033N | カタログされた DDM の DBID/FNR の検索 | NAT |
USR1034N | NTTF ファイルテーブルの表示 | NAT |
USR1035N | Software AG エディタエンジンを介したオブジェクトのメンテナンス | NAT |
USR1036N | Software AG エディタのユーザープロファイルのメンテナンス | NAT |
USR1037N | Natural ABEND データに関する情報 | NAT |
USR1038N | 現在のプラットフォームの特性の取得 | NAT |
USR1040N | UDB パラメータの取得または設定 | NAT |
USR1041N | エラートランザクション(*ERROR-TA)のインストール | NAT |
USR1042N | UPDATE コマンドの値の取得または設定 | NAT |
USR1043N | Adabas ダイレクトコールの実行 | NAT |
USR1047N | ファイル名をダイナミックに切り換え | NVS |
USR1048N | PF キーラベルの変更 | NAT |
USR1050N | ワークファイル名の取得または設定 | NAT |
USR1051N | Predict の各種データ用インターフェイス | PRD |
USR1054N | ライブラリのリスト | NAT |
USR1055N | ライブラリ内のオブジェクトのリスト | NAT |
USR1056N | FDIC ファイル上またはライブラリ内の DDM のリスト | NAT |
USR1057N | Natural ソースを配列に読み取り | NAT |
USR1058N | DDM ソースを配列に読み取り | NAT |
USR1066N | Natural "Executing ..." メッセージの表示 | NAT |
USR1067N | ライブラリ名のチェック | NAT |
USR1068N | DBMS コールの値の取得またはリセット | NAT |
USR1070N | オペレータコマンドを Entire Net-Work に発行 | NAT |
USR1071N | RPC:TOKEN データの維持 | RPC |
USR1072N | 保有セットのコマンド ID の取得 | NAT |
USR2001N | 最後のエラーに関する情報の読み取り | NAT |
USR2002P | ヘルプ機能のデフォルトテキスト文字列 | NAT |
USR2003P | MAINMENU のデフォルト設定 | NAT |
USR2004N | 論理ファイルに関する情報 | NAT |
USR2005N | 内部ファイル変換テーブルへのアクセス | NAT |
USR2006N | 詳細なメッセージ情報の取得 | NAT |
USR2007N | RPC デフォルトサーバー情報の設定/取得 | RPC |
USR2008N | VSAM/ISAM データセットのダイナミック OPEN | NVS |
USR2009N | エラーのダイナミック部分 :1: の読み取り | NAT |
USR2010N | DB エラー情報の表示 | NAT |
USR2011N | ワークファイル名の取得または設定 | NAT |
USR2012N | システム変数 *NET-USER の値の取得 | NAT |
USR2013N | SYSPROF 情報の取得 | NAT |
USR2014N | Software AG エディタエンジンを介したオブジェクトのメンテナンス | NAT |
USR2015N | Natural RPC 用の EBCDIC または ASCII 変換テーブル | NAT |
USR2016N | マッププロファイルの FNAT から FUSER へのコピー | NAT |
USR2017N | FUSER からのマッププロファイル処理の有効化 | NAT |
USR2018N | Natural オブジェクトディレクトリの読み取り | NAT |
USR2019N | Natural ソースのソースエリアへの保存/ソースエリアからの読み取り | NAT |
USR2020N | Adabas ダイレクトコールの実行 | NAT |
USR2021N | データセットのダイナミックアロケーション | NAT |
USR2022N | 保存データエリアへの GUID の挿入 | NAT |
USR2023N | データベースのタイプ(2 バイト) | NAT |
USR2026N | TECH 情報の取得 | NAT |
USR2027N | セッション待機時間の定義 | NAT |
USR2028N | Natural バージョンの出力 | NAT |
USR2029N | ファイルのダイナミックアロケーション(BS2000/OSD) | NAT |
USR2030N | エラーのダイナミック部分 :1:,... の読み取り | NAT |
USR2031N | SYSPROD 情報の取得 | NAT |
USR2032N | CLOSE CONVERSATION のコミットのサポート | RPC |
USR2033N | PRD List Xref セットに関する情報 | PRD |
USR2034N | エラーテキストの読み取り(全体が対象) | NAT |
USR2035N | SSL のサポート | RPC |
USR2036N | *TIMESTAMP を数値変数に変換 | NAT |
USR2071N | クライアント側の EntireX Security のサポート | RPC |
USR2072N | サーバー側の EntireX Security のサポート | RPC |
USR2073N | RPC サーバーの ping または終了 | RPC |
USR2075N | EntireX Broker サービスの終了 | RPC |
USR3001N | ロールサーバーのディレクトリエントリのリスト | NAT |
USR3002N | ロールサーバーのディレクトリエントリの削除 | NAT |
USR3005N | ドキュメンテーションオブジェクトの処理 | PRD |
USR3013N | SYSPROF 情報の取得 | NAT |
USR3025N | 複数の steplib の処理 | NAT |
USR3320N | FNAT または FUSER からユーザーショートエラーメッセージを検索 | NAT |
USR4001N | Natural プロファイルパラメータ PROGRAM の設定
(USR6002N に対応していますが、メインフレームでのみ使用可能です) |
NAT |
USR4002N | 現在のシステムの変数の取得 | NAT |
USR4003N | Natural スタック情報の取得(英数字) | NAT |
USR4004N | ダイナミック Natural プロファイルパラメータの取得 | NAT |
USR4005N | 現在のキー設定をすべて読み取り | NAT |
USR4006N | CICS 環境での Natural セッションの選択(およびキャンセル) | NCI |
USR4007N | プロファイルパラメータ SYNERR の現在の値の取得/設定 | NAT |
USR4008N | RPC 実行のライブラリの設定 | RPC |
USR4009N | EntireX のパラメータの設定 | RPC |
USR4010N | サーバーのランタイム設定の取得 | RPC |
USR4011N | 可変入力の A20 ハッシュ値の作成 | NAT |
USR4201N | データエリアソースの処理 | NAT |
USR4202N | コードページのテーブル情報の取得 | NAT |
USR4203N | Natural オブジェクトのロック、ロックのチェック、アンロック | NAT |
USR4204N | CICS コンテナ名の設定または再設定 | NCI |
USR4206N | ライブラリ内のオブジェクトのリスト、およびディレクトリ情報を戻す | NAT |
USR4207N | マシン特性を NATQVS が提供する方式で戻す | NAT |
USR4208N | Natural リソースの読み取り/書き込み | NAT |
USR4209N | サブルーチンのショートネームを戻す | NAT |
USR4210N | Base64 の英数字/バイナリのバイト変換 | NAT |
USR4211N | DBCS 文字の取得 | NAT |
USR4212N | データエリアの分析 | NAT |
USR4213N | DBCS サポートのための文字列処理 | NAT |
USR4340N | バッファプールコンテンツまたはバッファプールキャッシュのリスト | NAT |
USR4341N | Natural バッファプールのブラックリストの管理 | NAT |
USR6002N | 一部の内部カウンタの現在の値を取得 | NAT |
USR6204N | Natural プロファイルパラメータ PROGRAM の設定
(USR4001N に対応していますが、すべてのプラットフォームで使用可能です) |
NAT |
USR6303N | Natural スタック情報の取得(Unicode) | NAT |
USR6304N | RPC 実行のための信頼できる状態の設定/取得 | RPC |
USR6305N | Reliable RPC メッセージのコミット/ロールバック | RPC |
USR6306N | 現在の EntireX Broker ユーザーの UOW のステータス | RPC |