ActuateデスクトップAPIガイド

(1)

(2)

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

情報の所有権は、下記に含まれます。 Actuate Corporation

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

このマニュアルの情報の所有権は、米国 Actuate Software Corporation にあります。このソフトウェアおよびマニュアルは、本製品の使用許諾書のもとでのみ使用することができます。

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

Actuate、e.Report、e.Reporting、Live Report Document、Live Report Extension、 ReportBlast、ReportCast、Report Encyclopedia、SmartSearch、Transporter、Virtual Report Distribution、および、XML Reports。

その他の商標

ActiveX、Microsoft、MSN、The Microsoft Network、Windows、Windows NT、 Windows 95/98 と他の Microsoft の製品は Microsoft の商標および登録商標です。CT-Library は Sybase, Inc. の商標です。Digital Creations および DCLC は、Digital Creations, LC の商標です。Graphics Server は Bits Per Second, Ltd. と Pinnacle Publishing, Inc. の商標です。HDK は Virtual Media Technology Pty Ltd. の登録商標です。INFORMIX-ESQL/C は、Informix Software, Inc. の商標です。InstallShield は InstallShield Corporation の登録商標です。LEADTOOLS は LEAD Technologies, Inc. の登録商標です。 Netscape、 Netscape Communications、 Netscape Communicator、 Netscape Enterprise Server、 Netscape FastTrack Server、Netscape Navigator は Netscape

Communications Corporation の商標および登録商標です。NobleNet と WinRPC は NobleNet, Inc. の商標です。ONC、Solaris、SPARC、 Sun、Sun Microsystems は Sun Microsystems の商標です。Oracle Call Interface は Oracle Corporation の商標です。 Progress は Progress Software Corporation の登録商標です。Sheridan Calendar Widgets は Sheridan Software Systems, Inc. の商標です。 SmartHeap は MicroQuill Software Publishing, Inc. の商標です。 Tools.h++ は Rogue Wave Software, Inc. の商標です。 UNIX は X/Open Company, Ltd. の登録商標です。 XPrinter は Bristol Technology, Inc. の登録商標および商標です。James Clark によって作成された XPAT は Mozilla ライセンス契約に基づく使用許諾を受けています。WinWidgets は Simple Software, Inc. の商標です。

他のすべてのブランド名または製品名は、それぞれの会社または組織の商標または登録商標です。

(3)

『Actuate デスクトップ API ガイド』について . . . . x オンラインマニュアル . . . xi オンラインマニュアルの使用 . . . xi オンラインヘルプ . . . xii コンテキスト依存のオンラインヘルプ . . . . xii Actuate オンラインヘルプシステムの使用 . . . . xii レポート固有のオンラインヘルプの使用 . . . xv 表記の規約 . . . . xvi 構文規約 . . . xvii

1 章

章

章 Actuate API について

について

について . . . 1

プログラミングインターフェースについて . . . . 1 API 機能について . . . . 2 使用する API の選択 . . . . 3 レポートサーバ API を使用する場合 . . . . 3 リクエスタ API を使用する場合 . . . . 3 サーチ拡張 API を使用する場合 . . . . 4 Actuate ActiveX コントロールを使用する場合 . . . . 4

Part 1 リクエスタ

リクエスタ

リクエスタ API

(4)

Windows のライブラリ . . . .13 Windows NT および 95/98 . . . .14 UNIX ライブラリおよび path 変数 . . . .15 コンパイラ . . . . 15 UNIX C++ のコンパイルオプションとリンクオプション . . . .16 リクエスタ API の操作環境 . . . . 17 Actuate ビューアによるリクエスタ API の使用 . . . .17 LRX API の操作環境 . . . .18 プログラムタスク別 API 関数 . . . . 18 スタートアップコードとクリーンアップコードの記述 . . . . 19 レポートファイルの処理 . . . . 20 ローカルファイル名の指定―リクエスタ API . . . . 20 レポートサーバファイル名の指定―リクエスタ API . . . . 20 パラメタ名とパラメタグループ名の取得 . . . . 22 パラメタ属性の取得 . . . . 22 パラメタのデフォルト値の取得 . . . . 23 パラメタの現在値の取得 . . . . 24 パラメタ値の設定 . . . . 24 プリンタの設定 . . . . 24 レポートの実行、表示、印刷 . . . . 26 LRX 製品がサポートするメソッド . . . .26 リクエスタ API を使用したローカルでのレポートの実行 . . . . 27 エラーの検査 . . . . 27 エラーチェックをサポートする関数 . . . . 28 エラーチェックをサポートしない関数 . . . . 28 LRX API に含まれる関数 . . . .29 最初のリクエスタアプリケーションの作成 . . . . 29 レポートサーバを使用するアプリケーションの作成 . . . . 29 API セッションの初期化 . . . .30 サーバへの接続 . . . . 30 パラメタの指定 . . . . 31 レポートの実行と表示 . . . . 31 レポートの印刷 . . . . 32 API セッションの終了 . . . .32 ローカルレポート用のアプリケーションの作成 . . . . 33 Visual Basic メソッドでの宣言 . . . .33 セッションの初期化 . . . . 33 レポート生成パラメタの指定 . . . . 34 新規レポートの生成 . . . . 34 レポートの表示 . . . . 35 新規レポートの印刷 . . . . 35 セッションの終了 . . . . 35 LRX から印刷するアプリケーションの作成 . . . .35

(5)

Actuate Basic でのリクエスタ API の使用 . . . 36

例 . . . 36

Visual Basic でのリクエスタ API の使用 . . . 38

Visual Basic からリクエスタ API へのアクセス . . . 38

宣言文内の DLL の指定 . . . 38 パラメタ値の操作とレポートの生成・印刷 . . . 39 パラメタ値入力用カスタムダイアログボックスの作成 . . . 44 C++ アプリケーション内でのリクエスタの使用 . . . 46 BSTR の処理 ― Windows 環境 . . . 46 C++ の例 . . . 47 デベロッパワークベンチに含まれる例 . . . 53

3 章

章

章リクエスタ

リクエスタ

リクエスタ API リファレンス

リファレンス

リファレンス . . . 55

AcReqCloseFile . . . 56 AcReqConnect . . . 56 AcReqDisconnect . . . 57 AcReqGenerateReport . . . 58 AcReqGetAdhoc . . . 62 AcReqGetAfcNameForRox . . . 63 AcReqGetAlias . . . 64 AcReqGetDefaultValueCurrency . . . 65 AcReqGetDefaultValueDate . . . 66 AcReqGetDefaultValueDouble . . . 67 AcReqGetDefaultValueInteger . . . 68 AcReqGetDefaultValueString . . . 69 AcReqGetDefaultValueStr . . . 70 AcReqGetError . . . 72 AcReqGetErrorString . . . 74 AcReqGetFirstGroup . . . 75

(6)

