webサイトへの組込み方法、APIリファレンス

印刷革命は、WebサイトへJavaScriptを組み込み、クライアントアプリにPDFデータ、またはReceiptLine形式データの印刷命令を送る必要があります。

以下のURLのJavaScriptを読み込むか、ダウンロードして貴社サイトに組み込んでください。

https://www.hako-soft.com/print_server/print_revolution.js

JavaScriptライブラリ

「print_revolution.js」をWebサイトに読み込むと、JavaScript上でPrintRevolutionクラスが使用できるようになります。

PrintRevolutionクラスAPI

object PrintRevolution(object param)

object param:初期化パラメータ

PrintRevolutionオブジェクトを生成するコンストラクタメソッドです。

初期化パラメータには連想配列で以下の内容を設定できます。

キー:client_url

印刷革命クライアントアプリのWebScoketのURL、待受ポート番号を設定します。

初期値は「wss://local.hako-soft-app.com:2020/」です。

キー:connected

印刷革命クライアントアプリ接続時に実行されるコールバック関数を指定します。

キー:closed

印刷革命クライアントアプリ切断時に実行されるコールバック関数を指定します。

キー:print_finished

印刷革命クライアントアプリで印刷が完了した際に実行されるコールバック関数を指定します。

void connect()

印刷革命クライアントアプリと通信を接続します。

void disconnect()

印刷革命クライアントアプリと通信を切断します。

void print_base64(string base64str, string data_format, string printer_code)

string base64str:PDFデータをbyte配列として読み込み、更にbase64化した文字列

string data_format:”pdf”=PDFファイル, “image”=画像ファイル

string printer_code:プリンタを指定する場合のプリンタ番号(1~5)

印刷革命クライアントアプリに印刷するPDFデータを送信します。

void print_download(string url, string data_format, string printer_code)

string url:PDFファイルのURL

string data_format:”pdf”=PDFファイル, “image”=画像ファイル

string printer_code:プリンタを指定する場合のプリンタ番号(1~5)

印刷革命クライアントアプリに印刷するPDFファイルのURLを送信します。

指定したURLのPDFファイルがクライアントアプリ内でダウンロードされ、印刷されます。

void print_receiptline(string receiptline_data, string printer_code)

string receiptline_data:ReceiptLine形式のテキストデータ

string printer_code:サーマルプリンタを指定する場合のプリンタ番号(1~2)

印刷革命クライアントアプリに印刷するReceiptLine形式のテキストデータを送信します。

ReceiptLine形式のデータ作成方法については、ReceiptLine公式サイトをご確認ください。

void print_bpac(string base64_str, object[] template_param)

string base64_str: LBX形式P-touchテンプレートファイルをbase64文字列に変換したもの

object[] template_param: テンプレートに挿入するデータ配列( データ形式は {“field”:フィールド名,”data”:データ名} )

印刷革命クライアントアプリに印刷するP-touchデータを送信します。

P-touchテンプレートファイルは、Brother社のP-touchエディターを使用して作成し、Webサイト上に配置してください。

string arrayBufferToBase64(ArrayBuffer buffer)

ArrayBuffer buffer: PDFデータのbyte配列

byte配列をbase64文字列に変換します。

print_base64メソッドと共にご利用ください。

サンプル

以下のURLからWebサイト組込み例をご確認いただけます。

通常プリンタデモ

サーマルプリンタデモ(ReciptLineデモ)

ラベルプリンタデモ

クライアントアプリの設定

クライアントアプリの設定

1.ライセンスキー

別途メールにてお知らせしますライセンスキーを入力します。

ライセンス未認証時は試用モードとなり、印刷時に透かしが印刷されます。

2.自動起動設定

PC起動時に自動的に起動するかどうかを設定します。

3.印刷時ダイアログ設定

印刷時に印刷ダイアログを表示するかどうかを設定します。

ダイアログを表示しない場合、印刷命令を受け取った後、すぐに印刷されます。(直接印刷)

4.待受けポート

印刷革命はWebブラウザと独立したソフトとして動作し、Webサイトから印刷命令を受信します。Webサイトから印刷命令を受信するための、待受けポート番号を設定します。

5.データ保存フォルダ

フォルダを設定した場合、印刷すると共に、指定フォルダにPDF(ReceiptLine形式の場合はTXTファイル)が保存されます。

ファイル名は出力時刻.pdf(yyyyMMddHHmmss.pdf)(またはtxt)の形式になります。

6.PDF印刷プリンタ設定

印刷時のプリンタを指定する事ができます。

また、2~5のプリンタを設定し、Webサイト側から2~5のプリンタを使用するよう命令することで、PDFの種類に応じて複数のプリンタに出しわける事ができます。

7.許可ドメイン

ドメインを指定すると、指定したドメインのWebサイトでだけ印刷革命が動作するよう制限することができます。

8.更新チェックボタン

印刷革命の最新版が公開されているかどうかのチェックを行います。

9.PDF連続用紙設定

プリンタが連続用紙の場合にチェックします。

10.サーマルプリンタ設定

サーマルプリンタ使用時に設定します。

印刷革命にReceiptLineフォーマットのテキストデータを送信することで、サーマルプリンタに印刷することができます。

2~のプリンタを設定し、Webサイト側から2~のプリンタを使用するよう命令することで、複数のサーマルプリンタに出しわける事ができます。

