5.1.3 RemotePropertiesクラス

帳票のリモート出力時に使用する属性情報を保持します。

なお、RemoteProperties クラスを使用して帳票を出力する場合、帳票の出力に関する各属性を
PrintPropertiesクラスのsetPropertyメソッドで指定することを推奨します。

setProperty メソッドについては、オンラインマニュアル“ アプリケーション作成ガイド”のsetProperty

メソッドの記載を参照してください。

java.lang.Object
 ∟ com.fujitsu.systemwalker.outputassist.connector.RemoteProperties

public class RemoteProperties
extends java.lang.Object
implements java-io Serializable

RemotePropertiesクラスのsetCompressResourceメソッドで指定するフィールドを以下に示します。

表5.33 RemotePropertiesクラスのsetCompressResourceメソッドで指定するフィールド
定数	説明
RESOURCE_UNCOMPRESS	圧縮しないで転送します。
RESOURCE_COMPRESS	圧縮して転送します。

RemotePropertiesクラスのsetSendResourceメソッドで指定するフィールドを以下に示します。

表5.34 RemotePropertiesクラスのsetSendResourceメソッドで指定するフィールド
定数	説明
RESOURCE_SEND	帳票を転送します。
RESOURCE_NOSEND	配置済みの帳票を使用します。

RemotePropertiesクラスのsetUpdateResourceメソッドで指定するフィールドを以下に示します。

表5.35 RemotePropertiesクラスのsetUpdateResourceメソッドで指定するフィールド
定数	説明
RESOURCE_ALWAYS	すべて上書きします。読み取り専用の帳票も上書きします。
RESOURCE_OVERRIDE	アプリケーションサーバの帳票が更新されている場合（アプリケーションサーバの帳票のファイル日時が帳票出力サーバのファイル日時より新しい場合）にのみ転送し、上書きします。読み取り専用の帳票も上書きします。

RemotePropertiesクラスのコンストラクタを以下に示します。

表5.36 RemotePropertiesクラスのコンストラクタ
コンストラクタの概要
RemoteProperties() RemotePropertiesオブジェクトを生成します。

RemotePropertiesクラスのメソッドを以下に示します。

表5.37 RemotePropertiesクラスのメソッド
メソッドの分類	メソッドの概要 W：アプリケーションサーバがWindowsの場合に使用できるメソッドです。 S：アプリケーションサーバがSolarisの場合に使用できるメソッドです。 L：アプリケーションサーバがLinuxの場合に使用できるメソッドです。共：どの環境でも使用できるメソッドです。
動作情報に関するメソッド	共	void	setHost (java.lang.String host) 通信対象の帳票出力サーバのコンピュータ名を、TCP/IPのホスト名またはIP アドレスで指定します。このメソッドは、必ず指定してください。
	共	void	setCompressResource (int mode) アプリケーションサーバの帳票やデータファイル、メディアデータファイルなどの転送データを圧縮して転送する場合に指定します。
	共	void	setSendResource (int mode) アプリケーションサーバの帳票を帳票出力サーバに転送せず、帳票出力サーバに配置済みの帳票を使用して帳票を出力する場合に指定します。
	共	void	setUpdateResource (int mode) 帳票出力サーバの転送先ディレクトリ（環境設定画面の［全般］タブで指定されている作業用ディレクトリ）にすでに同名の帳票が存在した場合に、どのような処理を行うかを指定します。
ユーザ資源情報に関するメソッド	共	void	setLcVisualFile(java.lang.String file) (*1) アプリケーションサーバのメディアデータファイルを帳票出力サーバに転送する場合に、アプリケーションサーバのメディアデータファイル名を指定します。
ユーザ資源情報に関するメソッド	共	void	setRemoteDirectory (java.lang.String dir) (*1) 帳票出力サーバの帳票格納ディレクトリを指定します。
電子保存情報に関するメソッド	共	void	setLwFaxFile (java.lang.String file) (*2) 電子保存した帳票をFAX 送信する場合に使用するFAX 受信者情報ファイルを、アプリケーションサーバから帳票出力サーバに転送する場合に、アプリケーションサーバのFAX 受信者情報ファイル名を指定します。
FAX送信情報に関するメソッド	共	void	setFaxFile (java.lang.String file) (*2) FAX 送信する場合に使用する FAX 受信者情報ファイルを、アプリケーションサーバから帳票出力サーバに転送する場合、アプリケーションサーバの FAX 受信者情報ファイル名を指定します。
その他のメソッド	共	void	setOption (java.lang.String option) リモート帳票出力のオプションを指定します（リモート帳票出力コマンドのコマンドオプションを指定します）。

