マクロ言語エレメント

この章では Host On-Demand マクロ言語エレメントとその属性について説明し、マクロ言語エレメントを使用してマクロを作成する方法を示します。

属性の指定

XML 要件

マクロ言語では、どの属性の値も二重引用符で囲む必要があります。 例えば、次の <mouseclick> エレメントでは、row と col 属性の値が二重引用符で囲まれます。

<mouseclick row="4" col="51" />

属性値の拡張形式

前述のように、マクロが拡張形式であっても、マクロ・エディター内のすべての入力フィールドで、ストリングが単一引用符 ('') で囲まれるわけではありません (ストリングと非英数字文字の表記を参照)。

同様に、マクロ言語では、拡張形式によって影響を受けるこれらの入力フィールドのいずれかに対応する属性に、ストリング値を指定する場合、そのストリングを拡張形式で入力する必要があります。

<input value="'3[enter]'" row="0" col="0" movecursor="true"
             xlatehostkeys="true" encrypted="false" />

しかし、属性が、拡張形式によって影響を受ける入力フィールドのいずれかに対応しない場合、マクロが拡張形式であっても、単一引用符で囲まれた値を入力する必要はありません。例えば、<screen> エレメントの name 属性は単一引用符で囲みません。

<screen name="Screen1" entryscreen="true" exitscreen="true" transient="false" >
   ...
</screen>

マクロ言語エレメントについてのこの章の説明では、データ・タイプを指定しないことによって、こうした属性 (拡張形式によって影響を受けない属性) を示します。 例えば、<screen> エレメントの name 属性の記述は、「必須のストリング」ではなく、「必須」です。

タイプ付きデータ

大部分の属性には、特定のデータ・タイプ (ブール、整数、ストリング、倍精度、またはインポート済み) が必要です。 これらの属性には、マクロ・エディターと同じ規則が適用されます。

<actions> エレメント

<actions> エレメント、<description> エレメント、および <nextscreens> エレメントは、<screen> エレメント内に存在する 3 つの基本構造エレメントです (マクロ画面の概念視点を参照)。

<actions> エレメントには、マクロの再生時にマクロ・ランタイムが実行する、アクションと呼ばれるエレメント (例えば、キー・ストロークのシミュレート、データの取り込みなど) が含まれます (マクロ・アクションを参照)。

属性

promptall
オプションのブール (デフォルトは false)。この属性が true に設定されると、マクロ・ランタイムは、<actions> エレメント内のアクションを実行する前に、そのエレメント内の <prompt> エレメントに対するユーザー入力を収集します。具体的には次のとおりです。
  1. マクロ・ランタイムは、<actions> エレメントを検索して、そのエレメント内にある <prompt> エレメントを見つける。
  2. マクロ・ランタイムは、すべての <prompt> エレメントのプロンプトをただちに表示する (すべてのプロンプトは 1 つのポップアップに結合されます)。
  3. マクロ・ランタイムは、すべてのポップアップ・ウィンドウのユーザー入力を収集する。
  4. マクロ・ランタイムは、<actions> エレメント内のすべてのエレメントを、通常どおりに順に実行する。
  5. マクロ・ランタイムは、<prompt> アクションに達すると、ユーザー入力用のポップアップ・ウィンドウを表示するのではなく、上記のステップ 3 からの入力を使用して <prompt> アクションを実行する。

<HAScript> エレメントの promptall 属性は、1 つのマクロ内のすべての <prompt> エレメントに対して同じ機能を実行します (<HAScript> エレメントを参照)。

XML サンプル

図 85. <actions> エレメントの例
<actions promptall="true">
   ...
</actions>

 

<attrib> エレメント

<attrib> エレメントは、行と列の位置、および 3270 または 5250 属性の値を指定する記述子です (属性記述子 (<attrib> エレメント)を参照)。

属性

plane
必須。属性が置かれているデータ平面。有効な値は次のとおりです。
value
必須。形式 0x37 の 16 進値。属性の値。
row
必須の整数。データ平面内の属性の行の位置。
col
必須の整数。データ平面内の属性の列の位置。
optional
オプションのブール (デフォルトは false)。Optional 属性を参照。
invertmatch
オプションのブール。Invertmatch 属性を参照。

XML サンプル

図 86. <attrib> エレメントの例
<attrib value="0x3" row="4" col="14" plane="COLOR_PLANE"
            optional="false" invertmatch="false" />

 

<comment> エレメント

<comment> エレメントは、<screen> エレメント内のサブエレメントとしてテキスト・コメントを挿入します。制限事項は次のとおりです。

属性

なし。

XML サンプル

図 87. <comment> エレメントの例
<screen name="Screen2" entryscreen="false" exitscreen="true"
               transient="false">
   <comment>This comment provides information about this macro screen.
   </comment>
   ...
</screen>

コメントを挿入する代替方式

コメントを挿入する代替方式では、XML スタイルのコメント大括弧 <!-- --> を使用します。マクロ・スクリプトへのコメントの挿入を参照してください。

<commwait> エレメント

<commwait> アクションは、セッションの通信状況が、指定された何らかの値に変わるのを待機します (通信待機アクション (<commwait> エレメント)を参照)。タイムアウト値を指定する必要があります。

属性

value
必須。待機する通信状況。この値は、次の状態のいずれかである必要があります。
timeout
必須の整数。ミリ秒単位のタイムアウト値。指定された通信状況が発生しないうちにタイムアウトになる場合、マクロ・ランタイムはアクションを終了します。