11.サーマルプリンタ名

サーマルプリンタのプリンタ名を指定します。

12.サーマルプリンタエンコーディング

サーマルプリンタのエンコードを設定します。

13.サーマルプリンタ命令セット

サーマルプリンタの命令セットを設定します。

14.印字桁数

サーマルプリンタの印字桁数を設定します。

15.ポート名

シリアル接続のポート名を設定します。

16.ボーレート

シリアル接続のボーレートを設定します。

17.接続

接続の種類を設定します。

プロキシ使用時の追加設定

ネットワーク設定でプロキシを使用する場合、ネットワーク設定のプロキシ設定で「ローカル(イントラネット)のアドレスにはプロキシサーバーを使わない」にチェックを入れてください。

起動方法

クライアントアプリの起動

ファイルの内容は以下のようになっています。

「print_revolution.exe」が印刷革命クライアント本体となっています。
「print_revolution.exe」をダブルクリックすると印刷革命クライアントが起動します。

ライセンスキー設定

タスクトレイのアイコンをダブルクリックすると、印刷革命の画面が表示されます。
初回起動時はライセンスキーが設定されていないため、試用モードになっています。

※試用モード中は、印刷時に透かしが印刷されます。

設定ボタンを押すと、設定画面が開きます。
ライセンスキーの入力欄に、別途メールでお知らせしましたライセンスキーを入力し、認証ボタンを押してください。

認証が完了すると、試用モードが解除されます。

クライアントアプリ インストール

ソフトウェア使用許諾書

印刷革命をインストールされる前に、以下のソフトウェア使用許諾書をよくお読みください。 本ソフトウェアをご使用されるお客さま(以下、「使用者」といいます)は、本ソフトウェアをご使用になることで、本契約の各条項の拘束を受けることに同意されたことになります。 本契約の各条項に同意されない場合は、本ソフトウェアを削除の上、ご利用にならないでください。

インストール

印刷革命は、ご利用のPCにクライアントアプリをインストールする必要があります。

WebView2ランタイムのインストール

こちらから環境に合わせたWebView2ランタイムをダウンロードし、インストールしてください。

クライアントアプリのインストール

以下のリンクよりファイルをダウンロードし、解凍します。
解凍後、任意のフォルダに配置します。

インストール

ソフトウェア使用許諾書

雲筆をインストールされる前に、以下のソフトウェア使用許諾書をよくお読みください。 本ソフトウェアをご使用されるお客さま(以下、「使用者」といいます)は、本ソフトウェアをご使用になることで、本契約の各条項の拘束を受けることに同意されたことになります。 本契約の各条項に同意されない場合は、本ソフトウェアを削除の上、ご利用にならないでください。

インストール

雲筆は、PCにインストールするクライアントアプリ、ブラウザにインストールする拡張機能で構成されています。

クライアントアプリのインストール

以下のリンクの、「その他のTools、Frameworks、そしてRedistributable」より「Microsoft Visual C++ Redistributable for Visual Studio 2022 (x86)」をダウンロードし、インストールしてください。

https://visualstudio.microsoft.com/ja/downloads/

以下のリンクよりファイルをダウンロードし、解凍します。
解凍後、任意のフォルダに配置します。

拡張機能のインストール

以下のリンクより、ブラウザ張機能をインストールします。

入力のコツ

入力時、ペン認識ボックスが表示されるまで待つ

お使いのタブレットの性能にもよりますが、ペンを画面に近づけてから ペン認識ボックスが表示されるまで、多少のタイムラグがあります。 ペン認識ボックスが表示される前に、画面に接触してしまうと、 ペン入力ではなく指の入力と認識され、思った操作になりません。 ペン認識ボックスが表示されるまで待つことで、正常なペン入力ができます。

入力中、ペンを浮かせすぎない

ペンを画面から大きく離した時点で、文字認識が行われます。 ペンを画面から浮かせすぎないよう入力することで、 中途半端なフレーズで文字認識されるのを防ぐことができます。

単語、文節でペンを離す

実際のテキスト入力の日本語変換と同じく、適切なフレーズ単位で文字認識を行うことで 正確な文字認識が行われます。

カスタマイズ

カスタマイズ

雲筆拡張機能を用いず、Webサイトに直接JavaScriptをロードすることで 雲筆クライアントとの通信部分、ペン入力の制御などをカスタマイズできます。 カスタマイズ可能な範囲は拡張機能部分のみであり、 雲筆クライアントのカスタマイズは受け付けておりません。

イベントについて

テキスト要素に対して、雲筆によるテキスト入力、またはテキスト消去が行われると、blurイベントが発生します。
JavaScriptによって、テキスト要素の変化に応じた処理を行う場合、 blurイベントをハンドリングしてください。

オフラインで使用する場合

hostsファイルの編集

インターネット環境が無い場合など、雲筆をオフラインで使用する場合、 hostsファイルの設定が必要になります。 雲筆クライアントの設定画面から、「Hostsファイルの編集」ボタンを押すと、設定が行われます。 設定の際には、管理者権限が必要になります。

ライセンス確認

雲筆をオフラインで使用する場合でも、月に1回、ライセンス確認が必要になります。 ライセンス確認の期日が3日以内に近づくと、お知らせが表示されます。 インターネットに接続し、ライセンス確認作業を行ってください。