idapi.book

(1)

Actuate iServer API リファレンス

(2)

このマニュアルの情報は、予告なしに変更されることがあります。このマニュアル中で提示している例は架空のものです。このマニュアルの一部または全部を、Actuate

Corporationの文書による承諾なく、いかなる形あるいは手段においても複製、電送する

ことを禁じます。

このマニュアルの情報の所有権は次に属します。

Actuate Corporation 701 Gateway Boulevard South San Francisco, CA 94080 http://www.actuate.com

このマニュアルに記載されているソフトウェアは、使用許諾書の条件に従い、Actuate

Corporationにより提供されます。このソフトウェアおよびマニュアルは、本製品の使用

許諾書のもとでのみ使用することができます。

Actuate Corporationの商標および登録商標：

Actuate、Actuateロゴ、e.Analysis、e.Report、e.Reporting、e.Spreadsheet、 Formula One、Internet Spreadsheet、Live Report Document、ReportCast、 Report Encyclopedia、ReportingEngines、ReportingEnginesロゴ、Reportlet、

Spreadsheets Everywhere、Tidestone Technologies、およびXML reports。

サードパーティの各所有者、会社、または組織の商標または登録商標：

Apache Software Foundation（http://www.apache.org/）: Crimson、Tomcat、Xalan、およびXerces。 Apple Computer, Inc.: TrueType。 BEA Systems, Inc.: BEA WebLogic Server。 Bits Per Second, Ltd.およびGraphics Server Technologies, L.P.: Graphics Server。

Borland Software Corporation: JBuilder。 Bristol Technology, Inc.: XPrinter。 Bruno LowagieおよびPaulo Soares: Mozilla Public License（MPL）のライセンスによるiText。 Component One, LLC.: VSFlexGrid Pro。 Fred L. Drake, Jr.（http://sourceforge.net/

projects/expat）: James Clark作成、MIT LicenseのライセンスによるExpat XML parser。 Hewlett-Packard Company: HP-UX。 IBM Corporation: 1-2-3、AIX、DB2、Informix- ESQL/C、ICU、Lotus、およびWebSphere。 Indiana University Extreme! Lab（http://

www.extreme.indiana.edu）: XML Pull ParserおよびXPP。 InstallShield Corporation:

InstallShield。 InterNetivity Inc.: Databeacon。 JDBM Project

（http://jdbm.sourceforge.net）: JDBM。 LEAD Technologies, Inc.: LEADTOOLS。 Linus Torvalds: Linux。 Microsoft Corporation: ActiveX、Microsoft、MS-DOS、MSN、

Windows、Windows NT。 Netscape Communications Corporation, Inc.: Netscape、

Netscape Communications、Netscape Communicator、Netscape Enterprise Server、

およびNetscape Navigator。 Oracle Corporation: Oracle Call Interface。 Progress Software Corporation: Progress。 Quadralay Corporation: WebWorks。 Rogue Wave Software, Inc.:

NobleNet RPCおよびRogue Wave SourcePro。 SAP AG: SAP。

(3)

不要な情報や技術を減らすことによって、ビジネスユーザが使用できる機能をいっそう拡充したものにすることが、常に重視されてきました。プロジェクト全体の費用と人件費を抑えるとともに、ビジネスユーザは、開発された技術や情報を、独自のニーズを満たすために活用できなければなりません。それと同時に、情報管理者は、内部情報の信頼性を高めるために、社内のビジネスユーザが、提供された情報をどのように使用しているかを確実に把握しておく必要があります。

たとえば、SEC（Securities and Exchange Commission：米国証券取引委員会）では、法人の情報管理インフラストラクチャに関する規定を新たに加えました。

Actuateの技術を採用すると、ビジネスユーザは、適切な形式の正しい情報にアク

セスし、その情報を的確に活用することができます。また、情報技術関連会社では、自社の持つ情報という資産を適切に管理するためのツールも必要です。この条件を満たすために、Actuateの情報管理アプリケーションプラットフォームには、

次の3つの重要な要素が含まれています。

■ 情報サーバ

■ 情報管理アプリケーション開発環境

■ ユーザ向けのツール

(12)

Actuate 製品のユーザについて

Actuate製品は、航空宇宙産業、金融・証券・保険業、エンターテイメント、小売

業、通信業、人間工学・製薬・ヘルスケア産業、ハイテク産業、防衛・政府機関など、幅広い分野で使用されています。

Actuateのインフラストラクチャソフトウェアは、事業の分析と評価、取引管理、

e.billing、電子調達、インタラクティブなレポート作成、スプレッドシート形式の

レポート作成、管理機能の統合、人事、情報ポータル、業績評価指標、サービスオートメーション、サプライチェーン管理、システム管理などで使用するアプリケーションの基盤となるものです。また、Actuate製品の構造化されたコンテンツ

は、e.Business環境で、企業のWebサイトやアプリケーションパッケージにシー

ムレスに組み込むことができます。

ユーザのニーズに確実に対応

Actuate 7を使って、会社のデータベースから業務用の情報を取得します。このと

き、正しい情報を取得・確認・保存できることが非常に重要になります。さらに、

ユーザの取引先や提携会社、従業員は、インタラクティブなWebページやExcelスプレッドシートで、データを処理して配布するための情報管理アプリケーションも使用します。したがって、Actuate製品のユーザには、次のような機能が必要です。

■ 複数のトランザクションアプリケーションで使用する複数のデータソースのデータを組み合わせる。

■ ビジネスユーザのデスクトップと取引先のWebサイトで使用するExcelシートに矛盾がなく、管理も簡単である。

多言語の情報の配布

Actuateのユーザの事業基盤は、世界各国に広がっています。このようなユーザの

ニーズにお応えするために、Actuate 7には、Unicodeの完全サポートや各種ロケール設定など、さまざまな言語でのレポート作成に必要な機能が搭載されています。