AcReqGetValueInteger . . . .89 AcReqGetValueString . . . .90 AcReqGetValueStr . . . .91 AcReqGetVersionNumber . . . . 92 AcReqHasDefaultValue . . . . 93 AcReqInitialize . . . . 94 AcReqInstallAfc . . . .95 AcReqIsAfcInstalled . . . . 95 AcReqPrintReport . . . . 96 AcReqPrintReportEx . . . . 98 AcReqReadFile . . . . 99 AcReqReportStatus . . . 100 AcReqSelectClient . . . 101 AcReqSetCacheSize . . . 103 AcReqSetDefaultPrinter . . . 103 AcReqSetEUDTPath . . . 104 AcReqSetPrinterCollate . . . 105 AcReqSetPrinterColor . . . 105 AcReqSetPrinterDuplex . . . 106 AcReqSetPrinterFormName . . . 107 AcReqSetPrinterName . . . 107 AcReqSetPrinterNumberCopies . . . 108 AcReqSetPrinterOrientation . . . 109 AcReqSetPrinterPaperSize . . . 109 AcReqSetPrinterScale . . . 112 AcReqSetPrinterTray . . . 113 AcReqSetRequestPriority . . . 114 AcReqSetValueCurrency . . . 114 AcReqSetValueDate . . . 115 AcReqSetValueDouble . . . 117 AcReqSetValueInteger . . . 117 AcReqSetValueString . . . 118 AcReqUnInitialize . . . 119 AcReqViewReport . . . 120 AcReqWriteFile . . . 121 内部使用関数 . . . 122

(7)

Part 2 サーチ拡張

サーチ拡張

サーチ拡張 API

4 章

章

章サーチ拡張

サーチ拡張

サーチ拡張 API ユーザガイド

ユーザガイド

ユーザガイド . . . 125

サーチ拡張 API について . . . 126 プログラムタスク別サーチ拡張 API 関数 . . . 126 スタートアップコードとクリーンアップコードの記述 . . . 126 サーチパラメタの設定 . . . 127 サーチ結果の処理 . . . 128 サーチ拡張の開発 . . . 128 サーチ拡張コードの作成 . . . 128 定義ファイルの作成 . . . 129 ヘッダファイルの作成 . . . 129 コードのコンパイル . . . 130 カスタムサーチ拡張のインストール . . . 130 アプリケーション例 . . . 130 例 . . . 131 定義ファイル . . . 132 ヘッダファイル . . . 133

5 章

章

章サーチ拡張

サーチ拡張

サーチ拡張 API リファレンス

リファレンス

リファレンス . . . 135

Close . . . 136 GetColumnDelimiter . . . 136 GetName . . . 137 GetParameters . . . 138 IncludeHeader . . . 138 InputParameters . . . 139 Open . . . 140

(8)

(9)

マニュアルについて

Actuate e.Reporting Suite 4 について

について

e. ビジネスのカスタマは、Actuate® e.Reporting Suite 4 を使用して、多くのユーザに高解像度の構造化されたコンテンツを開発して配布できます。Actuate は、従来のオンラインレポートや印刷レポートに加えて、個々のユーザにシームレスに対応する Web ページを提供するので、一歩進んだ Web レポートサイトを構築できます。 e. ビジネスサイトを構築するカスタマが直面する課題に対し、Actuate e.Reporting Suite 4 は次のような解決策を提供します。課題課題課題課題 Actuate の解決策の解決策の解決策の解決策 HTML を使用してのカスタムコンテンツの開発 DHTML は素早い、ダウンロード不要のオプションです。構造化コンテンツを表示するためのプラグインの使用多くのユーザにプラグインを配布したりインストールする必要がありません。組み込みツールがないことによる情報テンプレートに基づいたデザインと表

(10)

Actuate のツールとレポートは、

■ 複雑なデータアクセスの問題を解決します。

■ 他のツールでは適用範囲外の書式設定の問題を解決します。

■ 多くのユーザをサポートすることができます。

次に、Actuate e.Reporting Suite 4 の製品の概要を説明します。製品名製品名製品名製品名使用使用使用使用 Actuate デベロッパワークベンチレポートオブジェクトデザインとコンポーネントを設計・構築・配布するためのプロの開発者向けオブジェクト指向アプリケーション。 Actuate Basic 言語と Actuate Foundation Class ライブラリは、広範囲にわたるカスタマイズ機能に対応します。 Actuate e.Report デザイナデベロッパワークベンチを補完し、ビジネスユーザが様々なレポートを設計して配布するのに使用するアプリケーション。これらのレポートには、プログラミングは不要です。このアプリケーションは、複雑なレポートの変更とライブラリにある高度なコンポーネントの使用の両方をサポートします。 Actuate エンドユーザデスクトップネットワーククライアントシステム上でライブレポート文書を要求・生成・表示・印刷するためのエンドユーザ向けアプリケーション。 ReportQuery™ 機能を使用することにより、 Actuate レポートから他の開発支援ツールや分析ツールへデータをシームレスに転送できます。 Actuate ビューアレポート文書を検索・表示・印刷するためのエンドユーザ向けアプリケーション。 ReportQuery™ 機能は、Actuate ビューアにも含まれます。

(11)

Actuate e.Reporting サーバライブレポート文書を生成し、そのレポートをレポートエンサイクロペディア ® で管理し、ユーザに提供するサーバアプリケーション。この製品は、Actuate アドミニストレータデスクトップを含みます。これは、1 つまたは複数の Actuate レポートサーバを管理したり制御する、システム管理者およびネットワーク管理者用のアプリケーションです。また、この製品は、レポートエンサイクロペディアを、動的で保護された Web サイトに変換する Actuate レポートキャスト ™ も含みます。レポートキャストはチャンネルと他の Web サイトをシームレスに統合するための基礎を提供します。

この製品は、Microsoft Internet Explorer および Netscape Navigator と一緒に動作し、レポートの表示や印刷をサポートする Actuate ライブレポートエクステンション（LRX）を含みます。

Actuate Advanced e.Reporting サーバ基本的な e.Reporting サーバの機能に、オープンサーバとページセキュリティの 2 つの機能が追加されたアプリケーション。 ■ オープンサーバは、Actuate e.Reporting サーバを使った他社のレポーティングツールの使用をサポートします。 ■ ページセキュリティは、ユーザごとに、レポートの部分を個別表示することをサポートします。製品名製品名製品名製品名使用使用使用使用

(12)

Actuate ビューアおよび Actuate ライブレポートエクステンション（LRX）は、 Actuate ソフトウェアデベロップメントキット以外のすべての製品に含まれています。

『

『Actuate デスクトップ

デスクトップ

デスクトップ API ガイド』について

デスクトップ

ガイド』について

『Actuate デスクトップアプリケーションプログラミングインターフェースガイド』は、次の Actuate e.Reporting Suite 製品に含まれます。

■ デベロッパワークベンチ ■ ソフトウェアデベロップメントキット『Actuate デスクトップ API ガイド』は、いつどのようにレポートを生成するかを制御するために使用する、API に関わる情報を提供します。リクエスタ API には次のタスクを実行するための機能が含まれています。 ■ レポートパラメタの属性と値へのアクセス。 ■ レポートパラメタ値の変更。 ■ レポートの生成。 Actuate ソフトウェアデベロップメントキット Actuate ActiveX コントロールはカスタムアプリケーションに Actuate レポーティング機能を埋め込みます。 Actuate リクエスタ API は、レポートパラメタの属性と値にアクセスしレポートパラメタ値を変更して、いつどのようにレポートを生成するかを制御します。さらにレポートの表示・印刷および印刷環境設定を行います。 API にアクセスするには、Actuate Basic 、 Visual Basic 、C、または C++ を使用します。 Actuate サーチ拡張 API は、他社製品や分析ツールにデータを転送するサーチ拡張の開発をサポートします。 Actuate レポートサーバ API は、既存の企業アプリケーションに一般的なレポートエンサイクロペディアのタスクを導入し、レポートサーバ機能を統合して定常業務や時間がかかるタスクを自動化し、カスタム業務処理に適した新機能グループをインプリメントします。レポートサーバ API にアクセスするには、 C++ を使用します。 Actuate レポートサーバセキュリティ拡張は、他社のセキュリティツールの使用をサポートします。 Actuate アーカイブドライバは、他社のアーカイブソフトウェアやハードウェアの使用をサポートします。製品名製品名製品名製品名使用使用使用使用

