UIマップ属性および関数

注意: このトピックでは、「フィールド」という用語を使用して、一般的な概念であるフィールドへのデータの表示および取得を示す他に、フィールドを定義するために製品で提供されるメタデータ・オブジェクトを示します。後者を指す場合は、「メタデータ・フィールド」という用語が使用され、フィールドの説明へのハイパーリンクが提供されます。

内容

HTMLへのXMLのバインド

ポップアップ・エクスプローラ・ゾーンを使用した検索

エラーの表示

ブラウザ・イベントに対するJavaScriptの起動

要素の非表示

スキーマベース・サービスの起動

レンダリングされたマップまたはポータル・ページのリフレッシュ

フレームワーク・ナビゲーションの埋込み

ビジネス・プロセス・アシスタント・スクリプトの起動

CSVファイルのアップロードおよびダウンロード

ポータル・ゾーン・マップ・フラグメントの構成

必要なJavaScriptライブラリ

未保存の変更の検出

ポータルのタブの非表示

HTMLへのXMLのバインド

UIマップのXMLをそのHTMLにバインドするには、2つの異なる属性のみが必要です。これらの属性の両方に、HTML内に埋め込まれたXMLドキュメントが必要です。XMLは、<xml>ノードによってバインドされます。

警告: バインドを実行するには、<xml></xml>タグのペアをHTMLドキュメント内に埋め込む必要があります。

フィールドのリンク


構文	値	摘要
oraField=" "	フィールド要素のXPath	この属性は、HTML要素をXML要素に直接リンクするために使用されます。XML要素は、UIマップのXMLスキーマ内に定義されています。属性は、<span>、<div>および<input>などのHTMLのレンダリング要素とともに使用できます。

input要素のHTML:


<html>
<body>
<table>
   <tr>
      <td>Address:</td>
      <td><input type="text" oraField="address"/></td>
   </tr>
   <tr>
      <td>City:</td>
      <td><input type="text" oraField="city"/></td>
   </tr>
   <tr>
      <td>State:</td>
      <td><input type="text" oraField="state"/></td>
   </tr>
   <tr>
      <td>Zip:</td>
      <td><input type="text" oraField="zip"/></td>
   </tr>
</table>
</body>
<xml>
   <root>
      <address>123 Main St</address>
      <city>Alameda</city>
      <state>CA</state>
      <zip>94770</zip>
   </root>
</xml>
</html>

レンダリングされたHTML

spanおよびdiv要素のHTML:


<html>
<body>
 
<div oraField="address"></div>
<span oraField="city"></span>
<span>,</span>
<span oraField="state"></span>
<span oraField="zip"></span>
<span oraField="country"></span>
 
</body>
<xml>
   <root>
      <address>123 Main St</address>
      <city>Alameda</city>
      <state>CA</state>
      <zip>94770</zip>
   </root>
</xml>
</html>

レンダリングされたHTML:

リストのリンク

この属性は、HTML表をXMLリストにリンクするために使用されます。XMLリストは、UIマップのXMLスキーマ内に定義されています。この要素の目的は、リストの発生ごとに表のHTMLを複製するフレームワークをトリガーすることです。


構文	値	摘要
oraList=" "	リスト要素のXPath	この属性は、HTML表をXMLリストにリンクするために使用されます。XMLリストは、UIマップのXMLスキーマ内に定義されています。この要素の目的は、リストの発生ごとに表のHTMLを複製するフレームワークをトリガーすることです。

注意: リスト内に埋め込まれたoraField属性には、リストに相対的に指定されたXPathナビゲーションが含まれる必要があります。例については、次を参照してください。

<html>
<head><title>Bind xml list element</title></head>
<body>
<table oraList="payment">
   <thead>
      <tr>
         <th><span>Pay Date</span></th>
         <th><span>Amount</span></th>
        </tr>
        <tr/>
    </thead>
    <tr>
      <td>
         <span oraField="date" oraType="date"></span>
      </td>
      <td align="right">
         <span oraField="amount" oraType="money"></span>
      </td>
   </tr>
</table>
</body>
<xml>
<root>
    <payment>
        <date>2008-01-01</date>
        <amount>44.28</amount>
    </payment>
    <payment>
        <date>2008-02-01</date>
        <amount>32.87</amount>
    </payment>
    <payment>
        <date>2008-03-01</date>
        <amount>21.76</amount>
    </payment>
</root>
</xml>
</html>

レンダリングされたHTML:

ドロップダウン・リストの作成

次の各属性は、様々なソースに基づいてHTMLの‘select’要素(ドロップダウンとも呼ばれる)を作成するために用意されています。


Source	構文	値	例
参照	oraSelect="lookup: ;"	参照フィールド	`... <td>House Type:</td> <td> <select oraField="houseType" oraSelect="lookup:HOUSE_TYPE;"> </select> </td>`
拡張可能参照	oraSelect="lookupBO: ;"	ビジネス・オブジェクト・コード	`... <td>UI Device Display Type:</td> <td> <select oraField="uiDeviceType" oraSelect="lookupBO: F1-DeviceDisplayTypes;"></select> </td>`
特性タイプ(事前定義)	oraSelect="charType: ;"	特性タイプ・コード	`... <td>Usage:</td> <td> <select oraField="statusReasonUsage" oraSelect="charType:F1-SRUSG;"></select> </td> ...`
管理表	oraSelect="table: ;" 注意: この属性は、列DESCRをその摘要列として含む関連言語表がある標準管理表構造に準拠する表でのみ機能します。アプリケーション・ビューアのデータ・ディクショナリを使用して、この機能に適格な表を識別します。警告: oraSelect関数は、500個未満の値を表示する場合にのみ有効です。	表名	`... <td>Currency: </td> <td> <select oraField="currency" oraSelect="table:CI_CURRENCY_CD;"> </select> </td> ...`
ページ・サービス	oraSelect="service: ;"	ページ・サービス名	`... <td>Country:</td> <td> <select oraField="country" oraSelect="service:CIPTCNTW;"> </select> </td> ...`
埋込みリスト	マップのXML内のリストに基づいて選択ドロップダウンを作成するために使用されます。 oraSelect="valuePath: ;descPath: "	valuePathの後に、値を保持する要素のXPathを指定します。descPathの後に、摘要を保持する要素のXPathを指定します。	<html> <body> <table summary="" border="0" cellpadding="1" cellspacing="1"> <tr> <td>Select: </td> <td><select oraSelect= "valuePath:list/value; descPath:list/desc" oraField="target"></select></td> </tr> </table> </body> <xml> <root> <target>10</target> <list> <value>10</value> <desc>Ten</desc> </list> <list> <value>20</value> <desc>Twenty</desc> </list> <list> <value>40</value> <desc>Forty</desc> </list> </root> </xml> </html>
サービス・スクリプト	oraSelect="ss: ;"	サービス・スクリプト・コード	この関数の使用時に必要な追加構文については、次を参照してください。
ビジネス・サービス	oraSelect="bs: ;"	ビジネス・サービス・コード	この関数の使用時に必要な追加構文については、次を参照してください。

サービス・スクリプトまたはビジネス・サービスを指定するときは、サービスとの間でデータの受け渡すために追加のマッピング情報が必要です。


構文	値	摘要
oraSelectIn=" ;"	serviceXPath:要素;	別の要素の値をサービスに渡すために使用されます(サービスのXPathへのマッピング)。
oraSelectIn=" ;"	serviceXPath:'リテラル';	定数またはリテラルをサービスに渡すために使用されます(サービスのXPathへのマッピング)。
oraSelectOut="valuePath: ; descPath: "	次の例を参照してください	サービスの出力内で値を保持している要素と摘要を保持している要素を示すために使用されます。

ビジネス・サービスを使用した例:

...
<td>External System: </td>
<td>
   <select oraField="externalSystem" 
    oraSelect="bs:F1-RetrieveExternalSystems" 
    oraSelectIn="outboundMsgType:boGroup/parameters/outboundMsgType;" 
    oraSelectOut="valuePath:results/externalSystem; 
    descPath:results/description">
   </select>
</td>
...

通常、ドロップダウンを作成するこの方法は、要素間に依存関係があり、ドロップダウンの有効値のリスト(子要素)がマップ内の別の要素(親要素)に基づいている場合に使用されます。親要素が変更されると、子要素のリフレッシュが必要な場合があります。この動作は、マップのonChangeイベント内でコールされる関数を使用して実装できます。構文はoraHandleDependentElements('依存要素');です。複数のターゲット要素(依存)を指定できます。

次の例は、前述のビジネス・サービスの例に関連しています。外部システムのリストは特定のアウトバウンド・メッセージ・タイプに固有のもので、入力として渡されます。次のスニペットは、外部システムのドロップダウン・リストのリフレッシュをトリガーするアウトバウンド・メッセージ・タイプ要素の構成を示しています。

...
<div>
   <label oraLabel="boGroup/parameters/outboundMsgType"></label>
      <span>
         <select oraSelect="table:F1_OUTMSG_TYPE"  
          oraField="boGroup/parameters/outboundMsgType"
          onChange="oraHandleDependentElements('boGroup/parameters/externalSystem');">
         </select>
      </span>
</div>
...

入力および出力フィールドの書式設定

次の各属性は、入力および出力フィールドに対してデータ型書式設定を適用するように設計されています。

自動書式設定


構文
oraSchemaDataTypes="false"

この属性は、レンダリングされたHTMLドキュメントで自動書式設定をトリガーするために使用されます。自動書式設定は、UIマップのスキーマで定義されたデータ型属性に従って実行されます。特定のデータ型書式設定の詳細は、次のoraType属性の説明を参照してください。

警告: 属性oraSchemaDataTypes="true"は、UIマップのHTMLに自動的に挿入されます。スキーマのデータ型をレンダリングされたHTMLに適用しない場合は、この属性をbodyノードに値をfalseにして指定する必要があります。属性<body oraSchemaDataTypes="false">は、自動書式設定を回避するために必要です。

UIマップ・スキーマ:

<schema>
    <schemaDate dataType="date"/> 
    <schemaDateTime dataType="dateTime"/> 
    <schemaFKRef fkRef="CI_USER"/> 
    <schemaLookup dataType="lookup" lookup="ACCESS_MODE"/> 
    <schemaMoney dataType="money"/> 
    <schemaNumber dataType="number"/> 
    <schemaTime dataType="time"/> 
</schema>

UIマップHTML:


<html>
<body oraSchemaDataTypes="true">
<table border="1" cellpadding="1" cellspacing="1">
   <tr><th>dataType</th><th>result type</th><th>input result</th><th> display-only result</th></tr>
   <tr>
      <td rowspan="2">date (from schema)</td>
      <td>raw</td>
      <td><input oraField="schemaDate" oraType="string" /></td>
      <td><span oraField="schemaDate" oraType="string"></span></td>
   </tr>
   <tr>
      <td>rendered</td>
      <td><input oraField="schemaDate"></td>
      <td><span oraField="schemaDate"></span></td>
   </tr>
 
   <tr>
      <td rowspan="2">dateTime (from schema)</td>
      <td>raw</td>
      <td><input oraField="schemaDateTime" oraType="string"></td>
      <td><span oraField="schemaDateTime" oraType="string"></span></td>
   </tr>
   <tr>
      <td>rendered</td>
      <td><input oraField="schemaDateTime"></td>
      <td><span oraField="schemaDateTime"></span></td>
   </tr>

   <tr>
      <td rowspan="2">fkRef (from schema)**</td>
      <td>raw</td>
      <td><input oraField="schemaFkRef" oraType="string"></td>
      <td><span oraField="schemaFkRef" oraType="string"></span></td>
   </tr>
   <tr>
      <td>rendered</td>
      <td><input oraField="schemaFkRef"></td>
      <td><span oraField="schemaFkRef"></span></td>
   </tr>
 
   <tr>
      <td rowspan="2">lookup (from schema)</td>
      <td>raw</td>
      <td><input oraField="schemaLookup" oraType="string"></td>
      <td><span oraField="schemaLookup" oraType="string"></span></td>
   </tr>
   <tr>
      <td>rendered</td>
      <td><input oraField="schemaLookup"></td>
      <td><span oraField="schemaLookup"></span></td>
   </tr>
   
   <tr>
      <td rowspan="2">money (from schema)</td>
      <td>raw</td>
      <td><input oraField="schemaMoney" oraType="string"></td>
      <td><span oraField="schemaMoney" oraType="string"></span></td>
   </tr>
   <tr>
      <td>rendered</td>
      <td><input oraField="schemaMoney"></td>
      <td><span oraField="schemaMoney"></span></td>
   </tr>
 
   <tr>
      <td rowspan="2">number (from schema)</td>
      <td>raw</td>
      <td><input oraField="schemaNumber" oraType="string"/></td>
      <td><span oraField="schemaNumber" oraType="string"></span></td>
   </tr>
   <tr>
      <td>rendered</td>
      <td><input oraField="schemaNumber"></td>
      <td><span oraField="schemaNumber"></span></td>
   </tr>
 
   <tr>
      <td rowspan="2">time (from schema)</td>
      <td>raw</td>
      <td><input oraField="schemaTime" oraType="string"></span></td>
      <td><span oraField="schemaTime" oraType="string"></span></td>
   </tr>
   <tr>
      <td>rendered</td>
      <td><input oraField="schemaTime"></td>
      <td><span oraField="schemaTime"></span></td>
   </tr>
 