高いパフォーマンスのスケーラブルなサーバ

(13)

充実した情報配布ソリューション

Actuateの情報管理アプリケーションプラットフォームを導入すると、安全かつ費

用効率のよいタイムリーな方法で、必要なコンテンツを必要な形式で使用できます。次の表に、Actuateのアプリケーションプラットフォームに統合できる3種類

のe.Businessアプリケーションを示します。

次の表に、エンタープライズでのレポート作成と情報管理に必要な処理と、それに対応するActuate 7のソリューションの特長を示します。

インフラストラクチャ主な機能 Actuate製品と機能データベースデータの構成 Actuateのデザインツー

ル。データへのアクセス・

管理・更新をサポートします。

コンテンツ管理システム構造化されたコンテンツの管理

Actuate iServer。電子カタログなどの構造化されたコンテンツの公開をサポートします。

アプリケーションサーバオンラインアプリケーションの導入と使用

Actuate Active Portal や

Management Console な

どのWebアプリケーション。複雑なトランザクションの実行、サプライチェーンの管理、商取引などをサポートします。

必要な処理 Actuateのソリューションの特長高品質な情報を配布する。さまざまなデータソースを使用して

も、データのアクセスや表示方法が複雑になりません。

構造化されたコンテンツを表示する。 DHTML形式とスプレッドシート形式のレポートを標準的なブラウザで表示できるので、ユーザが自分でプラグインをインストールする必要がありません。

(14)

Actuate 7 ^と ReportingEngine ^について

ここでは、Actuate Corporationのさまざまな製品について説明します。

Actuate End User DesktopActuate End User Desktop

レポート文書をリクエスト・生成・表示・印刷するためのエンドユーザ向けアプリケーション。 ReportQuery機能によって、Actuateレポートのデータを、その他のツールや分析ツールに簡単に転送できます。

さまざまな形式で情報を表示する。次の機能を使用できます。

■ テンプレートを使ったレポートの設計と表示。

■ 優れた書式設定機能。

■ スプレッドシート形式のレポート。

Webコンテンツを多数の宛先に配布する。

1つのCPUで1日に100万件を超えるヒット数を処理できます。

カスタマイズした情報を安全に配布する。

オープンセキュリティディレクトリとの統合やページレベルセキュリティを提供します。

すでに統合されているコンテンツを繰り返し使用する。

オープンサーバを使って、他のアプリケーションで作成したコンテンツにアクセスできます。

オンラインのデータと印刷されるデータを統一する。

PostScript形式やPDF形式の文書を、高

解像度で印刷できます。

異なるアプリケーション間で情報を交換する。

データをXML形式で出力して、別のアプリケーションでもアクセスできるようにします。

サーバ上でレポートを作成・管理する。クラスタの構成やフェールオーバーをサポートしています。

必要な処理 Actuateのソリューションの特長

(15)

Actuate e.Report Designer Professional

開発者向けのオブジェクト指向アプリケーション。コンテンツを構成して、インフォメーションオブジェクトやレポートオブジェクトデザインを設計・構築・配布できます。 Actuate Basic言語とActuate Foundation Classライブラリを使って、

レポートをカスタマイズすることもできます。

Actuate e.Report Designer Professionalには、次の機能を搭載したActuate Client

Integration Technologyが含まれています。

■ Actuate ActiveXコントロール： Actuateのレポート作成機能を、カスタムアプ

リケーションに組み込みます。

■ Actuate Requester API：レポートパラメタの属性と値へのアクセス、レポート

パラメタの値の変更、レポートの作成の時期と方法の指定、レポートの表示と印刷、レポートの印刷設定などを行います。 Requester APIでは、Actuate Basic、

Visual Basic、C、C++を使用します。

■ Actuate Search Extension API：サードパーティ製のオフィスツールや分析ツー

ルにデータを転送するための検索機能を開発できます。

■ Actuate Information Object：定義済みのクエリを使って、データソースから

データを取得します。Actuate iServer Actuate Query Optionでは、ユーザがインフォメーションオブジェクトのクエリをカスタマイズして、データソースから取得する情報をフィルタしたりソートすることができます。

Actuate e.Spreadsheet Designer

Webベースの独自のスプレッドシートを設計・作成・配布するためのアプリケー

ション。 Actuate iServerで取得したデータから、Excelなどの書式設定されたスプ

レッドシート形式のレポートを動的に作成できます。これらのスプレッドシート形式のレポートは、アプリケーションのコンポーネント、アプレット、JavaBean として使用できます。

Actuate iServer System

インフォメーションオブジェクトとレポート文書を生成し、EncyclopediaÆボリュームで管理して、ユーザが使用できるようにするためのサーバアプリケー

ション。複数のActuateサーバで構成したクラスタをサポートしています。Actuate

iServer Systemには、次の製品があります。

■ Actuate Active Portal for JSP、Actuate Active Portal for .NET、Actuate

ReportCast™ Encyclopediaボリュームから、セキュリティ機能を持つ動的な

Webサイトを作成します。作成するWebサイトのチャンネルを設定し、他の Webサイトとシームレスに統合できます。

■ Management Console：システム管理者やネットワーク管理者がActuateサーバ

を管理するためのアプリケーション。

(16)

■ Actuate Server Integration Technology：次の機能があります。

■ Actuate Information Delivery API： ActuateのWebサービスを、社内の既存

のアプリケーションに組み込み、iServerの導入や日常的な作業を自動化して、会社のビジネスプロセスに必要な独自の機能を実装します。 Actuate

Information Delivery APIは、XMLに基づいたインターフェースで、SOAP

メッセージプロトコルをサポートしています。

■ Actuate Report Server Security Extension：サードパーティ製のセキュリ

