15.1 配信操作画面のAPIの概要

配信操作画面のAPIを使用することにより、Web配信操作クライアントの画面をカスタマイズできます。

注意

製品に含まれているJSPファイル、JavaScriptファイル、CSSファイルをカスタマイズした場合は、製品として品質を保証することはできません。上記ファイルをカスタマイズした場合は、お客様の環境で十分テストして問題のないことを確認する必要があります。

配信操作画面のAPIは、以下のコンポーネントから構成されます。

ListGateway(Javaサーブレットプログラム)

Web配信操作クライアントからの要求に応じて配信管理サーバと通信し、結果をWeb配信操作クライアントへ送信します。HttpリクエストとJavaクラスがあります。

Httpリクエスト
ListGatewayへの処理要求に使用します。

Javaクラス

Web配信操作クライアントに送信する結果を作成するための、必要な情報取得に使用します。
Javaクラスには、以下のクラスがあります。

  DistributeConfig    …  印刷配信機能構成クラス
  UserConfig          …  ユーザ構成クラス
  OISConfig           …  出力指示画面構成クラス
  PESConfig           …  処理状況照会画面構成クラス
  ODLConfig           …  配信出力先一覧画面構成クラス
  DFMConfig           …  配信フォルダ管理画面構成クラス
  FormAttribute       …  帳票情報クラス
  PrintJobAttribute   …  印刷ジョブ情報クラス
  DestinationAttribute…  配信出力先情報クラス
  DistributeAttribute …  配信フォルダ情報クラス
  HtmlConv            …  HTML文字列クラス

Web操作配信クライアントの各画面の表記

配信操作画面のAPIでは、Web操作配信クライアントの各画面を以下のように略記しています。

OIS: 出力指示画面(Output Instruction Screen)のことです。

PES: 処理状況照会画面(Process Enquiry Screen)のことです。

ODL: 配信出力先一覧画面(Output Destination List)のことです。

DFM: 配信フォルダ管理画面(Distribution Folder Management)のことです。

画面の構成

帳票印刷配信機能における画面を構成するファイルについて、代表的な画面を例に説明します。

ログイン画面

メニュー画面

出力指示画面

処理状況照会画面

配信出力先一覧画面

配信フォルダ管理画面

各画面のファイルは、以下に格納されています。

JSPファイル

List Worksインストール先フォルダ\Distribute\manager\gui\app\jsp

JavaScriptファイル

List Worksインストール先フォルダ\Distribute\manager\gui\app\js

CSSファイル

List Worksインストール先フォルダ\Distribute\manager\gui\app\css

注意

製品に含まれているJSPファイル、JavaScriptファイル、またはCSSファイルをカスタマイズする場合は、必ずJSPファイル、JavaScriptファイル、CSSファイルをバックアップしてください。
複数のウィンドウを開いて、List Works(Webクライアント、Web配信操作クライアント)を操作できません。
配信管理サーバに接続した後は、必ずメニュー画面を表示しておく必要があります。メニュー画面を表示せずに、出力指示画面、処理状況照会画面、配信出力先一覧画面、配信フォルダ管理画面などは、表示できません。
JSPファイルは、UTF-8で記述されています。JSPファイルを編集する場合には、UTF-8で記述してください。
配信操作画面のAPIで使用するコマンド名、メソッド名、パラメタなどの文字列は、大文字・小文字を区別して指定してください。

カスタマイズした内容を有効にする方法

設定内容を有効にするには、WARファイルを再作成し、配信操作画面のGlassFish Serverクラスター(LWDST_MGUI)にWeb アプリケーションを配備した後、GlassFish Serverクラスターを再起動します。

配信操作画面のGlassFish Serverクラスターに対するWebアプリケーション配備用に、以下のサンプルスクリプトが用意されています。サンプルスクリプトを実行することで、上記の一連の作業を行うことができます。

なお、サンプルスクリプトでは、Webサーバの再起動を行います。

コマンドプロンプトを「管理者として実行」を選択して起動し、管理者権限に昇格させたコマンドプロンプトで、サンプルスクリプトの格納場所にフォルダを移動して、サンプルスクリプトを実行します。

