この章では Host On-Demand マクロ言語エレメントとその属性について説明し、マクロ言語エレメントを使用してマクロを作成する方法を示します。
マクロ言語では、どの属性の値も二重引用符で囲む必要があります。 例えば、次の <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> エレメント、<description> エレメント、および <nextscreens> エレメントは、<screen> エレメント内に存在する 3 つの基本構造エレメントです (マクロ画面の概念視点を参照)。
<actions> エレメントには、マクロの再生時にマクロ・ランタイムが実行する、アクションと呼ばれるエレメント (例えば、キー・ストロークのシミュレート、データの取り込みなど) が含まれます (マクロ・アクションを参照)。
<HAScript> エレメントの promptall 属性は、1 つのマクロ内のすべての <prompt> エレメントに対して同じ機能を実行します (<HAScript> エレメントを参照)。
<actions promptall="true"> ... </actions>
<attrib> エレメントは、行と列の位置、および 3270 または 5250 属性の値を指定する記述子です (属性記述子 (<attrib> エレメント)を参照)。
<attrib value="0x3" row="4" col="14" plane="COLOR_PLANE"
optional="false" invertmatch="false" />
<comment> エレメントは、<screen> エレメント内のサブエレメントとしてテキスト・コメントを挿入します。制限事項は次のとおりです。
なし。
<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="CONNECTION_READY" timeout="10000" />
<condition> エレメントは、マクロ・ランタイムが画面認識時に評価する条件式を指定します。式が true に評価される場合、マクロ・ランタイムはこの記述子を true と評価します。式が false に評価される場合、マクロ・ランタイムはこの記述子を false と評価します (条件記述子 (<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> エレメントは、<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>
<cursor> エレメントは、ホスト端末上のテキスト・カーソルの行と列の位置を指定する記述子です (カーソル記述子 (<cursor> エレメント)を参照)。
<cursor row="4" col="14" optional="false" invertmatch="false" />
<custom> エレメントによって、マクロ画面の <actions> エレメント内からカスタム Java プログラムを呼び出すことができます。
プロセスの概要は次のとおりです。
<custom id="'MyProgram1'" args="'arg1 arg2 arg3'" />
<custom id="'MyProgram1'" args="'arg1 arg2 arg3'" /> <custom id="'MyProgram2'" args="'arg1 arg2'" />
<customreco> エレメントを使用すると、カスタム記述コードを呼び出すことができます。
カスタム記述子を作成する手順は、次のとおりです。
マクロ・ランタイムは、他のすべての記述子を実行した後、<customreco> エレメントを実行します。
<customreco id="'MyCustomDescriptor01'" optional="false" invertmatch="false" />
<actions> エレメント、<description> エレメント、および <nextscreens> エレメントは、<screen> エレメント内に存在する 3 つの基本構造エレメントです (マクロ画面の概念視点を参照)。
<description> エレメントには、記述子と呼ばれるエレメントが含まれます。各記述子は、アプリケーション画面の識別特性を指定します (画面記述を参照)。 マクロ・ランタイムは、記述子を使用して、マクロ画面をアプリケーション画面と一致させます。
<description uselogic="true"> ... </actions>
<else> エレメントは、一連のマクロ・アクションを含み、<if> エレメントの直後に存在しなければなりません。 マクロ・ランタイムは、<if> エレメント内の条件式を評価します。 次に、
マクロ・オブジェクトは、<if> エレメント、および必要に応じて <else> エレメントを使用して、条件アクションを保管します (条件アクション (<if> エレメントおよび <else> エレメント)を参照)。
なし。
<if condition="($var_int$ > 10)"> ... </if> <else> ... </else>
<extract> エレメントは、ホスト端末からデータを取り込みます (抽出アクション (<extract> エレメント)を参照)。
下記のすべての属性の使用については、抽出アクション (<extract> エレメント)を参照してください。
<extract name="'Get Data'" srow="1" scol="1" erow="11" ecol="11"
assignto="$strText$" planetype="TEXT_PLANE" /><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> エレメント、および必要に応じて <else> エレメントを使用して、条件アクションを保管します (条件アクション (<if> エレメントおよび <else> エレメント)を参照)。
<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> エレメント、<vars> エレメント、および <screen> エレメントは、<HAScript> エレメント内に存在する 3 つの基本構造エレメントです (マクロ・スクリプトの概念視点を参照)。
<import> エレメントはオプションです。 これには <type> エレメントが含まれ、それぞれが、Java クラスに基づいて インポート済みタイプを宣言します (Java クラスのインポート済みタイプの作成を参照)。
<import> エレメントは、<HAScript> 開始タグの後、かつ <vars> エレメントの前に存在しなければなりません。
なし。
<HAScript .... >
<import>
<type class="java.util.Properties" name="Properties" />
</import>
<vars>
<create name="$prp$" type="Properties" value="$new Properties()$" />
</vars>
...
</HAScript><input> エレメントは、キー・ストロークのシーケンスをホスト端末に送ります。 このシーケンスには、文字 (a、b、c、#、& など) を表示するキーだけでな く、アクション・キー ([enterreset] など) を含めることができます。 (入力アクション (<input> エレメント)を参照)。
<input value="'3[enter]'" row="4" column="14" movecursor="true"
xlatehostkeys="true" encrypted="false" />
<mouseclick> エレメントは、ユーザーによるホスト端末上でのマウス・クリックをシミュレートします。実際のマウス・クリックと同様に、クリックが行われたときに マウス・アイコンが指していた行と列の位置にテキスト・カーソルがジャンプします。
<mouseclick row="20" col="16" />
<nextscreen> エレメントは、マクロ・ランタイムが、特に次に処理するマクロ画面の候補と見なす <screen> エレメント (マクロ画面) の名前を指定します (有効な次画面の認識を参照)。
<nextscreen> エレメントは、<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 adds ScreenS and ScreenG to the runtime list of
valid next screens.
-->
<nextscreens>
<nextscreen name="ScreenS">
<nextscreen name="ScreenG">
</nextscreens> <actions> エレメント、<description> エレメント、および <nextscreens> エレメントは、<screen> エレメント内に存在する 3 つの基本構造エレメントです (マクロ画面の概念視点を参照)。
<nextscreens> エレメントには、複数の <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 will attempt to recognize ScreenS and ScreenG.
-->
<nextscreens>
<nextscreen name="ScreenS">
<nextscreen name="ScreenG">
</nextscreens> <numfields> エレメントは、ホスト端末上のすべてのタイプの 3270 フィールドまたは 5250 フィールドの数を指定する記述子です (「フィールド数」記述子 (<numfields> エレメント)を参照)。
<numfields number="10" optional="false" invertmatch="false" />
<numinputfields> エレメントは、ホスト端末上の 3270 入力フィールドまたは 5250 入力フィールドの数を指定する記述子です (「入力フィールド数 (Number of Input Fields)」記述子 (<numinputfields> エレメント)を参照)。
<numinputfields number="10" optional="false" invertmatch="false" />
<oia> エレメントは、ホスト端末の入力禁止標識の状態を記述する記述子です (OIA 記述子 (<oia> エレメント)を参照)。
マクロ・ランタイムは、入力禁止標識がクリアされているときはこの記述子を true として評価し、入力禁止標識が設定されている場合は false として評価します。
マクロ・ランタイムは、常にこの記述子を true として評価します。
マクロ・ランタイムは、この式を評価してから、その結果に応じて、通常通りに記述子を評価します。
<oia status="NOTINHIBITED" optional="false" invertmatch="false" />
<pause> エレメントは、指定されたミリ秒数の間、待機します (一時停止アクション (<pause> エレメント)を参照)。
<pause timeout="5000">
<perform> エレメントは、インポートした Java クラスに属するメソッドを呼び出します (Java クラスのインポート済みタイプの作成を参照)。
<perform> エレメント以外の多くのコンテキストでも、メソッドを呼び出すことができます。 しかし、値を戻さないメソッドを呼び出したい場合は、<perform> エレメントが便利です (実行アクション (<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> エレメントを <actions> エレメント内に配置する場所には、制限があります (PlayMacro アクションの追加を参照)。
<playmacro name="ispf_ex1.mac" startscreen="ScreenA"
transfervars="Transfer" /><prompt> エレメントは、ユーザーに入力を求めるポップアップ・ウィンドウを表示し、ユーザーが「OK」をクリックするのを待ってから、その入力をホスト端末に送ります (プロンプト・アクション (<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> エレメントは、<description>、<actions>、および <nextscreens> エレメントと同じレベルで、<screen> エレメント内に存在するオプションのエレメントです (認識限界を参照)。
<recolimit> エレメントを使用すると、指定された回数より多くこのエレメントが表示されるマクロ画面をマクロ・ランタイムが処理する場合、アクションを取ることができます。
<recolimit value="1" goto="RecoveryScreen1" />
<screen> エレメント、<import> エレメント、および <vars> エレメントは、<HAScript> エレメント内に存在する 3 つの基本構造エレメントです (マクロ・スクリプトの概念視点を参照)。
マクロ内には、複数の screen エレメントが存在できます。 1 つの <screen> エレメントには、1 つのマクロ画面のすべての情報が入っています (マクロ画面とそのサブコンポーネントを参照)。
<screen> エレメントには、3 つの基本構造エレメント (<actions> エレメント、<description> エレメント、および <nextscreens> エレメント) が含まれます (マクロ画面の概念視点を参照)。
<screen name="ScreenB" entryscreen="false" exitscreen="false"
transient="false">
<description>
...
</description>
<actions>
...
</actions>
<nextscreens>
...
</nextscreens>
</screen>
<sqlquery> エレメントは、SQL ステートメントをデータベースに 送信し、SQL ステートメントの結果のデータがあれば取得します。 次に、マクロ変数にデータを格納します (SQLQuery アクション (<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> エレメント)を参照)。
文字のシーケンスは、長方形ブロック内の任意の場所に存在することができます。
<!-- 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="SYSOUT" value="’The value is ’+$strData$" />
<type> エレメントは、Java クラス (例えば、java.util.Properties) を表す インポート済みタイプ (例えば、Properties) を宣言します。タイプを宣言した後、そのタイプに基づいて変数を作成し、Java クラスのインスタンスを作成し、そのインスタンスでメソッドを呼び出すことができます (Java クラスのインポート済みタイプの作成を参照)。
また、タイプは、静的メソッドを直接呼び出すのにも使用できます (インスタンスを生成する必要がありません)。
<type> エレメントは、<import> エレメント内に存在する必要があります。
<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> エレメント、<import> エレメント、および <screen> エレメントは、<HAScript> エレメント内に存在する 3 つの基本構造エレメントです (マクロ・スクリプトの概念視点を参照)。
<vars> エレメントはオプションです。 このエレメントには、複数の <create> エレメントが含まれ、各エレメントは、変数を宣言し、初期化します (変数の作成を参照)。 <vars> エレメントは、<import> エレメントの後、かつ最初の <screen> エレメントの前に存在しなければなりません。
変数を使用するには、<HAScript> 内の usevars エレメントを true に設定する必要があります。
なし。
<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> エレメントにより、マクロ・ランタイムは、指定された値を指定された変数に保管します。 この値は、即時値、変数、Java メソッドの呼び出し、またはこれらの値のいずれかを含むことができる演算式にすることができます。値が式である場合、マクロの再生時に、マクロ・ランタイムはその式を評価し、指定された変数に結果の値を保管します (変数更新アクション (<varupdate> エレメント)を参照)。
また、<description> エレメント内の <varupdate> アクションを使用することもできます (変数更新アクション (<varupdate> エレメント)を参照)。
変数の詳細については、変数とインポートした Java クラスを参照してください。
<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>