(13)

■ レポートの表示と印刷。

■ 印刷環境の設定。

『Actuate デスクトップ API ガイド』には、以下の章が含まれます。

■ 「マニュアルについて」。この章では、このマニュアル、Actuate e.Reporting Suite、および、使用する表記の規約の概要を説明しています。

■ 1 章「Actuate API について」。この章は、3 つの Actuate API の機能を説明し、選

択するときの指針を提供します。

■ 2 章「リクエスタ API ユーザガイド」。この章は、リクエスタ API の説明と、作

業目的からみたこのインターフェースの特徴の説明を提供します。 Actuate

Basic と Visual Basic の例題により、API の使用方法を説明します。

■ 3 章「リクエスタ API リファレンス」。この章は、リクエスタ API の各メソッド の説明とプログラム情報を、アルファベット順のリファレンスとして提供します。 ■ 4 章「サーチ拡張 API ユーザガイド」。この章は、サーチ拡張 API の説明と、作 業目的からみたこのインターフェースの特徴の説明を提供します。 ■ 5 章「サーチ拡張 API リファレンス」。この章は、サーチ拡張 API 関数の説明と プログラム情報を、アルファベット順のリファレンスとして提供します。

オンラインマニュアル

Actuate 製品のマニュアルは Adobe Acrobat PDF 形式のファイルとして提供されます。また、オンラインヘルプもあります。Actuate e.Reporting サーバ、レポートキャストなどの Windows インターフェースを持たない製品では、 HTML 形式のヘルプファイルを提供しています。

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

オンラインマニュアルは製品と一緒に自動的にインストールされるわけではありません。製品 CD の Manuals ディレクトリにマニュアルファイルがあります。 HTML ファイルは製品と一緒に自動的にインストールされます。これらのファイ

(14)

オンラインヘルプ

Actuate 製品は、製品に関するコンテキスト依存のオンラインヘルプと、表示中のレポートに関するレポート固有のオンラインヘルプの両方を提供します。Actuate e.Reporting Suite では、開発者はカスタマイズしたレポート固有のオンラインヘルプを作成できます。レポート固有のオンラインヘルプは、Actuate エンドユーザデスクトップ、Actuate ビューア、Actuate LRX などの Actuate デスクトップ製品を使用してレポートを表示するときにだけ利用できます。

コンテキスト依存のオンラインヘルプ

マニュアルの各セクションが、ソフトウェアインターフェースに直接リンクされているので、作業中に関連情報を利用できます。使い方について補足説明が必要なダイアログには、ヘルプボタンがあります。オンラインヘルプにアクセスするにはメニューバーのヘルプメニューを使用します。 F1 キーを使うこともできます。

Actuate オンラインヘルプシステムの使用

オンラインヘルプシステムの使用

e.Reporting Suite のヘルプシステム内の情報にアクセスして表示するには、2 つのウィンドウを使用します。右側のウインドウはオンラインヘルプ項目の内容を表

(15)

示します。左側のウィンドウは目次かオンラインヘルプシステムの索引を表示します。

ヘルプ項目のアルファベット順リストを表示するにはソートボタンを使用する。

(16)

次の図は索引と索引の検索結果の例を示します。

索引のサーチに使うキーワードを入力する。結果ボタンを使用して項目を表示する。

(17)

次の図は、左側のウィンドウに表示されるサーチ結果を示します。右側のウィンドウに項目を表示させるには、リストの項目をダブルクリックします。項目が右側のウィンドウに表示されます。キーワード索引に戻るには索引ボタンを使用する。表示ボタンを使用して右側のウィンドウで項目を表示する。

(18)

レポート固有のオンラインヘルプに関する詳細は『レポートの使用』の 3 章「デスクトップからのレポート表示」を参照してください。

表記の規約

次の表は、このマニュアルで使用する表記の規約を説明します。項目項目項目項目規約規約規約規約例例例例コード例ゴシック体 Dim s As String ファイル名すべて大文字で表示します。 DETAIL.ROI キーの組み合わせキーの間の + 記号は、両方のキーを同時に押すことを意味します。 Ctr+Shift メニュー項目角括弧で囲みます。太字ではありません。 [ ファイル ]

(19)

構文規約

次の表は、 Actuate Basic 言語要素の構文を表すために使用される記号と規約を示します。サブメニュー項目メインメニュー項目を小さな矢印で区切ります。 [ ファイル ] → [ 新規作成 ] ユーザの入力またはユーザの応答カギ括弧で囲みます。「M*16*」項目項目項目項目規約規約規約規約例例例例記号記号記号記号説明説明説明説明例例例例 [] オプションの項目を示します。 [ Alias<alias name>] <> 必須の引数を示します。 <expression to format> {} 1 つしか選択できない複数のオプションまたは引数をグループ化します。 {While | Until} | グループ内で 1 つしか選択できないオプションまたは引数を区切ります。

Exit {Do | For | Function | Sub}

(20)

(21)

C h a p t e r

1 èÕ

Actuate API について

について

プログラミングインターフェースについて

ソフトウェアデベロップメントキットマニュアルは、開発者が Actuate レポート生成システムの機能を既存のアプリケーションに統合するための、Actuate プログラムインターフェースの使用方法を記述したものです。Actuate ではいくつかのアプリケーションプログラミングインターフェースを提供しています。 ■ レポートサーバ API ■ リクエスタ API ■ サーチ拡張 API ■ ビューアおよびデスクトップ ActiveX コントロールビューアおよびデスクトップ ActiveX コントロールは、Windows アプリケーションに Actuate レポートを埋め込む手順を簡単にするレベルの高いインターフェー

(22)

のサーチ機能を拡張します。開発者はサーチ拡張 API を使用して、ユーザが指定したサーチ結果を他社製品に転送できます。レポートサーバ API を使うと、開発者はレポートサーバと直接対話できます。セキュリティやスケジュール設定機能などの、他の 2 つの API からは利用できないレポートサーバ機能にもアクセスできます。

API 機能について

機能について

Actuate ActiveX コントロール、リクエスタ API、レポートサーバ API を使用して実行できる機能や Actuate レポートにアクセスできるレベルは、それぞれ異なります。次の表に Actuate インターフェース別の機能をリストします。タスクタスクタスクタスク ActiveX リクエスタリクエスタリクエスタリクエスタサーチ拡張サーチ拡張サーチ拡張サーチ拡張レポートサーバレポートサーバレポートサーバレポートサーバレポートの生成 ○ 1 ○ 2 ○ レポートの印刷 ○ ○ ○ プリンタの設定 ○ 3 ○ ○ レポートの表示 ○ ○ 4 GUI アプリケーションの構築 ○ パラメタの変更 ○ スケジュールの実行とレポートの印刷 ○ 結果の配布 ○ ○ セキュリティ機能 ○ エンサイクロペディアの管理 ○ カスタム機能 ○ 1. ローカルレポートの生成には、デスクトップ ActiveX コントロールが必要です。 2. エンドユーザデスクトップのローカルインスタンスが必要です。 3. ユーザ入力が必要です。 4. エンドユーザデスクトップかビューアのローカルインスタンスが必要です。