*1：
帳票出力サーバがUNIX系OSの場合、ファイルパスに、全角文字および半角カナ文字は指定できません。

*2：
帳票出力サーバがWindowsの場合のみ指定できます。

public

RemoteProperties()

用途: RemotePropertiesオブジェクトを生成します。

●動作情報に関するメソッド

public void

setHost (java.lang.String host)

throws ConnectorException

用途

このメソッドによる指定よりも、PrintPropertiesクラスのsetPropertyメソッドで、このメソッドに対応するキーと値による指定を推奨します。

通信対象の帳票出力サーバのコンピュータ名を、TCP/IPのホスト名またはIP アドレスで指定します。

リモート帳票出力する場合、このメソッドは、必ず指定してください。

パラメータ

host：: 通信対象コンピュータ名を指定します。

例外: ConnectorException

注意

帳票出力サーバがWindowsの場合、コンピュータ名とTCP/IPのホスト名は同一となるようネットワークの設定を行ってください。コンピュータ名とTCP/IPのホスト名が異なる場合は、IPアドレスで指定してください。

public void

setCompressResource (int mode)

throws ConnectorException

用途

このメソッドによる指定よりも、PrintPropertiesクラスのsetPropertyメソッドで、このメソッドに対応するキーと値による指定を推奨します。

アプリケーションサーバの帳票やデータファイル、メディアデータファイルなどの転送データを圧縮して転送する場合に指定します。

このメソッドの呼び出しを省略すると、転送データを圧縮せずに転送します。

パラメータ

mode：

転送データを圧縮して転送するかを指定します。

RESOURCE_UNCOMPRESS：: 圧縮しないで転送します（初期値）。

RESOURCE_COMPRESS：: 圧縮して転送します。

例外: ConnectorException

public void

setSendResource (int mode)

throws ConnectorException

用途

このメソッドによる指定よりも、PrintPropertiesクラスのsetPropertyメソッドで、このメソッドに対応するキーと値による指定を推奨します。

アプリケーションサーバの帳票を帳票出力サーバに転送するかどうかを指定します。

このメソッドの呼び出しを省略すると、アプリケーションサーバの帳票を帳票出力サーバの作業用ディレクトリに転送します。

マルチフォーム出力する場合（FormsクラスのChangeFormメソッドを指定した場合、またはFormsFileクラス、FormsStreamクラスのsetGrpOutメソッドに「GRPOUT_GRP」を指定した場合）は、このメソッド、またはFormsFileクラス、FormsStreamクラスのsetLcFormメソッドを必ず指定してください。ただし、両方のメソッドを同時に指定すると、エラーになります。

パラメータ

mode：

アプリケーションサーバの帳票を帳票出力サーバに転送するかを指定します。

RESOURCE_SEND：: 帳票を転送します（初期値）。

RESOURCE_NOSEND：: 配置済みの帳票を使用します。

例外: ConnectorException

注意

帳票出力サーバがSolarisまたはLinuxで、プリンタにFM出力またはFNP出力する場合は、必ず帳票出力サーバに帳票を配置し、このメソッドを指定してください。帳票をアプリケーションサーバに配置し、転送した場合（このメソッドを指定しない場合）、オーバレイが印刷されない、または違うオーバレイが印刷されることがあります。

備考

作業用ディレクトリは、帳票出力サーバ側のオペレーティングシステムによって、帳票出力サーバ上で以下の方法で指定します。

    ・帳票出力サーバがWindowsの場合  ：環境設定画面の［全般］タブ
    ・帳票出力サーバがUNIX系OSの場合 ：prsetremenvコマンド
                                       詳細については、オンラインマニュアル“環境設定・帳票運用編” 
                                       のprsetremenvコマンドについての記載を参照してください。

public void

setUpdateResource (int mode)

throws ConnectorException

用途

このメソッドによる指定よりも、PrintPropertiesクラスのsetPropertyメソッドで、このメソッドに対応するキーと値による指定を推奨します。

アプリケーションサーバの帳票を帳票出力サーバに転送する場合（setSendResourceメソッドに「RESOURCE_SEND 」を指定する場合）にのみ有効です。

帳票出力サーバの転送先ディレクトリ（作業用ディレクトリ）にすでに同名の帳票が存在した場合に、どのような処理を行うかを指定します。

このメソッドの呼び出しを省略すると、「RESOURCE_OVERRIDE 」が指定されたものとして動作します。

パラメータ

mode：

帳票出力サーバの転送先ディレクトリ（環境設定画面の［全般］タブで指定されている作業用ディレクトリ）にすでに同名の帳票が存在した場合に、どのような処理を行うかを指定します。

