多機能帳票作成ツール　xReport サーバー版

１．xReportサーバ版の概要 xReportサーバ版は、SOAP形式のXML Webサービスを提供するWebアプリケーションです。 業務アプリケーションからネットワークを介してデータを受け取り、帳票を作成します。 中間ファイルなどを必要としないため、業務アプリケーションとのシームレスな連携が実現できます。 ※ 帳票データの形式は、次の３種類が指定可能です： 1).NET FrameworkのDataSet型、2)XML形式の文字列、3)CSV形式の文字列 1

２．xReportサーバ版の導入手順 xReportサーバ版の導入手順の概要を解説します。 はじめに、業務アプリケーションの開発プラットフォームをご調査ください。 Ａ．業務アプリケーションの開発プラットフォームが .NET Framework である場合 １）[xReportServ]をWindowsサーバ（Webサーバ）にインストールする。 ※ [xReportServ]は.NET Frameworkで開発されたSOAP形式のXML Webサービスを公開するアプリケーションです。 ２）業務アプリケーション側で、xReportサーバ版連携API [xReportAPI.dll] の参照設定を行う。 ※ 連携APIの利用には、業務アプリケーションが、.NET Framework 2.0以降の、 VB.NETもしくはC#.NETで構築されている必要があります。 ３）業務アプリケーションに、「APIを利用して帳票を作成する処理」を実装する。 ※ 後述の[xReport API 利用例]をご参照ください。 Ｂ．業務アプリケーションの開発プラットフォームが .NET Framework でない場合 １）業務アプリケーションの開発プラットフォームのマニュアルを参照し、SOAP形式のWebサービスが利用 可能であることを確認する。 ２）[xReportServ]をWindowsサーバ（Webサーバ）にインストールする。 ※ [xReportServ]は.NET Frameworkで開発されたSOAP形式のXML Webサービスを公開するアプリケーションです。 ３）開発プラットフォームのマニュアルに従い、業務アプリケーションと、[xReportServ]が公開するWeb サービスとの接続設定を行う。 2

３．xReport API 利用例 3

４．xReport サーバ版 管理機能オプション 書式（帳票フォーマット）の管理や、利用状況の照会が可能なWebアプリケーションです。 ※ 管理機能オプションのご利用にはSQL ServerもしくはOracleが必要です。 ＜書式、イメージのアップロード＞ 書式（帳票フォーマット）のアップロード・ダウン ロード・削除を行うことができます。 ＜利用状況照会＞ 帳票の出力履歴を照会できます。 4

５．連携API 連携API[xReportAPI.dll]は、「xReportサーバ版が提供するWebサービス」の使用を簡易にするためのプログラムです。 このAPIは、VB.NETおよびC#.NETにて利用できます。 xReportAPI.xReportIfクラス プロパティ № 名前 説明 * 1 CompanyCode 会社コードを指定します。(注１ * 2 WebPassWord Webサービスパスワードを指定します。(注１ * 3 FormatCode 書式ファイル名（拡張子つき）を指定します。 指定できる拡張子はxlsもしくはxlsxです。 * 4 OutputType 出力形式を指定します。（1:PDF 2:Xls 3:Xlsx 4:HTML） 5 OwnerPassword PDFのOwnerPassword、Excelのシート保護パスワードを設定する時に指定します。 6 UserPassword PDFのUserPassword、Excelの読み取りパスワードを設定する時に指定します。 7 DocSort ソート・小計設定を指定します。 この設定は、書式ファイルに記述されたソート・小計設定よりも優先して適用されます。 8 PersonCode 作成者コードを指定します。 9 PersonName 作成者名を指定します。 10 DocFileName 成果物の名称を指定します（拡張子なし）。 ファイル名として使用できない文字は、"_"へ置換されます。 省力時には自動付与します。 11 ServerName xReportサーバ版をインストールしたマシンの名称を指定します。 動的にWebサービスの提供元への接続を変更したいときに指定します。 12 CloseTimeoutSeconds xReportの接続の終了を待機する時間間隔を秒で指定します。(注２ 13 OpenTimeoutSeconds xReportの接続の確立を待機する時間間隔を秒で指定します。(注２ 14 ReceiveTimeoutSeconds xReportの読み取り操作の完了を待機する時間間隔を秒で指定します。(注２ 15 SendTimeoutSeconds xReportの書き込み操作の完了を待機する時間間隔を秒で指定します。(注３ 注１指xR定epしorなtサいー時バは版呼のび設出定しフ元ァのイCoルnfのig内フ容ァをイ指ル定のし設ま定す値。で処理します。設定が600秒未満の時は600秒に設定します。 設定ファイルが次の内容である場合、会社コードには'example', Webサービスパスワードには'webpassword'を指定します。 例：<add key="UserKey_example" value="webpassword"/> 詳細は[xReportサーバ版インストールマニュアル]を参照してください。 注２ 指定しない時は呼び出し元のConfigファイルの設定値で処理します。 注３ 指定しない時は呼び出し元のConfigファイルの設定値で処理します。設定が600秒未満の時は600秒に設定します。 ※アスタリスク(*)が記されている項目は必須項目です。 メソッド № 名前 説明 1 CallxReport(DataSet) 指定したデータを基にレポートを作成します。 作成したファイルのパスを戻り値とします。 2 Show(String) 指定したURLのファイルを開きます。 エラー発生時はエラー情報を戻り値とします。 3 Show(urlString, flg) 指定したURLのファイルを開きます。 エラー発生時はエラー情報を戻り値とします。 urlString……String型。ファイルのURLを指定します。 flg……Integer型。0:指定したURLのファイルを開きます。1:urlStringをUNCパスへ変換 し、UNCパスにてファイルを開きます（"http://"を"\\"へ変換します）。 ※エラー情報……ナンバー記号（#）で始まる文字列です。 5

