列パラメータ
データ・エクスプローラ・ゾーンは、1つ以上のSQL文を使用して表示するデータを選択するのに使用されます。各SQL文に対して、ゾーンでは、出力データを表示するための書式設定定義を含む列を20まで構成できます。
次のパラメータをゾーン・タイプに適用できます。
-
情報データ・エクスプローラ - 単一のSQL (F1-DE-SINGLE)。パラメータの記述パターンは「列x」となります。
-
情報データ・エクスプローラ - 複数のSQL (F1-DE)。このゾーン・タイプの場合、すべてのSQLが実行され、ゾーンにすべての結果の和結合が表示されます。パラメータの記述パターンは「SQL yの列x」となります。同じ列の行内で異なっていることに意味がないニーモニックがあります。たとえば、列ラベルです。これらのニームニックは、SQL 1の値のみがその列で考慮されます。次の表に、このルールに従うニーモニックを示します。
-
問合せデータ・エクスプローラ - 複数のSQL (F1-DE-QUERY)。このゾーン・タイプの場合、1つのSQLのみが実行されます。SQL y条件パラメータがこれを制御するために使用される場合があります。条件が満たされる(または移入される条件がない)最初のSQLが実行されます。パラメータの記述パターンは「SQL yの列x」となります。
様々なタイプのニーモニックについては次の項で説明されています。
内容
ソース・ニーモニック
この表では、列のデータがどのように導出されるかを制御するニーモニックについて説明します。
ニーモニック |
摘要 |
有効値 |
コメント |
---|---|---|---|
source= |
列の値がどのように導出されるかを定義します。 |
SQLCOL |
列の値のソースがSQL文の列からであることを示します。この列のタイプはsqlcol=ニーモニックも参照する必要があります。 |
BO |
列の値のソースがビジネス・オブジェクトからであることを示します。この列のタイプではbo=、input=およびoutput=ニーモニックも参照し、ビジネス・オブジェクトをどのように操作するかを定義する必要があります。 |
||
BS |
列の値のソースがビジネス・サービスからであることを示します。この列のタイプではbs=、input=およびoutput=ニーモニックも参照し、ビジネス・サービスをどのように操作するかを定義する必要があります。 |
||
SS |
列の値のソースがサービス・スクリプトからであることを示します。この列のタイプではss=、input=およびoutput=ニーモニックも参照し、サービス・スクリプトをどのように操作するかを定義する必要があります。 |
||
FORMULA |
この列の値のソースが式を使用して計算されていることを示します。この列のタイプはformula=ニーモニックも参照する必要があります。 |
||
SETFUNC |
この列の値のソースがSQL文の行からの値のスーパーセットを使用して計算されていることを示します。この列のタイプはsetfunc=ニーモニックも参照する必要があります。 |
||
ICON |
この列の値のソースが表示アイコン参照であることを示します(つまり、列にアイコンが表示されます)。この列のタイプは、アイコン参照を定義するicon=ニーモニックも参照する必要があります。 |
||
FKREF |
この列の値のソースが外部キー参照であることを示します(つまり、列に外部キー参照のコンテキスト・メニューおよび情報文字列が表示され、ナビゲーションが可能になります)。この列のタイプは、外部キー参照がどのように呼び出されるかを定義するfkref=およびinput=ニーモニックも参照する必要があります。 注意: 外部キーの情報を表示するがナビゲーションを有効にしない場合は、「一般的なユース・ケース」で推奨される方法を参照してください。
|
||
SPECIFIED |
この列の値のソースがリテラルおよび他の列値を連結して指定されていることを示します。この列のタイプはspec=ニーモニックも参照する必要があります。 |
||
MSG |
この列の値のソースがメッセージ表(と置換変数)からのメッセージであることを示します。この列のタイプはmsg=ニーモニックも参照する必要があります。 |
||
sqlcol= |
source=SQLCOLのときにSQL文の列を定義します。 |
COLUMN_NAME |
SELECT文で取得される列の名前を入力します。select文で列の別名を使用する場合、その別名がここで参照されている必要があります。 |
x |
ここで、xはSELECT文の列の相対位置により列を参照する整数値です。たとえば、sqlcol=3はSELECT文の3番目の列が表示されます)。 |
||
bo= |
source=BOのときに呼び出すビジネス・オブジェクトを定義します。 このニーモニックはinput=およびoutput=ニーモニックと組み合せて使用する必要があり、情報がどのようにビジネス・オブジェクトに送信されるか/ビジネス・オブジェクトから受信されるかを定義します。 |
'ビジネス・オブジェクト・コード' |
|
bs= |
source=BSのときに呼び出すビジネス・サービスを定義します。 このニーモニックはinput=およびoutput=ニーモニックと組み合せて使用する必要があり、情報がどのようにビジネス・サービスに送信されるか/ビジネス・サービスから受信されるかを定義します。 |
'ビジネス・サービス・コード' |
|
ss= |
source=SSのときに呼び出すサービス・スクリプトを定義します。 このニーモニックはinput=およびoutput=ニーモニックと組み合せて使用する必要があり、情報がどのようにサービス・スクリプトに送信されるか/サービス・スクリプトから受信されるかを定義します。 |
'サービス・スクリプト・コード' |
|
fkref= |
source=FKREFの場合に、列の情報を取得する際に使用する外部キー参照を定義します。 このニーモニックはinput=ニーモニックと組み合せて使用する必要があり、情報を作成するために情報がどのように外部キー参照に送信されるかを定義します。 |
Cx |
外部キー参照コードが前の列に定義されていることを意味します。たとえば、列1で外部キー参照値を定義する場合は、C1を定義します。 |
COLUMN_NAME |
外部キー参照がSELECT文で取得されたことを意味します。値はSELECT句に定義した名前と一致する必要があります。 |
||
'外部キー参照コード' |
外部キー参照が直接定義されていることを意味します。例: 'F1-ROLE'。 |
||
formula= |
source=FORMULAのときに使用する式を定義します。 例:
|
この式には数値定数、演算子および列参照を含めることができます。 |
列参照の場合、書式Cxを使用します。ここで、xは列番号を表します。 |
サポートされている機能の詳細は、「式パーサー」を参照してください。 |
|||
setfunc= |
source=SETFUNCのときに指定の列の行に適用する関数を定義します。 |
function(Cx) |
ここで、Cxは行に関数が適用される列を表し、関数は次のいずれかになります。:
|
input= |
これは、ビジネス・オブジェクト、ビジネス・サービス、サービス・スクリプトおよび外部キー参照に渡される1つ以上の入力フィールドと値を定義するのに使用されます。 構文は次のとおりです: [ELEMENT_NAME=ELEMENT_REF ELEMENT_NAME=ELEMENT_REF ...] つまり、入力値のリストは大カッコで囲まれ、スペースで区切られます。渡される値ではまずELEMENT_NAMEを定義し、これはターゲットの要素/フィールドの名前です。ELEMENT_REFは渡される値です。次の列はELEMENT_REFに指定可能な値を示します。 |
Cx | ここで、Cxは前の列の値を表します。渡す値が最初の列にある場合、C1を参照します。 |
COLUMN_NAME | 渡す値がSELECT文で取得されたことを意味します。値はSELECT句に定義した名前と一致する必要があります。 | ||
'リテラル値' | これは、一重引用符で囲まれたリテラル値を渡す必要があることを意味します。 | ||
userTimeZone | これは、現在のユーザーのタイム・ゾーンを渡す必要があることを意味します。これは通常はビジネス・サービスF1-ShiftDateTimeとともに使用され、表示するためにストレージ・タイム・ゾーンのデータをユーザーのタイム・ゾーンに変換します。 | ||
installationTimeZone | インストール・タイム・ゾーンを渡す必要があることを意味します。これは通常はビジネス・サービスF1-ShiftDateTimeとともに使用され、表示するためにストレージ・タイム・ゾーンのデータをインストール・タイム・ゾーンに変換します。 | ||
例:
|
|||
output= |
これは、この列を移入するのに使用されるビジネス・オブジェクト、ビジネス・サービスまたはサービス・スクリプトから取得される要素の名前を定義するのに使用されます。 |
elementName |
例: output=personInfo |
pagingkey= |
このニーモニックは「ページングの有効化」パラメータが構成されている場合にのみ適用されます。この列が、結果のページングを編成するためにSQL文によって使用されるキーの1つであることを示します。このニーモニックはsource=SQLCOLの場合にのみ指定できます。 ファストパス: 詳細は、「ページ区切り構成」を参照してください。
|
Y |
|
N |
これがデフォルトで、列がページング・キーの1つでないことを示すためにpagingkey=Nを指定する必要がないことを意味します。 |
書式設定ニーモニック
この表では、列がどのように書式設定されるかを制御するニーモニックについて説明します。
ニーモニック |
摘要 |
有効値 |
コメント |
---|---|---|---|
type= |
列の値がどのように書式設定されるかを定義します。 注意: アイコンおよび外部キーの列。source=ソース・ニーモニックは、列をアイコン参照または外部キー(FK)参照から導出することを示すために使用されます。これらのいずれかのソースを使用する場合は、アイコンまたはコンテキスト・メニュー/情報文字列のいずれかが列に表示されるため、type=ニーモニックは関係ありません。
|
STRING |
このタイプの列は文字列を取得します。これはデフォルト値です。 |
DATE |
このタイプの列は、日付を取得して、ユーザーの表示プロファイルを使用して表示されます。 |
||
TIME |
このタイプの列は、(データベースの書式の)時間を取得して、ユーザーの表示プロファイルを使用して表示されます。 |
||
DATE/TIME |
このタイプの列は、(データベースの書式の)日時を取得して、ユーザーの表示プロファイルを使用して表示されます。 |
||
MONEY |
このタイプの列は通貨フィールドを取得します。この列のタイプはcur=ニーモニックも参照できます。curニーモニックが指定されていない場合、インストール・レコードの通貨コードが使用されます。 |
||
NUMBER |
このタイプの列は数値フィールドを取得します。この列のタイプはdec=ニーモニックも参照できます。 |
||
label= |
列の上書きラベルを定義します。このラベルは列の見出しおよびゾーンのドラッグ・アンド・ドロップ領域に表示されます。 このニーモニックが定義されていない場合は、列のデフォルト・ラベルが使用されます。列のデフォルト・ラベルのソースは、列のソースによって異なります。ソースによってはデフォルト値がなく、このニーモニックを省略すると空白ラベルになります。 注意:
ゾーン・タイプ「情報データ・エクスプローラ - 複数のSQL」(F1–DE)の場合、ラベルの定義にSQL 1の列定義が使用されます。 |
FIELD_NAME |
有効なフィールド名を入力し、そのラベルを列ラベルに使用します。これは常に、複数の言語が必要な場合に使用されるオプションです。 |
'text' |
テキストを直接定義します。 |
||
cur= |
インストール・レコードの通貨を使用できない場合に、type=MONEYのときに適用される通貨コードを定義します。 |
Cx |
通貨コード値が前の列に定義されていることを意味します。たとえば、列1で通貨コードを定義する場合は、C1を定義します。 |
COLUMN_NAME |
通貨コードがSELECT文で取得されたことを意味します。値はSELECT句に定義した名前と一致する必要があります。 |
||
'通貨コード' |
通貨コードが直接定義されていることを意味します。例: 'USD'。 |
||
dec= |
type=NUMBERの場合の小数点以下桁数を定義します。 これはオプションです。指定する場合は、整数である必要があります。指定しない場合は、小数点以下桁数は、インストール・レコードに指定した通貨コードに定義された小数点以下桁数にデフォルト設定されます。 |
nR |
ここで、nは表示する小数点以下の桁数です。小数点以下桁数にRのサフィックスを付けると、システムで切上げ/切捨てが処理されることを意味します。単純に(Rなしで) nを指定すると、小数点以下の桁数が切り捨てられることを意味します。たとえば、dec=4と入力すると、小数点以下4桁が表示され、残りは切り捨てられます。 注意: 書式設定のみ。このニーモニックは書式設定にのみ使用され、後続の計算に使用される精度には影響しません。たとえば、データベースから取得した列の有効桁数が6桁で、dec=0の場合、列は小数点以下の桁数なしで(切り捨てられて)表示されますが、その後の計算での列に対する参照では、小数点以下6桁が使用されます。たとえば、列が式またはset関数で参照される場合は、小数点以下6桁すべてが使用されます。
|
char= |
このニーモニックは列の値に特殊文字を適用します。 |
'x[]x' |
xは表示するリテラル値を参照し、[ ]は文字の(値の前または後ろの)相対位置を定義します。 値の前に文字を配置する場合は、[ ]のみを指定する必要があります。たとえば、char='%'は値の後にパーセント記号を配置します。値の前に'minutes'という語を配置する場合は、char='minutes [ ]'と入力します。BUDGET $123.12 (YTD)のような値を出力する場合は、char='BUDGET [ ] (YTD)'と入力します。 |
suppress= |
これは、列を表示しないよう指定するのに使用されます。 列が後続の列で使用されるためにのみ定義されている場合、その列が非表示にされることがあります。たとえば、2つの別の列を使用して列を導出する式があるとします。このシナリオでは、その式で参照される列は非表示にできます。 注意:
ゾーン・タイプ「情報データ・エクスプローラ - 複数のSQL」(F1–DE)の場合、SQL 1の列定義の設定が後続のすべてのSQLに適用されます。 |
true |
|
false |
これはデフォルトであり、フィールドを表示する必要があることを示すためにsuppress=falseと指定する必要はまったくありません。 |
||
suppressSearch= |
これは、ゾーンが検索モードで起動されたときのみ列を表示しないよう指定するのに使用されます。 注意:
ゾーン・タイプ「情報データ・エクスプローラ - 複数のSQL」(F1–DE)の場合、SQL 1の列定義の設定が後続のすべてのSQLに適用されます。 |
true |
|
false |
これはデフォルトであり、フィールドを表示する必要があることを示すためにsuppressSearch=falseと指定する必要はまったくありません。 |
||
suppressExport= |
これは、Excelにダウンロードしないよう指定するのに使用されます。 注意:
ゾーン・タイプ「情報データ・エクスプローラ - 複数のSQL」(F1–DE)の場合、SQL 1の列定義の設定が後続のすべてのSQLに適用されます。 |
true |
|
false |
これはデフォルトであり、フィールドをダウンロードに含める必要があることを示すためにsuppressExport=falseと指定する必要はまったくありません。 |
||
width= |
これは、列の幅(ピクセル数)を上書きするのに使用されます。デフォルト値は列にあるセルのうちの最大幅です。 |
n |
ここで、nは0から999の間の数字です。 注意:
データに適切な分割ポイントがない場合、列は指定されたピクセル数よりも長くなります。 (列の見出しに表示される)列のラベルの長さにより幅が指定より広くなることもあります。 ゾーン・タイプ「情報データ・エクスプローラ - 複数のSQL」(F1–DE)の場合、SQL 1の列定義に基づいて幅が設定されます。 |
color= |
これは、列のテキスト色を上書きするのに使用されます。 |
有効なHTMLの名前付きの色 |
例: color=yellow。 注意: HTMLの色'red'の使用およびアクセシビリティへの影響の詳細は、「色の対比」を参照してください。
|
有効なRGB色モデルの組合せ |
例: color=#E0292Fやcolor=#CCCCCC。#は必須です。 |
||
bgcolor= |
これは、列の背景色を上書きするのに使用されます。 |
有効なHTMLの名前付きの色 |
color=ニーモニックと同様です。 |
有効なRGB色モデルの組合せ |
color=ニーモニックと同様です。 |
||
order= |
列のデフォルトのソート順を定義します。 |
ASC |
昇順であることを示します。これはデフォルトであり、order=ASCと指定する必要はありません。 |
DESC |
降順であることを示します。 |
||
rowHeader= |
アクセシビリティの目的で、列を行ヘッダーとして指定します。 |
true |
デフォルトでは、データ・エクスプローラ結果の最初のデータ列は、アクセシビリティ・ツール用の行ヘッダーとして識別されます。最初の列のデータが行を一意に識別しない場合、このニーモニックを使用して異なる列または複数の列を行ヘッダーとして明示的にマークします。 注意: ゾーン・タイプ「情報データ・エクスプローラ - 複数のSQL」(F1–DE)の場合、システムではこのニーモニックが定義されたSQL 1の列のみが確認され、これらの列のすべての結果に適用されます。
|
クリック・ニーモニック
この表では、列値がクリック可能かどうか、そうである場合は何が起こるかを定義するニーモニックについて説明します。
ニーモニック |
摘要 |
有効値 |
コメント |
---|---|---|---|
navopt= |
ユーザーが列をクリックしたときにターゲット・トランザクションまたはスクリプトを参照するナビゲーション・オプションを定義します。 このニーモニックはcontext=ニーモニックと組み合せて使用する必要があり、ナビゲーション・オプションのターゲット・トランザクションに何の情報が送信されるかを定義します。 source=FKREFの場合、外部キー参照コードでハイパーリンクのリンク先が定義されているため、このニーモニックは無視されます。 |
Cx |
ナビゲーション・オプション・コードが前の列に定義されていることを意味します。たとえば、列1でナビゲーション・オプションを定義する場合は、C1を定義します。 |
COLUMN_NAME |
ナビゲーション・オプションがSELECT文で取得されたことを意味します。値はSELECT句に定義した名前と一致する必要があります。 例: navopt=MAIN_PORTAL |
||
'ナビゲーション・オプション・コード' |
ナビゲーション・オプション・コードが直接定義されていることを意味します。例: navopt='userMaint'。 |
||
context= |
これは、navopt=ニーモニックとの組合せで、ターゲット・ナビゲーション・オプションに渡される1つ以上のコンテキスト・フィールドおよび値を定義するのに使用されます。 構文は次のとおりです: [FIELD_NAME=FIELD_REF FIELD_NAME=FIELD_REF ...] つまり、入力値のリストは大カッコで囲まれ、スペースで区切られます。渡される各値では最初にFIELD_NAMEを定義します。これはナビゲーション・オプションのコンテキスト・フィールドの名前です。FIELD_REFは渡される値です。次の列はFIELD_REFに指定可能な値を示します。 |
Cx |
ここで、Cxは前の列の値を表します。たとえば、渡す値が最初の列にある場合、C1を参照します。 |
COLUMN_NAME |
渡す値がSELECT文で取得されたことを意味します。値はSELECT句に定義した名前と一致する必要があります。 |
||
'リテラル値' |
これは、一重引用符で囲まれたリテラル値を渡す必要があることを意味します。 |
||
bpa= |
ユーザーが列をクリックしたときにビジネス・プロセス・アシスタント・スクリプトを実行する必要があること、および実行するビジネス・プロセス・アシスタントを示します。 このニーモニックはtempstorage=ニーモニックと組み合せて使用する必要があり、スクリプトの実行時に開始される一時格納値を定義します。 source=FKREFの場合、外部キー参照コードでハイパーリンクのリンク先が定義されているため、このニーモニックは無視されます。 |
Cx |
ビジネス・プロセス・アシスタント・スクリプトが前の列で定義されていることを示します。 |
COLUMN_NAME |
実行するビジネス・プロセス・アシスタント・スクリプトがSELECT文で取得されたことを意味します。値はSELECT句に定義した名前と一致する必要があります。 |
||
'ビジネス・プロセス・アシスタント・スクリプト・コード' |
実行するビジネス・プロセス・アシスタント・スクリプトが直接定義されていることを意味します。 |
||
tempstorage= |
これは、bpa=ニーモニックが使用されるときに、一時格納変数がどのように開始されるかを定義するのに使用されます。 構文は次のとおりです: [FIELD_NAME=FIELD_REF FIELD_NAME=FIELD_REF ...] つまり、入力値のリストは大カッコで囲まれ、スペースで区切られます。渡される各値では最初にFIELD_NAMEを定義します。これは一時格納のフィールドの名前です。FIELD_REFは渡される値です。次の列はFIELD_REFに指定可能な値を示します。 |
Cx |
ここで、Cxは前の列の値を表します。たとえば、渡す値が最初の列にある場合、C1を参照します。 |
COLUMN_NAME |
渡す値がSELECT文で取得されたことを意味します。値はSELECT句に定義した名前と一致する必要があります。 |
||
'リテラル値' |
これは、一重引用符で囲まれたリテラル値を渡す必要があることを意味します。 |
||
list= |
これは、この列に対してワーク・リスト機能を有効化するのに使用します。 オプションで、listdesc=ニーモニックを指定して、ワークリスト・ゾーンに配置されるテキストを上書きできます。 |
true |
list=trueに設定すると、列の見出しにワーク・リスト・アイコンが表示されます。ユーザーが列をクリックすると、出力のすべての行がワーク・リスト・ゾーンに移入されます。 注意: ゾーン・タイプ「情報データ・エクスプローラ - 複数のSQL」(F1-DE)の場合、出力には複数のSQL文による結果の和結合が表示できます。このとき、すべてではなく一部のSQL文において特定の列にlist=trueが構成されている場合、ユーザーがアイコンをクリックすると、このニーモニックが構成されている文に対するセルのデータのみがワーク・リストに配置されます。また、ゾーンを作成する際にワークリスト・アイコンを含める列を決定する場合、システムではSQL 1の列の構成のみが確認されることに注意してください。
|
listdesc= |
これは、list=ニーモニックを使用しているときのオプションのニーモニックです。ワーク・リスト・ゾーンに配置されているテキストを上書きするのに使用できます。 |
Cx |
ここで、Cxは前の列の値を表します。たとえば、使用するテキストが最初の列にある場合、C1を参照します。 |
listbroadcast= |
列のブロードキャスト情報をワーク・リスト・ゾーンでも使用できるようにすることを示します。これは、ワーク・リストを使用してデータ・エクスプローラと同じ方法で情報をポータルにブロードキャスト可能であることを示します。 |
true |
この設定はこの機能をオンにするのに使用します。 |
一般的なユース・ケース
この項では、新しく作成されたゾーンに対してコピーして貼り付けることができる共通構成を示します。
ユース・ケース |
コード・スニペット |
---|---|
SQL文で取得された参照値の摘要の表示。ビジネス・サービスは、上書きラベルをチェックします。 |
source=BS bs='F1-GetLookupDescription' label=FLD_NAME input=[fieldName='FLD_NAME' fieldValue=FLD_NAME] output=description |
外部キーを情報とともに表示しますが、ナビゲーションは抑制します。(これは、ゾーンに追加情報としての外部キーがあるが、ナビゲーションを有効にすると混乱を生じるような場合に便利です。外部キー参照を情報とともに表示し、かつナビゲーションを有効にするには、前述のようにFKREFのソースを使用します。) 1つ目の例では、外部キー参照がわかっていることを前提としています。2つ目の例では、メンテナンス・オブジェクトを入力として受け取るビジネス・サービスを使用しています。 |
source=BS bs='F1-GetForeignKeyReference' input=[input/fkReference=FK_REF_CD input/fkValue1=BUS_OBJ_CD] output=output/infoDescription label=DESCR |
source=BS bs='F1-GetFKReferenceDetails' input=[input/maintenanceObject='F1-EXT LKUP' input/pkValue1=BUS_OBJ_CD input/pkValue2=C1] output=output/infoDescription label=DESCR |
|
外部キー参照がある、またはない汎用オブジェクトについて、外部キー(対応するナビゲーション・リンクを含む)を表示します。外部キー参照が存在する場合は、その情報が表示されます。存在しない場合は表示されません。 標準的な外部キー・サービスでは、すべての行に外部キー詳細があることを前提としています。サービス・スクリプトF1FKInfoOptは、同じ外部キー詳細を提供しますが、外部キー詳細が存在しないときにエラーになりません。外部キーの摘要とリンクを作成するには、このスクリプトを2回使用する必要があります。1つの列でナビゲーション詳細を取得し、もう1つの列で摘要を取得します。後者はナビゲーション詳細列を参照し、ビジネス・プロセス・アシスタント・スクリプトを起動して動的ナビゲーションを実行します。 |
この列は、ナビゲーション詳細を取得します。 source=SS ss='F1FKInfoOpt' input=[input/fkReference=C9 input/fkValue1=C6 input/fkValue2=C7] output=output/navigationOption suppress=true この列は、外部キーの摘要とリンクを構成します。 source=SS ss='F1FKInfoOpt' input=[input/fkReference=C9 input/fkValue1=C6 input/fkValue2=C7] output=output/infoDescription label=F1_APPSEC_COMP_DESCR bpa='F1ApsecNav' tempstorage=[navopt=C15 pkField1=C10 pkValue1=C6 pkField2=C11 pkValue2=C7] list=true |