RESOURCE_ALWAYS：: すべて上書きします。読み取り専用の帳票も上書きします。

RESOURCE_OVERRIDE：

アプリケーションサーバの帳票が更新されている場合（アプリケーションサーバの帳票のファイル日時が帳票出力サーバのファイル日時より新しい場合）にのみ転送し、上書きします。

読み取り専用の帳票も上書きします（初期値）。

例外: ConnectorException

備考

コネクタ連携時は、このメソッドの指定は無効となります。

作業用ディレクトリは、帳票出力サーバ側のオペレーティングシステムによって、帳票出力サーバ上で以下の方法で指定します。

    ・帳票出力サーバがWindowsの場合  ：環境設定画面の［全般］タブ
    ・帳票出力サーバがUNIX系OSの場合 ：prsetremenvコマンド
                                       詳細については、オンラインマニュアル“環境設定・帳票運用編” 
                                       のprsetremenvコマンドについての記載を参照してください。

●ユーザ資源情報に関するメソッド

public void

setLcVisualFile(java.lang.String file)

throws ConnectorException

用途

このメソッドによる指定よりも、PrintPropertiesクラスのsetPropertyメソッドで、このメソッドに対応するキーと値による指定を推奨します。

アプリケーションサーバのメディアデータファイルを帳票出力サーバに転送する場合に、アプリケーションサーバのメディアデータファイル名をフルパスで指定します。複数のファイルを指定する場合は、「セミコロン（;）」で区切って指定します。

帳票出力サーバに転送されたメディアデータファイルは、帳票出力後に削除されます。

このメソッドの呼び出しを省略すると、メディアデータファイルを配信しません。

なお、帳票出力サーバでの帳票の出力時、メディアデータ格納ディレクトリは、以下の優先順序で有効になります。

無効（このメソッドにより転送したメディアデータファイルのみ有効）
PrintPropertiesクラスのsetVisualDirメソッドで指定したメディアデータ格納ディレクトリ
setRemoteDirectoryで指定した帳票出力時の帳票格納ディレクトリ
帳票出力サーバで指定されている作業用ディレクトリ

パラメータ

file：: メディアデータファイル名をフルパスで指定します。

例外: ConnectorException

注意

このメソッドで指定したメディアデータファイルは、アプリケーションサーバ上に配置してください。
メディアデータファイルを転送する場合、組込みメディア項目に対する入力データ中のメディアデータファイル名は、ファイル名のみを指定してください。
このメソッドは、帳票出力サーバがWindowsの場合は、ListCREATOR V10.0L10以降およびList Creator V6.0L10以降、またはOutputASSIST V5.0L30以降の場合に使用できます。それ以前の場合は、エラーになります。
帳票出力サーバがSolarisの場合は、ListCREATOR 10.0以降およびList Creator 6.0以降、またはOutputASSIST 5.1以降の場合に使用できます。それ以前の場合は、エラーになります。

備考

作業用ディレクトリは、帳票出力サーバ側のオペレーティングシステムによって、帳票出力サーバ上で以下の方法で指定します。

    ・帳票出力サーバがWindowsの場合  ：環境設定画面の［全般］タブ
    ・帳票出力サーバがUNIX系OSの場合 ：prsetremenvコマンド
                                       詳細については、オンラインマニュアル“環境設定・帳票運用編” 
                                       のprsetremenvコマンドについての記載を参照してください。

public void

setRemoteDirectory (java.lang.String dir)

throws ConnectorException

用途

このメソッドによる指定よりも、PrintPropertiesクラスのsetPropertyメソッドで、このメソッドに対応するキーと値による指定を推奨します。

アプリケーションサーバの帳票を帳票出力サーバに転送せず、帳票出力サーバ上に配置済みの帳票を使用して帳票を出力する場合（setSendResourceメソッドに「RESOURCE_NOSEND 」を指定する場合）にのみ有効です。

帳票出力サーバの帳票格納ディレクトリをフルパスで指定します。

帳票を転送しない場合（setSendResourceメソッドに「RESOURCE_NOSEND 」を指定する場合）に、このメソッドの呼び出しを省略すると、帳票出力サーバの帳票格納ディレクトリが有効になります（List Creatorデザイナをインストールしている場合は、帳票格納ディレクトリを帳票定義一覧画面のオプション画面からも切り替えることができます）。

パラメータ

dir：: 帳票出力サーバの帳票格納ディレクトリをフルパスで指定します。

例外: ConnectorException

注意