(23)

使用する

使用する API の選択

の選択

このセクションでは、どの API を使用すべきかを決めるための指針を説明します。各 API の機能は前ページの表にまとめたとおりです。次にあげるのは、適切な API を選ぶ場合に考慮すべきその他の特徴です。 ■ 要約化のレベル − レベルの高い API は使用が簡単で、より短期の開発サイクルしか必要としません。Actuate ActiveX コントロールのインターフェースが一番単純で使いやすくなっています。その次がリクエスタ API とサーチ拡張、さらにその次がレポートサーバです。

■ ユーザインターフェース − Actuate ActiveX コントロールは、Actuate レポートを表示したり生成する Windows ベースの GUI アプリケーションを作成するために使用する一番簡単なツールです。

■ 動作環境 − リクエスタとレポートサーバ API は、Windows および UNIX システム上で動作します。ActiveX とサーチ拡張は Windows 固有のものです。

■ クライアント / サーバモデルまたはローカルモデル − ActiveX、リクエスタお

よびレポートサーバ API は、レポートエンサイクロペディアにアクセスできます。Actuate ActiveX コントロールとリクエスタ API は、ローカルでも動作します。サーチ拡張 API はクライアントアプリケーションと一緒にのみ動作します。 ■ 機能分類 − すべての API が基本的なレポート生成をサポートしますが、 Actuate レポート生成機能に最も幅広くアクセスできるのはレポートサーバ API です。

レポートサーバ

レポートサーバ API を使用する場合

を使用する場合

レポートサーバ API はレポートサーバ機能にアクセスできる、強力なインターフェースです。次の条件でアプリケーションを開発しているときは、レポートサーバ API を使用します。 ■ 環境 − 多様なプラットホームやオペレーティングシステム。 ■ 機能 − レポートサーバの全機能。

(24)

■ 開発リソース − 中程度の設計サイクル。

リクエスタ API の、レポートパラメタの属性と値にアクセスできるという特性は、重要な機能です。開発者がレポートパラメタを変更しなくてはならないアプリケーションでは、多くの場合、リクエスタ API とレポートサーバ API の両方を使用します。

LRX API は、リクエスタ API よりもかなり小さいため、Netscape ブラウザや Microsoft Internet Explorer 用のライブレポートエクステンションを使用してレポートを印刷するときに適しています。LRX API は、ローカルでしかレポートを印刷できません。レポートサーバを使って作業するには、リクエスタ API を使用する必要があります。

サーチ拡張

サーチ拡張 API を使用する場合

を使用する場合

サーチ拡張 API は、デベロッパワークベンチ、アドミニストレータデスクトップ、エンドユーザデスクトップ、LRX プラグイン、および ActiveX コントロールのサーチ機能をカスタマイズするために開発者が使用するツールです。一般に、開発者はサーチ拡張 API を使用して、ユーザが指定したサーチ結果を MS-Excel などの他社のアプリケーションに転送します。

Actuate ActiveX コントロールを使用する場合

コントロールを使用する場合

Windows アプリケーションに Actuate レポートを埋め込みたい場合は、Actuate ActiveX コントロールが一番簡単にインプリメントできます。Actuate ActiveX コントロールは、次のような条件でアプリケーションを開発している場合は、最適な選択といえます。 ■ 環境 − 新規または既存の Windows ベースのアプリケーション。 ■ 機能 − デスクトップ ActiveX コントロールでは、レポートの表示、実行、印刷。ビューア ActiveX コントロールでは、レポートの表示と印刷。 ■ 開発リソース − 最小限のリソースを使用した短期の設計サイクル。

Actuate ActiveX コントロールを使用すると、Actuate ビューアやエンドユーザデス

(25)

P a r t

Part I

リクエスタ

リクエスタ API

Part I

(26)

(27)

C h a p t e r

2 èÕ

リクエスタ

リクエスタAPIユーザガイド

リクエスタ

ユーザガイド

リクエスタ API は、Actuate プログラムに基づいたいくつかのインターフェースの 1 つで、以前は Actuate API と呼ばれていました。リクエスタ API を使うと、レポートパラメタを変更してから、新規レポートを生成、表示、印刷することができます。リクエスタ API のサブセットである LRX API は、ライブレポートエクステンションと連携してローカルでレポートを印刷します。この章では、次の項目について説明します。 ■ リクエスタ API について ■ LRX API について ■ レポートの処理 ■ リクエスタ API と LRX API の使用 ■ プログラムタスク別 API 関数 ■ LRX API に含まれる関数

(28)

リクエスタ

リクエスタ API について

について

リクエスタ API は、いつどのようにレポートを生成するかを制御します。リクエスタ API を使用すると、次の作業を実行するアプリケーションを作成できます。 ■ レポートパラメタの属性と値へのアクセス。 ■ レポートパラメタ値の変更。 ■ レポートの生成。 ■ レポートの表示と印刷。 ■ 印刷環境の設定。リクエスタ API は、Actuate ビューアやエンドユーザデスクトップと連携して動作することでレポートを表示します。また、レポートをローカルで生成するにはデベロッパワークベンチかエンドユーザデスクトップが必要です。

LRX API について

について

LRX API は、リクエスタ API よりもかなり小さいため、 Netscape や Microsoft Internet Explorer 用のライブレポートエクステンションからレポートを印刷するときに適しています。 LRX API を使用すると、次の作業を実行するアプリケーションを作成できます。 ■ レポート印刷用のクライアント環境の確認とセットアップ。 ■ ローカルでのレポートの表示と印刷。 LRX API は、ローカルでのみ動作します。レポートサーバを使って作業するには

リクエスタ API を使用する必要があります。 LRX API はリクエスタ API のサブ

セットなので、LRX の機能をインプリメントするには LRX とリクエスタ API のどちらでも使用できます。

Netscape または Internet Explorer から印刷するには、LRX のコマンドラインオプションを使用する必要があります。コマンドラインオプションについて詳細は、『レポートの使用』の 6 章「デスクトップからのレポートの印刷と配布」を参照してください。 LRX API メソッドの概要は、この章で後述する「LRX API に含まれる関数」を参照してください。

レポートの処理

リクエスタ API または LRX API の使用方法は、組織内でレポートを処理する方法に依存します。この API は、次に示す 2 つの方法で使用できます。

(29)

■ クライアント／サーバによるレポート作成。現在、Actuate e.Reporting サーバとレポートエンサイクロペディアを使用してレポートの作成を行っている場合は、通常、個々のレポートサーバと対話するクライアントマシン上でリクエスタ API を使用します。 ■ ローカルでのレポート作成。エンドユーザデスクトップかデベロッパワークベンチを使用してローカルでレポートを作成する場合は、リクエスタ API のローカルレポート作成機能を使用しなくてはなりません。 Web ブラウザを使用してレポートを表示して印刷するだけの場合は、LRX API が必要な機能を提供します。 LRX API は、ローカルのレポート作成時にのみ使用できます。クライアントサーバ用アプリケーションの書き方は、ローカルレポート作成用のアプリケーションと少々異なります。たとえば、 API アプリケーションがクライアントサーバ用の場合はレポートサーバに接続する必要がありますが、ローカルレポートでは不要です。次のセクションでは、レポート作成の両方の方法を説明し、必要な Actuate 製品と、それらの接続方法を示します。