XML サンプル

図 88. <commwait> エレメントの例
<commwait value="CONNECTION_READY" timeout="10000" />

<condition> エレメント

<condition> エレメントは、マクロ・ランタイムが画面認識時に評価する条件式を指定します。式が true に評価される場合、マクロ・ランタイムはこの記述子を true と評価します。式が false に評価される場合、マクロ・ランタイムはこの記述子を false と評価します (条件記述子 (<condition> エレメント)を参照)。

条件式の詳細については、条件演算子と論理演算子および式を参照してください。

属性

value
必須式。マクロ・ランタイムが評価する条件式。この条件式には、演算式、変数、Java™ メソッド呼び出しからの戻り値、およびその他の条件式を含むことができます。
optional
オプションのブール (デフォルトは false)。Optional 属性を参照。
invertmatch
オプションのブール。Invertmatch 属性を参照。

XML サンプル

図 89. <condition> エレメントの例
<description>
   <!-- Check the value of a variable -->
   <condition value="$intPartsComplete$ == 4"
            optional="false" invertmatch="false" />

   <!-- Check the return value of a Java method -->
   <condition value="$htHashTable.size()$ != 0"$
            optional="false" invertmatch="false" />
</description>

<create> エレメント

<create> エレメントは変数を作成し、初期化します (変数の作成を参照)。

<create> エレメントは、<vars> エレメント内に存在する必要があります。

属性

name
必須。変数に割り当てる名前。変数名のスペルには、いくつかの制限があります (変数名とタイプ名を参照)。
type
必須。変数のタイプ。標準のタイプは、ストリング、整数、倍精度、ブール、フィールドです。また、Java クラスを表すインポート済みタイプも定義できます (Java クラスのインポート済みタイプの作成を参照)。
value
オプション。変数の初期値。初期値を指定しない場合、デフォルトの初期値は変数のタイプによって異なります。

XML サンプル

図 90. <create> エレメントの例
<HAScript ... usevars="true" ... >
   <import>
      <type class="java.util.Properties" name="Properties" />
   </import>

   <vars>
      <create name="$prp$" type="Properties" value="$new Properties()$" />
      <create name="$strAccountName$" type="string" value="" />
      <create name="$intAmount$" type="integer" value="0" />
      <create name="$dblDistance$" type="double" value="0.0" />
      <create name="$boolSignedUp$" type="boolean" value="false" />
      <create name="$fldFunction$" type="field" />
   </vars>
   ...
</HAScript>

 

<cursor> エレメント

<cursor> エレメントは、ホスト端末上のテキスト・カーソルの行と列の位置を指定する記述子です (カーソル記述子 (<cursor> エレメント)を参照)。

属性

row
必須の整数。テキスト・カーソルの行の位置。
col
必須の整数。テキスト・カーソルの列の位置。
optional
オプションのブール (デフォルトは false)。Optional 属性を参照。
invertmatch
オプションのブール。Invertmatch 属性を参照。

XML サンプル

図 91. <cursor> エレメントの例
<cursor row="4" col="14" optional="false" invertmatch="false" />

<custom> エレメント

<custom> エレメントによって、マクロ画面の <actions> エレメント内からカスタム Java プログラムを呼び出すことができます。

プロセスの概要は次のとおりです。

  1. マクロ画面の <actions> エレメントの処理中にアクションとして 呼び出す Java プログラムがあると仮定します。
  2. マクロ・エディターで、カスタムの Java プログラムを呼び出す場所にある <actions> エレメントに次の行を追加します。
    <custom id="'MyProgram1'" args="'arg1 arg2 arg3'"  />
  3. MacroActionCustom クラスの指示に従います。MacroCustomActionListener を インプリメントするクラスを作成します。マクロ・ランタイムがステップ 2 の <custom> アクションを実行すると、イベントで、execute() メソッドが 呼び出されます。

属性

id
必須。実行するカスタムの Java プログラムを示す任意のストリング。
args
オプション。カスタムの Java プログラムに渡す引数。

XML サンプル

図 92. <custom> エレメントの例
<custom id="'MyProgram1'" args="'arg1 arg2 arg3'" />
<custom id="'MyProgram2'" args="'arg1 arg2'" />

<customreco> エレメント

<customreco> エレメントを使用すると、カスタム記述コードを呼び出すことができます。

カスタム記述子を作成する手順は、次のとおりです。

  1. カスタム記述を識別するストリング (例えば、MyCustomDescriptor01) を選択する。複数のタイプのカスタム記述を作成できるので、ID は必須です。
  2. ECLCustomRecoListener インターフェースをインプリメントする。doReco() メソッドで、次のことを行います。
    1. ストリングが自分のものであることを確認するために、ID ストリングを調べるためのコードを追加する。
    2. カスタム記述コードを追加する。
    3. カスタム記述に適合する場合は true を戻し、適合しない場合は false を戻す。
  3. ソース表示を使用して、<customreco> エレメントをマクロ画面の <description> エレメントに追加する。<customreco> エレメントは、ステップ 2 で選択した ID を指定する必要があります。

マクロ・ランタイムは、他のすべての記述子を実行した後、<customreco> エレメントを実行します。

属性

id
必須のストリング。このカスタム記述に割り当てた ID。
optional
オプションのブール (デフォルトは false)。Optional 属性を参照。
invertmatch
オプションのブール。Invertmatch 属性を参照。

XML サンプル

