バッチ処理による出力
作成したテキスト出力定義を使用し、バッチ処理にてデータ出力が実行できます。データはZIP形式で出力されます。
なお、事前準備として、バッチを実行する端末において、バッチ実行用ファイルのダウンロード・配置、Java
のインストール、Webサービス認証用キーの発行を行う必要があります。
バッチ実行用ファイル、Java
インストーラのダウンロードならびにWebサービス認証用キーの発行は、システム管理者が行います。
画面から実行する場合は、「画面からの出力」を参照してください。
バッチ処理はクライアント端末からでも実行可能です。 |
バッチ実行の準備を行う
バッチ実行する端末にて、下記の準備を行います。
-
バッチ実行用ファイルのダウンロード・配置
-
Java
のインストール
また、バッチ実行時に必要となるWebサービス認証キーを事前に発行します。
詳細は、「バッチ処理による取込み」の「バッチ実行の準備を行う」の項を参照してください。
ただし、「(3)Webサービス認証用キーの発行」において、発行画面で認証キーの情報を登録する際、「権限」、「処理者」の項目については下記の内容で登録してください。
項目名 | 説明 |
---|---|
権限 |
発行する認証キーが処理できる操作を選択します。 |
処理者 |
バッチを実行する社員を選択します。選択された社員が操作ログの実行社員に記録されます。 |
データ出力を実行する
-
バッチファイルを作成します。
以下を参考に、お客様の環境に合わせバッチファイルを作成してください。
例)バッチ実行用ファイルの配置ディレクトリが「C:\tool」の場合java -jar C:\tool\BatchClient.jar -server http://<サーバー名>[:ポート]/pe4j -apikey <認証キー> -type <実行処理> -processTimeout <タイムアウト時間> -targetCorpId <対象会社コード> -targetOutputDefinitionID <テキスト出力定義コード> -file <出力ファイル名> -header <タイトル行> -inreviewAndCirculation <決裁状況(審議・回覧中)> -sentbackAndWithdraw <決裁状況(差戻・取下)> -rejected <決裁状況(否認)> -approvedAndFinished <決裁状況(決裁・回覧完了)> -reExport <出力済みデータの再出力> -applicationDateFrom <申請日(開始日)> -applicationDateTo <申請日(終了日)> -approvalDateFrom <決裁日(開始日)> -approvalDateTo <決裁日(終了日)> -delimiter <区切文字> -replaceComma <区切文字置換文字> -replaceCrlf <改行コード置換文字> -fileEncoding <文字コード>
※上記は1行で記載します。
■指定するパラメタ 項目名 説明 http://<サーバー名>[:ポート]/pe4j *
当システムにアクセスする際のURLを指定します。
認証キー *
「バッチ実行の準備を行う」で発行した認証キーを指定してください。
実行処理 *
rrdexport を指定してください。
タイムアウト時間
バッチ処理のタイムアウト時間(秒)を指定してください。1から518,400までの間で指定してください。
未指定の場合は、21,600秒(6時間)となります。対象会社コード *
出力対象の会社コードを指定します。
テキスト出力定義コード *
出力するテキスト出力定義のコードを指定します。コードはテキスト出力定義一覧に表示されます。
出力ファイル名 *
出力するファイル名をフルパスで指定します。なお、拡張子は不要です。
ZIP形式で出力されます。
「\」「/」「:」「*」「?」「"」「<」「>」「|」などのOSで使用できない文字は指定できません。タイトル行 *
タイトル行を出力するかどうかを指定します。
<指定値>出力する場合
:
true
出力しない場合
:
false
決裁状況(審議・回覧中) *
決裁状況が審議または回覧中の案件を出力対象とするかどうかを指定します。
<指定値>出力する場合
:
true
出力しない場合
:
false
決裁状況(差戻・取下) *
決裁状況が差戻しまたは取下げの案件を出力対象とするかどうかを指定します。
<指定値>出力する場合
:
true
出力しない場合
:
false
決裁状況(否認) *
決裁状況が否認の案件を出力対象とするかどうかを指定します。
<指定値>出力する場合
:
true
出力しない場合
:
false
決裁状況(決裁・回覧完了) *
決裁状況が決裁または回覧完了の案件を出力対象とするかどうかを指定します。
<指定値>出力する場合
:
true
出力しない場合
:
false
出力済みデータの再出力 *
出力済みのデータを再出力するかどうかを指定します。
<指定値>出力する場合
:
true
出力しない場合
:
false
申請日(開始日)
申請日の範囲を条件にする場合は、申請日(開始日)をYYYYMMDD形式で指定します。
申請日(終了日)
申請日の範囲を条件にする場合は、申請日(終了日)をYYYYMMDD形式で指定します。
「申請日(開始日)」を指定する場合は、必ず指定してください。決裁日(開始日)
決裁日の範囲を条件にする場合は、決裁日(開始日)をYYYYMMDD形式で指定します。
決裁日(終了日)
決裁日の範囲を条件にする場合は、決裁日(終了日)をYYYYMMDD形式で指定します。
「決裁日(開始日)」を指定する場合は、必ず指定してください。区切文字
項目の区切文字を指定します。以下のいずれかを指定できます。
<指定値>カンマ
:
0
セミコロン
:
1
タブ
:
2
未指定の場合は、カンマとなります。
区切文字置換文字
CSVデータ内に区切文字と同じ文字列が存在していた場合に、置き換える文字を指定します。半角10文字以内で指定してください。
“@”(全角)、“/”(全角)、“:”(半角)は、使用できません。
未指定の場合は、全角カンマに変換されます。改行コード置換文字
CSVデータ内の改行コードを、置き換える文字を指定します。半角10文字以内で指定してください。
“@”(全角)、“/”(全角)、“:”(半角)は、使用できません。
置換文字を指定しなかった場合、レイアウトが崩れる可能性があります。文字コード
CSVファイルの文字コードを
shift-jis
またはutf-8
で指定してください。
未指定の場合は、shift-jis
として出力されます。-
決裁状況は、いずれか一つは出力対象とする必要があります。
-
申請日・決裁日については、双方または片方を指定する必要があります。
<サンプル>
java -jar C:\tool\BatchClient.jar -server http://d-circle/pe4j -apikey 19999999-a7aa-4444-9cc9-666aaa222222 -type rrdexport -processTimeout 10800 -targetCorpId friend -targetOutputDefinitionID 77 -file C:\work\A0500 -header true -inreviewAndCirculation false -sentbackAndWithdraw false -rejected false -approvedAndFinished true -reExport true -applicationDateFrom 20180101 -applicationDateTo 20180131 -approvalDateFrom 20180101 -approvalDateTo 20180131 -delimiter 0 -replaceComma , -replaceCrlf \n -fileEncoding utf-8
※上記は1行で記載します。
-
-
作成したバッチファイルを実行します。
実行時のパラメタに問題がある場合やバッチ処理起動時にエラーが発生した場合は、コマンドプロンプトにエラーメッセージが表示され、出力が行われません。エラーメッセージから原因を確認のうえ、エラー原因を取り除き、再度バッチファイルを実行してください。 -
バッチ実行が終了後、実行結果を確認します。
正常終了時には、コマンドプロンプトに正常終了した旨のメッセージが表示されます。
異常終了時には、コマンドプロンプトに警告またはエラーが発生した旨のメッセージが表示されます。ログ照会画面にて実行結果を確認します。正常終了時には出力件数、異常終了時には例外メッセージが出力されます。(出力結果が0件の場合は正常終了となります。)
ログ照会画面はシステム管理者のみ利用可能です。管理者マニュアル「ログ照会」の項を参照してください。
バッチファイルをOSのタスクスケジューラー機能などを利用し実行することにより、定期的に出力処理を行うことができます。OSのタスクスケジューラー機能については、OSのマニュアルをご確認ください。 |