</table>
 
</body>
<xml>
<root>
   <schemaDate>2007-11-02</schemaDate>
   <schemaDateTime>2007-11-02-23.45.00</schemaDateTime>
   <schemaFkRef>USD</schemaFkRef>
   <schemaLookup>A</schemaLookup>
   <schemaMoney>1000000</schemaMoney>
   <schemaNumber>5661976.11548</schemaNumber>
   <schemaTime>23.45.00</schemaTime>
</root>
</xml>
</html>

レンダリングされたHTML。

日付書式設定

この関数は、ユーザーの表示プロファイルに従って日付を表示するために使用されます。入力フィールドの場合は、ユーザーが入力フィールドから[Tab]キーで移動すると、設定によってデータが書式設定されます。


構文
oraType="date"


<html>
<body>
<table summary="" border="0" cellpadding="1" cellspacing="1">
   <tr>
      <td>Date: </td>
      <td><span oraField="date" oraType="date"></span></td>
   </tr>
   <tr>
      <td>Date: </td>
      <td><input oraField="date" oraType="date"/></td>
   </tr>
</table>
</body>
<xml>
<root>
   <date>2008-12-28</date>
</root>
</xml>
</html>

レンダリングされたHTML。

時間書式設定

この関数は、ユーザーの表示プロファイルに従って時間を表示するために使用されます。入力フィールドの場合は、ユーザーが入力フィールドから[Tab]キーで移動すると、設定によってデータが書式設定されます。


構文
oraType="time"

<html>
<body>
<table summary="" border="0" cellpadding="1" cellspacing="1">
   <tr>
      <td>Time: </td>
      <td><span oraField="time" oraType="time"></span></td>
   </tr>
   <tr>
      <td>Time: </td>
      <td><input oraField="time" oraType="time"/></td>
   </tr>
</table>
</body>
<xml>
<root>
   <time>00.28.54.389</time>
</root>
</xml>
</html>

レンダリングされたHTML。

日時書式設定

この関数は、ユーザーの表示プロファイルに従ってタイムスタンプを表示するために使用されます。この関数を入力要素に使用すると、日付と時間の2つの部分に分割されます。オプションで、属性値'time:suppress'を使用して、日時要素の時間部分を抑制できます。


構文
oraType="dateTime; time:suppress"


<html>
<body>
<table summary="" border="0" cellpadding="1" cellspacing="1">
   <tr>
      <td>Date time: </td>
      <td><span oraField="dateTime" oraType="dateTime"></span></td>
   </tr>
   <tr>
      <td>Date only: </td>
      <td><span oraField="dateTime" oraType="dateTime; time:suppress"></span></td>
   </tr>
   <tr>
      <td>Date time: </td>
      <td><input oraField="dateTime" oraType="dateTime"/></td>
   </tr>
   <tr>
      <td>Date only: </td>
      <td><input oraField="dateTime" oraType="dateTime; time:suppress"/></td>
   </tr>
</table>
</body>
<xml>
<root>
   <dateTime>2009-11-01-00.28.54</dateTime>
</root>
</xml>
</html>

レンダリングされたHTML。

標準時を使用した日時書式設定

このtrue関数は、基準タイム・ゾーンの夏時間スケジュールに従って日時要素をレンダリングするために使用されます。基準タイム・ゾーンはインストール表に指定され、データベース・タイム・ゾーンを表します。この設定を使用した入力要素の場合、入力されたすべての時間は基準タイム・ゾーンの夏時間スケジュールに対応していると想定されます。標準時に明確に変換できない時間が入力された場合、ユーザーは、タイム・ゾーン・ラベルを提供して、夏時間または標準時のいずれが入力されたかを指定するように要求されます。


構文
oraType="dateTime; stdTime:true;"

<html>
<body>
<table summary="" border="0" cellpadding="1" cellspacing="1">
   <tr>
      <td>Date time: </td>
      <td><span oraField="dateTime" oraType="dateTime; stdTime:true;"></span></td>
   </tr>
   <tr>
      <td>Date time: </td>
      <td><input oraField="dateTime" oraType="dateTime; stdTime:true;"/></td>
   </tr>
</table>
</body> 
<xml>
<root>
   <dateTime>2009-11-01-00.28.54</dateTime>
</root>
</xml>
</html>

レンダリングされたHTML。

注意: 1:28はあいまいであるため、タイム・ゾーン・ラベルが表示されます。法的に、夏時間(DST)は2:00 AMに削除されるため、November 1, 2009 1:28 AMは2回発生します。stdTime関数のタイム・ゾーン・ラベルが表示されるのは、時間の重複を明確にする必要がある場合のみです。

翌日に対してレンダリングされたHTML。

oraType="dateTime; stdTime:true"に対してレンダリングされたHTML (翌日)

タイム・ゾーン参照を使用した日時書式設定


構文	有効値	摘要
oraType="dateTime; stdTimeRef: ;"	コロンの後ろでXPathを参照します。	この関数は、XPathの参照先タイム・ゾーンのスケジュールに従って日時要素をレンダリングするために使用されます。処理された時間は参照先タイム・ゾーンの標準時に保存されていると想定されるため、夏時間のシフトのみが実行され、タイム・ゾーンのシフトは実行されません。
oraType="dateTime; displayRef: ;"	コロンの後ろでXPathを参照します。	この関数はstdTimeRef関数と似ていますが、夏時間のシフトに加えてタイム・ゾーンのシフトを実行する点が異なります。displayRefを正確に使用するには、基準タイム・ゾーンに保存されているタイム・ゾーン要素にのみ関連付けます。

入力要素の場合、入力されたすべての時間は参照先タイム・ゾーンの夏時間スケジュールに対応していると想定されます。標準時に明確に変換できない時間が入力された場合、ユーザーは、タイム・ゾーン・ラベルを提供して、夏時間または標準時のいずれが入力されたかを指定するように要求されます。

<html>
<body>
<table summary="" border="0" cellpadding="1" cellspacing="1">
   <tr>
      <td>Date time: </td>
      <td><span oraField="dateTime" oraType="dateTime; stdTimeRef:timeZone;"></span></td>
   </tr>
   <tr>
      <td>Date time: </td>
      <td><input oraField="dateTime" oraType="dateTime; stdTimeRef:timeZone;"/></td>
   </tr>
</table>
</body>
<xml>
<root>
   <timeZone>US-EAST</timeZone>
   <dateTime>2009-11-01-00.28.54</dateTime>
</root>
</xml>
</html>

レンダリングされたHTML。

注意: 参照先タイム・ゾーンのタイム・ゾーン・ラベルは常に表示されます。

翌日に対してレンダリングされたHTML。

oraType="dateTime; stdTimeRef:xpath"に対してレンダリングされたHTML (翌日)

期間書式設定


構文
oraType="duration"

この関数は、期間を表示するために使用されます。入力要素の場合、ユーザーが入力した値は、必要に応じて分数から時間数と分数に変換されます。たとえば、入力値'90'は、入力フィールドから[Tab]キーで移動すると、'00:01:30'に変換されます。

<html>
<body>
<table summary="" border="0" cellpadding="1" cellspacing="1">
   <tr>
      <td>Duration: </td>
      <td><span oraField="duration" oraType="duration"></span></td>
   </tr>
   <tr>
      <td>Duration: </td>
      <td><input oraField="duration" oraType="duration"/></td>
   </tr>
</table>
</body>
<xml>
<root>
   <duration>90</duration>
</root>
</xml>
</html>

レンダリングされたHTML。

月日書式設定


構文
oraType="dayInMonth"

この関数は、連結された月と日を表示するために使用されます。

<html>
<body>
<table summary="" border="0" cellpadding="1" cellspacing="1">
   <tr>
      <td>Day In Month: </td>
      <td><span oraField="dayMonth" oraType="dayInMonth"></span></td>
   </tr>
   <tr>
      <td>Day In Month: </td>
      <td><input oraField="dayMonth" oraType="dayInMonth"/></td>
   </tr>
</table>
</body>
<xml>
<root>
   <dayMonth>0228</dayMonth>
</root>
</xml>
</html>

レンダリングされたHTML。

年月書式設定


構文
oraType="monthInYear"

この関数は、連結された年と月を表示するために使用されます。

<html>
<body>
<table summary="" border="0" cellpadding="1" cellspacing="1">
   <tr>
      <td>Month In Year: </td>
      <td><span oraField="month" oraType="monthInYear"></span></td>
   </tr>
   <tr>
      <td>Month In Year: </td>
      <td><input oraField="month" oraType="monthInYear"/></td>
   </tr>
</table>
</body>
<xml>
<root>
   <month>200811</month>
</root>
</xml>
</html>

レンダリングされたHTML。

金額書式設定

この関数は、数値を金額として表示するために使用されます。通貨に関連する構成オプションについては、表を参照してください。入力要素の場合は、数値以外の値を入力するとエラーが発生します。


構文	摘要
oraType="money: "	コロンの後ろに通貨コードを直接指定します。
oraType="money;currencyRef: "	通貨コードを参照する要素のXPathを参照します(コロンの後ろ)。
oraType="money"	通貨または通貨参照が指定されていない場合は、インストール通貨が使用されます。

注意: 右揃えのために、マップのヘッダーにスタイルシート参照のcisEnabledとcisDisabledのペアを指定する必要があります。スタイルシートによって、フィールドのレンダリング方法が制御されます。レンダリングを変更する場合は、oraMoneyスタイルを上書きする必要があります。

<html>
<head>
    <link rel="stylesheet" type="text/css" href="cisDisabled.css"/>
    <link rel="stylesheet" type="text/css" href="cisEnabled.css"/>
</head>
<body>
<table summary="" border="1" cellpadding="1" cellspacing="1">
   <tr>
      <td>Amount, currency specified:</td>
      <td><span oraType="money:EUR" oraField="totalAmt"></span></td>
   </tr>
   <tr>
      <td>Amount, default currency:</td>
      <td><span oraType="money" oraField="totalAmt"></span></td>
   </tr>
   <tr>
      <td>Amount, default input:</td>
      <td><input oraType="money" oraField="totalAmt"/></td>
   </tr>
   <tr>
      <td>Amount, currency reference:</td>
      <td><input oraType="money;currencyRef:cur" oraField="totalAmt"/></td>
   </tr>
</table>
</body>
<xml>
<root>
   <totalAmt>50500.09</totalAmt>
   <cur>EUR</cur>
</root>
</xml>
</html>

レンダリングされたHTML

数値書式設定

この関数は、数値を表示または入力値を検証するために使用されます。入力要素の場合は、数値以外の値を入力するとエラーが返されます。


構文
oraType="number"

注意: 右揃えのために、マップのヘッダーにスタイルシート参照のcisEnabledとcisDisabledのペアを指定する必要があります。スタイルシートによって、フィールドのレンダリング方法が制御されます。レンダリングを変更する場合は、oraNumberスタイルを上書きする必要があります。

<html>
<head>
    <link rel="stylesheet" type="text/css" href="cisDisabled.css"/>
    <link rel="stylesheet" type="text/css" href="cisEnabled.css"/>
</head>
<body>
<table summary="" border="1" cellpadding="1" cellspacing="1">
   <tr>
      <td>Count:</td>
      <td><span oraType="number" oraField="count"></span></td>
   </tr>
   <tr>
      <td>Count, input:</td>
      <td><input oraType="number" oraField="count"/></td>
   </tr>
</table>
</body>
<xml>
<root>
   <count>989</count>
</root>
</xml>
</html>

