9.251 COMPOSER_RUN
この組み込み関数は対象システム(LANSA Composer サーバー別名引数にて識別されるシステム)がLANSA Composerシステムであり、LANSA Composer リクエストサーバー ソフトウェアがその中に入っていることを前提としています。そうでない場合には、この組み込み関数の実行は失敗します。
COMPOSER_RUNはLANSA Composer リクエストサーバーを通じて、サーバー別名の引数によって識別されるLANSA ComposerシステムのLANSA Composer処理シーケンスを実行します。処理シーケンスに最大5つのパラメータを受け渡すことができます。
この組み込み関数を実行する前に、COMPOSER_USE組み込み関数を使用して、サーバー接続詳細とそれを表す別名を定義しなくてはいけません。
この組み込み関数についての重要な情報は、このページの最後にて述べます。
詳細については、『LANSA Composer ガイド』のCOMPOSER_RUN操作及び付録F (「LANSA Composer リクエストサーバー」)を参照してください。
各製品の対応
|
LANSA/AD |
使用可 |
|
Visual LANSA for Windows |
使用可 |
|
Visual LANSA for Linux |
未対応 |
引数
|
番号 |
タイプ |
必須/任意 |
記述 |
最小長 |
最大長 |
最小小数桁数 |
最大小数桁数 |
|---|---|---|---|---|---|---|---|
|
1 |
A |
必須 |
LANSA Composerのサーバー別名。 別名はLANSA Composerサーバーシステムへの接続詳細を識別するのに使用されます。名前は、COMPOSER_USE組み込み関数を使用して、現在のセッションにおいて、これより前に指定されていなくてはいけません。 |
1 |
10 |
|
|
|
2 |
A |
必須 |
処理シーケンスID 実行するLANSA Composer 処理シーケンスを識別します。外部識別子（名前）もしくは内部識別子のいずれかを指定します。 |
1 |
32 |
|
|
|
3 |
A |
任意 |
パラメーター名1 (処理シーケンス・パラメータを参照)。 |
1 |
20 |
|
|
|
4 |
A |
任意 |
パラメーター値1 (処理シーケンス・パラメータを参照)。 |
1 |
200 |
|
|
|
5 |
A |
任意 |
パラメーター名2 (処理シーケンス・パラメータを参照)。 |
1 |
20 |
|
|
|
6 |
A |
任意 |
パラメーター値2 (処理シーケンス・パラメータを参照)。 |
1 |
200 |
|
|
|
7 |
A |
任意 |
パラメーター名3 (処理シーケンス・パラメータを参照)。 |
1 |
20 |
|
|
|
8 |
A |
任意 |
パラメーター値3 (処理シーケンス・パラメータを参照)。 |
1 |
200 |
|
|
|
9 |
A |
任意 |
パラメーター名4 (処理シーケンス・パラメータを参照)。 |
1 |
20 |
|
|
|
10 |
A |
任意 |
パラメーター値4 (処理シーケンス・パラメータを参照)。 |
1 |
200 |
|
|
|
11 |
A |
任意 |
パラメーター名5 (処理シーケンス・パラメータを参照)。 |
1 |
20 |
|
|
|
12 |
A |
任意 |
パラメーター値5 (処理シーケンス・パラメータを参照)。 |
1 |
200 |
|
|
|
13 |
A |
任意 |
同期呼び出しか否か。 組み込み関数が処理シーケンスが完了するのを待つかどうかを指定します。
省略値は'Y'で、待ちます。 |
1 |
1 |
|
|
|
14 |
N |
任意 |
同期タイムアウト（秒）。 組み込み関数が、同期的な処理シーケンス実行が完了するのを待つ秒数。このタイムアウトを超えた場合、組み込み関数は結果コード'TM'で終了します。 デフォルトは30秒です。 |
1 |
5 |
0 |
0 |
|
15 |
N |
任意 |
要求の有効期限（秒数）。IBM i サーバーのみ。Windowsサーバーには有効期限は適用されません。 リクエスト・サーバーに投げられた後、要求が有効である秒数。 リクエストサーバーが要求を処理し始めるまでに指定された間隔よりも長く経過した場合には、要求の有効期限が切れたと考え、その処理を行うのを取りやめます。 省略値はゼロ(0)です。これは、要求に対して有効期限が適用されないということです。 |
1 |
5 |
0 |
0 |
戻り値
|
番号 |
タイプ |
必須/任意 |
記述 |
最小長 |
最大長 |
最小小数桁数 |
最大小数桁数 |
|---|---|---|---|---|---|---|---|
|
1 |
A |
任意 |
結果コード。
組み込み関数が正常に完了した場合には、OK |
2 |
2 |
|
|
例
この例では、COMPOSERという別名を使いあらかじめ定義されたLANSAシステムへ接続して（COMPOSER_USEを参照）、'EXAMPLE_AATEST1'という処理シーケンスの呼び出しを行います。
use builtin(COMPOSER_RUN) with_args('COMPOSER' 'EXAMPLE_AATEST1')
この例では、上記と同じ接続を使用して、処理シーケンス'EXAMPLE_AATEST2'の呼び出しを行います。1つのパラメータ:'DIRECTORY' が値 '/'とともに受け渡されます。結果コードは、変数#RESULTで受け取ります。
use builtin(COMPOSER_RUN) with_args('COMPOSER' 'EXAMPLE_AATEST2' 'DIRECTORY' '/') to_get(#RESULT)
この例では、上記と同じ接続を使用して、パラメータを受け渡さずに処理シーケンス'EXAMPLE_AATEST1'の呼び出しを行います。タイムアウト値は30秒から60秒に倍増させます。
Use Builtin(COMPOSER_RUN) With_Args('COMPOSER' 'EXAMPLE_AATEST1' *Default *Default *Default *Default *Default *Default *Default *Default *Default *Default *Default 60) to_get(#RESULT)
処理シーケンス・パラメータ
組み込み関数の引数は、最大5つのパラメータ値を処理シーケンス実行に受け渡すのに使用することができます。一組の組み込み関数の引数が以下の各処理シーケンス・パラメータに使用されます。
ｷ 各組の最初の引数(パラメータ名n)には実行する処理シーケンスに定義されているパラメータ名を指定します。指定されていない場合は、省略値 '*NONE' が使用され、この組のパラメータは使用されないことになります。
ｷ 各組の二番目の引数(パラメータ値n) には、処理シーケンスに受け渡される、パラメータ名に対応したパラメータの値を指定します。受け渡すことができる値の最大長は200です。もし指定されていない場合には、省略値'*NONE'が使用されます。しかし、パラメータ名が指定されている場合には、パラメータ値を指定する必要があります。
LANSA Composer リクエストサーバーを通して実行される処理シーケンスに関するその他の考慮事項
この組み込み関数はLANSA Composer リクエストサーバーを通じて処理シーケンスを実行します。
このように実行される場合、処理シーケンスは別のプロセスやジョブで実行されます（リクエストサーバー）。組み込み関数とリクエストサーバーのプロセスやジョブは、要求を実行して結果を返すために、協力してやり取りをおこないます。
これらはアプリケーションに対して概ね影響を与えません。しかしながら、これらの実行方法に関していくつか特別に考慮すべきことがあり、それには以下の項目に関連する考慮事項が含まれます。
ｷ ユーザー・プロファイル、権限、実行環境
ｷ IBM i 作業管理 (ジョブやサブシステム)
LANSA Composerのリクエストサーバーを通して実行された要求に関しては、詳しくは『LANSA Composer ガイド』の付録F (「LANSA Composer リクエストサーバー」) を参照してください。