レポートサーバでの処理

リクエスタ API は、レポートサーバと連携し、クライアントサーバアーキテクチャを用いてレポートを実行、表示、印刷します。クライアントでは、一般に次のソフトウェアを実行します。 ■ リクエスタ API ■ カスタム API アプリケーション ■ Actuate ビューア（Windows OS のみ）ビューアはオプションで、アプリケーションからレポートを画面上に表示したい場合にのみ必要です。このようなアプリケーションには Actuate ビューアが適していますが、エンドユーザデスクトップやデベロッパワークベンチを使用することもできます。UNIX 環境では、クライアント上にレポートを表示することはできません。

(30)

レポートサーバ処理では、アプリケーションは次のように動作します。 ■ レポートをレポートエンサイクロペディア内で処理する。レポート実行ファイルやパラメタファイル、出力ファイルを参照するには、次に示す rotp ファイルシステム規約を使用します。 rotp://<server>/<path>/<filename>[;<version>] ■ レポートサーバのセキュリティを守る。レポートへの読み取りおよび実行特権を持つ有効なユーザとして、プログラムに基づいてレポートサーバにログインします。 ■ レポートサーバからレポートを印刷する。プリンタにはレポートサーバに認識されているものを指定します。 ■ レポートをローカルで表示する。（Windows OS のみ）ローカルにインストールされたビューアかエンドユーザデスクトップ、あるいはデベロッパワークベンチを起動します。 Windows ベースのアプリケーションでは、レポート表示はオプションです。レポートを生成するだけの場合は、ビューアやエンドユーザデスクトップ、デベロッパワークベンチは必要ありません。UNIX 環境では、クライアント上にレポートを表示することはできません。

ローカル処理

ローカルレポートの生成には、レポートサーバではなくエンドユーザデスクトップかデベロッパワークベンチを使用します。ローカル環境では、レポートを生成、表示、印刷するために必要なアプリケーションは、すべてクライアントマシンに含まれます。UNIX 環境ではローカル処理はできません。通常、ローカル環境は次のようになります。 ■ リクエスタ API と、エンドユーザデスクトップかデベロッパワークベンチ（ビューアを含む）。 ■ LRX API と LRX 製品。次の図に、エンドユーザデスクトップを使用してレポートを生成、表示、印刷するリクエスタアプリケーションの例を示します。リクエスタ API カスタムアプリビューア Actuate e.Reporting サーバサーバサーバサーバレポートエンサレポートエンサレポートエンサレポートエンサイクロペディアイクロペディアイクロペディアイクロペディアクライアントクライアントクライアントクライアント LAN サーバサーバサーバサーバケーション

(31)

ローカル処理では、リクエスタアプリケーションは次のように動作します。 ■ レポートをローカルディスク上で処理する。次に示す通常のオペレーティングシステムの規約に従って、レポート実行ファイルやパラメタ、出力ファイルを参照します。 <drive>:¥<path>¥<filename> ■ ローカルでレポートを生成、表示する。レポートをコンパイルして表示するアプリケーションの位置を指定します。標準ファイルシステム規約を使用して、レポート実行ファイルとパラメタ、出力ファイルを指定します。 ■ ローカルでレポートを印刷する。プリンタにはローカルオペレーティングシステムに認識されているものを指定します。 LRX API はローカルでも動作しますが、レポート生成はできません。リクエスタ API カスタムアプリエンドユーザデスクトップビューアローカルローカルローカルローカル ディスクディスクディスクディスククライアントクライアントクライアントクライアントケーション

(32)

リクエスタ

リクエスタ API と

と

と LRX API の開発環境

と

の開発環境

リクエスタ API アプリケーションは、Windows か UNIX プラットフォームで実行できます。 LRX API アプリケーションは、Windows プラットフォームでのみ実行できます。ヘッダもしくは Declare 文によって定義されたメソッドのライブラリ、および API のライブラリファイルを通してリクエスタ API と LRX API にアクセスします。

API の宣言

の宣言

使用するプログラム言語に従い、アプリケーションに対して API を特定します。

■ Actuate Basic

他の Actuate Basic 関数と同じようにして、リクエスタまたは LRX API 関数を呼び出します。

■ Visual Basic

Declare 文を使用してコードモジュールにリクエスタまたは LRX メソッドを宣言します。REQAPIVB.TXT ファイルには、リクエスタ API と LRX API メソッド用の宣言がすべて含まれます。 ■ C または C++ リクエスタ API では、 REQBASIC.H ヘッダファイルをインクルードします。 LRX API では、 LRXAPI.H ヘッダファイルをインクルードします。 C または C++ でプログラムする場合は、文字列を BSTR として宣言します。詳細は、この章で後述する「BSTR の処理 ― Windows 環境」を参照してください。

API ファイルの選択

ファイルの選択

リクエスタ API は、実行中にダイナミックリンクライブラリ（DLL）とコンパイル済みライブラリ（.ROX）を使用します。Actuate は定期的にこれらの DLL を更新し、機能を向上させたり、問題を解決したり、また異なる開発環境に対応しています。このセクションでは、アプリケーションに適切な DLL バージョンを選択する方法について説明します。

(33)

API ファイル名の規約

ファイル名の規約

次に示す表は、リクエスタ API で使用する名前付け規約をまとめたものです。

API ファイルバージョン

ファイルバージョン

アプリケーションに適切なファイルを選択する場合は、次の指針に従ってください。 ■ 使用中のリリースに添付されたライブラリを常に使用してください。 DLL ファイル名ファイル名ファイル名ファイル名レポートサーバ API DLL ACRSxxyy.DLL ■ xx = レポートサーバ API バージョン ■ yy = Visual C++ バージョン (4.2、5.0 または 6.0) 例： ACRS3042.DLL RogueWave DLL ACRxxyy.DLL ■ xx = RogueWave バージョン ■ yy = Visual C++ バージョン (4.2、5.0 または 6.0) 例：ACR7042.DLL リクエスタ API DLL ACRQxxyy.DLL ■ xx = Requester バージョン ■ yy = Visual C++ バージョン (4.2、5.0 または 6.0) 例：ACRQ3015.DLL LRX API DLL ACLXxxyy.DLL ■ xx = Requester バージョン ■ yy = Visual C++ バージョン (4.2、5.0 または 6.0) 例： ACLX3042.DLL

(34)

Windows NT および

および

および 95/98

リクエスタ API に対する適切な DLL については、次の表を参照してください。表にあるすべてのファイル名に DLL ファイル拡張子が付きます。リクエスタ API でアプリケーションを実行するには、レポートサーバ API の DLL が必要です。適切なレポートサーバ DLL を確認するには、次の表を参照してください。表にあるすべてのファイル名に DLL ファイル拡張子が付きます。 LRX API にはリクエスタ DLL やレポートサーバ DLL は不要です。 LRX API に必要な DLL を確認するには、次の表を参照してください。表にあるすべてのファイル名に DLL ファイル拡張子が付きます。通常、開発環境でライブラリファイルへのパスを指定するか、またはシステムディレクトリに DLL をコピーします。デベロッパワークベンチを使用している場合、ライブラリファイルは ¥Actuate¥Devwb¥lib フォルダに、DLL ファイルは ¥ リリースリリースリリースリリース VC++ 4.1 VC++ 4.2 VC++ 5.0 VC++ 6.0