ティツールを使用できるようにします。

■ Actuateアーカイブドライバ：サードパーティ製のアーカイブソフトウェア

とハードウェアを使用できるようにします。

■ Actuate Report Server API： C++を使って、Encyclopediaボリュームの一般

的な機能を実装します。

Actuate 7には、次のiServerオプションがあります。

■ Actuate e.Analysis Option

Actuate e.Reportのデータを、インタラクティブに使用できるようにします。

ユーザは、データを表示して、その関係や傾向を分析できます。

■ Actuate e.Report Option

BasicとJavaのオプション。Encyclopediaボリュームの機能を、e.Report

Designer、e.Report Designer Professional、Formula One e.Report Designerで使用できます。

■ Actuate e.Spreadsheet Option

e.Spreadsheet Designerファイルから、Excelスプレッドシートを生成するオー

プンサーバアプリケーション。スプレッドシート形式のレポートや分析情報を

Actuate iServerで管理したり、Actuateレポートを書式設定したExcelスプレッ

ドシートとして保存することができます。

■ Actuate Query Option

Webベースのツール。定義済みのデータストリームに基づいたアドホッククエリを使用できます。

■ Multi-Application Option

Actuate iServer Systemで、複数のEncyclopediaボリュームを使用できるオプ

ション。

(17)

Actuate Live Report Extension（LRX）

エンドユーザ向けアプリケーション。Microsoft Internet Explorer とNetscape

Navigatorの両方で、Web上のレポートを表示・印刷できるようにします。Actuate

ReportCastと一緒に使用します。

Actuate Viewer

エンドユーザが、レポート文書を検索・表示・印刷するためのアプリケーション。

Formula One e.Report Engine

データソースのデータを抽出・書式設定・配布するためのJavaツール。データベー

ス、Enterprise JavaBean、アプリケーション内のJavaオブジェクト、テキストファ

イルなどのデータソースを扱えます。完成したレポートは、DHTML、HTML、 PDF、XML 形式や電子メールメッセージ形式で、J2EE アプリケーション、

WebLogic、WebSphere、Webサーバを使って配布できます。アプリケーションの

データハンドラで、アプリケーション内のJavaオブジェクトへのアクセスを設定できます。 XMLで記述されたさまざまなデータソースとレポートの出力をサポートしています。

この製品には、Formula One e.Report Designerも含まれています。これは、Java プログラムの開発者向けのレポート開発アプリケーションです。DHTML、Excel、

HTML、PDF、XML形式のレポートを開発し、複数の表示と印刷の形式を設定で

きます。

Formula One e.Spreadsheet Engine

Webベースの独自のスプレッドシートを設計・作成・配布するためのアプリケーション。ユーザが、Excelなどの書式設定されたスプレッドシート形式のレポートを動的に作成できます。書式設定されたExcelファイルの読み取りと書き込み、計算機能の拡張、スプレッドシートの数式や関数の使用、モデル化によるリスク管理、動的なグラフの生成、スプレッドシートインターフェースの組み込みなどを行えます。

(18)

Actuate iServer System ^{製品の概要}

Actuate iServer Systemには、印刷されたユーザガイド、インストールガイド、オ

ンラインヘルプ、PDFとHTML形式のユーザガイド、リリースノートが付属しています。リリースノートには、印刷された文書には記載されていない情報が含まれています。

ActuateのWebサイト（http://www.actuate.com/jp）には、製品や機能の最新情

報と、製品のアップデートに関する情報が掲載されています。 Webサイトの登録ユーザ専用ページにアクセスするには、パスワードが必要です。詳しくは、Actuate カスタマサポートにお問い合わせください。 Actuateカスタマサポートでは、お客様とのサービス契約に基づいて、製品に関する技術的な質問にもお答えしています。カスタマサポートの電話番号と電子メールアドレスは、製品に同梱されているカードに記載されています。

次の表に、製品に付属している印刷文書とオンラインマニュアルを示します。

主な内容文書の名前

インストールインストールガイド

ソフトウェアと付属文書に関する最新情報

リリースノート

Actuate iServer Systemアーキテクチャ

の概要

iServer Systemの設定と管理

データベース接続

Encyclopediaボリューム管理

ユーザ、グループ、権限、および役割プリンタおよび印刷要求

Actuate Information Delivery API、

Webサービス、およびSOAPメッセージの概要

Information Delivery APIによるプログ

ラミングの例

Administering Actuate iServer System

iServer アプリケーションのプログラミング

(19)

Actuate Information Delivery API のデータ型とメッセージ

アーカイブ機能とReport Serverのセキュリティエクステンション機能

レポートへのアクセス・表示・実行・

印刷・検索について

さまざまな言語のレポートの書式設定について

レポートのエンコードについて右から左に読むレポートの設計

Actuate Active Portal、Active Portal JavaServer Pages、JavaScriptファイル、

カスケードスタイルシート、カスタムタグ、およびセキュリティ

Actuate ReportCastを使用したレポー

トへのアクセス・表示・実行・印刷・

検索について

Actuate ReportCast、ReportCastテンプレート、URL宣言、スクリプト言語、

セキュリティおよびユーザ認証機能

Actuate iServer API リファレンス

e.Reports の使用

Working with Multiple Locales

Creating Custom Web Applications using Actuate Active Portal

Using and Customizing Actuate ReportCast

(20)

Actuate iServer API Reference ^の概要

Actuate iServer API Referenceは、Actuate Information Delivery APIの使用に関する情報を提供します。

Actuate iServer API Referenceには、次の章があります。

■ 「はじめに」。この章では、このマニュアルの概要、Actuate e.Reporting Suite、

および表記規則について説明します。

■ 第I部「Actuate Information Delivery APIリファレンス」この部には、一緒に使用されることの多いActuate Information Delivery APIメッセージのグループ別一覧と、Actuate Information Delivery APIのデータ型およびメッセージの詳細説明があります。

