Field Reports .NET Bridge
.NET Bridge 2.0.0

Field Reports .NET Bridge（以降，本モジュールと表記します）は， PDF帳票ツールField Reportsを.NET対応プログラミング言語から利用するためのライブラリです。

.NET Bridge APIを通じて，Field Reportsの各機能を呼び出すことができます。

  • Field Reportsのバージョンを取得する。
  • レンダリング・パラメータを元にPDFを生成し，結果をバイナリ文字列として受け取る。
  • PDFデータを解析し，フィールドや注釈の情報を取得する。

ライセンス

本モジュールのソースコードは，BSDライセンスのオープンソースとします。 

https://github.com/field-works/dotnet-bridge/

以下のような場合，自由に改変／再配布していただいて結構です。

  • 独自機能の追加
  • ビルド/実行環境等の違いにより，本モジュールが正常に機能しない。
  • 未サポートの.NETバージョンへの対応のため改造が必要。
  • 他の言語の拡張ライブラリ作成のベースとして利用したい。

ただし，ソースを改変したモジュール自体において問題が発生し場合については， サポート対応いたしかねますのでご了承ください （Field Reports本体もしくはオリジナルの本モジュールに起因する問題であれば対応いたします）。

必要条件

Field Reports本体

本モジュールのご利用に際しては，Field Reports本体がインストール済みである必要があります。 

https://www.field-works.co.jp/製品情報/

Field Reports本体のインストール手順につきましては， ユーザーズ・マニュアルを参照してください。

連携手段の選択

本モジュールとField Reports本体との連携方法として，以下の２種類があります。 システム構成に応じて，適切な連携方法を選択してください。

  • コマンド呼び出しによる連携
    • 本モジュールとreports本体を同一マシンに配置する必要があります。
    • パスが通る場所にreportsコマンドを置くか，reportsコマンドのパスをAPIに渡してください。
  • HTTP通信による連携
    • リモートマシンにField Reportsを配置することができます。
    • Field Reportsは，サーバーモードで常駐起動させてください（reports server）。
    • サーバーモードで使用するポート番号（既定値：50080）の通信を許可してください。

開発環境

Visual Studioもしくはdotnetコマンドが導入済みであるものとします。

以下，dotnetコマンドからの利用を前提として説明します。

インストール

NuGetからのインストール

本モジュールは，NuGet galleryに登録されています。 利用している開発環境に応じた方法でインストールしてください。

> dotnet add package FieldWorks.FieldReports --version 2.0.0

動作確認

動作確認用のコンソールプロジェクトを作成します。

$ dotnet new console -o test
$ cd test
$ dotnet add package FieldWorks.FieldReports

Program.csを以下のように編集します。

{c#::Program.cs}
using FieldWorks.FieldReports;
var param = new {
template = new {
paper = "A4"
},
context = new {
hello = new {
@new = "Tx",
value = "Hello, World!",
rect = new int[] {100, 700, 400, 750}
}
}
};
var reports = Bridge.CreateProxy();
var pdf = reports.Render(param);

コマンド連携時

以下のコマンドを実行してください。

LinuxまたはmacOSでの実行例：

$ REPORTS_PROXY=exec:/usr/local/bin/reports dotnet run
2.0.0
%PDF-1.6
...

Windowsでの実行例：

> set REPORTS_PROXY="C:\Program Files\Field Works\Field Reports 2.0\reports.exe"
> dotnet run
2.0.0
%PDF-1.6
...

HTTP連携時

Field Reportsをサーバーモードで起動してください。

$ reports server -l4

以下のコマンドを実行してください（動作環境に応じて，URLは変更してください）。

LinuxまたはmacOSでの実行例：

$ REPORTS_PROXY=http://localhost:50080/ dotnet run
2.0.0
%PDF-1.6
...

Windowsでの実行例：

> set REPORTS_PROXY=http://localhost:50080/
> dotnet run
2.0.0
%PDF-1.6
...

著者