図 93. <customreco> エレメントの例
<customreco id="'MyCustomDescriptor01'" optional="false" invertmatch="false" />

<description> エレメント

<actions> エレメント、<description> エレメント、および <nextscreens> エレメントは、<screen> エレメント内に存在する 3 つの基本構造エレメントです (マクロ画面の概念視点を参照)。

<description> エレメントには、記述子と呼ばれるエレメントが含まれます。各記述子は、アプリケーション画面の識別特性を指定します (画面記述を参照)。 マクロ・ランタイムは、記述子を使用して、マクロ画面をアプリケーション画面と一致させます。

属性

uselogic
オプションのブール。デフォルト結合メソッドで使用可能な複数の記述子間で、より複雑な論理関係を定義できます (uselogic 属性を参照)。

XML サンプル

図 94. <description> エレメントの例
<description uselogic="true">
   ...
</actions>
 

<else> エレメント

<else> エレメントは、一連のマクロ・アクションを含み、<if> エレメントの直後に存在しなければなりません。 マクロ・ランタイムは、<if> エレメント内の条件式を評価します。 次に、

マクロ・オブジェクトは、<if> エレメント、および必要に応じて <else> エレメントを使用して、条件アクションを保管します (条件アクション (<if> エレメントおよび <else> エレメント)を参照)。

属性

なし。

XML サンプル

図 95. <else> エレメントの例
<if condition="($var_int$ > 10)">
   ...
</if>
<else>
   ...
</else>

<extract> エレメント

<extract> エレメントは、ホスト端末からデータを取り込みます (抽出アクション (<extract> エレメント)を参照)。

属性

下記のすべての属性の使用については、抽出アクション (<extract> エレメント)を参照してください。

name
必須のストリング。抽出されたデータに割り当てられる名前。
planetype
必須。データ抽出元の平面。有効な値は次のとおりです。
srow
必須の整数。行と列の座標の最初のペアの行。
scol
必須の整数。行と列の座標の最初のペアの列。
erow
必須の整数。行と列の座標の 2 番目のペアの行。
scol
必須の整数。行と列の座標の 2 番目のペアの列。
unwrap
オプションのブール。この属性を true に設定すると、マクロ・ランタイムは、指定された長方形内で始まる任意のフィールドの内容全体を取り込みます。unwrap 属性を参照してください。
continuous
オプションのブール。この属性を true に設定すると、マクロ・ランタイムは、必要に応じて次の行に折り返す連続した一連のデータの開始と終了の位置として、行と列の座標を解釈します。 この属性を false に設定すると、マクロ・ランタイムは、長方形のテキスト域の左上隅と右下隅として、行と列の座標を解釈します。ホスト端末からのテキスト・シーケンスのキャプチャーを参照してください。
assigntovar
オプションの変数名。 この属性を変数名に設定すると、マクロ・ランタイムは、テキスト平面データをストリング値として変数に保管します。 変数が、ストリング以外の標準タイプ (つまり、ブール、整数、または倍精度) である場合、可能であれば、データはその標準タイプに変換されます。 データが変換できない場合、マクロは、ランタイム・エラーになり、終了します。

XML サンプル

図 96. <extract> エレメントの例
<extract name="'Get Data'" srow="1" scol="1" erow="11" ecol="11"
            assignto="$strText$" planetype="TEXT_PLANE" />

<HAScript> エレメント

<HAScript> エレメントは、マクロ・スクリプトのマスター・エレメントです。 その他のエレメントを含み、マクロについてのグローバル情報を指定します (マクロ・スクリプトの概念視点を参照)。

属性

name
必須。マクロの名前。
description
オプション。このマクロについての記述テキスト。 このマクロについて覚えておきたい情報をここに組み込みます。
timeout
オプションの整数。画面認識に使用できるミリ秒数。 このタイムアウト値が指定されているときに、これを超えると、マクロ・ランタイムは、マクロを終了し、メッセージを表示します (<HAScript> エレメントの timeout 属性を参照)。 デフォルトで、マクロ・エディターはこの値を 60000 ミリ秒 (60 秒) に設定します。
pausetime
オプションの整数。「アクション間の一時停止」の遅延 (pausetime 属性を参照)。デフォルトでは、マクロ・エディターはこの値を 300 ミリ秒に設定します。
promptall
必須のブール。この属性が true に設定されると、マクロ・ランタイムは、最初のマクロ画面でアクションを実行する前に、マクロ全体内のすべての <prompt> エレメントに対するユーザー入力を収集し、個々のプロンプトを結合して 1 つの大きなプロンプトにします。 <actions> エレメントの promptall 属性は、1 つの <actions> エレメント内のすべての <prompt> エレメントに対して類似した機能を実行します (<actions> エレメントを参照)。
author
オプション。このマクロの作成者 (単数または複数)。
creationdate
オプション。このマクロの日付とバージョンについての情報。
suppressclearevents
オプションのブール (デフォルトは false)。 ホスト・アプリケーションが、clear screen コマンドの直後に、データ・ストリーム内のレコード終わり標識を続けて送信するときに、システムが画面イベントを無視するかどうかを判別する拡張機能。 アプリケーション・フロー内の画面に、すべてブランクのものがある場合、この値を true に設定できます。 マクロ内に有効なブランク画面があるときに、clear コマンドが無視されないと、すべてブランクの画面イベントが、動作不良のホスト・アプリケーションによる clear コマンドによって生成される可能性があります。 これにより、画面認識イベントが処理され、有効なブランク画面が、一致してはならないときに一致します。
usevars
必須のブール (デフォルトは false)。 この属性が true に設定される場合、マクロは拡張マクロ形式を使用します (基本マクロ形式と拡張マクロ形式を参照)。
ignorepauseoverride
オプション。3270 ディスプレイ・セッションのみ。 この属性が true に設定される場合、セッションが、コンテンション解消モードで実行される TN3270E セッションであれば、マクロ・ランタイムは、すべての <pause> エレメントをスキップします (画面の完了に関係する属性を参照)。 特定の <pause> エレメントを再度使用可能にするには、<pause> エレメントの ignorepauseoverrideforenhancedtn 属性を参照してください。
delayifnotenhancedtn
オプション。3270 ディスプレイ・セッションのみ。 この属性は、ミリ秒単位で値を指定し、セッションがコンテンション解消モードで実行される TN3270E セッションでない 場合だけ効果があります。 その状態では、この属性により、マクロ・ランタイムは、OIA 標識が変更されたという通知を受け取るたびに、指定された期間の一時停止を追加します (画面の完了に関係する属性を参照)。