レンダリングされたHTML。

外部キー参照書式設定

デフォルトでは、fkRef oraType付きの要素が表示されると、情報文字列、コンテキスト・メニュー、ナビゲーションおよび検索が有効になります(外部キー参照が適切に構成されている場合)。これらの機能を選択的にオフにできる構文が用意されています。

外部キー・ハイパーリンクを個別に有効化することもできます。詳細は、「フレームワーク・ナビゲーションの埋込み」を参照してください。外部キー参照機能の管理に使用する様々な属性は、次のとおりです。すべてのケースで、デフォルト値はtrueです。この機能を無効にするには、falseの値を使用する必要があります。


構文
oraType="fkRef:true\|false; info:true\|false; context:true\|false; navigation:true\|false; search:true\|false"

fkRef。'true'の値によって、次のすべての外部キー参照処理が有効になります。'false'の値を使用すると、外部キー参照処理が自動的に無効になります。
info。'true'の値によって、UIマップに情報文字列がレンダリングされます(該当する場合)。
context。'true'の値によって、外部キー参照要素の前に表示するコンテキスト・メニューがレンダリングされます(該当する場合)。
navigation。'true'の値によって、情報文字列がハイパーリンクとしてレンダリングされます(該当する場合)。ハイパーリンクをクリックすると、該当するページにナビゲートします。
search。'true'の値によって、検索ゾーンを起動する検索アイコンが表示されます(該当する場合)。

注意: 外部キー・ナビゲーションおよびコンテキスト・メニュー機能は、ポータル・ゾーンに表示されるUIマップに対してのみ使用できます。ビジネス・プロセス・アシスタント・スクリプトの処理中に表示されるUIマップでは、ナビゲーション・オプションをサポートできません。検索機能は、入力HTML要素に対してのみ使用できます。

UIマップ・スキーマ:


<schema>
  <bo fkRef="F1-BOMO"/>
</schema>

UIマップHTML:


<html>
<body>
<table summary="" border="1" cellpadding="1" cellspacing="1">
   <tr>
      <td>Business Object</td>
      <td><span oraField="bo" oraType="fkRef:true; info:true; context:true; navigation:true;"></span></td>
   </tr>
</table>
</body>
<xml>
<root>
   <bo>F1-COUNTRY</bo>
</root>
</xml>
</html>

レンダリングされたHTML。

参照書式設定

この関数は、参照値の摘要を表示するために使用されます。


構文	有効値
oraType="lookup: "	コロンの後ろの参照フィールド名。


<html>
<body>
<table summary="" border="1" cellpadding="1" cellspacing="1">
   <tr>
      <td>Status:</td>
      <td><span oraField="status" oraType="lookup:BATCH_JOB_STAT_FLG"></span></td>
   </tr>
</table>
</body>
<xml>
<root>
   <status>PD</status>
</root>
</xml>
</html>

レンダリングされたHTML。

拡張可能参照書式設定

この関数は、拡張可能参照値の摘要を表示するために使用されます。


構文	有効値
oraType="lookupBO: "	コロンの後ろのビジネス・オブジェクト・コード。


<html>
<body>
<table summary="" border="1" cellpadding="1" cellspacing="1">
   <tr>
      <td>Value:</td>
      <td><span oraField="status" oraType="lookupBO:F1-DeviceDisplayTypes"></span></td>
   </tr>
</table>
</body>
<xml>
<root>
    <status>oraTablet</status>
</root>
</xml>
</html>

レンダリングされたHTML。

特性タイプ書式設定

この関数は、事前定義の特性値の摘要を表示するために使用されます。


構文	有効値
oraType="charType: "	コロンの後ろの特性タイプ。


<html>
<body>
<table summary="" border="1" cellpadding="1" cellspacing="1">
    <tr>
        <td>Skill:</td>
        <td><span oraType="charType:CM-SKILL" oraField="skill"></span></td>
    </tr>
</table>
</body>
<xml>
<root>
    <skill>10</skill>
</root>
</xml>
</html>

レンダリングされたHTML。

管理表書式設定

この関数は、言語表が関連付けられた管理表の摘要を表示するために使用されます。


構文	有効値
oraType="table: "	コロンの後ろの表コード。


<html>
<body>
<table summary="" border="1" cellpadding="1" cellspacing="1">
   <tr>
      <td>Currency:</td>
      <td><span oraType="table:CI_CURRENCY_CD" oraField="curr"></span></td>
   </tr>
</table>
</body>
<xml>
<root>
   <curr>USD</curr>
</root>
</xml>
</html>

レンダリングされたHTML。

グリッドの追加/削除書式設定


構文	摘要
oraType="addGridRow"	addGridRow関数は、UIマップに行の挿入ダイアログを作成するために使用されます。追加のイメージが表示されます。イメージをクリックすると、グリッドに新しい行が挿入されます。リストが空の場合は、空のグリッド行が自動的に追加されます。これは、この属性を使用すると、少なくとも1つのグリッド行が常にユーザーに表示されることを意味します。
oraType="deleteGridRow"	deleteGridRow関数は、UIマップに行の削除ダイアログを作成するために使用されます。削除のイメージが表示されます。イメージをクリックすると、横にある行がグリッドから削除されます。

注意: 追加および削除ダイアログは表の内部にのみ関連するため、これらの属性は<td>要素内に指定する必要があります。

警告: これらの属性は、'update'ではなく'replace'のビジネス・オブジェクト処理とともに使用するように設計されています。したがって、マップにグリッドが含まれている場合は、'replace'のビジネス・オブジェクト処理を使用してビジネス・オブジェクトを更新する必要があります。詳細は、「ビジネス・オブジェクトの置換処理」を参照してください。

例:

<html>
<head>
<title>Demonstrate Grid Add and Grid Delete OraTypes</title>
    <link rel="stylesheet" type="text/css" href="cisDisabled.css"/>
    <link rel="stylesheet" type="text/css" href="cisEnabled.css"/>
</head>
<body>
<table oraList="listEntry">
   <thead>
      <tr>
         <th/>
         <th/>
         <th><span>Date</span></th>
         <th><span>Amount</span></th>
      </tr>
      <tr/>
   </thead>
   <tr>
      <td oraType="addGridRow"></td>
      <td oraType="deleteGridRow"></td>
      <td>
         <input oraField="date" oraType="date"></input>
      </td>
      <td align="right">
         <input oraField="amount" oraType="money"></input>
      </td>
   </tr>
</table>
</body>
<xml>
<root>
   <listEntry>
      <date>2008-01-01</date>
      <amount>44.28</amount>
   </listEntry>
   <listEntry>
      <date>2008-02-01</date>
      <amount>32.87</amount>
   </listEntry>
   <listEntry>
      <date>2008-03-01</date>
      <amount>21.76</amount>
   </listEntry>
</root>
</xml>
</html>

レンダリングされたHTML。

書式設定前要素

この関数は、レンダリングするスキーマ要素に定義されているとおりに未処理データを含む要素のコンテンツを表示するために使用されます。


構文
oraType="raw"

UIマップ・スキーマ:


<schema>
    <rawStuff type="raw"/>
</schema>

UIマップHTML:


<html>
<head>
   <link rel="stylesheet" type="text/css" href="cisDisabled.css"/>
   <link rel="stylesheet" type="text/css" href="cisEnabled.css"/>
</head>
<body>
<table summary="" border="1" cellpadding="1" cellspacing="1">
   <tr>
      <td>Raw Stuff:</td>
      <td><span oraType="raw" oraField="rawStuff"></span></td>
   </tr>
</table>
</body>
<xml>
<root>
   <rawStuff>
      <ele1>text in element 1</ele1>
      <group1>
         <ele2>text inside element 2, group 1</ele2>
         <ele3>text inside element 3, group 1</ele3>
      </group1>
   </rawStuff>
</root>
</xml>
</html>

レンダリングされたHTML。

文字列書式設定

この関数は、要素にエスケープしたXMLが含まれている場合に、その要素のコンテンツをXML pretty-printとして表示するために使用されます。


構文
oraType="xmlString"

注意: 必須ではありませんが、マップのヘッダーにスタイルシート参照のcisEnabledとcisDisabledのペアを指定すると、レンダリングされるXMLのpretty-printが拡張されます。

例:

<html>
<head>
   <link rel="stylesheet" type="text/css" href="cisDisabled.css"/>
   <link rel="stylesheet" type="text/css" href="cisEnabled.css"/>
</head>
<body>
<table summary="" border="1" cellpadding="1" cellspacing="1">
   <tr>
      <td>XML Stuff:</td>
      <td><span oraType="xmlString" oraField="xmlStuff"></span></td>
      </tr>
</table>
</body>
<xml>
<root>
   <xmlStuff>
      <ele1>text in element 1</ele1>
      <group1>
         <ele2>text inside element 2, group 1</ele2>
         <ele3>text inside element 3, group 1</ele3>
      </group1>
   </xmlStuff>
</root>
</xml>
</html>

レンダリングされたHTML。

oraType=”xmlString”なしでレンダリングされたHTML

HTML書式設定

この関数は、要素のコンテンツをプレーン・テキストではなくHTMLとして表示するために使用されます。oraType="fkref"として定義された要素は自動的にHTMLとしてレンダリングされます。


構文
oraType="html"

警告:

不当なHTMLが実行されないように、一部のHTMLタグはサポートされていません。サポートされているタグのリストは、"F1-HTMLWhiteList"管理対象コンテンツ定義に定義されています。

未サポートのHTMLが検出された場合は、その要素全体がエスケープされ、プレーン・テキストとしてレンダリングされます。したがって、有効なHTMLが含まれていないと想定している場合は、最終的なHTML要素に影響を与えるソース文字列を適切にエスケープすることをお薦めします。この方法によって、要素全体ではなく、問題の文字列のみがエスケープされます。

HTML要素がスクリプトで構成されている場合、詳細は、「データの編集構文」で説明されているescape関数を参照してください。Javaで構成されたテキストをエスケープする場合は、WebStringUtilities.asHTML java APIを使用します。


<html>
<head>
   <link rel="stylesheet" type="text/css" href="cisDisabled.css"/>
   <link rel="stylesheet" type="text/css" href="cisEnabled.css"/>
</head>
<body>
<table summary="" border="0" cellpadding="1" cellspacing="1">
   <tr>
   <td>Info :</td>
   <td><span oraType="html" oraField="info"></span></td>
   </tr>
</table>
</body>
<xml>
<root>
   <info><b>text in bold</b></info>
</root>
</xml>
</html>

レンダリングされたHTML。

oraType="html"なしでレンダリングされたHTML

ラベルの表示

要素からのラベルの導出

この属性は、<span>、<td>または<input> HTML要素に対して言語依存のラベルを取得するために使用されます。


構文	有効値
oraLabel=" "	UIマップ・スキーマの要素のXPath。要素は、mapField=、mdField=またはlabel=属性のいずれかを参照する必要があります。

注意: ラベル定義の場合は、HTMLにフィールドを直接定義することもできます。詳細は、「フィールドからのラベルの導出」を参照してください。

注意: スキーマに複数の属性が含まれている場合、oraLabel属性は、次の階層に従って、レンダリングするラベルを選択します。label属性はmdField属性を、mdField属性はmapField属性を順に上書きします。

UIマップ・スキーマ:

<schema>
   <user mapField="USER_ID"/> 
   <info type="group" mapXML="CLOB">
      <city label="Metro Area"/> 
      <age mdField="AGE_LBL"/>
   </info> 
</schema>

HTML:

<html>
<head><title oraMdLabel="BUS_LBL"></title></head>
<body>
<table>
   <tr>
      <td oraLabel="user"></td>
      <td><input oraField="user"/></td>
   </tr>
   <tr>
      <td oraLabel="info/city"></td>
      <td><input oraField="info/city"/></td>
   </tr>
   <tr>
      <td oraLabel="info/age"></td>
      <td><input oraField="info/age"/></td>
   </tr>
   <tr>
      <td/>
      <td><input type="button" oraMdLabel="ACCEPT_LBL"/></td>
   </tr>
</table>
</body>
<xml>
<root>
   <user>RWINSTON</user>
   <info>
      <city>Alameda</city>
      <age>32</age>
   </info>
</root>
</xml>
</html>

レンダリングされたHTML:

フィールドからのラベルの導出

この属性は、<span>、<td>、<input>または<title> HTML要素に対して言語依存のラベルを取得するために使用されます。ラベル・テキストは、参照先のフィールドから導出されます。