3.0.x1 ACRQ3041 ACRQ3042 N/A N/A

3.1.x2 ACRQ3041 ACRQ3042 N/A N/A

3.2.x3 ACRQ3041 N/A ACRQ3050 N/A

4.0 から 4.1 N/A N/A N/A ACRQ4060

1. 98/4/20 以前の日付の ACRQ 30yy.DLL を使用します。

2. 98/4/20、またはそれ以降の日付の ACRQ30yy.DLL を使用します。 VC++ 4.2 は、リリース 3.1.1 以降では対応していません。

3. 適切な DLL ファイルはバージョン 3.2.x を示すプロパティを持ちます。

リリースリリースリリースリリース VC++ 4.1 VC++ 4.2 VC++ 5.0 VC++ 6.0

3.0 から 3.0.61 ACRS3041 ACRS3042 N/A N/A

3.1 to 3.1.12 ACRS3341 ACRS3342 N/A N/A

3.2 から 3.2.13 ACRS3441 N/A ACRS3450 N/A

3.2.2 から

3.2.33 ACRS3541 N/A ACRS3550 N/A

4.0 から 4.1 N/A N/A N/A ACRS4060

1. 98/4/20 以前の日付の ACRQ30yy.DLL と一緒に使用します。

2. 98/4/20、またはそれ以降の日付の ACRQ30yy.DLL と一緒に使用します。 VC++ 4.2 は、リリース 3.1.1 以降では対応していません。

3. 適切な DLL ファイルはバージョン 3.2.x を示すプロパティを持ちます。

リリースリリースリリースリリース VC++ 4.1 VC++ 4.2 VC++ 5.0 VC++ 6.0

3.2.x ACLX3041 N/A ACLX3050 N/A

(35)

UNIX ライブラリおよび

ライブラリおよび

ライブラリおよび path 変数

変数

UNIX アプリケーションにリンクする場合は、ライブラリパスに固有の UNIX システムに対応した共有ライブラリを設定します。 AC_SERVER_HOME 環境変数が SDK のインストールディレクトリに設定されていることを確認してください。

コンパイラ

リクエスタ API と LRX API のアプリケーションに必要なコンパイラを次の表にリストします。 LRX API アプリケーションは Windows プラットフォームでしか動作しないため、UNIX コンパイラについての情報は、リクエスタ API にのみ適用されます。オペレーティングオペレーティングオペレーティング オペレーティングシスシスシスシステムテムテムテム共有ライブラリ共有ライブラリ共有ライブラリ共有ライブラリ Path 変数変数変数変数

SunOS libreqstapi.so LD_LIBRARY_PATH

HP-UX libreqstapi.sl SHLIB_PATH

AIX libreqstapi_share.a LIBPATH

プラットフォームプラットフォームプラットフォーム

プラットフォームコンパイラコンパイラコンパイラコンパイラ

Windows NT Visual Basic 5.0

e.Reporting Suite 4 には、Visual C++ 6.0 Actuate リリース 3.1.1 以降には、 Visual C++ 4.1 または 5.0

Actuate 3.1 以前には、

Visual C++ 4.1、4.2、または 5.0

IBM AIX C set ++ 3.6.4

HP-UX e.Reporting Suite 4.1 には、

(36)

UNIX C++ のコンパイルオプション

のコンパイルオプション

のコンパイルオプションとリンクオプション

とリンクオプション

リクエスタ API アプリケーションを UNIX 環境で実行するときに必要なコンパイルオプションおよびリンクオプションを次の表にリストします。

Sun Visual Workshop C++ 5.0 を使用する場合、リクエスタ API アプリケーションは、e.Reporting Suite4 SDK と一緒に出荷される Rogue Wave 7.0.A か、Sun Visual Workshop C++ 5.0 のコンパイラと一緒に提供される Rogue Wave 7.1 ライブラリを使ってコンパイルしてください。

Solaris と HP-UX プラットフォームの場合、Actuate は Sun Visual Workshop C++ バージョン 4.2 コンパイラを使用してリクエスタ API ライブラリを構築します。開発者が Sun Visual Workshop C++ 5.0 を使用する場合、Sun Visual Workshop C++ バージョン 4 と互換性を持つように指定してアプリケーションをコンパイルしなければなりません。

すべての UNIX プラットフォームで、e.Reporting Suite 4 SDK と一緒に配布される Rogue Wave ライブラリを使用する場合は、-lacrwtool を指定します。あるいは、 Sun Visual Workshop C++ 5.0 と一緒に配布される Rogue Wave ライブラリまたは Rogue Wave ソフトウェアから直接入手するライブラリを使用する場合は、 -lrwtool を指定します。

すべての UNIX プラットフォームで、コンパイル時にコマンドラインオプションとして -D_ACSERVER を指定します。同様に、AIX では -D_ILS_MACROS も指定します。

次に UNIX C++ のリンクオプションを示します。

Sun Visual Workshop

C++ 4.2 Sun Visual Workshop C++ 5.0 AIX C++ 3.X

HP-UX C++ A.10.24 から A.10.28 -I<Include paths> -L<Library paths> -lreqstrapi -lsocket -lthread -mt -compat=4 -I<Include paths> -L<Library paths> -lreqstrapi -lsocket -lthread -mt -lreqstrapi_share -lC_r -lC -ldcelibc_r -ldcepthreads -lpthreads -lc_r -lm -lc -lreqstrapi -ldce -lm

(37)

リクエスタ

リクエスタ API の操作環境

の操作環境

リクエスタ API を使用してアプリケーションを実行しているクライアントには、次の 3 つのコンポーネントが必要です。 ■ Actuate ビューアかエンドユーザデスクトップかデベロッパワークベンチ。 Actuate ビューアはレポートを表示するために必要です。エンドユーザデスクトップかデベロッパワークベンチはローカルでレポートを実行するために必要です。レポートサーバ上でレポートを生成するだけのアプリケーションには、このようなコンポーネントは不要です。 ■ リクエスタ API を使用するカスタムアプリケーション。 ■ ユーザのシステムに対応するリクエスタ API の DLL。 Actuate ビューアと一緒にリクエスタ API を使用する場合は、クライアントシステムにビューア実行ファイルをコピーし、操作環境を設定しなくてはなりません。Actuate ビューアは無料ですが、その他のコンポーネントには有効なライセンスが必要です。

Actuate ビューアによるリクエスタ

ビューアによるリクエスタ

ビューアによるリクエスタ API の使用

の使用

Actuate ビューアを使用して API アプリケーションのレポートを表示するには、次のようにクライアントを準備します。 1 ビューアをインストールします。 2 Windows のシステムディレクトリにリクエスタ DLL をコピーするか、あるい は PATH 環境変数に DLL の位置を設定します。DLL をコピーする場合は、次から選びます。

■ Windows NT および Windows 2000 − ACRQ3041.DLL を System32 ディレク

トリにコピーします。

■ Windows 95/98 − ACRQ3041.DLL を System ディレクトリにコピーします。 ■ Windows 3.1 − ACRQ3015.DLL を System ディレクトリにコピーします。 3 API アプリケーションをインストールします。