XML サンプル

図 97. <HAScript> エレメントの例
<HAScript name="ispf_ex2" description="ISPF Sample2" timeout="60000"
            pausetime="300" promptall="true" author="Owner"
            creationdate="Sun Jun 08 12:04:26 PDT 2003"
            supressclearevents="false" usevars="true"
            ignorepauseforenhancedtn="false"
            delayifnotenhancedtn="0">
   ...
</HAScript>

<if> エレメント

<if> エレメントには、条件式と一連のマクロ・アクションが含まれています。 マクロ・ランタイムは、<if> エレメント内の条件式を評価します。 次に、

マクロ・オブジェクトは、<if> エレメント、および必要に応じて <else> エレメントを使用して、条件アクションを保管します (条件アクション (<if> エレメントおよび <else> エレメント)を参照)。

属性

condition
必須。条件式。条件式には論理演算子と条件演算子を指定でき、 また演算式、即時値、変数、および Java メソッドの呼び出しを含む 項を指定できます (条件演算子と論理演算子および式を参照)。

XML サンプル

図 98. <if> エレメントの例
<vars>
   <create name="$condition1$" type="string"/>
   <create name="$condition2$" type="boolean" value="false"/>
   <create name="$condition3$" type="integer"/>
</vars>
<screen>
   <description>
        ...
   </description>
   <actions promptall="true">
      <extract name="Get condition 1" srow="2" scol="1" erow="2"
               ecol="80" assigntovar="$condition1$"/>
      <extract name="Get condition 2" srow="3" scol="1" erow="3"
               ecol="80" assigntovar="$condition2$"/>
      <extract name="Get condition 3" srow="4" scol="1" erow="4"
               ecol="80" assigntovar="$condition3$"/>

      <if condition=
               "(($condition1$ !='')&&
               ($condition2$)||($condition3$ < 100))">
           ...
      </if>
      <else>
           ...
      </else>
   </actions>
</screen>

<import> エレメント

<import> エレメント、<vars> エレメント、および <screen> エレメントは、<HAScript> エレメント内に存在する 3 つの基本構造エレメントです (マクロ・スクリプトの概念視点を参照)。

<import> エレメントはオプションです。 これには <type> エレメントが含まれ、それぞれが、Java クラスに基づいて インポート済みタイプを宣言します (Java クラスのインポート済みタイプの作成を参照)。

<import> エレメントは、<HAScript> 開始タグの後、かつ <vars> エレメントの前に存在しなければなりません。

属性

なし。

XML サンプル

図 99. <import> エレメントの例
<HAScript .... >
   <import>
      <type class="java.util.Properties" name="Properties" />
   </import>

   <vars>
      <create name="$prp$" type="Properties" value="$new Properties()$" />
   </vars>
...
</HAScript>

<input> エレメント

