Oracle® Fusion Middleware Oracle Reports ServicesレポートWeb公開ガイド 11g リリース2(11.1.2) B70751-01 |
|
![]() 前 |
![]() 次 |
配布XMLファイルの要素は、次のとおりです。
このうちほとんどの要素には、その要素の動作を定義する属性があります。次の各項では、配布XMLファイル要素とその関連属性について説明します。第19.5項「配布XMLファイルの例」では、一般的なシナリオにおける配布XMLファイルの要素と属性の使用例を示します。
例
<destinations>
one or more distribution specifications
</destinations>
必須/オプション
必須です。配布XMLファイルには、1つのdestinations
要素を指定する必要があります。
説明
destinations
要素は、配布XMLファイルのコンテンツ領域を開始および終了します。配布XMLファイルのタグ階層で見ると、destinations
要素にそれ以外のすべての要素が従属しています。
例
<foreach> <mail id="a1" to="my_addressee@mycompany.com" subject="Fourth Quarter Results"> <attach format="pdf" name="dept_&<department_ID>.pdf' srcType="report" instance="this"> <include src="mainSection"/> </attach> </mail> </foreach>
または
<mail id="a4" to="recipient@mycompany.com" subject="Regional Results"> <foreach> <attach format="pdf" name="report.pdf" srcType="report" instance="all"> <include src="mainSection"/> </attach> </foreach> </mail>
必須/オプション
オプションです。foreach
要素は、必要な数だけ指定できます。
説明
foreach
要素は、繰返しグループに対して配布を一括処理するために使用します。foreach
を使用できるのは、関連するレポート定義ファイル(RDF、JSP、XMLのいずれか)において、一括処理されるセクションに対する繰返しプロパティが、該当するグループに設定されている場合にかぎられます。foreach
要素は、開始と終了タグの間に定義されている配布を、各繰返しグループに対して実行するように指定します。
「繰返し」プロパティは、レポート・セクション(ヘッダー、メイン、トレーラ)でデータ・モデルのブレーク・グループをセクションに関連付けるために設定できます。セクションに「繰返し」プロパティを設定すると、セクションの複数インスタンス(繰返しセクション)を生成できます。
レポートで一括処理および配布を実装する場合は、セクションの「繰返し」プロパティをデータ・モデルのブレーク・グループに設定すると、セクション・レベルの配布を生成することができます。これにより、そのブレーク・グループの列レコードごとにセクションのインスタンスが生成されます。その後、セクションの各インスタンスを適宜配布できます(たとえば、MANAGER
グループ内の個々のマネージャへの配布)。
「繰返し」プロパティを複数のレポート・セクション(ヘッダー、メインおよびトレーラ)に対して設定する場合は、「繰返し」プロパティの値は同じデータ・モデルのブレーク・グループに設定する必要があります。ヘッダー、メインおよびトレーラ・セクションのいずれかで「繰返し」プロパティを異なるデータ・モデルのブレーク・グループに設定した場合、Oracle Reportsでは次のメッセージが表示されます。
REP-177: Error while running in remote server REP-34320: Report sections used in destination '<destination id>' do not repeat on the same group
foreach
要素をmail要素のサブ要素としても使用できます。これは、この項の始めで2番目の例に示されているとおりです (この例では、mainSection
がG_DEPARTMENT_ID
で繰り返されることを前提として、レポートのmainSection
のすべてのインスタンスを含んだ1つの添付ファイルが1つのファイルに作成されます)。
foreach
要素の動作には、attach要素およびfile要素のinstance
属性が密接に関係しています。foreach
でレコード・グループに従って配布を実行するように指定し、instance
で、一括処理されるグループを1つのファイルで配布するか(instance="all"
)、または別々のファイルとして、つまりグループ・インスタンスごとに1つのファイルを配布するか(instance="this"
)を指定します。
mail
要素とともに使用した場合、foreach
の意味は、mail
要素に対するその位置によって変わります。
foreach
がmail
要素およびinstance="this"
の前にある場合は、各グループ・インスタンスが別々のメールとして送信されます。例:
<foreach> <mail id="a1" to="managers@mycompany.com" subject="results"> <attach name="department_&<department_id>.pdf" instance="this"> <include src="mainSection" /> </attach> </mail> </foreach>
レポートがdepartment_id
に従ってグループ化され、かつ4つの部門が存在する場合は、グループ・インスタンスの数が4つになります。つまり、受信者ごとに4通の電子メールが作成され、各電子メールにその独自のグループ・インスタンスが添付されます。たとえば、ある電子メールに部門10のレポート、別の電子メールに部門20のレポートが添付され、残りの電子メールにもそれぞれ違う部門のレポートが添付されます。各受信者が、4通の電子メールすべてを受け取ります。
foreach
がmail要素およびinstance="this"
の後にある場合は、各グループ・インスタンスが1通の電子メールに添付され、それが各受信者に送信されます。例:
<mail id="a1" to="managers@mycompany.com" subject="results"> <foreach> <attach name="department_&<department_id>.pdf" instance="this"> <include src="mainSection" /> </attach> </foreach> </mail>
例
<mail id="a1" to="jsmith@foo.com" subject="Results"> <body srcType="text"> Attached are quarterly results. </body> <attach srcType="report"> <include src="headerSection"/> <include src="mainSection"/> </attach> </mail>
または
<mail id="a4" to="recipient@mycompany.com" subject="Regional Results"> <foreach> <attach format="pdf" name="report.pdf" srcType="report" instance="this"> <include src="mainSection"/> </attach> </foreach> </mail>
必須/オプション
オプションです。mail
要素は、必要な数だけ指定できます。
説明
mail
要素は、SMTPベースの発信メール・サーバーを介した配布を指定するために使用します。この要素を使用して、電子メールの受信者、件名および優先度を指定します。
mail
要素の開始と終了タグの間には、body
サブ要素を1つだけ指定できます。また、任意数のattach
サブ要素とforeach
サブ要素を任意の場所に指定できます。
mail
要素には、関連する属性もあります。これらの属性は、mail
タグ内に記述されます。たとえば、id
、to
、subject
の3つの属性が記述されます。
<mail id="a1" to="jsmith@foo.com" subject="Recent Hires">
表19-2では、mail
要素の属性を説明します。
表19-2 mail要素の属性
属性 | 有効値 | 説明 |
---|---|---|
文字列 |
必須です。特定のmail要素を識別する、配布XMLファイル内で一意のキーワードです。テキスト文字列と1つ以上の数値を組み合せた値を指定できます( |
|
文字列 |
必須です。変数値を指定できます。電子メールの受信者を指定します。完全で正式な電子メール・アドレスを含みます。例:
複数の受信者は、カンマで区切ります。 関連レポートで使用されている列を参照する変数値を指定することもできます。詳細は、第19.3.2項を参照してください。 |
|
文字列 |
オプションです。変数値を指定できます。電子メールのコピーを受け取る受信者を指定します。 |
|
文字列 |
オプションです。変数値を指定できます。電子メールのブラインド・コピーを受け取る受信者を指定します。 |
|
文字列 |
オプションです。変数値を指定できます。電子メールの送信者を指定します。 |
|
文字列 |
オプションです。変数値を指定できます。返信の送信先となる電子メール・アカウントを指定します。 |
|
文字列 |
デフォルト: Mail Sent from オプションです。変数値を指定できます。電子メールの件名を指定します。subjectが指定されなかった場合は、件名の行にMail Sent from [ |
|
|
デフォルト: 電子メールの配信優先度。 |
|
|
デフォルト: 電子メールが受信されたときに返信先の個人またはアカウントに通知するかどうかを指定します。 |
|
文字列 |
オプションです。変数値を指定できます。電子メールを配布する組織の名前を指定します。例: organization="Region 10 Sales" または organization=" |
注意: mail要素が正しく機能するには、Reports Serverで、メールの送信先である発信SMTPメール・サーバーを認識できる必要があります。この情報は、Reports Server構成ファイル(rwserver .conf )で指定します。このファイルのpluginParam 要素に、メール・サーバーの名前を入力できます。例:
<pluginParam name="mailServer" value="%MAILSERVER%"> <property name="enableSSL" value="yes"/> </pluginParam> 詳細は、第7章「Oracle Reports Servicesの構成」を参照してください。 |
例
Windowsの場合
<mail id="a1" to="jsmith@foo.com" subject="Results"> <body srcType="file"> <include src="c:\mail\body.html"/> </body> </mail>
UNIXの場合
<mail id="a1" to="jsmith@foo.com" subject="Results"> <body srcType="file"> <include src="/mail/body.html"/> </body> </mail>
必須/オプション
オプションです。1つのmail要素には、body要素を1つだけ関連付けることができます。
説明
body
要素は、mail
要素のサブ要素です。これは、電子メールの内容(body
)を指定します。body
では、body
要素の開始タグと終了タグとの間にテキスト文字列を入力することも、includeサブ要素を使用して外部ファイル、レポートまたはレポートのセクションを指定することもできます。例:
<mail id="a1" to="jsmith@foo.com" subject="Results"> <body srcType="text"> Attached are quarterly results. </body> …
または
<mail id="a1" to="jsmith@foo.com" subject="Results"> <body srcType="file"> <include src="d:/reports/admin/results.html"/> </body> …
または
<mail id="a1" to="&<first_name>.&<last_name>@myco.com" subject="Quarterly Results"> <body srcType="report" format="html"> <include src="headerSection"/> </body> …
body
要素には、srcType
、format
、instance
の3つの属性があります。詳細は、表19-3を参照してください。
表19-3 mailのbodyサブ要素の属性
属性 | 有効値 | 説明 |
---|---|---|
|
デフォルト: 電子メールの内容のソース。内容は電子メールの本文に表示されます。 |
|
|
デフォルト:
|
|
|
デフォルト: foreach要素が存在する場合にも使用します。グループ化されたレポートが別々のレポートに一括処理される場合は、 |
例
<mail id="a1" to="jsmith@foo.com" subject="Results"> <body srcType="text"> Attached are quarterly results. </body> <foreach> <attach format="html" name="contacts.htm" srcType="report" instance="all"> <include src="headerSection"/> <include src="mainSection"/> </attach> </foreach> </mail>
または
<mail id="DEST1" to="tsmith@oracle.com" subject="Mail from dest" > <attach srcType="report" format="delimiteddata" name="myattach.txt" <include src="report"/> </attach> </mail>
必須/オプション
オプションです。attach
要素は、1つのmail
要素に対して必要な数だけ指定できます。attach
は、foreachのサブ要素でもあることに注意してください。foreach
では、そのサブ要素(mail、file、printer、destype
およびattach
)を1つ以上使用する必要があります。
説明
attach
要素は、電子メールの添付ファイルを指定します。attach
には1つ以上のincludeサブ要素が必要です。srcType="report"
である場合は、このサブ要素を複数指定できます。
表19-4ではattach
要素の属性を説明します。
表19-4 mailのattachサブ要素の属性
属性 | 有効値 | 説明 |
---|---|---|
|
デフォルト: 添付ファイルのフォーマットを指定します( |
|
|
オプションです。変数値を指定できます。添付ファイルのファイル名を指定します。関連レポートで使用されている列を参照する変数値を指定することもできます。詳細は、第19.3.2項を参照してください。 |
|
|
デフォルト: 添付ファイルのソース(ファイル、レポート、テキストのいずれか)。 |
|
|
デフォルト: foreach要素が存在する場合にも使用します。グループ化されたレポートが別々のレポートに一括処理される場合は、 |
これらの属性をforeach要素と併用すると、グループ・インスタンスで繰り返される宛先を設計し、グループの添付ファイルごとに電子メールを生成できます。例:
<foreach> <mail id="a2" to="first.name@myco.com,second.name@myco.com, third.name@myco.com, fourth.name@myco.com" subject="Department Summaries"> <body srcType="text"> Attached is the breakdown of department summaries for the last quarter. </body> <attach format="htmlcss" name="deptsum.html" srcType="report" instance="this"> <include src="report"/> </attach> </mail> </foreach>
foreach
要素の位置を変えると、複数のファイルが添付された1通の電子メールを生成できます。この場合、グループ・インスタンスごとに添付ファイルが異なります。
<mail id="a2" to="first.name@myco.com,second.name@myco.com, third.name@myco.com, fourth.name@myco.com" subject="Department Summaries"> <body srcType="text"> Attached is the breakdown of department summaries for the last quarter. </body> <foreach> <attach format="htmlcss" name="deptsum.html" srcType="report" instance="this"> <include src="report"/> </attach> </foreach> </mail>
例
<mail id="a1" to="jsmith@foo.com" subject="Q4"> <body srcType="text"> Attached are quarterly results. </body> <attach srcType="report" format="pdf"> <include src="report"/> </attach> </mail>
または
<mail id="a1" to="jsmith@foo.com" subject="Q4"> <body srcType="text"> Attached are quarterly results. </body> <attach srcType="report" format="htmlcss"> <include src="headerSection"/> </attach> </mail>
または
<mail id="a1" to="jsmith@foo.com" subject="Q4"> <body srcType="text"> Attached are quarterly results. </body> <attach srcType="file"> <include src="d:/management/reports/current/Q4.htm"/> </attach> </mail>
必須/オプション
body
およびattach
と併用する際、srcType
がreport
またはfile
である場合は必須です。ただし、srcType
がtext
である場合はオプションです。また、file
、printer
およびdestype
とともに使用する場合は必須です。include
が必要なインスタンスでは、必ず1つ指定する必要があります。複数指定してもかまいません。
説明
include
要素は、body、attach、file、printerおよびdestypeの各要素とともに使用できます。これは、電子メールの本文に含めるファイル、レポートまたはレポート・セクションを、電子メールの添付ファイル、ファイルの内容、プリンタ出力またはカスタム宛先タイプの内容として指定します。
レポート全体ではなく複数のセクションを指定する場合は、必要なセクションごとにinclude
を入力します。例:
<mail id="a1" to="jsmith@foo.com" subject="Results"> <body srcType="text"> Attached are quarterly results. </body> <attach srcType="report" format="htmlcss"> <include src="headerSection"/> <include src="mainSection"/> </attach> </mail>
先に指定されたbody
要素やattach
要素のsrcType
属性がfile
である場合、これに続くinclude
で、そのファイルをディレクトリ・パスとファイル名で指定できますし、単にファイル名でも指定できます(そのファイルがREPORTS_PATH
環境変数で示されたディレクトリ内にある場合)。例:
<mail id="a1" to="jsmith@foo.com"> <body srcType="file"> <include src="q4sales.pdf"/> </body> </mail>
パスを指定する場合は、プラットフォームに適した標準を使用してください。例:
Windowsの場合:
<include src="c:\management\reports\current\Q4.htm"/>
UNIXの場合:
<include src="/management/reports/current/Q4.htm"/>
include
要素の開始タグと終了タグの間に他のXML要素は記述されません。
表19-5では、include
要素のsrc
属性について説明します。
表19-5 bodyまたはattachとともに使用されるincludeサブ要素の属性
属性 | 有効値 | 説明 |
---|---|---|
|
必須です。先行する 配布XMLファイルは、特定のレポートを実行するときに呼び出されるため、
その他の値: 先行する |
例
Windowsの場合
<file id="a7" name="c:\management\reports\report.pdf" format="pdf"> <include src="report"/> </file>
または
<file id="MyFiles2" name="c:\My_Departments_Report.txt" format="delimiteddata"> <include src="report"/> </file>
UNIXの場合
<file id="a7" name="/management/reports/report.pdf" format="pdf"> <include src="report"/> </file>
または
<file id="MyFiles2" name="/My_Departments_Report.txt" format="delimiteddata"> <include src="report"/> </file>
WindowsまたはUNIXの場合
<foreach> <file id="a7" name="section&<department_id>.pdf" format="pdf" instance="this"> <include src="mainSection"/> </file> </foreach>
必須/オプション
オプションです。file
要素は、必要な数だけ指定できます。
説明
file
要素は、ファイルへの配布を指定するために使用します。file
要素には、includeというサブ要素が1つあります。file
要素の開始タグと終了タグの間には、少なくとも1つのinclude
サブ要素が必要です。このサブ要素は複数指定できます。
file
要素を、foreach要素およびinstance="this"
属性とともに使用すると、グループ化されたレポートの各グループ・インスタンスを別々のファイルに配布できます。たとえば、レポートをdepartment_id
でグループ化し、4つの部門が存在する場合は、foreach
/file
/instance="this"
を組み合せて、それぞれが別々の部門のレポートを含んだ4つのファイルを生成できます。この場合、配布XMLファイルにおけるfile
エントリは、次のようになります。
<foreach> <file id="a3" name="dept_&<department_id>.pdf" format="pdf" instance="this"> <include src="report"/> </file> </foreach>
この例では、すべてのレポート・セクション(ヘッダー、メインおよびトレーラ)が同じグループ・インスタンス(department_id
など)で繰り返されます。
表19-6では、file
要素の属性を説明します。
表19-6 file要素の属性
属性 | 有効値 | 説明 |
---|---|---|
文字列 |
必須です。特定のfile要素を識別する、配布XMLファイル内で一意のキーワードです。テキスト文字列と1つ以上の数値を組み合せた値を指定できます( |
|
文字列 |
必須です。変数値を指定できます。宛先ファイルの場所とファイル名を指定します。ディレクトリ・パスを入力します。ファイル名も含めます。例: Windows: UNIX: 関連レポートで使用されている列を参照する変数値を指定することもできます。詳細は、第19.3.2項を参照してください。 |
|
|
デフォルト: 宛先ファイルのフォーマットです。例:
|
|
|
デフォルト: foreach要素が存在する場合にも使用します。グループ化されたレポートが別々のレポートに一括処理される場合、 |
例
Windowsの場合
<printer id="a1" name="\\server_name\printer_name" copies="5"> <include src="report"/> </printer>
UNIXの場合
<printer id="a1" name="alias_to_registered_printer" copies="5" instance="all"> <include src="report"/> </printer>
必須/オプション
オプションです。printer
要素は、必要な数だけ指定できます。
説明
printer
要素は、プリンタへの配布を指定するために使用します。printer
要素には、includeというサブ要素が1つあります。printer
要素の開始タグと終了タグとの間には、1つ以上のinclude
サブ要素が必要です。このサブ要素は複数指定できます。
printer
要素を、foreach要素とinstance="this"
属性と併用すると、グループ化されたレポートの各グループ・インスタンスを別々の印刷ジョブに配布できます。たとえば、レポートをdepartment_id
でグループ化し、4つの部門が存在する場合、foreach
/printer
/instance="this"
を組み合せて、4つの印刷レポート(それぞれが別々の部門のレポートを含んだレポート)を生成できます。この場合、配布XMLファイルにおけるprinter
エントリは、次のようになります。
<foreach> <printer id="a7" name="\\server_name\printer_name" instance="this"> <include src="report"/> </printer> </foreach>
この例では、すべてのレポート・セクション(ヘッダー、メインおよびトレーラ)が同じグループ・インスタンス(department_id
など)で繰り返されます。
表19-7では、printer
要素の属性を説明します。
表19-7 printer要素の属性
属性 | 有効値 | 説明 |
---|---|---|
文字列 |
必須です。特定のfile要素を識別する、配布XMLファイル内で一意のキーワードです。テキスト文字列と1つ以上の数値を組み合せた値を指定できます( |
|
文字列 |
必須です。変数値を指定できます。宛先のプリンタを指定します。この情報の入力方法は、WindowsとUNIXで異なります。 Windowsの場合は、プリンタ・サーバー名とプリンタ名を指定します。例: name=" UNIXの場合は、登録されたプリンタに割り当てられた別名を指定します。例: name=" 関連レポートで使用されている列を参照する変数値を指定することもできます。詳細は、第19.3.2項を参照してください。 |
|
文字列 |
デフォルト: 各レポートまたは各レポート・グループ・インスタンスの印刷部数。 |
|
|
デフォルト: foreach要素が存在する場合にも使用します。グループ化されたレポートが別々のレポートに一括処理される場合、 |
例
<destype id="acustom1" name="fax"> <include src="headerSection"/> <property name="number" value="914925551212"/> </destype>
配布XMLファイルにdestype
要素を使用して、配布の宛先をOracle Portal、FTP、WebDAVおよびFAXに指定する例の詳細は、第19.5項「配布XMLファイルの例」を参照してください。
必須/オプション
オプションです。destype
要素は、必要な数だけ指定できます。
説明
destype
要素は、FAXマシンやFTPサイトなどのカスタムの宛先への配布を指定するために使用します。また、Oracle Portalで作成されたポータルへの配布を指定する場合も、destype
要素を使用します。destype
要素では、propertyおよびincludeの2つのサブ要素を使用できます。このうち、include
は少なくとも1つ指定する必要があります。
注意: カスタムの宛先タイプを指定するには、レポートの内容をカスタムの出力先に導くための配布ハンドラを定義する必要があります。カスタムの宛先タイプは、Oracle Reports Services Destinations APIで作成します。使用可能なOracle ReportsのAPIの詳細は、Oracle Technology Network(OTN)( |
destype
要素を、foreach要素とinstance="this"
属性と併用すると、グループ化されたレポートの各グループ・インスタンスを別々のdestype
インスタンス(別々のFAXなど)に配布できます。たとえば、レポートをdepartment_id
でグループ化し、4つの部門が存在する場合は、それぞれが別々の部門のレポートが含まれる4つのdestype
インスタンスを生成できます。この場合、配布XMLファイルにおけるdestype
エントリは、次のようになります。
<foreach> <destype id="a9" name="fax" instance="this"> <include src="report"/> <property name="number" value="&<fax_number>"/> </destype> </foreach>
この例では、すべてのレポート・セクション(ヘッダー、メインおよびトレーラ)が同じグループ・インスタンス(fax_number
など)で繰り返されます。
カスタムの宛先タイプには、関連する属性もあります。これらの属性は、destype
タグ内に記述されます。たとえば、id
、name
、instance
の3つの属性が記述されます。
<foreach>
<destype id="a1" name="name_of_destination_type" instance="all">
<include src='report'/>
</destype>
</foreach>
表19-8ではdestype
要素の属性を説明します。
表19-8 destype要素の属性
属性 | 有効値 | 説明 |
---|---|---|
文字列 |
必須です。特定のfile要素を識別する、配布XMLファイル内で一意のキーワードです。テキスト文字列と1つ以上の数値を組み合せた値を指定できます( |
|
文字列 |
必須です。カスタムの宛先の名前を指定します。たとえば、FAXの場合は次のように指定します。
Oracle Portalで作成されたポータルの場合は、次のように指定します。
|
|
|
デフォルト: foreach要素が存在する場合にも使用します。グループ化されたレポートが別々のレポートに一括処理される場合は、 たとえば、カスタムの宛先タイプがFAXである場合、 |
例
<foreach> <destype id="custom1" name="fax" instance="all"> <include src="headerSection"/> <property name="number" value="914925551212"/> </destype> </foreach>
必須/オプション
オプションです。destype
要素の下には、必要な数のプロパティを指定できます。
説明
property
要素には、カスタムの宛先タイプ(destype)で認識できる用語により表された名前/値のペアを指定します。プロパティは、単に宛先ハンドラに渡されます。Oracle Reports Services内では特に機能しません。プロパティの指定方法は、使用するカスタムの宛先の要件に完全に依存します。