スクリプトの引数には、以下を指定してください。なお、[]は指定を省略できることを示します。

-u 管理ユーザーID

-w 管理者パスワード

[-p運用管理用HTTPリスナーポート番号]

省略時は「12041」になります。

管理ユーザーID、管理者パスワード、運用管理用HTTPリスナーポート番号は、Interstage Application Serverのインストール時に、以下の画面で設定した値を指定してください。

GlassFish 5機能の認証情報の設定
GlassFish 5機能のポート番号の設定

格納先: List Worksインストール先フォルダ\Distribute\manager\gui\samples配下

ファイル名: Webアプリケーションの配備：deploymentwar-javaee.bat

例

以下の場合の実行例です。

管理ユーザーID:admin
管理者パスワード:adminPWD

運用管理用HTTPリスナーポート番号:12041(省略値)

C:\ListWORKS\Distribute\manager\gui\samples> deploymentwar-javaee.bat -u admin -w adminPWD

コマンドプロンプトにWebサーバの再起動を確認する以下のメッセージが表示されます。

配信管理サーバのGlassFish Serverクラスターの作成処理を実行すると、Webサーバが再起動されます。
処理を実施してもよろしいですか(y/n)

問題がなければ「y」を入力してください。GlassFish Serverクラスター作成スクリプトの処理が続行されます。
問題があれば「n」を入力してください。GlassFish Serverクラスター作成スクリプトの処理が中断されます。
「y」または「n」以外の文字列を入力すると、再度確認メッセージが表示されます。

上記スクリプトを実行すると以下の警告メッセージが出力されますが特に問題はありません。

WARNING: Instance サーバーインスタンス名 seems to be offline; command サブコマンド名 was not replicated to that instance

警告メッセージの詳細は、Interstage Application Serverのマニュアルを参照してください。

ListGatewayメソッド一覧表

以下に、ListGatewayメソッドを示します。

コマンド/メソッド			機能
Httpリクエスト	全般	GetJspInSession	JSPファイルの取得(セションが有効な場合に限定する場合)
	ログイン画面	Login	配信管理サーバに接続
	ログイン画面	Logout	配信管理サーバから切断
	出力指示画面	BrowseForm	帳票の表示
		DeleteForm	帳票の削除
		GetFormDetails	帳票詳細情報の取得
		GetOIS	出力指示画面の表示
		OpenSearch	検索条件画面の表示準備
		PrintForm	帳票の印刷
		PrintForms	複数帳票の印刷
		SetFormDetails	帳票詳細情報の設定
	処理状況照会画面	ChangePriorityPrintJob	印刷ジョブの優先度を上げる
		DeletePrintJob	印刷ジョブの取り消し
		GetPES	処理状況照会画面の表示
		GetPrintJobDetails	印刷ジョブの詳細情報の取得
		MovePrintJob	印刷ジョブの移動
	配信出力先一覧画面	GetODL	配信出力先一覧画面の表示
	配信フォルダ管理画面	GetDFM	配信フォルダ管理画面の表示
		GetDistributeDetails	配信フォルダ詳細情報の取得
		SetDistributeDetails	配信フォルダ詳細情報の設定