構文	有効値
oraMdLabel=" "	メタデータ・フィールド・コード。

注意: マップのスキーマ定義から導出されるラベルを定義することもできます。詳細は、「要素からのラベルの導出」を参照してください。

HTML:

<html>
<head><title oraMdLabel="F1_DETAILS_LBL"></title></head>
<body>
<table>
   <tr>
      <td oraLabel="user"></td>
      <td><input oraField="user"/></td>
   </tr>
   <tr>
      <td oraLabel="info/city"></td>
      <td><input oraField="info/city"/></td>
   </tr>
   <tr>
      <td oraLabel="info/age"></td>
      <td><input oraField="info/age"/></td>
   </tr>
   <tr>
      <td/>
      <td><input type="button" oraMdLabel="ACCEPT_LBL"/></td>
   </tr>
</table>
</body>
<xml>
<root>
   <user>RWINSTON</user>
   <info>
      <city>Alameda</city>
      <age>32</age>
   </info>
</root>
</xml>
</html>

レンダリングされたHTML:

UIマップ・ヘルプの有効化

「ラベルの表示」の項では、基礎となるメタデータ・フィールドを使用して、要素のラベルを導出する方法を説明しています。さらに、同じメタデータ・フィールドにヘルプ・テキストが含まれている場合は、要素ラベルの横にツール・チップが自動的に生成されます。ツール・チップをクリックすると、ユーザーはヘルプ・テキストを表示できます。

ツール・チップのレンダリングを変更できます。詳細は、「カスタム・ルック・アンド・フィール・オプション」を参照してください

ポップアップ・エクスプローラ・ゾーンを使用した検索

検索オプション

この属性は、入力HTML要素に対して検索ゾーン機能を有効にするために使用されます。


構文	有効値
oraSearch=" "	ゾーン・コード。

注意: oraSearch属性はoraSchemaDataTypes属性を介してHTMLに自動的に組み込まれるため、oraType属性と類似しています。これは、UIマップHTMLへのoraSearch属性のコーディングは、検索ゾーンがスキーマ、またはスキーマ要素の外部キー参照に指定されていない場合にのみ必要であることを意味します。

HTMLでの検索の定義例。UIマップのスキーマ:

<schema>
   <uiMap/> 
</schema>

UIマップのHTML:

<html>
<body>
<table summary="" border="1" cellpadding="1" cellspacing="1">
   <tr>
      <td>UI Map with Search </td>
      <td><input oraField="uiMap" oraSearch="F1-UISRCH"></td>
   </tr>
</table>
</body>
<xml>
<root>
   <uiMap/>
</root>
</xml>
</html>

スキーマでの検索の定義例。UIマップのスキーマ:

<schema> 
   <uiMap search="F1-UISRCH"/>
</schema>

UIマップのHTML:

<html>
<body>
<table summary="" border="1" cellpadding="1" cellspacing="1">
   <tr>
      <td>UI Map with Search </td>
      <td><input oraField="uiMap"></td>
   </tr>
</table>
</body>
<xml>
<root>
   <uiMap/>
</root>
</xml>
</html>

外部キー参照で検索ゾーンが定義されている例。UIマップのスキーマ:


<schema>
   <uiMap fkRef="F1-UISRC"/> 
</schema>

UIマップのHTML:

<html>
<body>
<table summary="" border="1" cellpadding="1" cellspacing="1">
   <tr>
      <td>UI Map with Search </td>
      <td><input oraField="uiMap"></td>
   </tr>
</table>
</body>
<xml>
<root>
   <uiMap/>
</root>
</xml>
</html>

すべてのケースで、レンダリングされるHTMLは同じです。

検索フィールドの初期化

このオプションの属性は、検索ゾーンのフィルタを初期化するために使用されます。複数のフィルタを初期化できます。この属性は、oraSearch属性と組み合せてのみ使用できます。


構文	有効値	フィールド値のオプション	コメント
oraSearchField=" "	コロンで区切られた1つ以上のフィールド名とフィールド値のペア。各ペアはセミコロンで区切られます。 oraSearchField="fieldName:fieldValue: ..." フィールド名は、検索ゾーンの起動時に初期化するゾーン・フィルタを識別するために使用されます。フィールド名は、検索ゾーンのユーザー・フィルタまたは非表示フィルタ・パラメータに指定されたsearchFieldニーモニックの値と一致する必要があります。	値なし	フィールド値を指定しない場合は、oraSearchField属性が含まれる入力要素の値が使用されます。
		XPath	使用する値が含まれるスキーマ要素へのXPathを指定します。
		'リテラル'	提供するリテラル値を指定します。

注意: oraSearchField属性を指定せず、スキーマ要素に検索を使用可能にするfkRefが指定されている場合、フレームワークでは、フィールド名が外部キー参照のキー(メタデータ)フィールドと等しいoraSearchFieldが自動的に作成されます。

警告: ポップアップ・エクスプローラ・ゾーンは、次の2つの方法のいずれかで起動できます: 検索ボタンをクリックするか、ボタンの左にあるフィールドで[Enter]キーを押します。ボタンをクリックした場合、検索フィールドの情報はゾーンに渡されません。検索フィールドの情報は、[Enter]キーの押下時にゾーン・フィルタの値を初期化するためにのみ使用されます。

次の例に示すように、2つのフィルタ値が初期化されます。

<schema>
   <bo/> 
   <uiMap/>
</schema>

<html>
<body>
<table summary="" border="1" cellpadding="1" cellspacing="1">
   <tr>
      <td>UI Map with Search </td>
      <td><input oraField="uiMap" oraSearch="F1-UISRCH" oraSearchField="MAP_CD; BUS_OBJ_CD:bo;"></td>
    </tr>
</table>
</body>
<xml>
<root>
   <bo/>
   <uiMap/>
</root>
</xml>
</html>

返された検索フィールドのマッピング

このオプションの属性は、検索ゾーンから返された値を送信するために使用されます。複数のフィールドを指定できます。この属性は、oraSearch属性と組み合せてのみ使用できます。


構文	有効値	フィールド値のオプション	コメント
oraSearchOut=" "	コロンで区切られた1つ以上のフィールド名とフィールド値のペア。各ペアはセミコロンで区切られます。 oraSearchOut="field name:xpath target; ..." フィールド名は、問合せゾーンから返された検索結果を識別するために使用されます。フィールド名は、エクスプローラ・ゾーンの検索結果パラメータ内に定義されたELEMENT_NAMEニーモニックと一致する必要があります。	値なし	フィールド値を指定しない場合は、oraSearchField属性が含まれる入力要素が戻り値を受け取ります。
oraSearchOut=" "		XPath	戻り値を受け取るスキーマ要素へのXPathを指定します。

注意: oraSearchOut属性を指定しない場合、フレームワークでは、フィールド名がoraSearchFieldのフィールド名と同じに設定されたデフォルトが作成されます。

次の例では、2つの値が返されます。

<schema>
   <bo/>
   <mo/>
</schema>

<html>
<body>
<table summary="" border="1" cellpadding="1" cellspacing="1">
   <tr>
      <td>BO Search </td>
      <td><input oraField="bo" oraSearch="Z1-BOSRCH" oraSearchOut="BUS_OBJ_CD; MO_CD:mo;"></td>
   </tr>
</table>
</body>
<xml>
<root>
   <bo/>
   <mo/>
</root>
</xml>
</html>

エラーの表示

エラー変数の表示

次のいずれかのエラー変数を表示できます。


構文
oraErrorVar="ERRMSG-TEXT"
oraErrorVar="ERRMSG-LONG"
oraErrorVar="ERRMSG-CATEGORY"
oraErrorVar="ERRMSG-NUMBER"

...
<table width="100%" cellpadding="12">
   <tr class="oraErrorText">
      <td>
         <a href="" onclick="oraShowErrorAlert(); return false;">
            <span  class="oraErrorText" oraErrorVar="ERRMSG-TEXT"></span>
         </a>
      </td>
   </tr>
</table>
...

レンダリングされたHTML

エラーのフィールドのハイライト表示

注意: エラーのスローの詳細は、「データの編集構文」の「terminate文」を参照してください。


構文	コメント
oraError="automate:true\|false; prefix: "	automate:trueを指定すると、エラーが発生したときにエラー状態の要素を自動的にハイライト表示できます。trueがデフォルトのため、指定する必要がないことに注意してください。フィールドのハイライト表示をオフにするには、automate:falseを指定します。
	システムでは、エラー状態の参照先要素名をUIマップの要素名と照合します。スキーマの要素が、エラーによって参照された内容と照合できないXPath内にある場合は、prefix:XPathを使用して指定します。

注意: oraErrorスタイルの参照のために、スタイルシート参照のcisEnabledとcisDisabledのペアを指定する必要があります。スタイルシートによって、エラー状態のフィールドのレンダリング方法が制御されます。レンダリングを変更する場合は、oraErrorスタイルを上書きする必要があります。

次のHTMLの例は、マップの要素がboGroupと呼ばれるグループ内に定義されていることを示しています。エラーによって返される要素名にはこのグループは含まれないため、フィールドのハイライト表示を適切に行うには、prefix:属性でグループ名を指定する必要があります。

<html>
<head>
   <title>User Zone Input</title>
   <link rel="stylesheet" type="text/css" href="cisDisabled.css"/>
   <link rel="stylesheet" type="text/css" href="cisEnabled.css"/>
</head>
<body oraError="automate:true; prefix:boGroup">
<table width="100%" cellpadding="12">
   <tr class="oraErrorText">
      <td>
         <a href="" onclick="oraShowErrorAlert(); return false;">
            <span  class="oraErrorText" oraErrorVar="ERRMSG-TEXT"></span>
         </a>
      </td>
   </tr>
</table>
<table width="100%" border="0" cellpadding="4">
   <tr style="padding-top:30px;">
      <td align="right" class="label">User Id</td>
      <td>
         <span oraField="boGroup/userId" class="normal"/>
      </td>
   </tr>
   <tr>
      <td align="right" class="label">First Name</td>
      <td>
         <input oraField="boGroup/firstName" class="normal"/>
      </td>
   </tr>
   <tr>
      <td align="right" class="label">Last Name</td>
      <td>
         <input oraField="boGroup/lastName" class="normal"/>
      </td>
   </tr>
</table>
</body>
<xml>
<root>
   <boGroup>
      <userId>BOND007</userId>
      <firstName>James</firstName>
      <lastName></lastName>
   </boGroup>
</root>
</xml>
</html>

レンダリングされたHTML (スローされたエラーが'lastName'と等しい場合):

oraErrorを使用してbodyタグ内に自動的にレンダリングされたoraError要素

エラー要素名の上書き

まれな状況で、エラーによって返される要素名がマップの要素名と一致しない場合は、明示的な属性を追加してエラー要素名を指定できます。


構文	有効値	コメント
oraErrorElement=	"要素名"	ここで参照される名前は、エラーがスローされたときに割り当てられるエラー要素の名前と正確に一致する必要があります。同じエラー要素名で複数のHTMLフィールドを参照できます。

これは、エラーに関連付けられた要素名がマップの要素名と異なるシナリオを示しています。

<html>
<head>
   <title>User Zone Input</title>
   <link rel="stylesheet" type="text/css" href="cisDisabled.css"/>
   <link rel="stylesheet" type="text/css" href="cisEnabled.css"/>
</head>
<body>
<table width="100%" cellpadding="12">
   <tr class="oraErrorText">
      <td>
         <a href="" onclick="oraShowErrorAlert(); return false;">
            <span  class="oraErrorText" oraErrorVar="ERRMSG-TEXT"></span>
         </a>
      </td>
   </tr>
</table>
<table width="100%" border="0" cellpadding="4">
   <tr style="padding-top:30px;">
      <td align="right" class="label">User Id</td>
      <td>
         <span oraField="userId" class="normal"/>
      </td>
   </tr>
   <tr>
      <td align="right" class="label">First Name</td>
      <td>
         <input oraField="firstName" class="normal" oraErrorElement="firstName"/>
      </td>
   </tr>
   <tr>
      <td align="right" class="label">Last Name</td>
      <td>
         <input oraField="familyName" class="normal"  oraErrorElement="lastName"/>
      </td>
   </tr>
</table>
</body>
<xml>
<root>
   <userId>BOND007</userId>
   <firstName>James</firstName>
   <familyName></familyName>
</root>
</xml>
</html>

レンダリングされたHTML。