(38)

LRX API の操作環境

の操作環境

LRX API アプリケーションを実行しているクライアントには、次の 4 つのコンポーネントが必要です。

■ Netscape または Internet Explorer ブラウザ。 ■ そのブラウザに対応する Actuate LRX。 ■ LRX API を使用するカスタムアプリケーション。 ■ ユーザのシステムに対応する LRX DLL。 LRX API は、Windows 環境でのみ動作します。

プログラムタスク別

プログラムタスク別 API 関数

関数

このセクションでは、次に示す一般的なプログラムタスク別にリクエスタ API 内の関数を分類してリストしています。 ■ スタートアップコードとクリーンアップコードの記述 ■ レポートファイルの処理 ■ パラメタ名とパラメタグループ名の取得 ■ パラメタ属性の取得 ■ パラメタのデフォルト値の取得 ■ パラメタの現在値の取得 ■ パラメタ値の設定 ■ プリンタの設定 ■ レポートの実行、表示、印刷 ■ エラーの検査各関数の完全な説明については、3 章「リクエスタ API リファレンス」を参照してください。

(39)

スタートアップコードとクリーンアップコードの記述

次の表に、リクエスタ API と LRX API の起動と終了に使用する関数をリストします。アプリケーションは AcReqSelectClient か AcReqSetEUDTPath を呼び出して、クライアント製品を選択しなければなりません。 AcReqSelectClient は AcReqSetEUDTPath の代わりに使用できます。新規アプリケーションの場合は AcReqSelectClient メソッドの使用を推奨します。 AcReqIsAfcInstalled、

AcReqInstallAfc、または AcReqSetCacheSize を使用するには、AcReqSelectClient を使用しなければなりません。プログラミングタスクプログラミングタスクプログラミングタスクプログラミングタスク API 関数関数関数関数クライアント側でのレポートの表示、印刷、実行に使用するクライアント製品を選択します。 AcReqSelectClient レポート（.ROI）を生成するために使用するエンドユーザデスクトップアプリケーションを指定します。 AcReqSetEUDTPath1 API を初期化します。プログラムが他の API 関数を呼び出せるようになるためには、この手順は必須です。 AcReqInitialize1 プログラムがサーバ上のファイルにアクセスする場合は、サーバに接続します。 AcReqConnect プログラムがサーバ上のタスクを実行し終わった後、サーバへの接続を切断します。 AcReqDisconnect ライブラリを閉じ、API が使用していたリソースを解放します。 AcReqUnInitialize1 1. リクエスタ API と LRX API 両方のメンバです。

(40)

レポートファイルの処理

リクエスタ API 関数を使用する場合は、通常、次のファイルを処理する必要があります。 ■ レポートパラメタ値（.ROV）ファイルパラメタ値ファイルはレポートリクエストのパラメタ定義と値を含んでいます。ユーザがリクエストを発行すると、パラメタ値ファイルは自動的に作成されます。パラメタ値にアクセスして操作するには、パラメタ値ファイルを開きます。代わりに、次に説明するレポート実行（.ROX）ファイルを開くこともできます。パラメタ値の設定後、パラメタ値ファイルに情報を書き込むと、指定したパラメタ値に基づいたレポートの生成に使用できます。 ■ レポート実行（.ROX）ファイル実行ファイルは、他の情報とともにレポートリクエストのパラメタ定義を含んでいます。レポートデザインをコンパイルして構築すると、実行ファイルが作成されます。パラメタ値にアクセスして操作するには、パラメタ値ファイルか実行ファイルを開きます。 ■ レポート文書（.ROI）ローカルシステム上でもレポートサーバ上でも、いつでも API からレポート文書を表示したり印刷できます。

ローカルファイル名の指定―リクエスタ

ローカルファイル名の指定―リクエスタ API

リクエスタ API 関数の引数にファイル名を指定するとき、アクセスしたいファイルが現在のディレクトリにない場合は、フルパスを指定しなくてはなりません。たとえば、レポート内のコードで異なるディレクトリの .ROV ファイルを開くときには、 AcReqReadFile の引数には .ROV ファイルのフルパス名を指定してください。

レポートサーバファイル名の指定―リクエスタ

レポートサーバファイル名の指定―リクエスタ API

次に、API 関数の引数にサーバファイル名を指定するときの構文を示します。 rotp://[<user>:<password>@]<server>/<path>/<filename>[;<version>] 同じレポートに対して複数のユーザがリクエストを発行する場合や、同じパラメタファイルやレポート実行ファイルを複数のユーザが読み書きする場合は、ユーザ名とパスワードを含むようにしてください。 <user> オプションです。リクエストを提出するユーザの名前です。 <password> オプションです。リクエストを提出するユーザのパスワードです。

(41)

<server> オプションです。サーバの名前です。この引数を省略すると、プログラムが現在接続しているサーバがデフォルトで使用されます。 <path> ファイルが位置するディレクトリへのフルパスです。 <filename> アクセスするファイル名です。 <version> オプションです。使用するファイルのバージョンです。この引数を省略すると、最新バージョンのファイルがデフォルトで使用されます。次の値の 1 つを指定できます。次に示すのは、ファイル名引数を必要とするリクエスタ API 関数の 1 つである AcReqViewReport の有効な引数の使用例です。

AcReqViewReport( "rotp://Paradise/MyDir/MyReport.roi", AC_REQ_VIEW ) AcReqViewReport( "rotp://Paradise/MyDir/MyReport.rov;Latest", AC_REQ_VIEW ) AcReqViewReport( "rotp://Paradise/Accounting/July96/AcctRpt.roi", AC_REQ_VIEW ) AcReqViewReport( "rotp://Paradise/Accounting/July96/AcctRpt.roi;15", AC_REQ_VIEW ) 次の表に、レポートファイルを処理するための関数をリストします。値値値値説明説明説明説明 Latest 最新のファイルバージョンです。 Oldest 最も古いファイルバージョンです。 LatestDev 最新の開発ファイルバージョンです。 LatestRel 最新のリリースファイルバージョンです。 <#> ファイルのバージョン番号です。 <version name> ファイルのバージョン名です。

(42)

パラメタ名とパラメタグループ名の取得

デザイン時に、パラメタ名をグループ分けして定義することができます。たとえば、「Customer」という名前のパラメタグループに「Name」、「Credit_rank」、「Purchase_volume」というパラメタを含めることできます。また、「Office」というグループに「City」と「State」を含めることができます。リクエスタ API には、デベロッパワークベンチやエンドユーザデスクトップのリクエスタダイアログボックスに表示される順序でパラメタグループとパラメタの名前を取得するための関数があります。この情報を使うと、たとえば Visual Basic フォームで、カスタムリクエスタダイアログボックスを作成できます。また、パラメタ名は、パラメタ値を設定したり検索する他の関数への引数としても必要になります。

パラメタ属性の取得