va クラス	DistributeConfig (印刷配信機能構成クラス)	getDFMConfig	配信フォルダ管理画面構成クラスの取得
		getODLConfig	配信出力先一覧画面構成クラスの取得
		getOISConfig	出力指示画面構成クラスの取得
		getPESConfig	処理状況照会画面構成クラスの取得
		getUserConfig	ユーザ構成クラスの取得
	UserConfig (ユーザ構成クラス)	getGroupID	ユーザが所属するグループIDの取得
		getUserID	ユーザIDの取得
		isAdministrator	管理者権限を持つユーザかどうかの取得
		isLogin	ユーザがログインしているかどうかの取得
	OISConfig (出力指示画面構成クラス)	getCurrentDistributeAttribute	現在選択している配信フォルダの配信フォルダ情報クラスの取得
		getCurrentDistributeName	現在選択している配信フォルダの配信フォルダ名の取得
		getCurrentFormAttribute	現在選択している帳票の帳票情報クラスの取得
		getCurrentPage	現在表示しているページのページ番号の取得
		getDefaultFiltering	一覧に表示する帳票の絞り込みの有無の取得

		getDistributeNameList	配信フォルダ名のリストを取得
		getFormAttributeList	帳票情報クラスのリストを取得
		getItemDisplayList	一覧に項目を表示するかどうかのリストを取得
		getItemKeyList	一覧の項目キー名のリストを取得
		getItemNameList	一覧の項目名のリストを取得
		getItemSearchList	検索条件画面で表示できるかどうかのリストを取得
		getItemSortList	一覧の項目が並び替えできるかどうかのリストを取得
		getItemWidthList	一覧に表示する項目の幅のリストを取得
		getListTableWidth	一覧のテーブルの幅の取得
		getSortOrder	一覧の並び替え順の取得
		getSortOrderItem	一覧の並び替えの対象となる項目の取得
		getTotalPage	総ページ数の取得
		getViewFormNo	一覧に表示する帳票数の取得
		getViewNo	一覧の行数の取得
		getWindowHeight	画面の表示域の高さの取得
		getWindowWidth	画面の表示域の幅の取得
	PESConfig (処理状況照会画面構成クラス)	getCurrentDestinationAttribute	現在選択している配信出力先の配信出力先情報クラスの取得
		getCurrentDestinationName	現在選択している配信出力先の配信出力先名の取得
		getCurrentPage	現在表示しているページのページ番号の取得
		getCurrentPrintJobAttribute	現在選択している印刷ジョブの印刷ジョブ情報クラスの取得
		getDestinationNameList	配信出力先名のリストを取得
		getItemDisplayList	一覧に項目を表示するかどうかのリストを取得
		getItemFilterList	一覧の項目が絞り込みできるかどうかのリストを取得
		getItemKeyList	一覧の項目キー名のリストを取得
		getItemNameList	一覧の項目名のリストを取得
		getItemWidthList	一覧に表示する項目の幅のリストを取得
		getPrintJobAttributeList	印刷ジョブ情報クラスのリストを取得
		getSelectedUserID	選択された出力ユーザIDの取得
		getTotalPage	総ページ数の取得
		getUserIDList	出力ユーザIDのリストを取得
		getViewNo	一覧の行数の取得
		getViewPrintJobNo	一覧に表示する印刷ジョブ数の取得
		getWindowHeight	画面の表示域の高さの取得
		getWindowWidth	画面の表示域の幅の取得
	ODLConfig (配信出力先画面構成クラス)	getCurrentPage	現在表示しているページのページ番号の取得
		getDestinationAttributeList	配信出力先情報クラスのリストを取得
		getTotalPage	総ページ数の取得
		getViewDestinationNo	一覧に表示する配信出力先数の取得
	DFMConfig (配信フォルダ管理画面構成クラス)	getCurrentDistributeAttribute	現在選択している配信フォルダの配信フォルダ情報クラスの取得
		getCurrentPage	現在表示しているページのページ番号の取得
		getDistributeAttributeList	配信フォルダ情報クラスのリストを取得
		getTotalPage	総ページ数の取得
		getViewDistributeNo	一覧に表示する配信フォルダ数の取得
	FormAttribute (帳票情報クラス)	getCirculation	部数の取得
		getComment	コメントの取得
		getCreateDateTime	登録日時の取得
		getCreateUserID	作成ユーザIDの取得
		getCustomizeItem1	備考1の取得
		getCustomizeItem2	備考2の取得