エラー・ポップアップの表示

エラー・テキストが表示される場合は、この関数を使用して、ユーザーがエラー・メッセージをクリックしたときに標準のエラー・ダイアログ(詳細情報を表示する)をポップアップできます。


構文
oraShowErrorAlert(); return false;

<html>
<head>
   <link rel="stylesheet" type="text/css" href="cisDisabled.css"/>
   <link rel="stylesheet" type="text/css" href="cisEnabled.css"/>
</head>
<body>
<table width="100%" cellpadding="12">
   <tr class="oraErrorText">
      <td>
         <a href="" onclick="oraShowErrorAlert(); return false;">
            <span  class="oraErrorText" oraErrorVar="ERRMSG-TEXT"></span>
         </a>
      </td>
   </tr>
</table>
<table>
   <tr>
      <td >Address:</td>
      <td><input type="text" oraField="address"/></td>
   </tr>
   <tr>
      <td>City:</td>
      <td><input type="text" oraField="city"/></td>
   </tr>
   <tr>
      <td>State:</td>
      <td><input type="text" oraField="state"/></td>
   </tr>
   <tr>
      <td>Zip:</td>
      <td><input type="text" oraField="zip"/></td>
   </tr>
   <tr>
      <td/>
      <td style="padding-top=15px;">
         <oraInclude map="F1-SaveCancelButtons"/>
      </td>
   </tr>
</table>
</body>
<xml>
<root>
   <address>123 Main St</address>
   <city>Alameda</city>
   <state>CA</state>
   <zip>94770</zip>
</root>
</xml>
</html>

レンダリングされたHTML。

エラー・メッセージのクリックによって起動された標準のポップアップ・ダイアログ:

ブラウザ・イベントに対するJavaScriptの起動

JavaScriptフレームワークの使用

HTML/Javascript環境内で使用できる多数のJavaScriptイベントがあります。これには、onLoad、onBlur、onChangeなどのイベントが含まれます。UIマップ・フレームワークでもこれらのイベントの一部を利用します。一貫した結果を取得するには、開発するUIマップがフレームワークと連携することが重要です(イベントは常に同じ順序で実行されるとはかぎりません)。

警告:

次に、UIマップでフィールドの更新を安全にロードして処理するための推奨方法について説明します。

XHTML UIマップまたはフラグメント内でJavaScriptが必要な場合は、![CDATA[ ]]タグ内にバインドして、有効なXMLドキュメントを確保する必要があります。タグ自体はコメントアウトして、古いブラウザとの互換性の促進が必要な場合があります。次に例を示します。


<script type="text/javascript">
/* <![CDATA[ */

//
// javascript
//

/* ]]> */

</script>

要素変更イベント


構文	有効値
oraChange=" "	JavaScript関数。

UIマップのロード時に、HTML要素にすでに添付されているイベント・ハンドラがある場合、フレームワークではそのイベント・ハンドラを削除して、結合されているイベント・ハンドラを添付します。結合されているハンドラは、最初にフレームワークのハンドラをコールし、次のその他(カスタム)のハンドラをコールします。

警告: この関数は、関連するフィールド・データ値を再度変更するロジックの実行には使用できません(使用すると、無限ループが発生します)。

次の例では、ボタンがクリックされるとoraInvokeBS関数が実行されます。

<html>
  <head>
    <title>oraInvokeBS test</title>
  </head>
  <body>
    <table>
      <tr>
        <td>User Id:</td>
        <td>
          <input oraField= "xmlGroup/userId"/>
          <input type="button" value="Search" oraChange="oraInvokeBS('UserSearch','xmlGroup');"/>
        </td>
      </tr>
      <tr>
        <td/>
        <td>Search Results</td>
      </tr>
      <tr>
        <td/>
        <td>
          <table oraList="xmlGroup/searchList">
            <tr>
              <td><span oraField="userId"></span>
              </td>
            </tr>
          </table>
        </td>
      </tr>
    </table>
  </body>
  <xml>
    <root>
      <xmlGroup>
        <userId/>
        <searchList>
            <userId></userId>
        </searchList>
      </xmlGroup>
    </root>
  </xml>
</html>

ページ・ロード・イベント


構文	有効値
oraLoad=" "	JavaScript関数。

警告: フラグメントUIマップ内でoraLoadを実行し、ページ・ロード中にJavaScript関数を実行する必要がある場合(関数でビジネス・オブジェクト、ビジネス・サービスまたはサービス・スクリプトを起動する場合)は、特別な構文"oraLoad[$SEQUENCEID]"を使用できます。マップ・フラグメントで使用するその他の特別な構文については、「ポータル・ゾーン・ヘッダーの構成」の項を参照してください。

次の例では、ページ・ロード中にoraDisplayNone関数が実行されます。

<html>
<body>
<table summary="" border="1" cellpadding="1" cellspacing="1">
    <tr>
        <td oraLoad="oraDisplayNone(item,'userId','')">User Id: </td>
        <td><span oraField="userId"></span></td>
    </tr>
</table>
</body>
<xml>
<root>
    <userId>SPLAXT</userId>
</root>
</xml>
</html>

レンダリングされたHTML

ページ・ロード・イベント後


構文	有効値
oraAfterLoad=""	JavaScript関数。

次の例では、ページ・ロード後にoraGetValueFromScript関数が実行されます。

<div>
  <label for="boGroup_parameters_externalSystem" oraLabel="boGroup/parameters/externalSystem">
  </label>
    <span>
      <select oraSelect="bs:F1-RetrieveExternalSystems" class="oraInput" 
        id="boGroup_parameters_externalSystem" oraField="boGroup/parameters/externalSystem" 
        oraSelectOut="valuePath:results/externalSystem; descPath:results/description" 
        oraSelectIn="outboundMsgType:boGroup/parameters/outboundMsgType" 
        oraAfterLoad
        ="oraGetValueFromScript(document.getElementById('boGroup_parameters_externalSystem');">
      </select>
    </span>

</div>

要素の非表示

関数を使用した非表示

システムには、HTML要素を非表示にするための複数の手法が用意されています。


構文	有効値	コメント
oraDisplayNone(item );	(item, 'XPath', '値', '演算子')	別の要素(そのXPathを使用して参照されている)の値に基づいて、要素を非表示にするために使用されます。空白値を問い合せるために' 'の値を入力します。デフォルトでは、演算子は'='です。かわりに、'!='、'>'または'<'などの別の演算子を設定できます。
oraDisplayNone(item );	(item, 関数名,true \| false)	ブールを返すJavaScript関数を指定するために使用されます。
oraIsSuppress="true"		このオプションは、常に非表示にする必要があり、他のものに依存しないフィールドに使用します。この属性はHTML要素(div要素)で設定します。

ユーザーIDの値が存在しない場合にユーザーIDのラベルが非表示になる例。

<html>
<body>
<table summary="" border="1" cellpadding="1" cellspacing="1">
    <tr>
        <td oraLoad="oraDisplayNone(item,'userId','')">User Id: </td>
        <td><span oraField="userId"></span></td>
    </tr>
</table>
</body>
<xml>
<root>
    <userId></userId>
</root>
</xml>
</html>

アプリケーション・サービス'F1-DFLTS'の変更('C')処理へのセキュリティ・アクセス権がユーザーにない場合に、「Save」ボタンが非表示になる例。

<html>
<body>
<table summary="" border="1" cellpadding="1" cellspacing="1">
    <tr>
   <td oraLoad="oraDisplayNone(item, oraHasSecurity('F1-DFLTS', 'C'), false );">
      <input name="Save" type="button" onclick="oraInvokeBO('CM-IndividualTaxpayer', null, 'replace')"/>
   </td>
    </tr>
</table>
</body>
<xml>
<root>
    <userId></userId>
</root>
</xml>
</html>

ユーザーのセキュリティ・アクセス権のチェック

システムには、特定のアプリケーション・サービスおよびアクセス・モードへのユーザーのセキュリティ・アクセス権をチェックする2つの関数が用意されています。通常、これらは要素を非表示にするために使用されます。


構文	パラメータ
oraHasSecurity( )	'アプリケーション・サービス・コード'
oraHasSecurity( )	'アクセス・モード'
oraHasSecurityPath('x','y')	'アプリケーション・サービスのXPath'
oraHasSecurityPath('x','y')	'アクセス・モードのXPath'

oraHasSecurity関数の例は、前の項を参照してください。次に、アプリケーション・サービス'FORMTST'のアクセス・モード'ACT'へのセキュリティ・アクセス権がユーザーにない場合に、ステータス・ボタンが非表示になる例を示します。

<html>
<body>
<table>
    <tr>
   <td oraLoad="oraDisplayNone(item, oraHasSecurityPath('appService', 'accessMode'), false );">
      <input oraField="statusLabel" type="button" onclick="oraRunScript('UpdateState','status');"/>
   </td>
    </tr>
</table>
</body>
<xml>
<root>
    <status>ACTIVATE</status>
<statusLabel>Activate</statusLabel>
<appService>FORMTST</appService>
    <accessMode>ACT</accessMode>
</root>
</xml>
</html>

スキーマベース・サービスの起動

システムには、ビジネス・オブジェクト、ビジネス・サービスまたはサービス・スクリプトを起動するための関数が用意されています。

ビジネス・オブジェクトの起動関数

この関数は、ビジネス・オブジェクト相互作用をUIマップのHTMLから直接実行するために使用されます。起動でエラーが発生したかどうかに応じて、'true'または'false'が返されます。


構文	パラメータ	コメント
oraInvokeBO( )	'ビジネス・オブジェクト名'
	'XPath'またはnull	XPathを使用してグループ要素を識別します。nullという語を指定すると、埋込みXMLオブジェクト全体が渡されます。
	'処理'	使用する処理を指定します。有効な値は、add、delete、read、update、replace、fastAddおよびfastUpdateです。ファストパス: 様々なビジネス・オブジェクト処理の詳細は、「ビジネス・オブジェクト処理」を参照してください。

JavaScript関数で文が起動される例。

function invokeBO {
     if (!oraInvokeBO('F1-User','xmlGroup','read')) {
          oraShowErrorAlert();
          return;
}
}

onClick内で文が起動される例。

<input type="button"  class="oraButton" oraMdLabel="DISPLAY_LBL" onClick="oraInvokeBO('F1-User');"/>

ビジネス・サービスの起動関数

この関数は、ビジネス・サービス相互作用をUIマップのHTMLから直接実行するために使用されます。起動でエラーが発生したかどうかに応じて、'true'または'false'が返されます。


構文	パラメータ	コメント
oraInvokeBS( )	'ビジネス・サービス名'
oraInvokeBS( )	'XPath'またはnull	XPathを使用してグループ要素を識別します。nullという語を指定すると、埋込みXMLオブジェクト全体が渡されます。

JavaScript関数内で文がコーディングされた例。

function invokeBS {
     if (!oraInvokeBS('F1-UserSearch','xmlGroup')) {
          oraShowErrorAlert();
          return;
  }
}

onClickを介して文が起動される例。

<input type="button"  class="oraButton" oraMdLabel="DISPLAY_LBL" onClick="oraInvokeBS('F1-RetrieveInfo');"/>

サービス・スクリプトの起動関数

この関数は、サービス・スクリプト相互作用をUIマップのHTMLから直接実行するために使用されます。起動でエラーが発生したかどうかに応じて、'true'または'false'が返されます。


構文	パラメータ	コメント
oraInvokeSS( )	'サービス・スクリプト名'
oraInvokeSS( )	'XPath'またはnull	XPathを使用してグループ要素を識別します。nullという語を指定すると、親ノードに属するドキュメントが渡されます。親ノードでは不十分な場合は、次の構文を使用してドキュメント全体を常に渡すことができます。 `oraInvokeSS('service script', null, null, [$SEQUENCEID])`

JavaScript関数内で文が起動される例。


function invokeSS {
     if (!oraInvokeSS('F1-GetUsers','xmlGroup')) {
          oraShowErrorAlert();
          return;
}
}

onClick内で文が起動される例。

<input type="button"  class="oraButton" oraMdLabel="DISPLAY_LBL" onClick="oraInvokeSS('F1-GetUserInfo');"/>

レンダリングされたマップまたはポータル・ページのリフレッシュ

マップのリフレッシュ

この関数は、コマンドを発行したマップ・ゾーンのみをリフレッシュするために使用されます。


構文
oraRefreshMap;

...
    <tr>
        <td/>
        <td><input type="button" onclick="oraRefreshMap();" value="Refresh"/></td>
    </tr>