６．xReportWebServ [xReportWebServ]は、xReportサーバ版が XML Webサービス として公開するクラスです。 連携APIはこのクラスを利用してレポートを作成します。 xReportWebServクラス メソッド № 名前 説明 HelloWorld Webサービスの接続確認用メソッドです。1 文字列"Hello World"を返します。 CreateDocDS(hdrData, dtlData) 2 ※引数は.Net FrameworkのDataSet型。 書類作成処理を実行します。正常終了したとき、作成した書類の CreateDocXml(hdrData, dtlData) 3 ファイルURLを返します。異常終了したとき、エラー情報を返します。 ※引数はXML形式の文字列型。 ※エラー情報の先頭文字はナンバー記号(#)です。 CreateDocByCsv(hdrData, dtlData) 4 ※引数はCSV形式の文字列型。 引数の解説 hdrData（ヘッダデータ）　　※連携APIのプロパティNo.1～10に相当します。 No. 項目名 桁数 説明 * 1 Doc_CompanyCode 10 会社コードを指定します。(注１ * 2 Doc_WebPassWord 20 Webサービスパスワードを指定します。(注１ 書式ファイル名（拡張子つき）を指定します。 * 3 Doc_FormatCode 50 指定できる拡張子はxlsもしくはxlsxです。 * 4 Doc_OutputType 1 出力形式を指定します。（1:PDF 2:Xls 3:Xlsx 4:HTML） PDFのOwnerPassword、Excelのシート保護パスワードを設定する時に指定し 5 OwnerPassword 20 ます。 PDFのUserPassword、Excelの読み取りパスワードを設定する時に指定しま 6 UserPassword 20 す。 ソート・小計設定を指定します。 7 Doc_Sort 300 この設定は、書式ファイルに記述されたソート・小計設定よりも優先して適 用されます。 8 Doc_PersonCode 20 作成者コードを指定します。 9 Doc_PersonName 40 作成者名を指定します。 成果物の名称を指定します（拡張子なし）。 10 Doc_DocFileName 50 ファイル名として使用できない文字は、"_"へ置換されます。 省力時には自動付与します。 注 hdrDataの内容は1レコードのみとします。※CSV形式の場合は、列名の行とデータ行の計２行です。 注１xReportサーバ版の設定ファイルの内容を指定します。 設定ファイルが次の内容である場合、会社コードには'example', Webサービスパスワードには'webpassword'を指定します。 例：<add key="UserKey_example" value="webpassword"/> 詳細は[xReportサーバ版インストールマニュアル]を参照してください。 dtlData（明細データ） No. 項目名 桁数 説明 * 1 Doc_XmlSeqNo - 明細番号。連番値（1以上のユニークな数値）を指定します。 明細の区分を指定します。"C":一般 "K":経費 "N":ノーコマ * 2 Doc_DtlType 1 連携API使用時は、この項目は必須項目ではありません（この項目が 存在しない場合、すべての明細を区分"C"として扱います）。 3 任意項目 - 書式に設定した項目を定義し、出力する値を指定します。 ※アスタリスク(*)が記されている項目は必須項目です。 6

７．xReportサーバ版のディレクトリ構成 xReportサーバ版のディレクトリ構成を解説します。 ■ディレクトリ構成 wwwroot ※C:\inetpub\wwwroot xReportServ ① xReportEraser ② xReportUser ③ xReportWebServ ④ log ⑤ [会社コードフォルダ] ⑥ form ⑦ temp ⑧ [会社コードフォルダ] form temp [会社コードフォルダ] ： ： xReport.lic ⑨ ■説明 xReportサーバ版のルートディレクトリ（インストールディレクトリ）です。 ① xReportServ tempフォルダを定期的にクリアするためのアプリケーションです。Windowsタスク ② xReportEraser にて実行します。 管理機能オプション(Webアプリケーション)です。 ③ xReportUser xReportサーバ版が公開するWebサービス[xReportWebServ]の、ルートディレクト ④ xReportWebServ リです。 エラーログの格納先です。 ⑤ log 書式の参照先、および帳票成果物の出力先です。連携APIの[CompanyCode]と対応 ⑥ [会社コードフォルダ] します。※[CompanyCode]の値がフォルダ名となります。 書式の参照先です。書式ファイルを格納します。 ⑦ form 帳票成果物の出力先です。 ⑧ temp FBSが発行するライセンスファイルです。 ⑨ xReport.lic 7