■ 第1章「Actuate Information Delivery APIメッセージのサマリ」この章には、具

体的なタスクを実行する場合に一緒に使用されることの多いグループ別一覧

Actuateの用語集

用語集

データの分析、表示、カスタマイズ、

およびエクスポート

e.Analysisのカスタマイズ

Actuate 7 Glossary

Using e.Analysis

(21)

■ 第3章「Actuate Information Delivery APIのメッセージ」この章には、Actuate

Information Delivery APIのメッセージのアルファベット順一覧があり、各メッ

セージの一般的な説明、スキーマ、およびパラメタに関する一般的な説明が記載されています。

■ 第II部「iServer統合APIリファレンス」この部では、ActuateロギングAPI、

アーカイブ機能、Report Serverのセキュリティエクステンション（RSSE）機能について説明します。

■ 第4章「ActuateログとモニタAPI関数」この章では、Error Logging、Usage

Logging、およびPerformance Monitoring APIについて説明します。

■ 第5章「アーカイブ関数」この章では、アーカイブ機能について説明します。

■ 第6章「Report Server Security Extension関数」この章では、Report Serverのセキュリティエクステンション（RSSE）について説明します。

オンラインマニュアル

Actuate製品には、印刷されたマニュアルだけでなく、Adobe AcrobatのPDF形式

のマニュアルとオンラインヘルプが付属しています。 Actuate iServer Systemなど

の、Windowsのインターフェースを使わない製品には、HTML形式のヘルプが付

属しています。このヘルプは、一般的なWebブラウザで表示できます。

オンラインマニュアルの使用

Actuateのソフトウェアをインストールすると、オンラインマニュアルもManuals

ディレクトリに自動的にインストールされます。オンラインマニュアルの目次の項目と索引のページ番号は、本文の該当するページへのリンクになっています。索引のリンクを使用するには、項目ではなく、ページ番号をクリックしてください。

オンラインヘルプの使用

Actuate製品には、各製品のコンテキスト依存のオンラインヘルプと、表示してい

るレポート固有のオンラインヘルプが付属しています。また、Actuate 7のレポートには、それぞれに固有の情報を含めたオンラインヘルプを開発することもできます。

(22)

Actuate のオンラインヘルプの使用

Actuate 7のオンラインヘルプの画面は、2つのペインに分かれています。左側の

ペインには、目次と索引が表示されます。右側のペインには、トピックの内容が表示されます。

左側のペインの上部にあるタブを使って、「目次」、「キーワード」、「検索」、「お気に入り」を切り替えます。

次の図に、キーワードでトピックを検索した例を示します。

キーワード一覧を表示する場合に選択

ヘルプファイル内の任意の語にアクセスする場合に選択

ヘルプトピック一覧を表示する場合に選択

キーワード一覧を表示する場合に選択索引を検索するトピックを選択

検索結果からトピックを選択キーワード一覧を表示する場合に選択

(23)

トピックを表示するには、リストからトピックを選択します。トピックが右側のペインに表示されます。

次の図に、検索ページでトピックを検索した例を示します。右側のペインにトピックの内容を表示するには、左側のペインのリストでトピックをダブルクリックします。トピックが右側のペインに表示されます。

レポート固有のオンラインヘルプ

レポートを設計するときに、レポート固有のオンラインヘルプを付けることができます。たとえば、レポートで使われている固有のオブジェクトや計算の説明が表示されるようにします。

レポート固有のオンラインヘルプについては、『Using e.Reports』の3章「Viewing

an e.report」を参照してください。

レポート固有のオンラインヘルプ

(24)

表記規則

次の表に、このマニュアルで使用している表記規則を示します。

構文の表記規則

次の表に、構文の表記規則を示します。

項目表記規則例

コードゴシック体で表示します。 Dim Text1 As String ファイル名 1文字目を大文字で示し

ます。ただし、Formula One e.Report Designerでは、ファイル名の大文字と小文字が区別されるので、この限りではありません。

Detail.roi

キーの組み合わせ 2つのキーの間の＋記号は、両方のキーを同時に押すことを示します。

Ctrl＋Shift

メニュー項目大括弧で囲みます。［ファイル］

サブメニューの項目メインメニューとサブメニューを大括弧で囲み、

矢印で区切ります。

［ファイル］→［新規作成］

ユーザが入力する項目ゴシック体で表示します。 M*16*

ユーザが入力するXML コードとJavaコード

斜体で表示します。 chkjava.exe cab_name.cab

記号説明例

[ ] オプションの項目を示し [Alias<エイリアス名>]

(25)

{ } 複数のオプションや引数を囲みます。項目が縦線で区切られている場合は、

一度に1つしか選択できないことを示します。

{While | Until}

配列の要素を定義します。 {0、1、2、3}

コードのブロックを区切ります。

public ACJDesigner( ) {

}

| 一度に1つしか選択でき

ないオプションや引数を区切ります。

Exit {Do | For | Function

| Sub}

JavaのOR演算子を示します。

int length |4

記号説明例

(26)

(27)

第部

ëÊIïî

Actuate Information

Delivery API ^{リファレンス}

(28)

(29)

第章

ëÊ1èÕ

Actuate Information

Delivery API ^{メッセージの} サマリ

Actuate Information Delivery API（application programming interface）は、Actuate

iServer Systemの統合と管理をサポートします。このAPIを使用すると、ユーザロ

グインの認証、レポートの生成と表示、Encyclopediaボリュームの管理など、これらのサービスのアクセスや使用が可能になります。

この章では、特定のタスクを実行するために一緒に使用されることが多いメッセージをグループ別に分類して説明します。

■ チャンネル

■ ファイルとフォルダ

■ グループ

■ ジョブとレポート