...

ページのリフレッシュ

この関数は、ポータル内のすべてのゾーンをリフレッシュするために使用されます。


構文
oraRefreshPage;

...
    <tr>
        <td/>
        <td><input type="button" onclick="oraRefreshPage();" value="Refresh"/></td>
    </tr>
...

フレームワーク・ナビゲーションの埋込み

ナビゲーション・オプションを使用したナビゲート

この関数は、ナビゲーション・オプションで定義した情報を使用して別のページにナビゲートするために使用されます。


構文	パラメータ
oraNavigate( );	'ナビゲーション・オプション・コード'
oraNavigate( );	'キーのXPath'

警告: この関数は、ポータル・ゾーン内で定義されたUIマップのみを対象としています。ビジネス・プロセス・アシスタント・スクリプトで起動されたUIマップ内では使用できません。

次の例では、この関数の考えられる2つの使用方法(URLとして使用、およびボタンとして使用)を示します。UIマップ・スキーマにはfkRef属性が含まれている必要があります。詳細は、「外部キー参照書式設定」を参照してください。

<schema>
    <userId fkRef="CI_USER"/>
</schema>

<html>
<body>
<table summary="" border="1" cellpadding="1" cellspacing="1">
    <tr>
       <td>User Link: </td>
       <td><a href="" onclick="oraNavigate('userMaint','userId'); return false;">
         <span oraField="userId" oraType="fkRef:CI_USER"></span></a>
       </td>
    </tr>
    <tr>
        <td>User Button: </td>
        <td><input type="submit" onclick="oraNavigate('userMaint','userId')" 
          value="Go to User"/></td>
    </tr>
</table>
</body>
<xml>
<root>
    <userId>SPLAXT</userId>
</root>
</xml>
</html>

レンダリングされたHTML。

ビジネス・プロセス・アシスタント・スクリプトの起動


構文	パラメータ	コメント
oraRunScript( );	'ビジネス・プロセス・アシスタント・スクリプト・コード'。
oraRunScript( );	'XPath要素'	一時変数として参照できる1つ以上の要素値をビジネス・プロセス・アシスタントに渡すことができます。

警告: この関数は、ポータル・ゾーンに表示されるUIマップのみに適用できます。実行中のビジネス・プロセス・アシスタント・スクリプト内で起動されたUIマップは、そのUIマップのHTMLから直接別のビジネス・プロセス・アシスタント・スクリプトを起動できません。かわりに、UIマップから値が返され、「スクリプトの実行」または「管理の転送」ステップ・タイプが実行されます。

注意: スクリプトの初期ステップで情報を一時格納から取り出すのはスクリプト作成者の責務です。

次の例では、'personId'という名前の一時変数が値'1234567890'で作成され、'Edit Address'という名前のビジネス・プロセス・アシスタント・スクリプトが起動されます。

<html>
<body>
<table>
   <tr>
      <td>
         <div oraField="address"></div>
         <span oraField="city"></span>
         <span>,</span>
         <span oraField="state"></span>
         <span oraField="zip"></span>
         <span oraField="country"></span>
         <a href="" onClick="oraRunScript('Edit Address','personId');">edit</a>
      </td>
   </tr>
</table>
</body>
<xml>
<root>
   <personId>1234567890</personId>
   <address>123 Main St</address>
   <city>Alameda</city>
   <state>CA</state>
   <zip>94770</zip>
</root>
</xml>
</html>

レンダリングされたHTML。

値を使用したビジネス・プロセス・アシスタント・スクリプトの起動

この関数は、名前と値のペアを指定してビジネス・プロセス・アシスタントを起動し、一時格納にプッシュするために使用されます。複数の値を渡すことができます。ビジネス・プロセス・アシスタント・スクリプトは一時変数を名前で参照できます。


構文	パラメータ	コメント
oraRunScriptWithValues( );	'ビジネス・プロセス・アシスタント・スクリプト・コード'。
oraRunScriptWithValues( );	'XPath要素名':値	1つ以上の要素名と値のペア。

注意: UIマップのXML構造に配置されていない値をビジネス・プロセス・アシスタント・スクリプトにプッシュする必要がある場合は、このJavaScript関数をoraRunScriptのかわりに使用します。

次の例では、'editUser()'という名前のJavaScript関数が、'UserEdit'という名前のビジネス・プロセス・アシスタント・スクリプトを起動します。'userId'という名前の一時変数が値'CMURRAY'で作成されます。

<html>
<head>
<script type="text/javascript">
 
function editUser() {
    var values = {'userId': 'CMURRAY'};
    oraRunScriptWithValues('UserEdit', values);
    return;
}
 
</script>
</head>
<body>
...
</body>
</html>

値がバインドされたUIマップの終了

この関数は、UIマップを終了するために使用されます。マップを終了するときに、スクリプトに戻す値を指定できることに加え、更新されたXMLを戻すかどうかを指定できます。


構文	パラメータ	コメント
oraSubmitMap( );	'戻り値'
oraSubmitMap( );	ブール値	更新されたXMLを戻すかどうかを指定します。デフォルトはtrueです。

次の例では、「Save」ボタンは更新された情報を戻し、「Cancel」ボタンは更新された情報を戻しません。

<html>
<body>
<table>
   <tr>
      <td/>
      <td style="padding-bottom:15px;">
         <a href="" onclick="oraShowErrorAlert(); return false;">
         <span oraErrorVar="ERRMSG-TEXT"></span></a>
      </td>
   </tr>
   <tr>
      <td >Address:</td>
      <td><input type="text" oraField="address"/></td>
   </tr>
   <tr>
      <td>City:</td>
      <td><input type="text" oraField="city"/></td>
   </tr>
   <tr>
      <td>State:</td>
      <td><input type="text" oraField="state"/></td>
   </tr>
   <tr>
      <td>Zip:</td>
      <td><input type="text" oraField="zip"/></td>
   </tr>
   <tr>
      <td/>
      <td style="padding-top=15px;">
         <input type="button" value="Save" onClick="oraSubmitMap('SAVE');"/>
         <input type="button" value="Cancel" onClick="oraSubmitMap('CANCEL',false);"/>
      </td>
   </tr>
</table>
</body>
<xml>
<root>
   <address>123 Main St</address>
   <city>Alameda</city>
   <state>CA</state>
   <zip>94770</zip>
</root>
</xml>
</html>

レンダリングされた「Save」および「Cancel」ボタン:

マップ・フラグメントの包含

この関数は、別のUIマップ内にマップ・フラグメントを埋め込むために使用されます。マップまたはマップ・フラグメント内で包含ノードを使用できることに注意してください。


構文	パラメータ	コメント
<oraInclude map=' ' prefixPath=' '/>	map='UIマップ・コード'
<oraInclude map=' ' prefixPath=' '/>	prefixPath='Xpath'	オプションで、含まれているUIマップ・フラグメントのHTML内に定義されているoraField、oraLabel、oraList、oraSelectのvaluePathとdescPath、oraDownloadDataおよびoraUploadDataの各属性値に追加するXPathのプリフィクスを指定します。注意: この機能がXPath属性値に適用されるのは、その値がoraList属性の下に表示されない場合のみです。oraList属性が含まれる表内のXPath値は、prefixPathによって影響を受けません。

'F1-SaveCancelButtons'という名前の2つのボタンがあるマップ・フラグメントの例。

<input onClick ="oraSubmitMap('SAVE');" oraMdLabel="SAVE_BTN_LBL" class="oraButton" 
type="button"/>
<input onClick ="oraSubmitMap('CANCEL',false);" oraMdLabel="CANCEL_LBL" class="oraButton" 
type="button"/>

'F1-SaveCancelButtons'という名前のマップ・フラグメントを含むマップの例。

...
<tr>
   <td colspan="2" align="center">
<oraInclude map="F1-SaveCancelButtons"/>
   </td>
</tr>
...

Webコンポーネントを含める

Webコンポーネントは、特定のユーザー・インタフェース機能を生成するカスタムHTML要素です。サポートされているそれぞれのWebコンポーネントには通常、Webコンポーネントの機能とその表示方法に影響する1つ以上の定義済HTML属性があります。より複雑なWebコンポーネントには、結果のユーザー・インタフェース要素によって表示される動作および情報を定義する、対応するシステム構成オブジェクトがある場合があります。たとえば、情報の"ツリー"を生成するWebコンポーネントには、ツリーの情報の取得方法およびそれぞれのノードの表示方法に関する詳細を定義するツリー構成表があります。

共通属性

それぞれのWebコンポーネントに使用できる共通属性には、次のものがあります。

生成する詳細を制御する構成オブジェクトの特定のインスタンスへの参照。
コンテキスト・データを名前と値のペアとして渡す機能。
機能のプレビューの表示をサポートする'モード'

属性の中には、参照される単一値をサポートするものがあります。これらのタイプの属性については、次のいずれかの参照を使用して値を指定できます。

リテラル値。この値は直接参照できます。例:
```
treename="F1-Tree"
```
XPath参照。XPath参照では、明示的な構文x[value]を使用する必要があります。例:
```
treename="x[migrationTree]"
```
グローバルまたはポータル・コンテキスト参照。これらの参照では、明示的な構文c[value]を使用する必要があります。
```
treename="c[TREE_NAME]"
```
フィールド・ラベル参照。これらの参照では、明示的な構文md[value]を使用する必要があります。
```
text=md[F1_ADD_LBL]"
```
フィールド・ヘルプ・テキスト参照。これらの参照では、明示的な構文mdh[value] を使用する必要があります。
```
text=mdh[F1_OPERATIONS_LBL]"
```

1つ以上の名前/値のペアをサポートする複合属性については、名前と値を定義する構文は、リテラル値、XPath参照およびコンテキストについて前述したものと同じルールに従います。コロン(":")を使用して名前と値を区切り、セミコロン(";")を使用してそれぞれのペアを区切る必要があります。

context="FIELD_NAME1:x[value1];FIELD_NAME2:F1AB;x[fieldName3]:c[FIELD_NAME3];"

特定のWebコンポーネントには、その機能に固有の追加HTML属性がある場合があります。

注意: Webコンポーネントを定義するUIマップでは、"body"タグ内にF1-OJETLIBSRマップ・フラグメントが含まれている必要があります。

<body>
<oraInclude map="F1-OJETLIBSR"/>
..
</body>

注意: 標準HTML属性を指定することもできます(ID=".."やstyle=".."など)。これらは、通常どおりに定義されます。Webコンポーネント自体がスタイルに関するいくつかの側面を直接制御し、HTML Webコンポーネントで指定されたスタイル設定を上書きする可能性があることに注意してください。たとえば、コンテキスト依存インサイトの構成には、HTMLで定義された色を上書きするテキスト色の設定が用意されています。

次の各項では、サポートされているそれぞれのWebコンポーネントについて説明します。

ツリー

ツリー構成の詳細は、「ツリー」を参照してください。


構文	パラメータ	コメント
<ou-tree...></ou-tree>	treename="singleValue"	表示するツリーの構成を定義するツリー・オブジェクトの名前への参照を指定する必要があります。この属性には、前述の単一値の項で説明した構文に従った単一値が必要です。
<ou-tree...></ou-tree>	context="..."	オプションで、1つ以上の名前/値のペアを渡します。構文は、前述の複合属性に関する情報に示されている例に従います。

次の例では、ツリーへの明示的な参照を使用し、コンテキストを渡しません。この特定のツリーは、ツリー・ノード・アルゴリズムがアクセスできるグローバル・コンテキストに依存します。

<ou-tree treename="C1-PremiseTree"></ou-tree>

コンテキスト依存インサイト

コンテキスト依存インサイトの定義に関連する構成の詳細は、「コンテキスト依存インサイト」を参照してください。


構文	パラメータ	コメント
<ou-insights ...></ou-insights>	insightType="singleValue"	この属性を使用して、表示するインサイト・タイプを指定します。この属性またはインサイト・クラス属性を指定する必要があります。この属性には、前述の単一値の項で説明した構文に従った単一値が必要です。
	insightClass="singleValue"	インサイト・クラスを使用して、このクラスに関連するインサイト・グループのすべてのインサイト・タイプを表示します。この属性には、前述の単一値の項で説明した構文に従った単一値が必要です。
	context="..."	オプションで、1つ以上の名前/値のペアを渡します。構文は、前述の複合属性に関する情報に示されている例に従います。
	mode="preview"	オプションで、previewというモードを渡して、使用可能なコンテキストなしで、プレビュー・モードでインサイトがコールされることを、データを準備する基礎となるインサイト・アルゴリズムに示します。アルゴリズムがサンプル情報を返すことが理想的です。
	class=" "	オプションで、レンダリングされたインサイトの側面を制御するCSSヘルパー・クラスを指定します。サポートされている値は次のとおりです。 class="card-full-width" - カード・インサイトに適用できます。このオプション・クラスを使用して、カード・インサイトの幅が、それを含むゾーンの幅に調整されるようにします。このパラメータを設定しないカード・インサイトでは、固定幅が使用されます。