帳票格納ディレクトリのパスの区切りは、帳票出力サーバ側の指定方法に合わせて以下のように指定してください。
```
    ・帳票出力サーバがWindowsの場合  ：\
    ・帳票出力サーバがUNIX系OSの場合 ：/
```
帳票出力サーバがWindowsのとき、パスの区切り「円マーク（\）」を2 つ指定してください。
例：prop.setRemoteDirectory("C:\\ListCREATOR\\Assets");
帳票出力サーバがWindowsの場合、帳票格納ディレクトリ名の末尾には、「円マーク（\）」を指定しないでください。また、ネットワークパスは指定しないでください。
帳票出力サーバがUNIX系OSの場合、帳票格納ディレクトリ名の末尾には、「スラッシュ（/）」を指定しないでください。

備考

帳票格納ディレクトリは、帳票出力サーバ側のオペレーティングシステムによって、帳票出力サーバ上で以下の方法で指定します。

    ・帳票出力サーバがWindowsの場合  ：環境設定画面の［全般］タブ
    ・帳票出力サーバがUNIX系OSの場合 ：prsetassetsdirコマンド
                                       詳細については、オンラインマニュアル“環境設定・帳票運用編” 
                                       のprsetremenvコマンドについての記載を参照してください。

●電子保存情報に関するメソッド

public void

setLwFaxFile (java.lang.String file)

throws ConnectorException

用途

このメソッドによる指定よりも、PrintPropertiesクラスのsetPropertyメソッドで、このメソッドに対応するキーと値による指定を推奨します。

このメソッドは、帳票出力サーバがWindowsの場合にのみ有効になります。

電子保存した帳票をFAX送信する場合に使用するFAX受信者情報ファイルを、アプリケーションサーバから帳票出力サーバに転送する場合に、アプリケーションサーバのFAX受信者情報ファイル名をフルパスで指定します。FAX受信者情報ファイルには、FAX受信者情報を100件以内で記述してください。100件を超えて記述するとエラーになります。

FAX受信者情報は、1行に1件を以下の形式で記述します。[ ]は、省略できることを示します。複数件指定する場合は、次の行に記述します。改行のみの行は記述しないでください。

FAX番号[,名前[,所属[,住所[,電話番号]]]]

以下にFAX受信者情報ファイルの記述例を示します。

99-9999-9999,日本  太郎,営業1課
99-9999-9999,日本  花子,営業2課

帳票出力サーバに転送されたFAX受信者情報ファイルは、帳票出力後に削除されます。

メソッドの呼び出しを省略すると、FAX受信者情報ファイルを転送しません。その場合、FAX受信者情報は、以下の優先順序で有効になります。

PrintPropertiesクラスのsetListFaxRcvFileメソッドで指定したFAX受信者情報（ファイル）
PrintPropertiesクラスのsetListFaxRcvメソッドで指定したFAX受信者情報
帳票業務情報のプロパティ画面の［電子保存］タブの電子保存のFAX属性設定画面で指定した受信者情報
設定されない

パラメータ

file：: 電子保存した帳票をFAX送信する場合に使用するFAX受信者情報ファイルを、アプリケーションサーバから帳票出力サーバに転送する場合に、アプリケーションサーバのFAX受信者情報ファイル名をフルパスで指定します。

例外: ConnectorException

注意

このメソッドは、帳票出力サーバがWindowsの場合のみ有効になります。
アプリケーションサーバがWindowsの場合、FAX受信者情報ファイル中のデータは、必ずShift-JISの文字コード系で記述してください。
アプリケーションサーバがUNIX系OSの場合、FAX受信者情報ファイル中のデータは、以下のいずれかで指定した文字コード系で必ず記述してください。
- FormBaseインタフェースのsetFileTypeメソッド
- 環境変数LANGおよび環境変数OA_EUCTYPE
なお、文字コード系の指定は、以下の優先順序で有効になります。
1. FormBaseインタフェースのsetFileTypeメソッド
2. 環境変数LANGおよび環境変数OA_EUCTYPE
アプリケーションサーバがUNIX系OSで、FAX受信者情報ファイルをEUCコード系で記述した場合、アプリケーションサーバ（UNIX系OS）側でShift-JISに変換されるため、Shift-JISの文字コードの範囲で指定してください。Shift-JISに存在しない文字を指定すると、縮退が発生します。その場合、代替文字「_」または「＿」で出力されます。
このメソッドを指定する場合は、FAX番号を必ず指定してください。
このメソッドは、帳票出力サーバがWindowsで、ListCREATOR V10.0L10以降および
List Creator V6.0L10以降、またはOutputASSIST V5.0L30以降の場合に使用できます。それ以前の場合は、エラーになります。

