Hitachi

EUR 帳票出力 リファレンス EUR Server編(UNIX(R)用)


OutputXLSXReport関数

Excel形式ファイルを出力します。Excel出力ファイルは,EUR Server - Adapter稼働マシンにXLSXFILENAMEパラメタとXLSXFILEPATHパラメタの指定値に従って出力されます。

出力先に指定したExcel形式ファイルがすでにある場合は,上書きされます。

〈このページの構成〉

形式

WORKING-STORAGE SECTION.
01 EURPMPARAM.
           02  FILLER                   PIC X(4) VALUE '1010'.
           02  ERRORMESSAGE             PIC X(256) VALUE SPACE.
           02  FILLER                   PIC X(1) VALUE LOW-VALUE.
           02  XLSXFILENAME             PIC X(256) VALUE SPACE.
           02  FILLER                   PIC X(1) VALUE LOW-VALUE.
           02  XLSXFILEPATH             PIC X(256) VALUE SPACE.
           02  FILLER                   PIC X(1) VALUE LOW-VALUE.
           02  REPORTNAME               PIC X(256) VALUE SPACE.
           02  FILLER                   PIC X(1) VALUE LOW-VALUE.
           02  REPORTFILEPATH           PIC X(256) VALUE SPACE.
           02  FILLER                   PIC X(1) VALUE LOW-VALUE.
           02  MAPPINGDATA              PIC X(256) VALUE SPACE..
           02  FILLER                   PIC X(1) VALUE LOW-VALUE.
           02  MAPPINGDATAPATH          PIC X(256) VALUE SPACE.
           02  FILLER                   PIC X(1) VALUE LOW-VALUE.
           02  USERDEFDATA              PIC X(256) VALUE SPACE.
           02  FILLER                   PIC X(1) VALUE LOW-VALUE.
           02  USERDEFDATAPATH          PIC X(256 VALUE SPACE.
           02  FILLER                   PIC X(1) VALUE LOW-VALUE.
           02  DBINFOFILENAME           PIC X(256) VALUE SPACE.
           02  FILLER                   PIC X(1) VALUE LOW-VALUE.
           02  DBINFOFILEPATH           PIC X(256) VALUE SPACE.
           02  FILLER                   PIC X(1) VALUE LOW-VALUE.
           02  REPLACEITEMCNTLFILENAME  PIC X(256) VALUE SPACE.
           02  FILLER                   PIC X(1) VALUE LOW-VALUE.
           02  REPLACEITEMCNTLFILEPATH  PIC X(256) VALUE SPACE.
           02  FILLER                   PIC X(1) VALUE LOW-VALUE.
           02  PMSERVERADDR             PIC X(15) VALUE SPACE.
           02  FILLER                   PIC X(1) VALUE LOW-VALUE.
           02  FILLER                   PIC X(3) VALUE LOW-VALUE.
           02  PMSERVERPORT             PIC S9(9) COMP-5 VALUE -1.
           02  PRINTSTARTPAGE           PIC 9(9) COMP-X.
           02  PRINTENDPAGE             PIC 9(9) COMP-X.
           02  PSENVFILENAME            PIC X(256).
           02  FILLER                   PIC X(1) VALUE LOW-VALUE.
           02  PSENVFILEPATH            PIC X(256).
           02  FILLER                   PIC X(1) VALUE LOW-VALUE.
           02  FILLER                   PIC X(2) VALUE LOW-VALUE.
           02  OUTPUTPAGECOUNTOPT       PIC S9(9) COMP-5 VALUE -1.
           02  OUTPUTPAGECOUNT          PIC S9(9) COMP-5 VALUE 0.
           02  REPORTID                 PIC X(256).
           02  FILLER                   PIC X(1) VALUE LOW-VALUE.
           02  FILLER                   PIC X(3) VALUE LOW-VALUE.
01 RTNCODE                PIC S9(9) BINARY.
 
call 'OutputXLSXReport'  USING  EURPMPARAM
RETURNING  RTNCODE.

パラメタ

PRINTSTARTPAGE

出力開始ページを指定します。指定できる値は,0〜999,999です。

PRINTSTARTPAGEパラメタを省略する場合は,0を指定します。PRINTSTARTPAGEパラメタの指定を省略した場合は,1ページから出力されます。

複数の帳票ファイルを指定した場合は,PRINTSTARTPAGEパラメタの指定に関係なく,指定した複数の帳票ファイルの全ページが出力されます。

PRINTENDPAGE

出力終了ページを指定します。指定できる値は,0〜999,999です。

PRINTENDPAGEパラメタを省略する場合は,0を指定します。PRINTENDPAGEパラメタを省略した場合は,最終ページまで出力されます。

複数の帳票ファイルを指定した場合は,PRINTENDPAGEパラメタの指定に関係なく,指定した複数の帳票ファイルの全ページが出力されます。

XLSXFILENAME

出力するExcel形式ファイル名を指定します。Excel形式ファイルを出力する場合は,必ず指定してください。

Excel形式ファイルの拡張子は,*.xlsxです。Excel形式ファイル名は,拡張子を含めて指定してください。

Excel形式ファイル名を指定するときの規則,および注意については,「付録A.1 ファイル名,およびファイルのパスを指定するときの注意」を参照してください。

XLSXFILEPATH

XLSXFILENAMEパラメタで指定したExcel形式ファイルのパスを指定します。

XLSXFILENAMEパラメタをフルパスで指定した場合は,XLSXFILEPATHパラメタを指定する必要はありません。XLSXFILEPATHパラメタを省略する場合は,空白を指定します。

Excel形式ファイルのパスを指定するときの規則,および注意については,「付録A.1 ファイル名,およびファイルのパスを指定するときの注意」を参照してください。

REPORTNAME

帳票ファイル名(*.fms)を指定します。REPORTNAMEパラメタに指定できるファイル名は,一つだけです。

REPORTNAMEパラメタ,またはREPORTIDパラメタのどちらかは必ず指定してください。なお,REPORTNAMEパラメタに指定できるファイル名は,一つだけです。

REPORTIDパラメタを指定した場合は,REPORTNAMEパラメタを指定しても無効になります。

環境設定ファイル(EURPM.ini)でOPTIONセクションのPATHMODEキーに0(通常モード)を設定している場合,帳票ファイル名は,ファイル名だけを指定してください。このとき,指定するファイルは,PATHセクションのFORMキーで設定しているフォルダに格納しておいてください。

OPTIONセクションのPATHMODEキーに1(フルパスモード)を設定している場合は,フルパス,相対パス,またはファイル名だけのどれかで指定してください。パスは,REPORTFILEPATHパラメタに指定することもできます。REPORTFILEPATHパラメタにパスを指定しない場合は,次のことに注意してください。

  • フルパスを指定する場合

    環境設定ファイル(EURPM.ini)のPATHセクションのFORMキーには指定が要りません。

  • 相対パスを指定する場合

    環境設定ファイル(EURPM.ini)のPATHセクションのFORMキーで設定している起点フォルダ下にあるファイル名を指定してください。

  • ファイル名だけを指定する場合

    環境設定ファイル(EURPM.ini)のPATHセクションのFORMキーで設定しているフォルダにあるファイル名を指定してください。

帳票ファイル名を指定するときの規則,および注意については,「付録A.1 ファイル名,およびファイルのパスを指定するときの注意」を参照してください。

帳票ファイルは,EUR Server Service稼働マシンに配置してください。

REPORTFILEPATH

REPORTNAMEパラメタで指定する帳票ファイルのパスを指定します。指定されたファイルのパスは,REPORTNAMEパラメタで指定したファイルのパスとなります。

REPORTIDパラメタを指定した場合は,REPORTFILEPATHパラメタを指定しても無効になります。

REPORTNAMEパラメタをフルパスで指定した場合は,REPORTFILEPATHパラメタを指定する必要はありません。REPORTFILEPATHパラメタを省略する場合は,空白を指定します。

帳票ファイルのパスを指定するときの規則,および注意については,「付録A.1 ファイル名,およびファイルのパスを指定するときの注意」を参照してください。

MAPPINGDATA

マッピングデータファイル名,または可変記号値定義ファイル名を指定します。

MAPPINGDATAパラメタには,REPORTNAMEパラメタ,またはREPORTIDパラメタの帳票IDと紐付く帳票出力定義ファイルで指定した帳票ファイルに対応するファイル名を指定します。なお,指定できるファイル名は,一つだけです。REPORTNAMEパラメタを指定する場合は,REPORTNAMEパラメタで指定したファイル名の数以下で指定してください。

REPORTIDパラメタを指定する場合は,REPORTIDパラメタの帳票IDと紐付く帳票出力定義ファイルには帳票ファイル名を一つだけ指定してください。

MAPPINGDATAパラメタを省略する場合は,空白を指定します。

ファイル名を指定するときの規則,および注意については,「付録A.1 ファイル名,およびファイルのパスを指定するときの注意」を参照してください。

マッピングデータファイルは,EUR Server - Adapter稼働マシンに配置してください。

MAPPINGDATAPATH

MAPPINGDATAパラメタまたは帳票セット指定ファイルで指定するマッピングデータファイルのパス,または可変記号値定義ファイルのパスを指定します。

MAPPINGDATAパラメタをフルパスで指定した場合は,MAPPINGDATAPATHパラメタを指定する必要はありません。MAPPINGDATAPATHパラメタを省略する場合は,空白を指定します。

パスを指定するときの規則,および注意については,「付録A.1 ファイル名,およびファイルのパスを指定するときの注意」を参照してください。

USERDEFDATA

ユーザ定義データファイル名または可変記号値定義ファイル名を指定します。

USERDEFDATAパラメタには,REPORTNAMEパラメタ,またはREPORTIDパラメタの帳票IDと紐付く帳票出力定義ファイルで指定した帳票ファイルに対応するファイル名を指定します。ファイル名の数は,REPORTNAMEパラメタで指定したファイル名の数以下,またはREPORTIDパラメタの帳票IDと紐付く帳票出力定義ファイルで指定した帳票ファイル名の数と順序で指定してください。

USERDEFDATAパラメタを省略する場合は,空白を指定します。

ファイル名を指定するときの規則,および注意については,「付録A.1 ファイル名,およびファイルのパスを指定するときの注意」を参照してください。

ユーザ定義データファイルは,EUR Server - Adapter稼働マシンに配置してください。

USERDEFDATAPATH

USERDEFDATAパラメタで指定するユーザ定義データファイルのパス,または可変記号値定義ファイルのパスを指定します。

USERDEFDATAパラメタをフルパスで指定した場合は,USERDEFDATAPATHパラメタを指定する必要はありません。USERDEFDATAPATHパラメタを省略する場合は,空白を指定します。

パスを指定するときの規則,および注意については,「付録A.1 ファイル名,およびファイルのパスを指定するときの注意」を参照してください。

DBINFOFILENAME

接続情報ファイル名を指定します。

DBINFOFILENAMEパラメタを省略する場合は,空白を指定します。

環境設定ファイル(EURPM.ini)でOPTIONセクションのPATHMODEキーに0(通常モード)を設定している場合,接続情報ファイル名は,ファイル名だけを指定してください。このとき,指定するファイルは,PATHセクションのDBINFOキーで設定しているフォルダに格納しておいてください。

OPTIONセクションのPATHMODEキーに1(フルパスモード)を設定している場合は,フルパス,相対パス,またはファイル名だけのどれかで指定してください。パスは,DBINFOFILEPATHパラメタに指定することもできます。DBINFOFILEPATHパラメタにパスを指定しない場合は,次のことに注意してください。

  • フルパスを指定する場合

    環境設定ファイル(EURPM.ini)のPATHセクションのDBINFOキーには指定が要りません。

  • 相対パスを指定する場合

    環境設定ファイル(EURPM.ini)のPATHセクションのDBINFOキーで設定している起点フォルダ下にあるファイル名を指定してください。

  • ファイル名だけを指定する場合

    環境設定ファイル(EURPM.ini)のPATHセクションのDBINFOキーで設定しているフォルダにあるファイル名を指定してください。

接続情報ファイル名を指定するときの規則,および注意については,「付録A.1 ファイル名,およびファイルのパスを指定するときの注意」を参照してください。

接続情報ファイルは,EUR Server Service稼働マシンに配置してください。

DBINFOFILEPATH

接続情報ファイルのパスを指定します。

DBINFOFILENAMEパラメタをフルパスで指定した場合は,DBINFOFILEPATHパラメタを指定する必要はありません。DBINFOFILEPATHパラメタを省略する場合は,空白を指定します。

接続情報ファイルのパスを指定するときの規則,および注意については,「付録A.1 ファイル名,およびファイルのパスを指定するときの注意」を参照してください。

REPLACEITEMCNTLFILENAME

置き換え表管理情報ファイル名を指定します。

環境設定ファイル(EURPM.ini)でOPTIONセクションのPATHMODEキーに0(通常モード)を設定している場合,置き換え表管理情報ファイル名は,ファイル名だけを指定してください。このとき,指定するファイルは,PATHセクションのREPLACEITEMキーで設定しているフォルダに格納しておいてください。

OPTIONセクションのPATHMODEキーに1(フルパスモード)を設定している場合は,フルパス,相対パス,またはファイル名だけのどれかで指定してください。パスは,REPLACEITEMCNTLFILEPATHパラメタに指定することもできます。REPLACEITEMCNTLFILEPATHパラメタにパスを指定しない場合は,次のことに注意してください。

  • フルパスを指定する場合

    環境設定ファイル(EURPM.ini)のPATHセクションのREPLACEITEMキーには指定が要りません。

  • 相対パスを指定する場合

    環境設定ファイル(EURPM.ini)のPATHセクションのREPLACEITEMキーで設定している起点フォルダ下にあるファイル名を指定してください。

  • ファイル名だけを指定する場合

    環境設定ファイル(EURPM.ini)のPATHセクションのREPLACEITEMキーで設定しているフォルダにあるファイル名を指定してください。

置き換え表管理情報ファイル名を指定するときの規則,および注意については,「付録A.1 ファイル名,およびファイルのパスを指定するときの注意」を参照してください。

REPLACEITEMCNTLFILENAMEパラメタを省略する場合は,空白を指定します。

置き換え表管理情報ファイルは,EUR Server Service稼働マシンに配置してください。

REPLACEITEMCNTLFILEPATH

置き換え表管理情報ファイルのパスを指定します。

REPLACEITEMCNTLFILENAMEパラメタをフルパスで指定した場合は,REPLACEITEMCNTLFILEPATHパラメタを指定する必要はありません。REPLACEITEMCNTLFILEPATHパラメタを省略する場合は,空白を指定します。

置き換え表管理情報ファイルのパスを指定するときの規則,および注意については,「付録A.1 ファイル名,およびファイルのパスを指定するときの注意」を参照してください。

PMSERVERADDR

帳票サーバのIPアドレスを255.255.255.255形式で指定します。

PMSERVERADDRパラメタを省略する場合は,空白を指定します。

PMSERVERPORT

帳票サーバのポート番号を指定します。指定できる値は,0〜65,535です。

PMSERVERPORTパラメタを省略する場合は,-1を指定します。

PSENVFILENAME

EUR Print Serviceの動作環境を印刷ジョブごとに変更する場合に,EUR Print Serviceの環境設定ファイル(EURPS_ENV)名を指定します。

EUR Print Serviceの環境設定ファイル(EURPS_ENV)名は,REPORTIDパラメタの帳票IDと紐付く帳票出力定義ファイルでも指定できます。PSENVFILENAMEパラメタとREPORTIDパラメタの両方で指定したときは,REPORTIDパラメタの帳票IDと紐付く帳票出力定義ファイルでの同じ設定項目の指定が無効になります。

EUR Server Serviceの環境設定ファイル(EURPM.ini)で,OPTIONセクションのPATHMODEキーに0(通常モード)を設定している場合,PSENVFILENAMEパラメタは,ファイル名だけを指定してください。このとき,指定するファイルは,PATHセクションのPSENVキーで設定しているフォルダに格納しておいてください。

OPTIONセクションのPATHMODEキーに1(フルパスモード)を設定している場合は,フルパス,相対パス,またはファイル名だけのどれかで指定してください。

パスは,PSENVFILEPATHパラメタに指定することもできます。PSENVFILEPATHパラメタにパスを指定しない場合は,次のことに注意してください。

  • フルパスを指定する場合

    環境設定ファイル(EURPM.ini)のPATHセクションのPSENVキーには指定が要りません。

  • 相対パスを指定する場合

    環境設定ファイル(EURPM.ini)のPATHセクションのPSENVキーで設定している起点フォルダ下にあるファイル名を指定してください。

  • ファイル名だけを指定する場合

    環境設定ファイル(EURPM.ini)のPATHセクションのPSENVキーで設定しているフォルダにあるファイル名を指定してください。

EUR Print Serviceの環境設定ファイル(EURPS_ENV)名を指定するときの規則,および注意については,「付録A.1 ファイル名,およびファイルのパスを指定するときの注意」を参照してください。

PSENVFILENAMEパラメタを省略する場合は,空白を指定します。

EUR Print Serviceの環境設定ファイル(EURPS_ENV)は,EUR Server Service稼働マシンに配置してください。

PSENVFILEPATH

PSENVFILENAMEパラメタで指定したEUR Print Serviceの環境設定ファイル(EURPS_ENV)のパスを指定します。

EUR Print Serviceの環境設定ファイル(EURPS_ENV)のパスは,REPORTIDパラメタの帳票IDと紐付く帳票出力定義ファイルでも指定できます。PSENVFILEPATHパラメタとREPORTIDパラメタの両方で指定したときは,REPORTIDパラメタの帳票IDと紐付く帳票出力定義ファイルでの同じ設定項目の指定が無効になります。

PSENVFILENAMEパラメタをフルパスで指定した場合は,PSENVFILEPATHパラメタを指定する必要はありません。PSENVFILEPATHパラメタを省略する場合は,空白を指定します。

EUR Print Serviceの環境設定ファイル(EURPS_ENV)のパスを指定するときの規則,および注意については,「付録A.1 ファイル名,およびファイルのパスを指定するときの注意」を参照してください。

OUTPUTPAGECOUNTOPT

Excel形式ファイル出力を実行した帳票の総シート数を出力するかどうかを指定します。

指定できる値を次に示します。

  • 1:総シート数を出力します。

  • 0:総シート数を出力しません。

OUTPUTPAGECOUNTOPTパラメタを省略する場合は,-1を指定します。OUTPUTPAGECOUNTOPTパラメタを省略したときは,総シート数を出力しません。

REPORTID

帳票IDを指定します。

帳票IDには,Excel形式ファイル出力を実行するときに使用する帳票出力定義ファイル名を指定します。

なお,帳票IDと紐付く帳票出力定義ファイルには帳票ファイル名を一つだけ指定してください。

REPORTIDパラメタ,またはREPORTNAMEパラメタのどちらかは,必ず指定してください。

REPORTIDパラメタを省略する場合は,空白を指定します。

帳票IDには,帳票出力定義ファイルのファイル名だけ,または相対パスのどちらかを指定できます。次のことに注意して指定してください。

  • 文字列が256バイトに満たない場合は,空白で埋めてください。

  • ファイル名だけを指定する場合

    環境設定ファイル(EURPM.ini)のPATHセクションのREPORTIDキーで設定しているフォルダにあるファイル名を指定してください。

  • 相対パスを指定する場合

    環境設定ファイル(EURPM.ini)のPATHセクションのREPORTIDキーで設定している起点フォルダ下にあるファイル名を指定してください。

    フォルダおよびファイルの区切り文字に使用できる文字を次に示します。

    Windows環境:「\」または「/

    UNIX/Linux環境:「/

帳票出力定義ファイルは,EUR Server Service稼働マシンに配置してください。

重要

REPORTIDパラメタで帳票IDを指定した場合,REPORTSETFILEパラメタで帳票セット指定ファイル名を指定しても無効となるため,複数帳票の一括出力および複数様式の帳票の出力はできません。

戻り値

RTNCODE

終了コードが設定されます。終了コードについては,「10.4.1 エラー情報一覧」を参照してください。

ERRORMESSAGE

エラーが発生した場合,エラーメッセージとメッセージIDが設定されます。エラーメッセージについては,マニュアル「EUR メッセージ」を参照してください。

エラーが発生しなかった場合は,空白が設定されます。

OUTPUTPAGECOUNT

OUTPUTPAGECOUNTOPTパラメタに1を指定した場合,OutputXLSXReport関数の実行後に帳票の総シート数(最大100シート)が設定されます。

エラーが発生した場合は,0が設定されます。

注※

EUR Server - Adapterで実行したジョブが正常または警告で終了したタイミングで,帳票の総シート数が設定されます。

エラーメッセージ

EUR Print Serviceと連携して使用するパラメタでエラーが発生した場合は,次のエラーメッセージが出力されます。メッセージが表示されたときは,EUR Print Serviceのイベントログ,またはeurpsログを参照してください。

メッセージID

メッセージ

KEEY263-E

XLSX形式ファイル出力処理でエラーが発生しました。(337)