■ ロール

■ サーバ

■ ユーザ

■ ボリューム

(30)

チャンネル

ファイルとフォルダ

タスクメッセージ

チャンネルを作成 CreateChannel チャンネルを削除 DeleteChannel チャンネルの情報を取得 SelectChannels チャンネルプロパティを更新 UpdateChannel チャンネルのアクセスコントロール

リスト（ACL）を取得

GetChannelACL

Encyclopediaデータベースから

ファイルをダウンロード

DownloadFile フォルダを作成 CreateFolder

Encyclopediaにファイルをアップロード UploadFile

ファイルまたはフォルダを削除 DeleteFile ファイルまたはフォルダをコピー CopyFile ファイルまたはフォルダを移動 MoveFile フォルダ内のオブジェクトを取得 GetFolderItems ファイルの情報を取得 SelectFiles ファイルプロパティを取得 GetFileDetails ファイルまたはフォルダのプロパティ

を更新

UpdateFile 新しいファイルの種類を作成 CreateFileType ファイルの種類を削除 DeleteFileType

(31)

グループ

ジョブとレポート

通知グループを作成 CreateGroup 通知グループを削除 DeleteGroup 通知グループの情報を取得 SelectGroups 通知グループのプロパティを更新 UpdateGroup

同期レポートを実行 ExecuteReport レポートを印刷 PrintReport レポートを実行 SubmitJob レポートを実行して印刷 SubmitJob クエリを読み取ってDOV（data

object values）ファイルを生成

CreateQuery クエリを読み取って実行 ExecuteQuery クエリ情報を取得 GetQuery

ジョブを削除 DeleteJob

非同期ジョブ実行を停止 CancelJob 同期レポート実行をキャンセル CancelReport リクエストステータスを取得して

同期レポート実行をキャンセル

WaitForExecuteReport ジョブの情報を取得 SelectJobs

同期ジョブの情報を取得 GetSyncJobInfo ジョブの詳細を取得 GetJobDetails スケジュールを設定したジョブを更新 UpdateJobSchedule ジョブ通知の情報を取得 SelectJobNotices ジョブ通知を削除 DeleteJobNotices 表示するページまたはページ範囲を

取得

SelectPage

(32)

指定したレポートコンポーネントの内容を取得

GetContent レポートからスタティックデータ、

ダイナミックデータ、スタイルシートを取得

GetEmbeddedComponent

レポートの目次を取得 GetTOC レポートのページ数を取得 GetPageCount レポートパラメタ値を取得 GetReportParameters ROV（report parameter values）

ファイルを作成

CreateParameterValuesFile レポートのパラメタ値ファイルを取得 GetReportParameters 新規ファイルにパラメタ定義を

エクスポート

ExportParameterDefinitionsToFile 指定したファイルからパラメタ

定義を取得

ExtractParameterDefinitionsFromFile レポートを検索 SearchReport

指定した基準に一致するスケジュール設定済みの全ジョブを選択

SelectJobSchedules AcReport::GetCustomFormat

メソッドの処理結果を取得

GetCustomFormatData

(33)

ロール

サーバ

ロールを作成 CreateRole ロールを削除 DeleteRole ロールの情報を取得 SelectRoles ロールのプロパティを更新 UpdateRole

iServerのadministratorとしてログイン SystemLogin

システムプリンタの情報を取得 GetSystemPrinters Report Server Security Extension

（RSSE）を使用して外部ソースからデータを呼び出す

CallOpenSecurityLibrary

オープンセキュリティキャッシュを消去 UpdateOpenSecurityCache 利用できるボリュームの名前を取得 GetSystemVolumeNames サーバにあるMessage Distribution

サービスの名前を取得

GetSystemMDSInfo サーバがサポートするロケールや

形式のリストを取得

GetFormats

Factoryサービスの情報を取得 GetFactoryServiceInfo

ノードにある保留中の同期ジョブや実行中の全ジョブの情報を取得

GetFactoryServiceJobs システムからiServersのリストと

そのステータスを取得

GetSystemServerList

(34)

ユーザ

ボリューム

ユーザのログをiServer Systemに記録 Login

iServerのadministratorとしてログイン SystemLogin

ユーザを作成 CreateUser

ユーザを削除 DeleteUser

ユーザの情報を取得 SelectUsers

ユーザのプリンタ設定を取得 GetUserPrinterOptions ユーザプロパティを更新 UpdateUser

ユーザが作成した全新規ファイルに適用するACLテンプレートを取得

GetFileCreationACL

Encyclopediaボリュームプロパティを

取得

GetVolumeProperties

Encyclopediaボリュームプロパティを

更新

UpdateVolumeProperties 定義済みのEncyclopediaボリューム

コントロールコマンドを実行

ExecuteVolumeCommand

(35)

第章

ëÊ2èÕ

Actuate Information

Delivery API ^{のデータ型}

この章では、Actuate Information Delivery APIで使用するデータ型をアルファベット順に一覧します。各エントリは、データ型に関する一般的な説明、スキーマ、パラメタに関する説明で構成されています。

Information Delivery API のデータ型

ArchiveRule Argument

ArrayOfArchiveRule ArrayOfArgument ArrayOfAttachment ArrayOfChannel

ArrayOfChannelCondition ArrayOfCondition

ArrayOfComponent ArrayOfDate ArrayOfDateTime ArrayOfFieldDefinition ArrayOfFile

ArrayOfFileCondition ArrayOfFileType ArrayOfGroup

ArrayOfGroupCondition ArrayOfInt

ArrayOfJobCondition ArrayOfJobNotice

(36)

ArrayOfJobNoticeCondition ArrayOfJobProperties

ArrayOfJobScheduleCondition ArrayOfJobScheduleDetail ArrayOfMDSInfo

