Runlist 関数

Runlist 関数は、Runlist コマンド ファイルにリストされている IMSDBU 関数を実行します。このファイルは、テキスト エディターで手動で作成するか、または Makelist によって生成することができます。

構文

mfims imsdbu RUN {database-name|filename}
     [[NO]CLS] 
     [ECHO(keyword,msglvl,stoplvl
     [[NO]INI(filespec)]
     [[NO]LIST(filespec)]
     [LISTOPEN(disp)]
     [[NO]LOG(filespec)]
     [PROGRESS(no-of-segments)]

パラメーター

database-name

関数の実行対象のデータベースの名前。

filename

関数の実行対象のデータベースのリストを含むファイルの名前。

CLS 指令 (共通)

ユーティリティの起動前に画面をクリアします。NOCLS を指定すると、画面の初期クリアは行われません。NOCLS は、コマンド ファイルで一連のユーティリティを実行している場合に役立ちます。

デフォルト：

NOCLS

ECHO

IMSDBU が表示するメッセージの表示、およびそれらのメッセージとの対話を制御します。

デフォルト：

ECHO(MSGS,4,8)

サブパラメーター

keyword	表示される情報のカテゴリ。次のいずれかを指定します。 ALL 処理メッセージ、入力ソースまたは詳細情報、および終了メッセージを常に表示します。メッセージ レベルが msglvl および stoplvl 値以上の場合は、警告およびエラー メッセージが表示され、ユーザー入力を求めて停止します。 MSGS 処理メッセージおよび終了メッセージを常に表示します。ソースや詳細情報は表示されません。メッセージ レベルが msglvl および stoplvl 値以上の場合は、警告およびエラー メッセージが表示され、ユーザー入力を求めて停止します。 ERREND ユーティリティ終了メッセージを常に表示します。メッセージ レベルが msglvl および stoplvl 値以上の場合は、警告およびエラー メッセージが表示され、ユーザー入力を求めて停止します。 ENDMSG ユーティリティ終了戻りコードが msglvl 以上の場合のみ終了メッセージを表示します。ユーティリティ終了戻りコードが stoplvl 以上の場合は、「Press any key to continue」というメッセージが表示され、入力を求めて停止します。すべての終了メッセージで表示または停止、あるいはその両方を行うには、msglvl または stoplvl (あるいはその両方) の値としてゼロを入力します。 COND 警告またはエラー メッセージ、および終了メッセージは、どちらも msglvl および stoplvl 値を条件としています。メッセージ レベルが msglvl および stoplvl 値以上の場合は、警告およびエラー メッセージが表示され、ユーザー入力を求めて停止します。終了戻りコードが msglvl 以上の場合は、終了メッセージが表示されます。ユーティリティ終了戻りコードが stoplvl 以上の場合は、入力を求める「Press any key to continue」というメッセージが表示されます。 ERRORS メッセージ レベルが msglvl および stoplvl 以上の場合は、入力を求める警告およびエラー メッセージが表示されます。終了メッセージは表示されません。
msglvl	表示するメッセージの重大度を示す 4 から 20 までの値。1
stoplvl	ユーザー入力を求めて停止するメッセージの重大度を示す 4 から 20 までの値。1

¹ 次の値を指定できます。

値	カテゴリ	原因例
4	一般的な警告メッセージ	DBDGEN が想定して続行できる DBD ソース内のマイナーなコーディング エラー
6	IMS 固有の警告メッセージ	キーワードまたは文がサポート対象外で無視されるという警告 (処理は続行可能)
8	一般的な重大エラー	補正できない DBD ソース内の無効なコーディング (「no DBD statement」など)
10	IMS Option 固有の重大エラー	補正できないサポート対象外の機能が定義されている (「Exceeded some maximum」など)
12	重大エラー - 起こりうる一時的な状態	一時的な入出力エラー (「file locked」または「database locked」状態など)
16	重大エラー - 永続的 - インストールの問題の可能性	永続的な入出力エラー (無効なデータ セット名やメンバー名がユーティリティに入力された場合や、環境変数が正しく設定されていない場合など)
20	重大エラー - 永続的	回復不能な入出力エラーまたは他の予期しないエラー

INI

デフォルトの指令ファイルを指定します。

デフォルト：

なし

サブパラメーター

filespec

IMSDBU プログラム デフォルトをオーバーライドする指令を含む .INI ファイルの名前および場所。

構文規則

1. filespec には、必要に応じてドライブまたはディレクトリ (あるいはその両方) を含められます。ドライブやディレクトリを指定しない場合、IMSDBU は指定された .INI ファイルを現在のディレクトリで検索します。
2. .INI ファイルにリストされた指令は、IMSDBU プログラム デフォルトをオーバーライドします。
3. コマンド ラインまたは対話式画面で入力された指令は、.INI ファイル内の指令をオーバーライドします。
4. NOINI を指定すると、.INI ファイルによるプログラム デフォルトのオーバーライドは行われません。
5. 指定した .INI ファイルが存在しない場合は、NOINI を指定した場合と同様にプログラム デフォルトの指令が使用されます。

一般規則

1. .INI ファイルは ASCII テキスト形式のファイルで、見出し [IMSDBU] を行 1 に含み、列 1 から始まり、1 行に 1 つの指令が含まれる mfims imsdbu 指令のリストが続きます。行は改行またはファイルの末尾で終了します。コメント行は、列 1 にアスタリスク (*) またはセミコロン (;) があることで示されます。次に例を示します。

   [IMSDBU]
   PROGRESS(1000)
   ;use local log
   LOG(C:\MYDIR\MYDB.LOG)

LIST

詳細リスティング ファイルの場所および名前を制御します。リスティング ファイルには、ソース リスティング、完了状態、エラー メッセージ、実行統計などの項目が含まれます。

デフォルト：

LIST(*.LST)

サブパラメーター

filespec

リスティング ファイルに使用する名前および場所。

構文規則

1. filespec には、必要に応じてドライブまたはディレクトリ (あるいはその両方) を含められます。ドライブやディレクトリを指定しない場合、IMDBU は現在のディレクトリにリスティング ファイルを作成します。
2. NOLIST はリスティング ファイルの作成を抑制します。
3. パスの指定では、パスを表す環境変数名の冒頭にドル記号 ($) を書く表記法を使用できます。たとえば、LIST($ENVVAR\*.DOC) と記述すると、ENVVAR 環境変数で指定したディレクトリに dbdname.DOC のリスト ファイルが作成されます。
4. LIST(*.LST) または LIST(*.RPT) を指定すると、プロジェクト リスティング ディレクトリにリスティング ファイルが作成されます。
5. パスを指定しない場合、リスティング ファイルは現在のディレクトリに作成されます。
6. filespec のベース名をアスタリスク (*) として指定した場合、そのアスタリスクは DBD 名に置き換えられます。これにより、IMSDBU は、複数のデータベースを操作できる関数の個別レポートを提供できます。また、これは DBD 名による履歴詳細レポートの管理にも役立ちます。
7. LIST を filespec なしで指定すると、LIST(*.LST) を指定した場合と同じ結果が得られます。

LISTOPEN

詳細リスティング ファイルのオープン ディスポジションを制御します。

デフォルト：

LISTOPEN(NEW)

サブパラメーター

disp	使用するディスポジション。次のいずれかになります。 NEW 新しいリスティング ファイルを作成するか、既存のリスティング ファイルを上書きします。 MOD リスト出力を既存のファイルに追加します。既存のファイルがない場合は、新しいリスティング ファイルを作成します。MOD を指定すると、データベース関数の詳細履歴レコードを管理できます。

構文規則

1. NOLIST を指定した場合、LISTOPEN は無視されます。

LOG

各関数の終了メッセージ状態を示す IMSDBU アクティビティ ログを指定します。

デフォルト：

LOG(IMSDBU.LOG)

サブパラメーター

filespec

IMSDBU アクティビティ ログとして使用するファイルの名前および場所。

構文規則

1. filespec には、必要に応じてドライブまたはディレクトリ (あるいはその両方) を含められます。ドライブやディレクトリを指定しない場合は、現在のディレクトリにリスティング ファイルが作成されます。
2. NOLOG を指定すると、ログ ファイル出力は抑制されます。

一般規則

1. ログ ファイルが存在しない場合は作成されます。
2. ログ ファイルは、ファイルの末尾に書き込まれた最新のエントリを含む履歴ファイルです。
3. ログ ファイルは時間とともにサイズが大きくなるため、状況に応じて定期的に削除する必要があります。

PROGRESS

進捗レポートの頻度を制御します。

デフォルト：

PROGRESS(200)

サブパラメーター

no-of-segments

進捗メッセージを表示する前に処理するセグメントの数を示す 0 から 9999 までの値。0 を指定すると、進捗レポーティングは無効になります。

構文規則

1. 指定するセグメント数は、デフォルトの 200 より小さくしないことをお勧めします。非常に小さい値を使用すると、データベース関数のパフォーマンスが明確に低下します。
2. 比較的高速なシステムでは、設定値を高くすると (たとえば 1000 以上にすると)、パフォーマンスが多少向上することがあります。

一般規則

1. 進捗メッセージには、処理済みのセグメントの数、または完了率および予想残り時間が表示されます。

入力

IMSDBU 関数が含まれているコマンド ファイルの名前。これは、各関数が別々の行で指定されている ASCII テキスト ファイルです。このレコードのフォーマットは次のとおりです。

function dbdname [directives]

個々のコマンドが複数の行にまたがることはできません。カラム 1 のアスタリスク (*) は、コメント行であることを示します。

Runlist ファイルには、Reorganize 関数と Runlist 関数を除く、すべての IMSDBU 関数をリストすることができます。Reorganize は Runlist を使用して再編成を実行します。Runlist 実行をネストすることはできません。

出力

出力は、正常に実行された関数の結果と、IMSDBU リスティングおよびログ レポート ファイルです。

処理

Runlist コマンド ファイルにリストされている関数は、連続して処理されます。個別ステップによって設定された最も高いエラー レベルは、Runlist によって終了戻りコードとして返されます。8 以上の戻りコードでステップが失敗した場合、残りのステップはすべてキャンセルされます。終了戻りコードは、失敗したステップの戻りコードに設定されます。

IMSBDU をコマンド ラインから実行する場合、Runlist 関数に使用する function-id は RUN です。

Runlist に対して入力された指令は、Runlist が実行している関数に渡されます。Runlist を使用して関数を処理する場合、指令処理のシーケンスは次のようになります。

1. IMSDBU プログラム デフォルト。
2. .INI ファイル内の指令は、プログラムされたデフォルト値をオーバーライドします。
3. 対話式画面から Runlist を起動した場合、Runlist 入力画面からの指令は上記の指令に優先します。
4. コマンド ラインから Runlist を起動した場合、Runlist コマンド ラインで入力した指令は上記の指令に優先します。
5. Runlist コマンド ファイル内の関数に対して指定された指令は、他のどの指令よりも優先されます。

Makelist 関数は、出力 Runlist コマンド ファイル内の関数コマンドに指令を追加します。Makelist 関数が追加する指令は、関数に固有のものだけです。Makelist と Runlist の間で .INI ファイル指令に変更があっても、Runlist コマンド ファイル内の関数指令には影響しません。Makelist は、どの共通指令も追加しません(たとえば、LIST、LOG、ECHO 指令など)。Runlist によって使用される共通指令は、Makelist によるコマンド ファイルの作成時ではなく Runlist の起動時にアクティブな共通指令です。

.INI ファイル指令に加えた変更が Runlist の操作に影響しないようにしたい場合は、共通指令を Runlist コマンド ファイルに追加することができます。

回復

失敗が発生した場合は、エラー メッセージが発行され、Runlist は終了します。Runlist コマンド ファイル内の残りのステップは実行されません。ユーザーは、失敗の原因を特定して修正する必要があります。Runlist から発行されたエラー メッセージは、詳細レポート ファイルにも書き込まれます。このメッセージでは、失敗の原因を特定できるだけの十分な情報が提供されるはずです。場合によっては、IMSMTO.LOG ファイルによって追加情報が提供されます。

アクティビティ ログでは、成功した Runlist ステップと失敗した Runlist ステップがすべて示されます。このログを使用して、どのステップから再開するかを確認します。ログにリストされている関数を元の Runlist ファイルと比較して、失敗したステップを特定します。

テキスト エディターを使用して Runlist ファイルを変更し、正常に完了したステップをすべて削除またはコメント アウトします。ステップをコメント アウトするには、その行のカラム 1 にアスタリスク (*) を入力します。

変更した Runlist コマンド ファイルを使用して Runlist を返します。