<input> エレメントは、キー・ストロークのシーケンスをホスト端末に送ります。 このシーケンスには、文字 (a、b、c、#、& など) を表示するキーだけでな く、アクション・キー ([enterreset] など) を含めることができます。 (入力アクション (<input> エレメント)を参照)。

属性

value
必須のストリング。ホスト端末に送られる一連のキー。
row
オプションの整数 (デフォルトは、テキスト・カーソルの現在位置)。 入力が開始する行。
col
オプションの整数 (デフォルトは、テキスト・カーソルの現在位置)。 入力が開始する列。
movecursor
オプションのブール (デフォルトは true)。 この属性を true に設定すると、マクロ・ランタイムは、テキスト・カーソルを入力の末尾に移動します (入力の末尾へカーソルを移動 (movecursor 属性)を参照)。
xlatehostkeys
オプションのブール (デフォルトは true)。 この属性を true に設定すると、マクロ・ランタイムは、アクション・キー (例えば、[enter]) の名前を、文字シーケンスとしてではなく、アクション・キーとして解釈します (ホスト・アクション・キーの変換 (xlatehostkeys 属性)を参照)。
encrypted
オプションのブール (デフォルトは false)。この属性を true に 設定すると、マクロ・エディターは閉じるときに value 属性に含まれている一連のキーを暗号化します (encrypted 属性を参照)。

XML サンプル

図 100. <input> エレメントの例
<input value="'3[enter]'" row="4" column="14" movecursor="true"
            xlatehostkeys="true" encrypted="false" />

 

<mouseclick> エレメント

<mouseclick> エレメントは、ユーザーによるホスト端末上でのマウス・クリックをシミュレートします。実際のマウス・クリックと同様に、クリックが行われたときに マウス・アイコンが指していた行と列の位置にテキスト・カーソルがジャンプします。

属性

row
必須の整数。マウス・クリックが行われるホスト端末上の行と列の位置の行。
col
必須の整数。マウス・クリックが行われるホスト端末上の行と列の位置の列。

XML サンプル

図 101. <mouseclick> エレメントの例
<mouseclick row="20" col="16" />

 

<nextscreen> エレメント

<nextscreen> エレメントは、マクロ・ランタイムが、特に次に処理するマクロ画面の候補と見なす <screen> エレメント (マクロ画面) の名前を指定します (有効な次画面の認識を参照)。

<nextscreen> エレメントは、<nextscreens> エレメント内に存在する必要があります。

属性

name
必須。次に処理するマクロ画面の候補である <screen> エレメントの名前。

XML サンプル

図 102. <nextscreen> エレメントの例
   <!--
   The effect of the following <nextscreens> element and its contents
   is that when the macro runtime finishes performing the actions in
   the current screen, it adds ScreenS and ScreenG to the runtime list of
   valid next screens.
   -->
   <nextscreens>
      <nextscreen name="ScreenS">
      <nextscreen name="ScreenG">
   </nextscreens>    

<nextscreens> エレメント

<actions> エレメント、<description> エレメント、および <nextscreens> エレメントは、<screen> エレメント内に存在する 3 つの基本構造エレメントです (マクロ画面の概念視点を参照)。

<nextscreens> エレメントには、複数の <nextscreen> エレメントが含まれ、各エレメントは、現行のマクロ画面の後に表示されるマクロ画面の名前を指定します (画面認識を参照)。

属性

timeout
オプションの整数。画面認識タイムアウトの値 (ミリ秒)。 マクロ・ランタイムは、このタイムアウト値が満了する前に、名前が有効な次画面のランタイム・リスト上にあるマクロ画面をアプリケーション画面と一致させることができない場合、マクロを終了します (画面認識のタイムアウト設定を参照)。

XML サンプル

図 103. <nextscreens> エレメントの例
   <!--
   The effect of the following <nextscreens> element and its contents
   is that when the macro runtime finishes performing the actions in
   the current screen, it will attempt to recognize ScreenS and ScreenG.
   -->
   <nextscreens>
      <nextscreen name="ScreenS">
      <nextscreen name="ScreenG">
   </nextscreens>    

<numfields> エレメント

<numfields> エレメントは、ホスト端末上のすべてのタイプの 3270 フィールドまたは 5250 フィールドの数を指定する記述子です (「フィールド数」記述子 (<numfields> エレメント)を参照)。

属性

number
必須の整数。ホスト端末上のフィールドの数。
optional
オプションのブール (デフォルトは false)。Optional 属性を参照。
invertmatch
オプションのブール (デフォルトは false)。Invertmatch 属性を参照。

XML サンプル

図 104. <numfields> エレメントの例
<numfields number="10" optional="false" invertmatch="false" />

<numinputfields> エレメント

<numinputfields> エレメントは、ホスト端末上の 3270 入力フィールドまたは 5250 入力フィールドの数を指定する記述子です (「入力フィールド数 (Number of Input Fields)」記述子 (<numinputfields> エレメント)を参照)。

属性

number
必須の整数。ホスト端末上のフィールドの数。
optional
オプションのブール (デフォルトは false)。Optional 属性を参照。
invertmatch
オプションのブール (デフォルトは false)。Invertmatch 属性を参照。

XML サンプル

図 105. <numinputfields> エレメントの例
<numinputfields number="10" optional="false" invertmatch="false" />

 

<oia> エレメント

<oia> エレメントは、ホスト端末の入力禁止標識の状態を記述する記述子です (OIA 記述子 (<oia> エレメント)を参照)。

属性

status
必須。次の値にすることができます。
optional
オプションのブール (デフォルトは false)。Optional 属性を参照。
invertmatch
オプションのブール。Invertmatch 属性を参照。

XML サンプル

図 106. <oia> エレメントの例
<oia status="NOTINHIBITED" optional="false" invertmatch="false" />

<pause> エレメント

<pause> エレメントは、指定されたミリ秒数の間、待機します (一時停止アクション (<pause> エレメント)を参照)。

属性

value
オプションの整数。待機するミリ秒数。この属性を指定しない場合、 マクロ・オブジェクトは、スクリプトを保存するときに、属性 "value=10000" (10 秒) をこのエレメントに追加します。
ignorepauseoverride
オプションのブール (デフォルトは false)。3270 ディスプレイ・セッション専用。 この属性を true に設定すると、マクロ・ランタイムは、<HAScript> エレメントの ignorepauseforenhancedtn 属性が true に設定されている場合であっても、<pause> エレメントを処理します (画面の完了に関係する属性を参照)。

XML サンプル

図 107. <pause> エレメントの例
<pause timeout="5000">   

<perform> エレメント

<perform> エレメントは、インポートした Java クラスに属するメソッドを呼び出します (Java クラスのインポート済みタイプの作成を参照)。

<perform> エレメント以外の多くのコンテキストでも、メソッドを呼び出すことができます。 しかし、値を戻さないメソッドを呼び出したい場合は、<perform> エレメントが便利です (実行アクション (<perform> エレメント)を参照)。

属性

value
必須。変数と同じように、メソッド呼び出しをドル記号 ($) で囲む必要があります (メソッド呼び出しの構文を参照)。 マクロ・エディターで実行アクションを作成する場合に使用するのと同じ形式で、メソッド呼び出しのパラメーター (ある場合) を指定する必要があります。

XML サンプル

図 108. <perform> エレメントの例
<!-- Call the update() method associated with the class to which
     importedVar belongs (such as mypackage.MyClass).
-->
<perform value="$importedVar.update( 5, 'Application', $str$)$" />

<playmacro> エレメント

<playmacro> エレメントは、現行のマクロを終了し、別のマクロを起動します (PlayMacro アクション (<playmacro> エレメント)を参照)。このプロセスは、マクロのチェーニングと呼ばれます。

<playmacro> エレメントを <actions> エレメント内に配置する場所には、制限があります (PlayMacro アクションの追加を参照)。

属性

name
必須。ターゲット・マクロの名前。 ターゲット・マクロは、呼び出し側マクロと同じロケーションに存在する必要があります。
startscreen
オプション。マクロ・ランタイムがターゲット・マクロの処理を開始するマクロ画面 (<screen> エレメント) の名前。 マクロ・ランタイムに、ターゲット・マクロの通常の開始画面から開始させるには、値 *DEFAULT* を使用するか、このパラメーターを省略してください。
transfervars
必須。この属性を Transfer に設定すると、マクロ・ランタイムは、呼び出し側マクロに属する変数をターゲット・マクロに転送します (変数の転送を参照)。 デフォルトは No Transfer です。

XML サンプル

図 109. <playmacro> エレメントの例
<playmacro name="ispf_ex1.mac" startscreen="ScreenA"
                 transfervars="Transfer" />

<prompt> エレメント

<prompt> エレメントは、ユーザーに入力を求めるポップアップ・ウィンドウを表示し、ユーザーが「OK」をクリックするのを待ってから、その入力をホスト端末に送ります (プロンプト・アクション (<prompt> エレメント)を参照)。

属性

name
オプションのストリング。'Enter your response here:'. のような、ポップアップ・ウィンドウに表示されるテキスト。
description
オプションのストリング。このアクションの記述。 この記述は表示されません。
row
必須の整数。マクロ・ランタイムがユーザー入力データの入力を開始する、ホスト端末上の行。
col
必須の整数。マクロ・ランタイムにユーザー からの入力データの入力を開始させる、ホスト端末上の列。
len
必須の整数。ユーザーがプロンプト入力フィールドに入力できる文字数。
default
オプションのストリング。ポップアップ・ウィンドウの入力フィールドに表示されるテキスト。 ユーザーが入力フィールドにデータを入力せずに単に「OK」をクリックすると、マクロ・ランタイムはこのデフォルト入力をホスト端末に送ります。
clearfield
オプションのブール。この属性を true に設定すると、マクロ・ランタイムは、入力シーケンスをホスト端末に送る前に、指定の行と列の位置がある、ホスト端末の入力フィールドをクリアします。
encrypted
オプションのブール。この属性を true に設定すると、ユーザーがウィンドウの入力フィールドにキーを入力するときに、マクロ・ランタイムは、そのキーに関連した文字ではなく、アスタリスク (*) を表示します。
movecursor
オプションのブール。この属性を true に設定すると、マクロ・ランタイムは、カーソルを入力の末尾に移動します。
xlatehostkeys
オプションのブール。この属性を true に設定すると、マクロ・ランタイムは、アクション・キー (例えば、[enter]) の名前を、文字シーケンスとしてではなく、アクション・キーとして解釈します。
assigntovar
オプションの変数名。 この属性を変数名に設定すると、マクロ・ランタイムは、ユーザーがここで指定する名前を持つ変数に入力を保管します。
varupdateonly
オプションのブール。この属性を true に設定すると、マクロ・ランタイムは、入力を変数に保管し、ホスト端末にはその入力を送りません。 この属性が有効なのは、assigntovar 属性が true に設定されている場合だけです。
required
オプションのブール。この属性を true に設定すると、 マクロ・ランタイムは、プロンプト・ウィンドウの入力フィールドに テキストが入力されるまで、プロンプト・ウィンドウで「OK」ボタンを 使用不可にします。デフォルトの応答を指定してあるか、テキストを入力フィールドに 入力していると、入力フィールドにはテキストが入っています。

XML サンプル

図 110. <prompt> エレメントの例
<prompt name="'ID'" row="1" col="1" len="8" description="'ID for Logon'"
        default="'guest'" clearfield="true" encrypted="true"
        assigntovar="$userID$" varupdateonly="true" required="true"/> 

<recolimit> エレメント

<recolimit> エレメントは、<description>、<actions>、および <nextscreens> エレメントと同じレベルで、<screen> エレメント内に存在するオプションのエレメントです (認識限界を参照)。

<recolimit> エレメントを使用すると、指定された回数より多くこのエレメントが表示されるマクロ画面をマクロ・ランタイムが処理する場合、アクションを取ることができます。

属性

value
必須の整数。認識限界。 マクロ・ランタイムがマクロ画面を何度も認識する場合、マクロ・ランタイムは、このマクロ画面のアクションを処理するのではなく、指定されたアクションを実行します。
goto
オプションのストリング (デフォルトは、マクロ・ランタイムがエラー・メッセージを表示し、マクロを終了することです)。 認識限界に達したときにマクロ・ランタイムが処理を開始する、マクロ画面の名前。

XML サンプル

図 111. <recolimit> エレメントの例
<recolimit value="1" goto="RecoveryScreen1" />

<screen> エレメント

<screen> エレメント、<import> エレメント、および <vars> エレメントは、<HAScript> エレメント内に存在する 3 つの基本構造エレメントです (マクロ・スクリプトの概念視点を参照)。

マクロ内には、複数の screen エレメントが存在できます。 1 つの <screen> エレメントには、1 つのマクロ画面のすべての情報が入っています (マクロ画面とそのサブコンポーネントを参照)。

<screen> エレメントには、3 つの基本構造エレメント (<actions> エレメント、<description> エレメント、および <nextscreens> エレメント) が含まれます (マクロ画面の概念視点を参照)。

属性

name
必須。この <screen> エレメント (マクロ画面) の名前。 この名前は、すでに存在している <screen> エレメントの名前と同じあってはなりません。
entryscreen
オプションのブール (デフォルトは false)。この属性を true に設定すると、マクロ・ランタイムは、この <screen> エレメントをマクロの有効な開始画面として取り扱います (エントリー画面を参照)。
exitscreen
オプションのブール (デフォルトは false)。この属性を true に設定すると、 マクロ・ランタイムは、この <screen> エレメントをマクロの 有効な終了画面として取り扱います (終了画面を参照)。
transient
オプションのブール (デフォルトは false)。この属性を true に設定すると、マクロ・ランタイムは、いつでも表示される可能性があり、常にクリアする必要がある画面として、この <screen> エレメントを取り扱います (一時画面を参照)。
pause
オプションの整数 (デフォルトは -1)。 この属性の値をミリ秒単位で指定すると、マクロ・ランタイムは、この <screen> エレメントに対して、 (<HAScript> エレメントの pausetime 属性を使用して設定された) アクション間の デフォルトの一時停止の遅延を無視し、代わりにこの値を使用します (pause 属性を参照)。

XML サンプル

図 112. <screen> エレメントの例
<screen name="ScreenB" entryscreen="false" exitscreen="false"
            transient="false">
   <description>
      ...
   </description>
   <actions>
      ...
   </actions>
   <nextscreens>
      ...
   </nextscreens>
</screen>   

 

<sqlquery> エレメント

<sqlquery> エレメントは、SQL ステートメントをデータベースに 送信し、SQL ステートメントの結果のデータがあれば取得します。 次に、マクロ変数にデータを格納します (SQLQuery アクション (<sqlquery> エレメント)を参照)。

属性

url
必須のストリング。SQL ステートメントの送信先のデータベース・サーバーのデータベース URL(例えば、jdbc:as400://myHost)。
driver
必須のストリング。データベース・サーバーと接続するために使用する ドライバーの完全修飾パッケージ名 (例えば、COM.ibm.db2.jdbc.app.DB2DRIVER)。 このパッケージは、クライアント・ワークステーションに存在しなければなりません。
userid
オプションのストリング。データベースにアクセスするために必要なユーザー ID (必要な場合)。
password
オプションのストリング。データベースにアクセスするために必要なパスワード (必要な場合)。
statement
必須のストリング。SQL ステートメント。
outputtype
必須の整数。SQL ステートメントによって生成されたデータを送信する 宛先。有効な値は 0 (データは、マクロ変数 $HMLSQLUtil$ に保管される) です。この変数に対するメソッドを呼び出して、データを取得できます。

XML サンプル

図 113. <sqlquery> エレメントの例
<sqlquery url="'jdbc:as400://elcrtp06'"  
   driver="'com.ibm.as400.access.AS400JDBCDriver'" 
   userid="'myuser'"
   password="Ex0bRtrf73mPrwGrWMT+/g=="
   statement="'SELECT * FROM SQLTEST WHERE ((SQLTEST.DESCRIPT is not null))'"
   outputtype="0" />                                       

<string> エレメント

<string> エレメントは、文字のシーケンスや、ホスト端末上にある文字のシーケンスが含まれる長方形域を指定する記述子です (ストリング記述子 (<string> エレメント)を参照)。

文字のシーケンスは、長方形ブロック内の任意の場所に存在することができます。

属性

value
必須のストリング。文字のシーケンス。
row
オプションの整数 (デフォルトは画面全体の検索)。 長方形のテキスト・ブロックの一方のコーナーの行位置。
col
オプションの整数。長方形のテキスト・ブロックの一方のコーナーの列位置。
erow
オプションの整数。長方形のテキスト・ブロックの向かい側のコーナーの行位置。
ecol
オプションの整数。長方形のテキスト・ブロックの向かい側のコーナーの列位置。
casesense
オプションのブール (デフォルトは false)。この属性を true に設定すると、マクロ・ランタイムは、大文字小文字の区別のあるストリング比較を実行します。
wrap
オプションのブール (デフォルトは false)。
optional
オプションのブール (デフォルトは false)。Optional 属性を参照。
invertmatch
オプションのブール。Invertmatch 属性を参照。

XML サンプル

図 114. <string> エレメントの例
   <!-- The string must occur in one specific area of a single row  -->
   <string value="'Utility Selection Panel'" row="3" col="28"
               erow="3" ecol="51" casesense="false" wrap="false"
               optional="false" invertmatch="false" />

   <!-- The string can occur in any single row of the session area -->
   <string value="'Utility Selection Panel'" row="1" col="1"
               erow="-1" ecol="-1" casesense="false" wrap="false"
               optional="false" invertmatch="false" />

 

<trace> エレメント

<trace> エレメントは、指定のトレース宛先 (コンソールなど) にトレース・メッセージを送ります (トレース・アクション (<trace> エレメント)を参照)。

属性

type
必須。トレース・データの宛先。 この宛先は、次のいずれかでなければなりません。
value
必須のストリング。トレースの宛先に送信されるストリング。

XML サンプル

図 115. <trace> エレメントの例
<trace type="SYSOUT" value="’The value is ’+$strData$" />

<type> エレメント

<type> エレメントは、Java クラス (例えば、java.util.Properties) を表す インポート済みタイプ (例えば、Properties) を宣言します。タイプを宣言した後、そのタイプに基づいて変数を作成し、Java クラスのインスタンスを作成し、そのインスタンスでメソッドを呼び出すことができます (Java クラスのインポート済みタイプの作成を参照)。

また、タイプは、静的メソッドを直接呼び出すのにも使用できます (インスタンスを生成する必要がありません)。

<type> エレメントは、<import> エレメント内に存在する必要があります。

属性

class
必須。パッケージ名 (例えば、java.util.Properties) があれば、これを含めて、インポートされるクラスの完全修飾クラス名。
name
オプション。インポート済みタイプを参照するためにマクロ内の他の場所で使用できる、短い名前 (例えば、Properties)。 短い名前を指定しない場合、短い名前は、完全修飾クラス名と同じになります。 タイプ名のスペルには、いくつかの制限があります (変数名とタイプ名を参照)。

XML サンプル

図 116. <type> エレメントの例
   <import>
      <type class="java.util.Date" name="Date"/>
      <type class="java.io.FileInputStream"/>
      <type class="com.ibm.eNetwork.beans.HOD.HODBean" name="HODBean"/>
      <type class="myPackage.MyClass" name="MyClass"/>
   </import>       

<vars> エレメント

<vars> エレメント、<import> エレメント、および <screen> エレメントは、<HAScript> エレメント内に存在する 3 つの基本構造エレメントです (マクロ・スクリプトの概念視点を参照)。

<vars> エレメントはオプションです。 このエレメントには、複数の <create> エレメントが含まれ、各エレメントは、変数を宣言し、初期化します (変数の作成を参照)。 <vars> エレメントは、<import> エレメントの後、かつ最初の <screen> エレメントの前に存在しなければなりません。

変数を使用するには、<HAScript> 内の usevars エレメントを true に設定する必要があります。

属性

なし。

XML サンプル

図 117. <vars> エレメントの例
<HAScript ... usevars="true" .... >
   <import>
      <type class="java.util.Properties" name="Properties" />
   </import>

   <vars>
      <create name="$prp$" type="Properties" value="$new Properties()$" />
      <create name="$strAccountName$" type="string" value="" />
      <create name="$intAmount$" type="integer" value="0" />
      <create name="$dblDistance$" type="double" value="0.0" />
      <create name="$boolSignedUp$" type="boolean" value="false" />
      <create name="$fldFunction$" type="field" />
   </vars>
   ...
</HAScript>

<varupdate> エレメント

<varupdate> エレメントにより、マクロ・ランタイムは、指定された値を指定された変数に保管します。 この値は、即時値、変数、Java メソッドの呼び出し、またはこれらの値のいずれかを含むことができる演算式にすることができます。値が式である場合、マクロの再生時に、マクロ・ランタイムはその式を評価し、指定された変数に結果の値を保管します (変数更新アクション (<varupdate> エレメント)を参照)。

また、<description> エレメント内の <varupdate> アクションを使用することもできます (変数更新アクション (<varupdate> エレメント)を参照)。

変数の詳細については、変数とインポートした Java クラスを参照してください。

属性

name
必須。変数の名前。
value
必須のストリング。変数に割り当てられる値または式。

XML サンプル

図 118. <varupdate> エレメントの例
<type>
   <type class="mypackage.MyClass" name="MyClass" />
   <type class="java.util.Hashtable" name="Hashtable" />
   <type class="java.lang.Object" name="Object" />
</type>

<vars>
   ...
</vars>

<screen>
   <description>
   ...
   </description>
   <actions>
      <varupdate name="$var_boolean1$"  value="false" />
      <varupdate name="$var_int1$"      value="5" />
      <varupdate name="$var_double1$"   value="5" />
      <varupdate name="$var_string1$"   value="'oak tree'" />
      <varupdate name="$var_field1$"    value="4,5" />

      <!-- null keyword -->
      <varupdate name="$var_importedMC1$"  value="null" />
      <!--  Equivalent to null keyword for an imported type  -->
      <varupdate name="$var_importedMC2$"  value="" />

      <varupdate name="$var_importedMC4$"
                  value="$new MyClass( 'myparam1', 'myparam2' )$" />
      <varupdate name="$var_importedMC5$"
                  value="$var_importedMC4$" />
      <varupdate name="$var_importedMC6$"
                  value="$MyClass.createInstance( 'mystringparam1' )$" />
      <varupdate name="$var_boolean2$"
                  value="$var_importedMC4.isEmpty()$" />
      <varupdate name="$var_int2$"
                  value="$($var_importedMC4.getHashtable()$).size()$" />
      <varupdate name="$var_double2$"
                  value="$var_importedMC4.getMeters()$" />
      <varupdate name="$var_string2$"
                  value="$var_importedMC4.toString()" />
   </actions>
</screen>