ArrayOfParameterDefinition ArrayOfParameterValue ArrayOfPendingSyncJob ArrayOfPermission ArrayOfPrinter

ArrayOfPrinterOptions ArrayOfRecord ArrayOfRole

ArrayOfRoleCondition ArrayOfRunningJob ArrayOfServerInformation ArrayOfService

ArrayOfString ArrayOfTime ArrayOfUser

ArrayOfUserCondition Attachment

Boolean

CancelReportStatus Channel

ChannelCondition ChannelSearch ComponentType DataType Date DateTime Decimal EnumString EnumString

ExternalTranslatedRoleName

(37)

FormatType Group

GroupCondition GroupSearch Integer JobCondition JobInputDetail JobNotice

JobNoticeCondition JobNoticeSearch JobPrinterOptions JobProperties JobSchedule

JobScheduleCondition JobScheduleDetail JobScheduleSearch JobSearch

Long MDSInfo NewFile ObjectIdentifier OpenServerOptions PageIdentifier ParameterDefinition ParameterValue PendingSyncJob Permission Printer PrinterOptions PrivilegeFilter Query Range Record RetryOptions Role

RoleCondition RoleSearch RunningJobs ServerInformation ServerState

ServerStatusInformation

(38)

ServerVersionInformation Service

SoapResponseStatus Stream

String Struct SystemType Time User

UserCondition UserSearch ViewParameter Volume

WaitForExecuteReportStatus

ArchiveRule

ArchiveRuleは、アーカイブ規則を表す複合データ型です。

スキーマ <xsd:complexType name="ArchiveRule">

<xsd:sequence>

<xsd:element name="FileType" type="xsd:string"/>

<xsd:element name="NeverExpire" type="xsd:boolean"

minOccurs="0"/>

<xsd:element name="ExpireDependentFiles" type="xsd:boolean"

minOccurs="0"/>

<xsd:element name="ArchiveOnExpiration" type="xsd:boolean"

minOccurs="0"/>

<xsd:choice minOccurs="0">

<xsd:element name="ExpirationAge" type="xsd:unsignedInt"

minOccurs="0"/>

<xsd:element name="ExpirationTime" type="xsd:dateTime"

minOccurs="0"/>

</xsd:choice>

<xsd:element name="IsInherited" type="xsd:boolean"

(39)

パラメタ FileType

ファイルの種類。

NeverExpire

オブジェクトに有効期限を設定するかどうかを指定します。

ExpireDependentFiles

オブジェクトの期限が切れたときに、オブジェクトの従属ファイルを期限切れにするかどうかを指定します。

ArchiveOnExpiration

オブジェクトガ期限切れになる前にアーカイブするかどうかを指定します。

ExpirationAge

オブジェクトの失効年。

ExpirationTime

オブジェクトの失効時刻。

IsInherited

規則を継承するかどうかを指定します。

InheritedFrom

規則の継承元となるオブジェクト。

Argument

Argumentは、引数を表す複合データ型です。

スキーマ <xsd:complexType name="Argument">

<xsd:sequence>

<xsd:element name="Name" type="xsd:string"/>

<xsd:element name="Value" type="xsd:string"/>

</xsd:sequence>

</xsd:complexType>

パラメタ Name 引数名。

Value 引数の値。

(40)

ArrayOfArchiveRule

ArrayOfArchiveRuleは、アーカイブ規則の配列を表す複合データ型です。

スキーマ <xsd:complexType name="ArrayOfArchiveRule">

<xsd:complexContent>

<xsd:extension base="enc:Array"/>

</xsd:complexContent>

</xsd:complexType>

ArrayOfArgument

ArrayOfArgumentは、引数の配列を表す複合データ型です。

スキーマ <xsd:complexType name="ArrayOfArgument">

</xsd:complexType>

ArrayOfAttachment

ArrayOfAttachmentは、添付ファイルの配列を表す複合データ型です。

スキーマ <xsd:complexType name="ArrayOfAttachment">

</xsd:complexType>

(41)

ArrayOfChannel

ArrayOfChannelは、チャンネルの配列を表す複合データ型です。

スキーマ <xsd:complexType name="ArrayOfChannel">

</xsd:complexType>

ArrayOfChannelCondition

ArrayOfChannelConditionは、チャンネル検索条件の配列を表す複合データ型で

す。

スキーマ <xsd:complexType name="ArrayOfChannelCondition">

</xsd:complexType>

ArrayOfCondition

ArrayOfConditionは、検索条件の配列を表す複合データ型です。

スキーマ <xsd:complexType name="ArrayOfCondition">

</xsd:complexType>

(42)

ArrayOfComponent

ArrayOfComponentは、コンポーネントの配列を表す複合データ型です。

スキーマ <xsd:complexType name="ArrayOfComponent">

</xsd:complexType>

ArrayOfComponentIdentifier

ArrayOfComponentIdentifierは、コンポーネント識別子の配列を表す複合データ

型です。

スキーマ <xsd:complexType name="ArrayOfComponentIdentifier">

<xsd:sequence>

<xsd:element name="ComponentIdentifier"

type="actu:ComponentIdentifier" minOccurs="0"

maxOccurs="unbounded"/>

</xsd:sequence>

</xsd:complexType>

ArrayOfDate

ArrayOfDateは、日付の配列を表す複合データ型です。

スキーマ <xsd:complexType name="ArrayOfDate">

(43)

ArrayOfDateTime

ArrayOfDateTimeは、日時の配列を表す複合データ型です。

スキーマ <xsd:complexType name="ArrayOfDateTime">

</xsd:complexType>

ArrayOfFieldDefinition

ArrayOfFieldDefinitionは、フィールド定義の配列を表す複合データ型です。

スキーマ <xsd:complexType name="ArrayOfFieldDefinition">

<xsd:sequence>

