Httpリクエストには、以下のコマンドがあります。
コマンド名 | 機能 |
|---|---|
getjsp | JSPファイルの取得(セションに関係なし) |
getjspinsession | JSPファイルの取得(セションが有効な場合に限定する場合) |
getkeepfolder | 保管フォルダ一覧の表示 |
getkeeplist | 帳票一覧の表示 |
listbrowser | 帳票の表示＜ActiveXコントロール版固有＞ |
listbrowserspnh | 帳票の表示＜Webプラグイン版固有＞ |
listprint | 帳票の印刷＜ActiveXコントロール版固有＞ |
listprintspoh | 帳票の印刷＜Webプラグイン版固有＞ |
login | リスト管理サーバに接続 |
logout | リスト管理サーバから切断 |
openframe | 保管フォルダ/帳票一覧の表示準備 |
List Works Web連携は、クライアントサイドからListGatewayに対してリクエストコマンドを送信することで動作しています。
リクエスト方式には、GET/POSTオペレーションの2つがあり用途に応じて使い分けます。
http://サーバ名/listworks/servlet/ListGateway?command=コマンド名&パラメタ名=パラメタ値 (注)
注：プロトコルが「https」の場合は、「http」を「https」に置き換えて参照してください。
以降の説明では、コマンド名に上記の「コマンド名」のみを記述しています。リクエスト形式については、各コマンドの説明ページの使用例を参照してください。
注意
新規に作成するJSPファイルにおいて、Httpリクエストのコマンドを使用する場合は、以下の行を追加してください。
<%
response.setHeader("Pragma","no-cache");
response.setHeader("Cache-Control","no-cache");
response.setDateHeader("Expires",0);
%>追加しない場合は、ブラウザにキャッシュされたリクエストコマンドが、ListGatewayに送信され、正しく動作しません。
ただし、ActiveXコントロールを使用しているJSPファイルには、追加しないでください。
以下のフォルダに格納されているJSPファイルを編集することにより、【ログイン】ボタン、または【ログアウト】ボタンをクリックしたあと、任意のURLに接続することができます。
/opt/FJSVlw-gw/app/jsp
保管フォルダの帳票一覧の表示/帳票の表示・印刷する機能の【ログイン】ボタン、および【ログアウト】ボタンのリンク先を編集する手順は以下のとおりです。
| 【ログイン】ボタン、【ログアウト】ボタンの説明は、“操作手引書 利用者編”を参照してください。 |
logout.jspファイルに接続したいURLを設定します。以下の例では、「/listworks/」に移動します。
<@ page session="false" %>
<@ page contentType="text/html; charset=Windows-31J" %>
<%
response.setHeader("Pragma","no-cache");
response.setHeader("Cache-Control","no-cache");
response.setDateHeader("Expires",0);
%>
<HTML>
<%
String strWinID = request.getParameter("winid");
String strCommand;
if(strWinID == null || strWinID.equals("") == true)
strCommand = "/listworks/";
↑
移動先のURL
else
strCommand = "/listworks/jsp/login.jsp?winid=" + strWinID;
%>
<HEAD>
<META http-equiv="Content-type" content="text/html; charset=Shift_JIS">
<TITLE>List Works ログアウト</TITLE>
</HEAD>
<SCRIPT language="JavaScript">
<! --
window.location.href = "<%=strCommand%>;
// -- >
</SCRIPT>
</HTML>コマンド名
getjsp
機能
セションに関係なくJSPファイルを取得します。
パラメタの説明
本コマンド完了後に実行させるJSPファイル名を指定します。
必ず指定します。
使用例
WWWサーバ「WebServer」経由で、「list.jsp」ファイルを取得します。
http://WebServer/listworks/servlet/ListGateway?command=getjsp&jsp=list.jsp
コマンド名
getjspinsession
機能
セションが有効な場合に限定して、JSPファイルを取得します。
パラメタの説明
本コマンド完了後に実行させるJSPファイル名を指定します。
必ず指定します。
使用例
WWWサーバ「WebServer」経由で、「list.jsp」ファイルを取得します。
http://WebServer/listworks/servlet/ListGateway?command=getjspinsession&jsp=list.jsp
注意
あらかじめリスト管理サーバに接続しておく必要があります。接続していない場合は、JSPファイルを取得できません。
コマンド名
getkeepfolder
機能
保管フォルダの一覧を表示します。
パラメタの説明
保管フォルダの一覧を取得する範囲を0から4までの数値で指定します。
0：すべての保管フォルダ 1：ルート(最上位)階層の保管フォルダ 2：表示中の階層の1階層上の保管フォルダ 3：指定した保管フォルダの直下の保管フォルダ 4：表示中の階層の保管フォルダ
省略可能です。省略すると「0」が指定されたものとみなします。
保管フォルダの識別子を指定します。指定した保管フォルダの直下に存在する保管フォルダを取得します。
rangeパラメタに「3」を指定した場合のみ有効で、その場合は本パラメタかkeeptreenoパラメタのどちらかを必ず指定します。
保管フォルダの番号を指定します。指定した保管フォルダの直下に存在する保管フォルダを取得します。
rangeパラメタに「3」を指定して、nodeidパラメタが指定されていない場合のみ有効で、その場合は必ず指定します。
本コマンド完了後に実行させるJSPファイル名を指定します。
省略可能です。省略すると何も表示されません。
リスト管理サーバから保管フォルダ一覧を再取得するかどうかを指定します。ただし、保管フォルダの一覧を取得する範囲(rangeパラメタ)に「0」を指定した場合のみ有効となります。
yes：取得する no：取得しない
省略可能です。省略すると「yes」が指定されたものとみなします。
使用例
WWWサーバ「WebServer」経由で、すべての保管フォルダの一覧を表示するために「folderlist.jsp」ファイルを要求します。
http://WebServer/listworks/servlet/ListGateway?command=getkeepfolder&jsp=folderlist.jsp
注意
あらかじめリスト管理サーバに接続しておく必要があります。接続していない場合は、保管フォルダの一覧を表示できません。
本コマンドを実行する前に、保管フォルダ一覧の表示準備(openframeコマンド)を行う必要があります。
コマンド名
getkeeplist
機能
帳票一覧を表示します。
パラメタの説明
保管フォルダの選択方法を指定します。
no：keeptreenoパラメタ(保管フォルダの番号)で指定 current：getkeepfolderのrangeパラメタに「2」、「3」または「4」を指定したときのフォルダを指定
省略可能です。省略すると「no」が指定されたものとみなします。
保管フォルダの番号を指定します。
folderパラメタで「no」を指定した場合のみ有効で、その場合は必ず指定します。
帳票一覧に表示する先頭の帳票番号を指定します。
必ず指定します。
本コマンド完了後に実行させるJSPファイル名を指定します。
省略可能です。省略すると何も表示されません。
使用例
WWWサーバ「WebServer」経由で、保管フォルダの番号[1]の帳票一覧で帳票番号[1]を先頭にして表示させるために「sheetlist.jsp」ファイルを要求します。
http://WebServer/listworks/servlet/ListGateway?command=getkeeplist&keeptreeno=1&keepliststartno=1&jsp=sheetlist.jsp
注意
あらかじめリスト管理サーバに接続し、保管フォルダの一覧を表示しておく必要があります。 リスト管理サーバに接続し、保管フォルダの一覧を表示していない場合は、帳票一覧を表示できません。
本コマンドを実行する前に、帳票一覧の表示準備(openframeコマンド)を行う必要があります。
帳票一覧を絞り込んで表示するためには、あらかじめsession.setAttribute("[条件]","[値]")メソッドを使用して、セションに表示条件を設定しておく必要があります。
| 表示条件の設定については、“E.1 帳票一覧の表示条件の設定”を参照してください。 |
コマンド名
listbrowser
機能
帳票を表示します。
パラメタの説明
表示中の帳票一覧に含まれる帳票の識別子を指定します。
本パラメタかkeepsheetnoパラメタのどちらかを必ず指定します。
表示中の帳票一覧における帳票番号を指定します。
sheetnodeidパラメタを指定していない場合のみ有効で、その場合は必ず指定します。
本コマンド完了後に実行させるJSPファイル名を指定します。
省略可能です。省略すると何も表示されません。
使用例
WWWサーバ「WebServer」経由で、表示中の帳票一覧における帳票番号「1」の帳票を表示するために「browse.jsp」ファイルを要求します。
http://WebServer/listworks/servlet/ListGateway?command=listbrowser&keepsheetno=1&jsp=browse.jsp
注意
あらかじめリスト管理サーバに接続し、保管フォルダの一覧の表示、帳票一覧の表示をしておく必要があります。
リスト管理サーバに接続し、保管フォルダの一覧の表示、帳票一覧の表示をしていない場合は、帳票を表示できません。
コマンド名
listbrowserspnh
機能
帳票を表示します。
パラメタの説明
表示中の帳票一覧に含まれる帳票の識別子を指定します。
必ず指定します。
使用例
WWWサーバ「WebServer」経由で、保管フォルダ内の0番の帳票を表示します。
<iframe src="/listworks/jsp/nodata.htm" name="hiddenFrame" style="display: none"></iframe>
KeepSheetAttribute keepSheetAttribute = listConfig.getKeepSheetAttribute(0); strSheetNodeId = keepSheetAttribute.getNodeId(); http://WebServer/listworks/servlet/ListGateway?command=listbrowserspnh&sheetnodeid=<%=strSheetNodeId%> target="hiddenFrame"
注意
あらかじめリスト管理サーバに接続し、保管フォルダの一覧の表示、帳票一覧の表示をしておく必要があります。
リスト管理サーバに接続し、保管フォルダの一覧の表示、帳票一覧の表示をしていない場合は、帳票を印刷できません。
APIの表示対象としたフレームには何も表示されず、新規に起動されたウィンドウで帳票が表示されます。
APIの表示ターゲットには非表示フレームを指定するなどの対処をしてください。
コマンド名
listprint
機能
帳票を印刷します。
パラメタの説明
表示中の帳票一覧に含まれる帳票の識別子を指定します。
本パラメタかkeepsheetnoパラメタのどちらかを必ず指定します。
表示中の帳票一覧における帳票番号を指定します。
sheetnodeidパラメタを指定していない場合のみ有効で、その場合は必ず指定します。
本コマンド完了後に実行させるJSPファイル名を指定します。
省略可能です。省略すると何も表示されません。
使用例
WWWサーバ「WebServer」経由で、表示中の帳票一覧における帳票番号「1」の帳票を印刷するために「print.jsp」ファイルを要求します。
http://WebServer/listworks/servlet/ListGateway?command=listprint&keepsheetno=1&jsp= print.jsp
注意
あらかじめリスト管理サーバに接続し、保管フォルダの一覧の表示、帳票一覧の表示をしておく必要があります。
リスト管理サーバに接続し、保管フォルダの一覧の表示、帳票一覧の表示をしていない場合は、帳票を印刷できません。
コマンド名
listprintspoh
機能
帳票を印刷します。
パラメタの説明
表示中の帳票一覧に含まれる帳票の識別子を指定します。
必ず指定します。
使用例
WWWサーバ「WebServer」経由で、保管フォルダ内の0番の帳票を印刷します。
<iframe src="/listworks/jsp/nodata.htm" name="hiddenFrame" style="display: none"></iframe>
KeepSheetAttribute keepSheetAttribute = listConfig.getKeepSheetAttribute(0); strSheetNodeId = keepSheetAttribute.getNodeId(); http://WebServer/listworks/servlet/ListGateway?command=listprintspoh&sheetnodeid=<%=strSheetNodeId%> target="hiddenFrame"
注意
あらかじめリスト管理サーバに接続し、保管フォルダの一覧の表示、帳票一覧の表示をしておく必要があります。
リスト管理サーバに接続し、保管フォルダの一覧の表示、帳票一覧の表示をしていない場合は、帳票を印刷できません。
APIの表示対象としたフレームには何も表示されず、新規に印刷ダイアログが表示されます。
APIの表示ターゲットには非表示フレームを指定するなどの対処をしてください。
コマンド名
login
機能
リスト管理サーバに接続します。
パラメタの説明
接続するユーザIDを指定します。
必ず指定します。文字列は、半角36文字以内で指定します。
ユーザIDに対応したパスワードを指定します。
必ず指定します。パスワードは、半角255文字以内で指定します。
ホスト名を指定します。
必ず指定します。ホスト名は、半角15文字以内で指定します。
本コマンド完了後に実行させるJSPファイル名を指定します。
省略可能です。省略すると何も表示されません。
使用例
WWWサーバ「WebServer」経由で、リスト管理サーバ「Server」にユーザID「user-A」、パスワード「password」で接続して、「list.jsp」ファイルを要求します。
http://WebServer/listworks/servlet/ListGateway?command=login&userid=user-A&password=password&servername=Server&jsp=list.jsp
WWWサーバ「WebServer」経由で、リスト管理サーバ「Server」にユーザID「user-A」、パスワードなしで接続して、「list.jsp」ファイルを要求します。
http://WebServer/listworks/servlet/ListGateway?command=login&userid=user-A&password=&servername=Server&jsp=list.jsp
コマンド名
logout
機能
リスト管理サーバから切断します。
パラメタの説明
本コマンド完了後に実行させるJSPファイル名を指定します。
省略可能です。省略すると何も表示されません。
使用例
WWWサーバ「WebServer」経由で、リスト管理サーバから切断して「logout.jsp」ファイルを要求します。
http://WebServer/listworks/servlet/ListGateway?command=logout&jsp=logout.jsp
注意
あらかじめリスト管理サーバに接続しておく必要があります。接続していない場合は、本コマンドは実行されません。
コマンド名
openframe
機能
保管フォルダ/帳票一覧の表示準備を行います。
パラメタの説明
本コマンド完了後に実行させるJSPファイル名を指定します。
省略可能です。省略すると何も表示されません。
使用例
WWWサーバ「WebServer」経由で、保管フォルダの一覧を表示するために、getkeepfolder(保管フォルダの一覧の表示)コマンドを含む「list.jsp」ファイルを要求します。
http://WebServer/listworks/servlet/ListGateway?command=openframe&jsp=list.jsp
list.jspの内容
： http://WebServer/listworks/servlet/ListGateway?command=getkeepfolder&jsp=folderlist.jsp ：
注意