デザイン時には、データ型などの各種の属性がパラメタに割り当てられます。たとえば、各パラメタが必須であるかオプションであるか、アドホックパラメタであるかどうかなどです。リクエスタ API には、各パラメタの属性についての情報を取得するための関数があります。API を使ってこれらの属性を変えることはできません。プログラミングタスクプログラミングタスクプログラミングタスクプログラミングタスク API 関数関数関数関数第 1 パラメタグループ名を取得します。 AcReqGetFirstGroup 次のパラメタグループ名を取得します。 AcReqGetNextGroup 第 1 パラメタ名を取得します。 AcReqGetFirstParameter 次のパラメタ名を取得します。 AcReqGetNextParameter プログラミングタスクプログラミングタスクプログラミングタスクプログラミングタスク API 関数関数関数関数パラメタの別名を取得します。別名はリクエスタダイアログボックスにプロンプトとして表示されます。 AcReqGetAlias パラメタが必須かオプションかを確認します。 AcReqGetRequired パラメタがプログラムでしか設定できないかどうかを確認します。 AcReqGetHidden ユーザがリクエスタで値を入力するとき、パラメタがアスタリスクを表示するように定義されているか、実際のテキストを表示するように定義されているかを確認します。 AcReqGetHideText パラメタがアドホックパラメタであるかどうかを確認します。 AcReqGetAdhoc

(43)

パラメタのデフォルト値の取得

デザイン時に必須であると定義されたパラメタには、デフォルト値が必要です。デフォルト値は、レポート実行時に値が提供されない場合に使用されます。次の表に、パラメタのデフォルト値を取得するための関数をリストします。パラメタのデータ型を文字列として取得します。 AcReqGetParmType パラメタのデータ型を列挙として取得します。 AcReqGetType プログラミングタスクプログラミングタスクプログラミングタスクプログラミングタスク API 関数関数関数関数プログラミングタスクプログラミングタスクプログラミングタスクプログラミングタスク API 関数関数関数関数データ型にかかわらずパラメタのデフォルト値を文字列として取得します。 AcReqGetDefaultValueStr 通貨型のパラメタのデフォルト値を通貨として取得します。 AcReqGetDefaultValueCurrency 日付型のパラメタのデフォルト値を日付として取得します。 AcReqGetDefaultValueDate 倍精度浮動小数点数型のパラメタのデフォルト値を倍精度浮動小数点数として取得します。 AcReqGetDefaultValueDouble 整数型のパラメタのデフォルト値を整数として取得します。 AcReqGetDefaultValueInteger 文字列型のパラメタのデフォルト値を文字列として取得します。 AcReqGetDefaultValueString パラメタがデフォルト値を持つかどうかを確認します。 AcReqHasDefaultValue

(44)

パラメタの現在値の取得

パラメタの現在値とは、最後にパラメタ値（.ROV）ファイルに入力された値です。パラメタ値ファイルにアクセスしていてパラメタ値を検索する必要があるときは、次の表で説明する関数を使用します。実行ファイルにアクセスしているときは、パラメタ値はデザイン時に定義されたデフォルト値です。

パラメタ値の設定

次の表はパラメタ値を設定するために使用する関数をリストしたものです。値を割り当てるときは、値の型とパラメタの型が一致するように注意する必要があります。各データ型には、それぞれ関数があります。パラメタに値を割り当てる前に、AcReqGetParmType を呼び出してパラメタの型を調べることができます。

プリンタの設定

システムのデフォルトプリンタを使用したくなかったり、プリンタのデフォルト設定を使用したくない場合には、レポートを印刷する前にプリンタやプリンタ設定を変えることができます。次の表にプリンタ関連の API 関数をリストします。プログラミングタスクプログラミングタスクプログラミングタスクプログラミングタスク API 関数関数関数関数通貨型のパラメタの現在値を通貨として取得します。 AcReqGetValueCurrency 日付型のパラメタの現在値を日付として取得します。 AcReqGetValueDate 倍精度浮動小数点数型のパラメタの現在値を倍精度浮動小数点数として取得します。 AcReqGetValueDouble 整数型のパラメタの現在値を整数として取得します。 AcReqGetValueInteger 文字列型のパラメタの現在値を文字列として取得します。 AcReqGetValueStr 文字列型のパラメタの現在値を文字列として取得します。引数を渡すことが必要な場合は、AcReqGetValueStr ではなく AcReqGetValueString を使用します。 AcReqGetValueString プログラミングタスクプログラミングタスクプログラミングタスクプログラミングタスク API 関数関数関数関数通貨型のパラメタ値を設定します。 AcReqSetValueCurrency 日付型のパラメタ値を設定します。 AcReqSetValueDate 倍精度浮動小数点数型のパラメタ値を設定します。 AcReqSetValueDouble 整数型のパラメタ値を設定します。 AcReqSetValueInteger 文字列型のパラメタ値を設定します。 AcReqSetValueString

(45)

プログラミングタスクプログラミングタスクプログラミングタスクプログラミングタスク API 関数関数関数関数使用するプリンタを指定します。 AcReqSetPrinterName1 印刷部数を指定します。 AcReqSetPrinterNumberCopies 印刷方向が縦か横かを指定します。 AcReqSetPrinterOrientation 印刷サイズの拡大・縮小率を指定します。 AcReqSetPrinterScale カラー印刷のオン、オフを指定します。 AcReqSetPrinterColor 両面印刷のオン、オフを指定します。2 AcReqSetPrinterDuplex 部数単位で印刷するかどうかをオン、オフで指定します。 AcReqSetPrinterCollate 用紙サイズを指定します。用紙の種類（A4、B4 など）か、実際のサイズを指定します。3 AcReqSetPrinterFormName 用紙サイズを寸法で指定します。 AcReqSetPrinterPaperSize システムのデフォルトプリンタに設定を戻します。 AcReqSetDefaultPrinter 用紙トレイを指定します。 AcReqSetPrinterTray 1. リクエスタ API と LRX API 両方のメンバです。 2. UNIX サーバはこの機能をサポートしていません。 3. UNIX サーバは論理サイズのみをサポートしています。実際のサイズはサポートしていません。

ActuateデスクトップAPIガイド

目次

目次

目次

目次

マニュアルについて

マニュアルについて

マニュアルについて

マニュアルについて. . .

. . .

. . .

. . . vii

vii

vii

vii

1 章

章

章

章 Actuate API について

について

について

について . . . 1

Part 1 リクエスタ

リクエスタ

リクエスタ

リクエスタ API

3 章

章

章

章 リクエスタ

リクエスタ

リクエスタ

リクエスタ API リファレンス

リファレンス

リファレンス

リファレンス . . . 55

Part 2 サーチ拡張

サーチ拡張

サーチ拡張

サーチ拡張 API

4 章

章

章

章 サーチ拡張

サーチ拡張

サーチ拡張

サーチ拡張 API ユーザガイド

ユーザガイド

ユーザガイド

ユーザガイド . . . 125

5 章

章

章

章 サーチ拡張

サーチ拡張

サーチ拡張

サーチ拡張 API リファレンス

リファレンス

リファレンス

リファレンス . . . 135

マ ニ ュ ア ル に つ い て

マ ニ ュ ア ル に つ い て

マ ニ ュ ア ル に つ い て

マ ニ ュ ア ル に つ い て

Actuate e.Reporting Suite 4 について

について

について

について

『

『

『

『Actuate デスクトップ

デスクトップ

デスクトップ API ガイド』について

デスクトップ

ガイド』について

ガイド』について

ガイド』について

オンラインマニュアル

オンラインマニュアル

章リクエスタ

章サーチ拡張

章サーチ拡張

マニュアルについて

マニュアルについて

マニュアルについて

マニュアルについて