getCustomizeItem3		備考3の取得
getCustomizeItem4		備考4の取得
getCustomizeItem5		備考5の取得
getCustomizeItem6		備考6の取得
getCustomizeItem7		備考7の取得
getCustomizeItem8		備考8の取得
getCustomizeItem9		備考9の取得
getCustomizeItem10		備考10の取得
getCustomizeItem11		備考11の取得
getCustomizeItem12		備考12の取得
getCustomizeItem13		備考13の取得
getCustomizeItem14		備考14の取得
getCustomizeItem15		備考15の取得
getCustomizeItem16		備考16の取得
getDefaultDestinationIndex		帳票に対応付けされている配信出力先IDのインデックスの取得
getDestinationNameList		配信出力先名のリストを取得
getDistributeName		配信フォルダ名の取得
getEndPage		終了ページの取得
getFirstPrintedDateTime		初回印刷完了日時の取得
getID		帳票IDの取得
getLastPrintedDateTime		最終印刷完了日時の取得
getMaxOutputCount		最大出力回数の取得
getName		帳票名の取得
getOutputCount		出力回数の取得
getPaperCode		用紙コードの取得
getSaveLimitDate		保存期限の取得
getScreenCustomizeItemValueList		画面カスタマイズ設定ファイルで指定できる項目の値のリストを取得
getStartPage		開始ページの取得
getStatus		帳票状態の取得
getTitle		タイトルの取得
getTotalPage		総ページ数の取得
PrintJobAttribute (印刷ジョブ情報クラス)	getDestinationName	配信出力先名の取得
	getErrorMessage	エラーメッセージの取得
	getErrorNo	エラーメッセージ種別の取得
	getID	印刷ジョブIDの取得
	getName	帳票名の取得
	getOutputDateTime	出力依頼日時の取得
	getOutputUserID	出力ユーザIDの取得
	getPaperCode	用紙コードの取得
	getPrintedPage	出力完了ページの取得
	getPriority	優先度の取得
	getScreenCustomizeItemValueList	画面カスタマイズ設定ファイルで指定できる項目の値のリストを取得
	getStatus	出力状態の取得
	getTotalPrintedPage	出力総ページ数の取得
	isOperation	印刷ジョブを操作できるかどうかの取得
DestinationAttribute (配信出力先情報クラス)	getAccessOperationPrintJob	アクセス権「出力先配下の印刷ジョブの操作」の有無の取得
	getAccessListViewPrintJob	アクセス権「出力先配下の印刷ジョブの一覧の表示」の有無の取得
	getComment	コメントの取得
	getCustomizeItem1	備考1の取得
	getCustomizeItem2	備考2の取得
	getCustomizeItem3	備考3の取得
	getCustomizeItem4	備考4の取得
	getCustomizeItem5	備考5の取得
	getCustomizeItem6	備考6の取得
	getCustomizeItem7	備考7の取得
	getCustomizeItem8	備考8の取得
	getDeviceName	プリンタ名の取得
	getHostName	サーバ名の取得
	getID	配信出力先IDの取得
	getMakerName	機器メーカー名の取得
	getName	配信出力先名の取得
	getOutputJobsCount	印刷ジョブ数の取得
	getSendMessageHostName	メッセージ通知先の取得
	getSeparatorMode	セパレータの印刷方法の取得
	getSeparatorPaperFeedName	セパレータ印刷時の給紙口名の取得
	getStatus	状態の取得
	getTypeName	機器型名の取得
	isSeparatorStatus	セパレータ印刷指定の取得
DistributeAttribute (配信フォルダ情報クラス)	getAccessDeleteForm	アクセス権「フォルダ配下の帳票の削除」の有無の取得
	getAccessPrintForm	アクセス権「フォルダ配下の帳票の印刷」の有無の取得
	getAccessUpdate	アクセス権「フォルダの詳細情報の更新」の有無の取得
	getAccessUpdateForm	アクセス権「フォルダ配下の帳票情報の更新」の有無の取得
	getComment	コメントの取得
	getCustomizeItem1	備考1の取得
	getCustomizeItem2	備考2の取得
	getCustomizeItem3	備考3の取得
	getCustomizeItem4	備考4の取得
	getCustomizeItem5	備考5の取得
	getDefaultDestinationName	配信フォルダに設定されている配信出力先名の取得
	getDestinationIDList	配信出力先IDのリストを取得
	getDestinationNameList	配信出力先名のリストを取得
	getFormStateCount	帳票数の取得
	getID	配信フォルダIDの取得
	getKeepDays	保存日数の取得
	getName	配信フォルダ名の取得
	getOutputMode	出力動作モードの取得
	getPriority	印刷指示時の印刷ジョブの優先度の取得
HtmlConv (HTML文字列クラス)	sanitize	Unicode文字列内の特定文字をサニタイズ