<xsd:element name="FieldDefinition" type="actu:FieldDefinition"

</xsd:sequence>

</xsd:complexType>

ArrayOfFile

ArrayOfFileは、ファイルの配列を表す複合データ型です。

スキーマ <xsd:complexType name="ArrayOfFile">

</xsd:complexType>

(44)

ArrayOfFileCondition

ArrayOfFileConditionは、ファイル検索条件の配列を表す複合データ型です。

スキーマ <xsd:complexType name="ArrayOfFileCondition">

</xsd:complexType>

ArrayOfFileType

ArrayOfFileTypeは、ファイルの種類の配列を表す複合データ型です。

スキーマ <xsd:complexType name="ArrayOfFileType">

</xsd:complexType>

ArrayOfGroup

ArrayOfGroupは、通知グループの配列を表す複合データ型です。

スキーマ <xsd:complexType name="ArrayOfGroup">

</xsd:complexType>

(45)

ArrayOfGroupCondition

ArrayOfGroupConditionは、グループ検索条件の配列を表す複合データ型です。

スキーマ <xsd:complexType name="ArrayOfGroupCondition">

</xsd:complexType>

ArrayOfInt

ArrayOfIntは、整数の配列を表す複合データ型です。

スキーマ <xsd:complexType name="ArrayOfInt">

</xsd:complexType>

ArrayOfJobCondition

ArrayOfJobConditionは、ジョブ検索条件の配列を表す複合データ型です。

スキーマ <xsd:complexType name="ArrayOfJobCondition">

</xsd:complexType>

(46)

ArrayOfJobNotice

ArrayOfJobNoticeは、ジョブ通知の配列を表す複合データ型です。

スキーマ <xsd:complexType name="ArrayOfJobNotice">

</xsd:complexType>

ArrayOfJobNoticeCondition

ArrayOfJobNoticeConditionは、ジョブ通知検索条件の配列を表す複合データ型です。

スキーマ <xsd:complexType name="ArrayOfJobNoticeCondition">

</xsd:complexType>

ArrayOfJobProperties

ArrayOfJobPropertiesは、ジョブプロパティの配列を表す複合データ型です。

スキーマ <xsd:complexType name="ArrayOfJobProperties">

</xsd:complexType>

(47)

ArrayOfJobScheduleCondition

ArrayOfJobScheduleConditionは、ジョブスケジュール検索条件の配列を表す複合

データ型です。

スキーマ <xsd:complexType name="ArrayOfJobScheduleCondition">

</xsd:complexType>

ArrayOfJobScheduleDetail

ArrayOfJobScheduleDetailは、ジョブスケジュールの詳細の配列を表す複合デー

タ型です。

スキーマ <xsd:complexType name="ArrayOfJobScheduleDetail">

</xsd:complexType>

ArrayOfMDSInfo

ArrayOfMDSInfoは、Message Distributionサービス（MDS）情報の配列を表す複

合データ型です。

スキーマ <xsd:complexType name="ArrayOfMDSInfo">

<xsd:sequence>

<xsd:element name="MDSInfo" type="actu:MDSInfo" minOccurs="0"

</xsd:sequence>

</xsd:complexType>

パラメタ MDSInfo

Message Distributionサービス情報。

(48)

ArrayOfParameterDefinition

ArrayOfParameterDefinitionは、パラメタ定義の配列を表す複合データ型です。

スキーマ <xsd:complexType name="ArrayOfParameterDefinition">

</xsd:complexType>

ArrayOfParameterValue

ArrayOfParameterValueは、パラメタ値の配列を表す複合データ型です。

スキーマ <xsd:complexType name="ArrayOfParameterValue">

</xsd:complexType>

ArrayOfPendingSyncJob

ArrayOfPendingSyncJobは、保留中の同期ジョブの配列を表す複合データ型です。

スキーマ <<xsd:complexType name="ArrayOfPendingSyncJob">

<xsd:sequence>

<xsd:element name="PendingSyncJob"

type="actu:PendingSyncJobs" minOccurs="0"

</xsd:sequence>

(49)

ArrayOfPermission

ArrayOfPermissionは、権限の配列を表す複合データ型です。

スキーマ <xsd:complexType name="ArrayOfPermission">

</xsd:complexType>

ArrayOfPrinter

ArrayOfPrinterは、プリンタの配列を表す複合データ型です。

スキーマ <xsd:complexType name="ArrayOfPrinter">

</xsd:complexType>

ArrayOfPrinterOptions

ArrayOfPrinterOptionsは、プリンタオプションの配列を表す複合データ型です。

スキーマ <xsd:complexType name="ArrayOfPrinterOptions">

</xsd:complexType>

(50)

ArrayOfRecord

ArrayOfRecordは、表のフィールド値の配列を表す複合データ型です。

スキーマ <xsd:complexType name="ArrayOfRecord">

<xsd:sequence>

<xsd:element name="Record" type="actu:Record"

</xsd:sequence>

</xsd:complexType>

ArrayOfRole

ArrayOfRoleは、ロールの配列を表す複合データ型です。

スキーマ <xsd:complexType name="ArrayOfRole">

</xsd:complexType>

ArrayOfRoleCondition

ArrayOfRoleConditionは、ロール検索条件の配列を表す複合データ型です。

スキーマ <xsd:complexType name="ArrayOfRoleCondition">

</xsd:complexType>

(51)

ArrayOfRunningJob

ArrayOfRunningJobは、Factory内で実行中のジョブの配列を表す複合データ型です。

スキーマ <xsd:complexType name="ArrayOfRunningJob">

<xsd:sequence>

<xsd:element name="RunningJob" type="actu:RunningJobs"

minOccurs="0" maxOccurs="unbounded"/>

</xsd:sequence>

</xsd:complexType>

ArrayOfServerInformation