次の例は、インサイト・タイプがコンテキスト内のインサイト・タイプであるインサイト・プレビュー・マップからのものです。コンテキスト・データは不要で、モードは'preview'です。

<ou-insights insightType="x[insightType]" mode="preview"></ou-insights>

次の例では、インサイト・クラスを使用し、明示的に定義されたコンテキスト名とともにXPath要素からのコンテキスト値を渡します。

<ou-insights insightClass="C1CI" context="PER_ID:x[personId];ACCT_ID:x[accountId];PREM_ID:x[premiseId];"></ou-insights>

ボタン

ボタンWebコンポーネントでは、システム内で使用されるボタン形式の標準セットがサポートされます。


構文	パラメータ	コメント
<ou-button...></ou-button>	type="singleValue"	表示するボタンのタイプを定義する必要があります。この属性には、前述の単一値の項で説明した構文に従った単一値が必要です。有効なタイプ値は次のとおりです。 image - イメージのみ text - テキストのみ imageText - イメージの後にテキスト menu - テキストと、メニューを開くためのドロップダウン・キャレット imageMenu - イメージと、メニューを開くためのドロップダウン・キャレットタイプ属性が指定されていない場合は、'壊れたボタン'のイメージが表示されます。
	img="singleValue"	表示するイメージのパスを定義します。イメージを含むボタン・タイプには、この属性またはイメージ参照属性を指定する必要があります。この属性には、前述の単一値の項で説明した構文に従った単一値が必要です。 SVGイメージについては、パスのないSVGファイル名のみが参照に含まれている場合、そのパスはフレームワークSVGリポジトリとみなされます。
	imgRef="singleValue"	使用するイメージの表示アイコン参照を定義します。イメージを含むボタン・タイプには、この属性またはイメージ属性を指定する必要があります。この属性には、前述の単一値の項で説明した構文に従った単一値が必要です。
	text="..."	ボタンに必要な様々なテキスト要素を定義します。構文は、前述の複合属性に関する情報に示されている例に従います。有効なテキスト要素名の値は次のとおりです。 label - ボタンに使用するラベル・テキスト tooltip - ボタンに使用するホバー・テキスト aria-label - ボタンのARIAラベル
	menu="singleValue"	ボタンで使用するメニューを定義します。メニュー・コントロールを含むボタン・タイプには、この属性を指定する必要があります。この属性には、前述の単一値の項で説明した構文に従った単一値が必要です。
	disabled="singleValue"	これは標準HTML属性です。値を"true"にするか、単にテキスト"disabled"が存在すると、最初はボタンが無効になります。
	security="..."	オプションで、ボタンのセキュリティ設定を定義します。適切なセキュリティ・アクセス権をユーザーが持っていない場合、ボタンは非表示になります。構文は、前述の複合属性に関する情報に示されている例に従います。有効なセキュリティ要素名の値は次のとおりです。 service - セキュリティ・アクセス権がボタンへのアクセスを制御するアプリケーション・サービス accessMode - ボタンへのよりきめ細かなアクセス・レベルを決定する、サービスの具体的なアクセス・モード
	clickAction="..."	オプションで、ボタンが'クリック'されたときに実行する処理を定義します。構文は、前述の複合属性に関する情報に示されている例に従います。この属性には、次のような特定の'名前'の値があります。 action - 実行する処理。有効な値は'BPA'および'NAVIGATE'です script - 処理が'BPA'の場合に実行するスクリプト navopt - 処理が'NAVIGATE'の場合に使用するナビゲーション・オプションこの属性には、スクリプトに渡す情報やナビゲーション・コンテキスト・フィールドとして使用する情報を定義する他の名前/値のペアを含めることもできます。セキュリティ属性の設定に加えて、処理を実行する前に、スクリプトまたはナビゲーション・パスへのアクセス権をユーザーが持っていることが確認されます。標準HTMLの'onClick'属性を引き続き使用できます。HTMLに'onClick'属性と'clickAction'が含まれている場合は、'onClick'属性が優先されます

次に、テキストを含む単純なボタンの例を示します。

<ou-button type="text" text="label:md[F1_BOOKMARK_LBL];"></ou-button>

次に、表示アイコン参照を使用するアイコン・ボタンの例を示します。

<ou-button type="image" imgRef="F1CMNT"></ou-button>

次に、イメージ・メニュー・ボタンの例を示します。

<ou-button type="imageMenu" imgRef="F1STTGS" menu="CI_CONTEXTSCRIPT" text="tooltip:md[F1INSTY_VIS_LBL];></ou-button>

次に、別のページにナビゲートするテキスト・ボタンの例を示します。

<ou-button type="text" text="label:md[ALG_CD];tooltip:md[GOTO_ALG]" clickAction="action:NAVIGATE; navopt:f1algqTabMenu; ALG_CD:x[algorithm];></ou-button>

追加時のスキーマ・デフォルトの表示

UIマップのスキーマ内のデフォルト値は、埋め込まれた<action>ノードに'ADD'の値があるか、空白の場合に、UIマップの入力フィールドに表示されます。


構文
<action>ADD</action>

<action> </action>

<description>要素のスキーマ・デフォルトが表示されます。

<schema>
    <action/>
    <boGroup type="group">
        <key/>
        <description default="enter description here"/>
    </boGroup>
</schema>

<html>
<body>
<table summary="" border="1" cellpadding="1" cellspacing="1">
    <tr>
        <td>Description   </td>
        <td><input oraField="boGroup/description"></td>
    </tr>
</table>
</body>
<xml>
<root>
    <action>ADD</action>
    <boGroup>
        <key/>
        <description/>
    </boGroup>
</root>
</xml>
</html>

レンダリングされたHTML。

グラフの構成

グラフとゾーンの統合に加えて、UIマップHTML内で同じ属性を使用して、XMLリストのグラフィカル表現を構成することもできます。デザイナはこれらの属性を使用して、グラフのタイプ、サイズ、位置およびコンテンツを制御できます。属性および構文の詳細は、「データ・エクスプローラ・グラフ構成」を参照してください。

グラフの例

円グラフ構成のサンプル:

<html>
<head>
<title>Pie Chart</title>
</head>
<body>
 
<div style="width:100%; height:290px;"
    oraChart="type:pie;"
    oraChartSeries1="list:set; labelPath:date; amount:amount; "
    oraChartBroadcast="BILL_ID:billId;">
</div>
 
</body>
 
<xml>
<root>
  <set>
<date>05-02-2003</date>
<amount>163.24</amount>
<billId>592211649441</billId>
  </set>
  <set>
<date>06-02-2003</date>
<amount>97.29</amount>
<billId>592211649442</billId>
  </set>
  <set>
<date>07-02-2003</date>
<amount>54.38</amount>
<billId>592211649443</billId>
  </set>
</root>
</xml>
</html>

単一の系列に対してレンダリングされた円グラフ:

線、クラスタまたは積上げグラフ構成(それぞれに2つの系列がある)のサンプル:

<html>
<head>
<title>Stacked Chart</title>
</head>
<body>
 
<div style="width:100%; height=300px;"
    oraChart="type:line;"
oraChartSeries1="list:set; xaxis:date; label:Charge; amount:amount; "
oraChartSeries2="list:set; xaxis:date; label:Balance; amount:balance; "
    oraChartBroadcast="BILL_ID:billId;">
</div>
 
<div style="width:100%; height=300px;"
oraChart="type:cluster;"
oraChartSeries1="list:set; xaxis:date; label:Charge; amount:amount; "
oraChartSeries2="list:set; xaxis:date; label:Balance; amount:balance; "
oraChartBroadcast="BILL_ID:billId;">
</div>
 
<div style="width:100%; height=300px;"
oraChart="type:stacked;"
oraChartSeries1="list:set; xaxis:date; label:Charge; amount:amount; "
oraChartSeries2="list:set; xaxis:date; label:Balance; amount:balance; "
oraChartBroadcast="BILL_ID:billId;">
</div>
 
</body>
 
<xml>
<root>
  <set>
<date>05-02-2003</date>
<amount>163.24</amount>
<balance>163.24</balance>
<billId>592211649441</billId>
  </set>
  <set>
<date>06-02-2003</date>
<amount>97.29</amount>
<balance>260.53</balance>
<billId>592211649442</billId>
  </set>
  <set>
<date>07-02-2003</date>
<amount>54.38</amount>
<balance>314.91</balance>
<billId>592211649443</billId>
  </set>
</root>
</xml>
</html>

2つの系列それぞれに対してレンダリングされた3種類のグラフ: 線、クラスタおよび積上げ。

CSVファイルのアップロードおよびダウンロード

次のHTML属性を使用して、マップのスキーマ内に定義されたリストとCSV (カンマ区切り値)ファイル間でのアップロードとダウンロードの両方を管理できます。この手法は、データが数百行を超えないなど、低ボリュームから中ボリュームの場合にのみお薦めします。より高いボリュームの場合は、かわりにバッチ・アップロードまたはダウンロード機能を使用することをお薦めします。

構文はoraUploadData="type:embed;path:list xpath;useLabels:true;showCount:true"です

構成のアップロードでは、アップロードするCSVファイルと、XMLリストをターゲットとして指定する必要があります。通常は、CSVの各行によって個別のリスト・インスタンスが作成されます。ファイル内のカンマ区切りの各フィールドが、リストの個別の要素としてアップロードされます。アップロード・ダイアログをマップ内に埋め込むには、div、td、spanなどのコンテナ要素にoraUploadData属性を関連付ける必要があります。

オプションのuseLabels:true値は、アップロードCSVファイルの解析でヘッダーをラベルにする必要があることを示します。

注意: useLabels:true値を指定せず、XMLターゲット要素名が"camelCase"の場合、対応するスプレッドシートのヘッダーは、タイトルの先頭文字を大文字にして、単語間にスペースを入れる必要があります(例: "Camel Case")。文字と特殊文字は別の文字列とはみなされず、たとえば、Address1はターゲットXML要素のaddress1にアップロードされます。

オプションのshowCount:true値を指定すると、アップロードされたレコード数が表示されます。

注意: oraUploadData関数と組み合せてグリッドを使用している場合は、'replace'ビジネス・オブジェクト処理を使用してグリッドのリストを保守する必要があります。詳細は、「ビジネス・オブジェクトの置換処理」を参照してください。

div要素内にあるoraUploadData="embed"のサンプル。

<html>
<head>
    <title>File Upload</title>
</head>
<body>
   
    <div oraUploadData="type:embed;path:myList"> </div>
 
</body>
 
<xml>
<root>
    <myList>
<id>838383930</id>
        <name>Janice Smith</name>
    </myList>
    <myList>
<id>737773730</id>
        <name>Bill McCollum</name>
    </myList>
</root>
</xml>
</html>

このファイル・アップロード・ダイアログが、oraUploadDataが定義されているページの本文に埋め込まれます。

oraUploadData="type:popup;path:list xpath;useLabels:true;showOk:true;showCount:true"

構成のアップロードでは、アップロードするCSVファイルと、XMLリストをターゲットとして指定する必要があります。通常は、CSVの各行によって個別のリスト・インスタンスが作成されます。ファイル内のカンマ区切りの各フィールドが、リストの個別の要素としてアップロードされます。ポップアップ・ダイアログを使用してCSVファイルをアップロードするには、button、text link、imageなどの入力要素にoraUploadData属性を関連付ける必要があります。

オプションのuseLabels:true値は、アップロードCSVファイルの解析でヘッダーをラベルにする必要があることを示すために使用されます。

オプションのshowOk:true値を指定すると、アップロードの終了後に"Ok"ボタンが表示されます。ボタンを押すまでポップアップは開いたままになります。さらに、showCount:true値を指定すると、アップロードされたレコード数が表示されます。

ボタンと関連付けられたoraUploadData="popup"のサンプル:

<html>
<head>
    <title>File Upload</title>
</head>
<body>
   <input type="button" name="submitButton" oraUploadData="type:popup;path:myList;" value='Get Data'>
   <table oraList="myList">
      <tr/>
      <tr>
         <td><span oraField="id"/></td>
         <td><span oraField="name"/></td>
      </tr>
   </table>
</body>
<xml>
<root>
   <myList>
      <id>838383930</id>
      <name>Janice Smith</name>
   </myList>
   <myList>
      <id>737773730</id>
      <name>Bill McCollum</name>
   </myList>
</root>
</xml>
</html>

レンダリングされたHTML:

「Get Data」ボタンを押すと、次に示すように、標準のファイル・アップロード・ダイアログ(フレームワークによって提供)が起動します。

oraDownloadData="list xpath"

構成のダウンロードでは、ダウンロードするXMLリストを指定する必要があります。通常は、各リスト・インスタンスが、作成されるファイル内の個別の行を表します。デフォルトでは、リストの各要素は、ファイル内でカンマで区切られます。

注意: 数値の書式設定は、ユーザー・プロファイルの設定に基づきます。小数点記号がカンマの地域では、カンマではなくセミコロンを要素を区切るデリミタとしてシステムで使用するように、実装でプロパティ設定(spl.csv.delimiter.useFromDisplayProfile=true)を構成できます。

oraDownloadDataのサンプル。

<html>
<head>
<title>File Download</title></head>
<body>
<input type="button" name="downloadButton" oraDownloadData="myList" value="Download"/>
</body>
<xml>
<root>
   <myList>
      <id>881-990987</id>
      <name>John Mayweather</name>
   </myList>
   <myList>
      <id>229-765467</id>
      <name>Anna Mayweather</name>
   </myList>
   <myList>
      <id>943-890432</id>
      <name>Andrew Brewster</name>
   </myList>
</root>
</xml>
</html>

レンダリングされたHTML:

「Download」ボタンを押すと、次に示すように、標準のファイル・ダウンロード・ダイアログ(フレームワークによって提供)が起動します。

ダウンロードに成功すると、CSVファイルが作成されます。

データをサブ・リストからダウンロードする場合は、oraDownloadDataのかわりに属性oraDownloadDataInListを使用します。属性oraDownloadDataInListにはサブ・リスト名が保持されます。サブ・リストのXPathは、親リストから特定行のデータを選択するために使用されます。このため、特定のサブ・リストのみがダウンロードされます。

oraDownloadDataUseLabels="true"

oraDownloadDataUseLabels属性は、前述のoraDownloadData属性と組み合せて使用できます。生成されたCSVファイルで、要素名ではなく、列ヘッダーの要素ラベルを使用する場合は、oraDownloadDataUseLabelsを指定します。

ポータル・ゾーン・マップ・フラグメントの構成

ポータル・ゾーンは、ゾーン・ヘッダーおよびフィルタ領域に対するUIマップを参照できます。このUIマップは、完全なHTMLドキュメントではありませんが、かわりにUIマップのフラグメントとして構成されます。ゾーン・マップ・フラグメントを構成するときは、次の置換変数を参照できます。これらの変数には、ポータル内のマップのゾーンに固有の情報が実行時に動的に移入されることに注意してください。


変数	置換ロジック
[$ZONEDESCRIPTION]	ゾーンの摘要テキスト。
[$SEQUENCEID]	ゾーンのシーケンスID。
[$ZONENAME]	ゾーンの名前。
[$HELPTEXT]	ゾーンのヘルプ・テキスト。
[$ZONEPARAMNAME]	ゾーン・パラメータの値(指定されていない場合は空白)。

警告:

例として、次のいずれかのマップを参照してください: F1-UIMapHeaderおよびF1-ExplorerHeader。
これらのマップはoraIncludeタグを使用して、ヘッダー・メニューおよびフレームワーク処理のHTMLフラグメントを組み込みます。HTMLに含めるUIマップ・フラグメントのゾーン・タイプ・パラメータを参照してください。
ゾーン摘要の横にヘルプ・テキスト・アイコンを表示する場合は、摘要が含まれる<td>にid="title_[$SEQUENCEID]"が必要です。
UIマップ・フラグメント内にJavaScriptをカプセル化する必要がある場合は、JavaScriptを![CDATA[ ]]タグ内にバインドして、有効なXMLドキュメントを確保する必要があります。タグ自体はコメントアウトして、古いブラウザとの互換性の促進が必要な場合があります。次に例を示します。
```
<script type="text/javascript">

/*<![CDATA[ */

//
//javascript
//
/*]]> */
</script>
```

注意: フィルタ・マップ・フラグメント内で、フレームワークの「戻る」および「進む」機能に対してフィルタ入力フィールドの値を保存する場合は、入力フィールド(テキスト・ボックス、選択、その他)を一意のHTML IDと関連付ける必要があります。一意のIDと関連付けられた入力フィールド値は、フレームワークの「メメント」に取得されます。「メメント」は、「戻る」または「進む」機能を使用してポータル・ゾーンがナビゲートされたときに入力マップを再作成するために使用されます。

注意: ゾーンの動作を操作するために多くの特殊な関数が存在します。次に例を示します。

oraGetZoneSequence(zoneName)。ゾーンのコードを使用して、そのシーケンス番号を取得します。
oraIsZoneCollapsed(sequenceId)。ゾーンのシーケンスを使用して、縮小されているかどうかを判断します。
oraHandleCollapse(seq)。ゾーンを縮小します。
oraHandleExpand(seq,refresh)。ゾーンを展開またはリフレッシュ(あるいはその両方)します。

これらのすべて、およびその他多数の関数は、次に説明するJavaScriptライブラリuserMapSupport.jsにあります。

注意: フラグメントUIマップ内でoraLoadを実行し、ページ・ロード中にJavaScript関数を実行する必要がある場合(関数でビジネス・オブジェクト、ビジネス・サービスまたはサービス・スクリプトを起動する場合)は、特別な構文"oraLoad[$SEQUENCEID]"を使用できます。詳細は、「ページ・ロード・イベント」の項を参照してください。

関数内で使用されるoraLoad[$SEQUENCEID]の例:

<script type="text/javascript">
function oraLoad[$SEQUENCEID]() {
checkRebateClaimStatus();
}
 
function checkRebateClaimStatus() {
    var work = id(''analyticsFilterText[$SEQUENCEID]'',
document).cells[0].innerText.split('' '');
    var rebateClaimId = work[work.length - 3];
    id(''rebateClaimId'', document).value = rebateClaimId;
oraInvokeSS(''C1-CheckRCSt'',''checkRebateClaimStatus'', false);
    var statusIndicator = id(''statusInd'', document).value;
    if (statusIndicator == ''C1PE'' || statusIndicator == ''C1ID'') {
       id(''addRebateClaimLine'', document).style.display = '''';
    } else {
id(''addRebateClaimLine'', document).style.display = ''none'';
    }
}
</script>

レンダリングされたF1-ExplorerHeader:

ビジネス・オブジェクトの起動

oraInvokeBO関数は、ポータル・ゾーン・ヘッダーまたはゾーン・フィルタ・マップ内で使用できます。「ビジネス・オブジェクトの起動関数」で説明されているコマンドと同様で、UIマップのHTML内でビジネス・オブジェクトを起動できます。最初の3つのパラメータの摘要は、その項を参照してください。


構文	パラメータ	コメント
oraInvokeBO( )	'ビジネス・オブジェクト名'
	'XPath'またはnull
	'処理'
	null	4番目の引数として指定する必要があります。
	[$SEQUENCEID]	5番目の引数として指定する必要があります。
	true \| false	フラグメントがポータル・ゾーン・ヘッダー内で使用される場合はtrueを指定します。フラグメントがゾーン・フィルタ・マップで使用される場合はfalseを指定します。

ポータル・ゾーン・ヘッダー内の例:

oraInvokeBO('CM-User','xmlGroup','read', null, [$SEQUENCEID], true)

ビジネス・サービスの起動

oraInvokeBS関数は、ポータル・ゾーン・ヘッダーまたはゾーン・フィルタ・マップ内で使用できます。「ビジネス・サービスの起動関数」で説明されているコマンドと同様で、UIマップのHTML内でビジネス・サービスを起動できます。最初の2つのパラメータの摘要は、その項を参照してください。


構文	パラメータ	コメント
oraInvokeBS( )	'ビジネス・オブジェクト名'
	'XPath'またはnull
	null	4番目の引数として指定する必要があります。
	[$SEQUENCEID]	5番目の引数として指定する必要があります。
	true \| false	フラグメントがポータル・ゾーン・ヘッダー内で使用される場合はtrueを指定します。フラグメントがゾーン・フィルタ・マップで使用される場合はfalseを指定します。

ポータル・ゾーン・ヘッダー内の例:

oraInvokeBS('CM-UserSearch','xmlGroup', null, [$SEQUENCEID], true)

サービス・スクリプトの起動

oraInvokeSS関数は、ポータル・ゾーン・ヘッダーまたはゾーン・フィルタ・マップ内で使用できます。「サービス・スクリプトの起動関数」で説明されているコマンドと同様で、UIマップのHTML内でサービス・スクリプトを起動できます。最初の2つのパラメータの摘要は、その項を参照してください。


構文	パラメータ	コメント
oraInvokeSS( )	'サービス・スクリプト名'
	'XPath'またはnull
	null	4番目の引数として指定する必要があります。
	[$SEQUENCEID]	5番目の引数として指定する必要があります。
	true \| false	フラグメントがポータル・ゾーン・ヘッダー内で使用される場合はtrueを指定します。フラグメントがゾーン・フィルタ・マップで使用される場合はfalseを指定します。

ポータル・ゾーン・ヘッダー内の例:

oraInvokeSS('UserSearch','xmlGroup', null, [$SEQUENCEID], true)

未保存の変更の検出

この関数を使用して、未保存の変更がある場合にtrueに設定されたブールを返します。ユーザーがナビゲートしようとして警告がそれに応じて発生した場合は、システムで関数を問い合せます。この関数は、UIマップがカスタムjavascriptを使用して、変更が行われたかどうかをシステムが検出できないような要素を管理している場合にのみ必要です。また、この関数で使用されるブールの値をUIマップのjavascriptで管理する必要もあります。

function hasUnsavedChanges(){
       return isDirtyFlag;
   }

ポータルのタブの非表示

製品には、JavaScriptでoraAuthorizeTab JavaScript APIを使用して、特定の条件に基づいて現在のポータルのタブを非表示にする機能が用意されています。このAPIは関数をパラメータとして受け入れて、指定されたタブの索引をオフにします。

たとえば、1つ以上のタブの索引をオフにする関数をUIマップに保持できます。

function overrideTabIndex(index){
    if (index == 2) return false;
    if (index == 3) return false;
  }

JavaScriptはロード時に参照されます。

<body class="oraZoneMap"
onLoad="oraAuthorizeTabs(overrideTabIndex);">

必要なJavaScriptライブラリ

このドキュメントで説明されているすべての機能は、2組のJavaScriptライブラリに基づいています。UIマップ・レンダリング・フレームワーク内でマップを完全に記述および実行している場合は、次のライブラリを手動で挿入する必要はありません。UIマップのレンダリング時にフレーワークによって自動的に挿入されます。

警告: フレームワークの外部でHTMLを実行する場合は、次の参照をHTML内に明示的に含める必要があります。さらに、HTMLをレンダリングするために使用するツールには、バインド・サポートのためにprivateUserMapSupport.jsの物理コピーへのアクセス権が必要です。

src="privateUserMapSupport.js"

スタンドアロン環境でバインドを実行するために、HTMLドキュメントはこのライブラリを参照する必要があります。

警告: このJavaScriptライブラリ内の関数の参照は危険を伴います。これは、これらの関数はフレームワークによって所有され、バージョン・アップグレードや通常のパッチ・プロセスを介して変更される場合があるためです。

<script type="text/javascript" src="privateUserMapSupport.js"></script>

src="userMapSupport.js"

オプションのツールセット機能を活用するには、このライブラリを参照する必要があります。

注意: このJavaScriptライブラリ内の関数を参照して、UIマップ内でカスタム関数を記述できます。

<script type="text/javascript" src="userMapSupport.js"></script>

onload="oraInitializeUserMap();"

スタンドアロン環境でバインドを実行するには、次のonload関数を<body>ノードに埋め込む必要があります。

<body onload="oraInitializeUserMap();">