備考

電子保存後にFAX送信する場合は、FAX送信時にFAX受信者情報を変更することもできます。

●FAX送信情報に関するメソッド

public void

setFaxFile (java.lang.String file)

throws ConnectorException

用途

このメソッドによる指定よりも、PrintPropertiesクラスのsetPropertyメソッドで、このメソッドに対応するキーと値による指定を推奨します。

FAX送信する場合に使用するFAX受信者情報ファイルを、アプリケーションサーバから帳票出力サーバに転送する場合に、アプリケーションサーバのFAX受信者情報ファイル名をフルパスで指定します。FAX受信者情報ファイルには、FAX受信者情報を100件以内で記述してください。100件を超えて記述すると、エラーになります。

FAX受信者情報は、1行に1件を以下の形式で記述します。[ ]は、省略できることを示します。複数件指定する場合は、次の行に記述します。改行のみの行は記述しないでください。

FAX番号[,名前[,所属[,住所[,電話番号]]]]

以下にFAX受信者情報ファイルの記述例を示します。

99-9999-9999,日本  太郎,営業1課
99-9999-9999,日本  花子,営業2課

帳票出力サーバに転送されたFAX受信者情報ファイルは、帳票出力後に削除されます。

このメソッドの呼び出しを省略すると、FAX受信者情報ファイルを転送しません。その場合、FAX受信者情報は、以下の優先順序で有効になります。

setFaxRcvFileメソッドで指定したFAX受信者情報（ファイル）
setFaxRcvメソッドで指定したFAX受信者情報
帳票業務情報のプロパティ画面の［FAX］タブで指定した受信者情報

FAX送信する場合は、FAX受信者情報をいずれかで必ず指定してください。

パラメータ

file：: FAX送信する場合に使用するFAX受信者情報ファイルを、アプリケーションサーバから帳票出力サーバに転送する場合に、アプリケーションサーバのFAX受信者情報ファイル名をフルパスで指定します。

例外: ConnectorException

注意

このメソッドは、帳票出力サーバがWindowsの場合のみ有効になります。
アプリケーションサーバがWindowsの場合、FAX受信者情報ファイル中のデータは、必ずShift-JISの文字コード系で記述してください。
アプリケーションサーバがUNIX系OSの場合、FAX受信者情報ファイル中のデータは、以下のいずれかで指定した文字コード系で必ず記述してください。
- FormBaseインタフェースのsetFileTypeメソッド
- 環境変数LANGおよび環境変数OA_EUCTYPE
なお、文字コード系の指定は、以下の優先順序で有効になります。
1. FormBaseインタフェースのsetFileTypeメソッド
2. 環境変数LANGおよび環境変数OA_EUCTYPE
アプリケーションサーバがUNIX系OSで、FAX受信者情報ファイルをEUCコード系で記述した場合、アプリケーションサーバ（UNIX系OS）側でShift-JISに変換されるため、Shift-JISの文字コードの範囲で指定してください。Shift-JISに存在しない文字を指定すると、縮退が発生します。その場合、代替文字「_」または「＿」で出力されます。
このメソッドを指定する場合は、FAX番号を必ず指定してください。
このメソッドは、帳票出力サーバがWindowsで、ListCREATOR V10.0L10以降またはOutputASSIST V5.0L30以降の場合に使用できます。それ以前の場合は、エラーになります。

●その他のメソッド

public void

setOption (java.lang.String option)

throws ConnectorException

用途

このメソッドによる指定よりも、PrintPropertiesクラスのsetPropertyメソッドで、このメソッドに対応するキーと値による指定を推奨します。

Javaインタフェースのキーやメソッドでサポートされていないprputprtコマンドのオプションを指定します。

prputprtコマンドのオプションは、以下の優先順序で有効になります。

他のメソッドで指定した値
このメソッドで指定した値

パラメータ

option：: Javaインタフェースのキーやメソッドでサポートされていないprputprtコマンドのオプションを指定します。prputprtコマンドについては、オンラインマニュアル“アプリケーション作成ガイド”を参照してください。

例外: ConnectorException

注意

このメソッドに-zオプションまたは-zオプション以降のコマンドオプションを指定しないでください。帳票出力オプションを指定する場合は、PrintPropertiesクラスを使用してください。

5.1.3 RemotePropertiesクラス

5.1.3.1 フィールドの概要

5.1.3.2 コンストラクタの概要

5.1.3.3 メソッドの概要

5.1.3.4 コンストラクタの詳細

5.1.3.5 メソッドの詳細