ArrayOfServerInformationは、サーバ情報の配列を表す複合データ型です。

スキーマ <xsd:complexType name="ArrayOfServerInformation">

<xsd:sequence>

<xsd:element name="ServerInformation"

type="actu:ServerInformation" maxOccurs="unbounded"/>

</xsd:sequence>

</xsd:complexType>

ArrayOfService

ArrayOfServiceは、サービスの配列を表す複合データ型です。

スキーマ <xsd:complexType name="ArrayOfService">

<xsd:sequence>

<xsd:element name="Service" type="actu:Service" minOccurs="0"

</xsd:sequence>

</xsd:complexType>

(52)

ArrayOfString

ArrayOfStringは、文字列の配列を表す複合データ型です。

スキーマ <xsd:complexType name="ArrayOfString">

</xsd:complexType>

ArrayOfTime

ArrayOfTimeは、時間の配列を表す複合データ型です。

スキーマ <xsd:complexType name="ArrayOfTime">

</xsd:complexType>

ArrayOfUser

ArrayOfUserは、ユーザの配列を表す複合データ型です。

スキーマ <xsd:complexType name="ArrayOfUser">

</xsd:complexType>

(53)

ArrayOfUserCondition

ArrayOfUserConditionは、ユーザ検索条件の配列を表す複合データ型です。

スキーマ <xsd:complexType name="ArrayOfUserCondition">

</xsd:complexType>

Attachment

Attachmentは、添付ファイルに含まれるオブジェクトの詳細を表す複合データ型

です。

スキーマ <xsd:complexType name="Attachment">

<xsd:sequence>

<xsd:element name="ContentId" type="xsd:string"/>

<xsd:element name="ContentType" type="xsd:string"/>

<xsd:element name="FileType" type="xsd:long"/>

<xsd:element name="ContentEncoding" type="xsd:string"

minOccurs="0"/>

<xsd:element name="Locale" type="xsd:string" minOccurs="0"/>

</xsd:sequence>

</xsd:complexType>

パラメタ ContentId オブジェクトID。 ContentType オブジェクト型。

FileType

オブジェクトファイルの種類。

ContentEncoding

使用されるオブジェクトエンコード。

Locale

オブジェクトのロケール。

(54)

Boolean

Booleanは、TrueまたはFalseの値を持つ標準的なXML Booleanデータ型です。

CancelReportStatus

CancelReportStatusは、同期レポートをキャンセルするリクエストのステータスを

表す単純データ型です。

スキーマ <xsd:simpleType name="CancelReportStatus" base="xsd:string">

<xsd:restriction base="xsd:string">

<xsd:enumeration value="Succeeded"/>

<xsd:enumeration value="Failed"/>

<xsd:enumeration value="InActive"/>

</xsd:restriction>

</xsd:simpleType>

パラメタ Succeeded

同期レポート生成が正しくキャンセルされました。

Failed

同期レポートをキャンセルするリクエストが失敗しました。

InActive

同期レポート生成は完了しており、キャンセルできません。

idapi.book

Actuate iServer API リファレンス

目次

はじめに . . . ix

Actuate Information Delivery API リファレンス

Actuate Information Delivery API メッセージのサマリ . . . . 3

Actuate Information Delivery API のデータ型 . . . . 9

Actuate Information Delivery API のメッセージ . . . . 119

iServer 統合 API リファレンス

Actuate ログとモニタ API 関数 . . . . 259

アーカイブ関数. . . . 267

Report Server Security Extension 関数. . . . 271

は じ め に

Actuate 7 について

Actuate 製品のユーザについて

ユーザのニーズに確実に対応

多言語の情報の配布

高いパフォーマンスのスケーラブルなサーバ

充実した情報配布ソリューション

Actuate 7 と ReportingEngine について

Actuate iServer System 製品の概要

Actuate iServer API Reference の概要

オンラインマニュアル

オンラインマニュアルの使用

オンラインヘルプの使用

Actuate のオンラインヘルプの使用

レポート固有のオンラインヘルプ

表記規則

構文の表記規則

第 部

Actuate Information

Delivery API リファレンス

第 章

Actuate Information

Delivery API メッセージの サマリ

チャンネル

ファイルとフォルダ

グループ

ジョブとレポート

ロール

サーバ

ユーザ

ボリューム

第 章

Actuate Information

Delivery API のデータ型

ArchiveRule

Argument

ArrayOfArchiveRule

ArrayOfArgument

ArrayOfAttachment

ArrayOfChannel

ArrayOfChannelCondition

ArrayOfCondition

ArrayOfComponent

ArrayOfComponentIdentifier

ArrayOfDate

ArrayOfDateTime

ArrayOfFieldDefinition

ArrayOfFile

ArrayOfFileCondition

ArrayOfFileType

ArrayOfGroup

ArrayOfGroupCondition

ArrayOfInt

ArrayOfJobCondition

ArrayOfJobNotice

ArrayOfJobNoticeCondition

ArrayOfJobProperties

ArrayOfJobScheduleCondition

ArrayOfJobScheduleDetail

ArrayOfMDSInfo

ArrayOfParameterDefinition

ArrayOfParameterValue

ArrayOfPendingSyncJob

ArrayOfPermission

ArrayOfPrinter

ArrayOfPrinterOptions

ArrayOfRecord

ArrayOfRole

Actuate Information Delivery API ^{リファレンス}

iServer ^統合 API ^{リファレンス}

Actuate ^{ログとモニタ} API 関数 . . . . 259

はじめに

Actuate 7 ^について

Actuate 7 ^と ReportingEngine ^について

Actuate iServer System ^{製品の概要}

Actuate iServer API Reference ^の概要

第部

Delivery API ^{リファレンス}

第章

Delivery API ^{メッセージの} サマリ

第章

Delivery API ^{のデータ型}