uCosminexus 電子フォームワークフロー 解説

[目次][用語][索引][前へ][次へ]

付録E.1 BLCプロパティファイル

BLCプロパティファイルのファイル名と保存先,プロパティファイルを読み込むタイミング,プロパティファイルの書式,およびプロパティ情報について説明します。

<この項の構成>
(1) プロパティファイルのファイル名と保存先
(2) プロパティファイルを読み込むタイミング
(3) プロパティファイルの書式
(4) プロパティ情報一覧
(5) プロパティファイルのサンプル

(1) プロパティファイルのファイル名と保存先

BLCプロパティファイルのファイル名および保存先を次に示します。

ファイル名
BLC.BLCproperties
保存先
BLCプロパティファイルは,アプリケーションサーバの次のディレクトリに保存してください。
  • Windows版の場合
    <BLC2のインストールディレクトリ>\conf
注意事項
BLCプロパティファイル格納ディレクトリは,クラスパスに追加する必要があります。
クラスパスに追加されたディレクトリすべてを対象として,BLC.BLCpropertiesファイルが複数にならないようにしてください。

(2) プロパティファイルを読み込むタイミング

BLCプロパティ情報は,プロセスで最初にBLCInfoクラスのsetInfoメソッドがコールされたタイミングでstatic領域に保持します。プロパティ情報を更新した場合は,次のプロセス起動時から有効です。プロパティファイルがない場合,BLCInfoクラスのsetInfoメソッドは例外(BLCException)をスローします。

(3) プロパティファイルの書式

BLCプロパティファイルの書式,および書式の規則を次に示します。

プロパティファイルの書式
キー名=設定値
書式の規則
  1. ASCII文字だけが指定でき,大文字/小文字は区別します。
  2. 空白文字だけの行,または最初の非空白文字がASCII文字「#」(シャープ)または「!」(感嘆符)の行は無視します。「#」(シャープ)または「!」(感嘆符)はコメント行を示します。
  3. キー名は,行の最初の非空白文字から,最初のASCII文字「=」(イコール),「:」(コロン),または空白文字の直前までの行内すべての文字から構成される文字列です。
  4. キー名の終わりを示すASCII文字「=」(イコール),「:」(コロン),または空白文字は,前に「\」(円記号)を付けるとキー名に含められます。
  5. キー名の後ろの空白はすべて無視します。
  6. キー名の後ろにある最初の非空白文字が「=」(イコール)または「:」(コロン)の場合,これらの文字,およびそのあとの空白文字をすべて無視します。
  7. 行内で5.,6.の条件以外の文字はすべて,キー値として扱います。
  8. 要素文字列内では,ASCIIエスケープシーケンス「\t」,「\\」,「\"」,「\'」,および「\ 」(円記号とスペース)は認識され,単独の文字に変換されます。
  9. 行の最後の文字が「\」(円記号)場合は,次の行は現在の行に継続します。その場合,「\」(円記号)と改行コード,および継続行の先頭の空白はすべて無視されます。
注意事項
Javaで提供するPropertiesクラスのgetPropertyメソッドを使用して読み込みます。PropertiesクラスのgetPropertyメソッドの仕様に従ったフォーマットで記述する必要があります。詳細は,マニュアル「uCosminexus 電子フォームワークフロー APIリファレンス」を参照してください。
エンコードしないので,2バイト文字は対応しません。

(4) プロパティ情報一覧

BLCプロパティ情報を次に示します。

表E-1 プロパティ情報の一覧(BLC)

項番 キー名 必須/任意 内容 範囲(単位) デフォルト(単位)
1 TracePath※1 必須 BLCトレースファイルの出力先ディレクトリをフルパスで指定します。なお,指定したディレクトリには書き込み権限を与えておく必要があります。
指定したディレクトリがない場合,指定したディレクトリが有効な名称であればBLCでプロセス開始後の初回アクセス時に作成されます。
指定したディレクトリが無効な名称であればプロセス開始後の初回アクセス時にエラーをスローします。
例:C:\Program Files\Hitachi\HBPM2\logs
2 TraceFileNum 任意 BLCトレースファイルの面数を指定します。 2〜16 16
3 TraceFileSize 任意 BLCトレースファイルのサイズを指定します。 4096〜2147483647(バイト) 10485760(バイト)
4 TraceLevel 任意 BLCトレースの出力レベルを次の値で指定します。
  • -1:出力しません。
  • 10:例外情報と最低限必要な情報だけ出力します。
  • 20:例外情報とコールトレースを出力します。
  • 30:例外情報と主要なコールトレースと内部トレースを出力します。
  • 40:例外情報とすべてのコールトレースと内部トレースを出力します。
-1〜1000 20
5 TraceEncoding 必須 トレース出力の文字セットを指定します。 Shift_JISまたはUTF-8のどちらか
Windows版
Shift_JIS
6 yyyyyyyy.ApTracePath※1※2 任意 ユーザアプリケーションのトレースファイルの出力先ディレクトリをフルパスで指定します。
指定したディレクトリがない場合,指定したディレクトリが有効な名称であればyyyyyyyyで指定したアプリケーション名のプロセスで初回トレース出力要求時BLCによって作成されます。
指定したディレクトリが無効な名称であればyyyyyyyyで指定したアプリケーション名のプロセスで初回トレース出力要求時にエラーをスローします。
例:C:\Program Files\Hitachi\HBPM2\logs\Ap
7 yyyyyyyy.ApTraceFileNum※2 任意 ユーザアプリケーションのトレースファイルの面数を指定します。 2〜16 16
8 yyyyyyyy.ApTraceFileSize※2 任意 ユーザアプリケーションのトレースファイルのサイズを指定します。 4096〜2147483647(バイト) 10485760(バイト)
9 yyyyyyyy.ApTraceLevel※2 任意 ユーザアプリケーションのトレース出力レベルを指定します。 -1〜1000 20
10 yyyyyyyy.ApTraceEncoding※2 任意 ユーザアプリケーションのトレースファイル出力時のエンコーディング値を指定します。 Shift_JIS
11 BLCMASTER.method 必須 BLCデータベースとの接続方法を次の値で指定します。
  • pool:DBコネクションプール機能を使って接続します。
  • direct:直接接続します。
DBコネクションプール機能は,uCosminexus Application ServerのJ2EEサーバモードのコネクションプール機能を利用します。DBコネクションプール機能は,プールされたコネクションを利用するため,接続に掛かる時間を節約できますが,コネクション数などのリソース見積もりが必要です。
直接接続は,毎回DBへ接続するため,プール機能と比較すると接続に時間が掛かります。
"direct"指定は単独の動作確認用などで利用し,"pool"指定は実業務環境や,多重実行の確認に利用することをお勧めします。
poolまたはdirectのどちらか
12 BLCMASTER.drv 任意※3 JDBCのドライバ名を指定します。
HiRDBの場合
JP.co.Hitachi.soft.HiRDB.JDBC.HiRDBDriver
Oracleの場合
oracle.jdbc.driver.OracleDriver
SQL Serverの場合
com.microsoft.sqlserver.jdbc.SQLServerDriver
13 BLCMASTER.url 任意※3 接続情報URLを指定します。
HiRDBの場合
jdbc:hitachi:hirdb://DBID=22200,DBHOST=BPMSV,ENCODELANG=MS932
Oracleの場合
jdbc:oracle:thin:@BPMSV:1521:BLCDB
SQL Serverの場合
jdbc:sqlserver://BPMSV:1433;DatabaseName=BLCDB;selectMethod=cursor
添付ファイル操作を行う場合,「付録H 添付ファイルの使用方法」を参照して,BUF_SIZE=バッファ長を含む形式で指定してください。
14 BLCMASTER.properties 任意※3 DB接続用パラメタ情報を"キーワード=値,・・・接続引数リスト"の形式で指定します。ただし,キーワードおよび値には,","(半角コンマ)および"="(半角イコール)を指定しないでください。
例:user=BPM,password=BPM
15 BLCMASTER.name 任意※4 論理DB名称を"java:comp/env/任意文字列"で指定します。
例:java:comp/env/BLC
16 xxxxxxxx.method※5 任意 DBとの接続方法を次の値で指定します。
  • pool:DBコネクションプール機能を使って接続します。
  • direct:直接接続します。
DBコネクションプール機能は,uCosminexus Application ServerのJ2EEサーバモードのコネクションプール機能を利用します。DBコネクションを利用するため,接続に掛かる時間を節約できますが,コネクション数などのリソース見積もりが必要です。
直接接続は,毎回DBへ接続するため,プール機能と比較すると接続に時間が掛かります。
"direct"指定は単独の動作確認用などで利用し,"pool"指定は実業務環境や,多重実行を確認する場合に利用することをお勧めします。
17 xxxxxxxx.drv※5 任意※6 JDBCのドライバ名を指定します。
HiRDBの場合
JP.co.Hitachi.soft.HiRDB.JDBC.HiRDBDriver
Oracleの場合
oracle.jdbc.driver.OracleDriver
SQL Serverの場合
com.microsoft.sqlserver.jdbc.SQLServerDriver
18 xxxxxxxx.url※5 任意※6 接続情報URLを指定します。
HiRDBの場合
jdbc:hitachi:hirdb://DBID=33300,DBHOST=BPMSV,ENCODELANG=MS932
Oracleの場合
jdbc:oracle:thin:@BPMSV:1521:BLCDB
SQL Serverの場合
jdbc:sqlserver://BPMSV:1433;DatabaseName=BLCDB;selectMethod=cursor
19 xxxxxxxx.properties※5 任意※6 DB接続用パラメタ情報を"キーワード=値,・・・接続引数リスト"の形式で指定します。ただし,キーワードおよび値には,","(半角コンマ)および"="(半角イコール)を指定しないでください。
例:user=BPM,password=BPM
20 xxxxxxxx.name※5 任意※7 論理DB名称を"java:comp/env/任意文字列"で指定します。
例:java:comp/env/BLC
21 Directory_Class 任意 ディレクトリ情報アクセスクラスを変更する場合に,ディレクトリ情報アクセスクラス名を指定します。
例:jp.co.Hitachi.soft.blc.BLCDirs
22 ListForm_UserAddClass 任意 ユーザ追加の帳票一覧処理クラスを変更する場合に,ユーザ追加の帳票一覧処理クラス名を指定します。
例:jp.co.Hitachi.soft.blc.BLCListForm
23 ListMenu_UserAddClass 任意 ユーザ追加のメニューボタン取得クラスを変更する場合に,ユーザ追加のメニューボタン取得クラス名を指定します。
例:jp.co.Hitachi.soft.blc.BLCListMenu
24 RequestDataEncode 必須 Webコンテナに依存して必要になるHttpServletRequestクラスのリクエストデータに対するエンコードで使用する文字セットを指定します。指定がないときはエンコードしません。
例:Shift_JIS
Shift_JISまたはUTF-8のどちらか
25 PINamePrefix 任意 申請IDのプレフィックスを任意文字列で指定します。申請IDは30文字以内の半角英数字の任意の文字列です(30文字を超えるとエラーになります)。
例:BLC
空文字列(文字)
26 PINameLength 任意 申請IDの長さを指定します。 1〜12(バイト) 7(バイト)
27 TimeZone※8 任意 カレントホストのタイムゾーンを指定します。BLCで保持する日付時刻の値はGMTです。該当するキーで指定された値でローカライズします。
例:GMT+09:00
カレントホストのタイムゾーン
28 SpaceHtmlEncode 任意 半角スペースコードをHTMLエンコードするかどうかを次の値で指定します。ただし,textareaタグに含まれる半角スペースコードはHTMLエンコードしません。
  • true:&nbsp;に変更します。
  • false:HTMLエンコードしません。
trueまたはfalseのどちらか true
29 DispHistory 任意 帳票上部に承認履歴を表示するかどうかを指定します。
  • true:表示します。
  • false:表示しません。
この項目の指定がない,値の指定がない,または値が範囲外の場合,デフォルト値で動作します。
また,キーおよび値は大文字と小文字が区別されます。
EUR-Form連携帳票の場合,この項目の指定にかかわらず承認履歴は表示されません。
trueまたはfalseのどちらか false
30 PIHistory.outputPIStatus※9 任意 最終作業の実行処理名を表示するかどうかを設定します。
  • yes:表示します。
  • no:表示しません。
yesまたはnoのどちらか no
31 PIPFrameWork 任意 BLC案件処理フレームワークを使用するかどうかを設定します。ただし,BLC案件処理フレームワークを使用できるのは,BLC帳票の場合だけです。
  • yes:使用します。
  • no:使用しません。
指定がない,または値が範囲外の場合,デフォルト値で動作します。
yesまたはnoのどちらか no
32 BLCPIStatusFactoryName 任意 案件ステータスクラスのファクトリクラス名を指定します。ユーザは,このキーに指定したクラスを作成し,案件ステータスクラスのインスタンスを返すメソッドを実装します。
PIPFrameWorkキーに"yes"が指定されているときに,BLCPIStatusFactoryキーが存在しない場合は,デフォルトのBLCPIStatusFactoryクラス(jp.co.Hitachi.soft.blc.BLCPIStatusFactory)が使用されます。BLCPIStatusFactoryクラスは,デフォルトのBLCPIStatusクラス
(jp.co.Hitachi.soft.blc.BLCPIStatusFactory)をgetInstanceメソッドで返すため,案件ステータス管理は行いません。
jp.co.Hitachi.soft.blc.BLCPIStatusFactory
33 FormDataSeparateSize 任意 帳票データの分割文字数を指定します。
BLCMASTERテーブルのBLC_FORM_DATA_TテーブルのnmFormDataカラムに,帳票データを格納する文字数を指定します。
  • 1950:データベースがShift_JISの場合
  • 975:データベースがUTF-8の場合
上記以外の値は指定しないでください。範囲外の値を指定した場合,または975未満の値を指定した場合は,無効な文字列と判断されプロパティ不正のエラーになります。
975または1950のどちらか(文字)
Windows版(Shift_JIS)
1950(文字)
34 CheckSendToData 任意 申請/承認処理で,宛先未指定(BLC_SendToDataに値が設定されているかどうか)のチェックをするかどうかを設定します。クライアント側での宛先選択チェックではありません。
  • true:チェックします。
    宛先が未指定の場合は,エラーをスローします。
  • false:チェックしません。
    この場合,BLC_SendToDataに値が指定されていないため,別途ユーザプログラムで宛先を指定するなど,振り分けルールなどを含めて矛盾が発生しないようにしてください。
trueまたはfalseのどちらか true
35 CheckHistoryNodeExist 任意 送信ログからの内容確認時に,ログインユーザが処理した履歴が存在チェックをするかどうかを指定します。
  • true:チェックします。
    ログインユーザが処理した履歴がない場合は,エラーをスローします。
  • false:チェックしません。
    ログインユーザが処理した履歴がない場合は,現在の最終処理ノードとして表示します。
trueまたはfalseのどちらか true
36 PasswordType 任意 パスワード形式を指定します。
ユーザ管理機能で入力したパスワードが,指定した形式に変換されます。
  • md5:MD5形式
  • sha1:SHA-1形式
  • 指定なし:平文
キーおよび値は大文字と小文字を区別します。
md5,sha1,指定なしのどれか 指定なし
37 MailSMTPHost 任意 メール連携機能でメールの送信を実行する場合に,メールサーバ(SMTPサーバ)のホスト名,またはIPアドレスを指定します。
例:MailSMTPHost=XXX.XXX.XXX.XXX
38 ScreenValidPolicy※10 任意 画面表示の期間を指定します。
  • cookie:従来の方法です。ポータルでsessionタイムアウトが発生しても,BLC単独の画面が起動している場合は動作が続行されます。
  • session:ポータルのsessionに合わせた方法です。sessionタイムアウトが発生した場合,エラー画面が表示されます。
なお,sessionタイムアウトを発生させたくない場合は,ポータルの基本画面に隠しフレームを作成し,そのフレーム内にmetaタグを埋め込んでください。
例:<meta http-equiv="refresh" content="1200" />
例のcontent(秒)の値は,セッションタイムアウト期間より短い期間を設定してください。セッションタイムアウト期間のデフォルト値は30分(1800秒)です。web.xmlで指定します。
cookieまたはsessionのどちらか cookie
39 PortalScreenEnable 任意 BLCの画面がポータル対応かどうかを指定します。
  • true:BLCのバージョン05-50以降の画面
  • false:BLCのバージョン05-00以前の画面
trueまたはfalseのどちらか false
40 PasswordMin 任意 パスワードに入力する文字の最小文字数を指定します。 1〜128(バイト) 8(バイト)
41 MaxSearchUser 任意 ユーザ管理機能のユーザ検索で検索できるユーザの最大件数を指定します。 0〜2147483647(件) 500(件)
42 BLCMaxRequestSize 任意 Webコンテナに依存して必要になるHttpServletRequestクラスのリクエストデータに対して,送信できるデータの最大データサイズを指定します。
指定した最大データサイズとjavax.servlet.ServletRequest#getContentLengthメソッドの値を比較し,最大データサイズの値を超えた場合はリクエストの送信に失敗します。
値が不正または範囲外の場合は,デフォルト値で動作します。
なお,キーの指定がない場合,サイズチェックは実行されません。
また,javax.servlet.ServletRequest#getContentLengthメソッドの値が不明だった場合は,最大データサイズを超えていないものとして動作します。
4096〜2147483647(バイト) サイズをチェックしない
43 MailSMTPPort 任意 メール連携機能でメールを送信する場合に,メールサーバ(SMTPサーバ)のポート番号を指定します。 1〜65535 25
(凡例)
−:該当しません。
キーを指定しない場合,デフォルトの値で動作します。
注※1
Windowsでディレクトリパスにセパレータを含む場合は,"\\"としてください。
注※2
yyyyyyyyは16バイト以内の半角英数字の任意の文字列です。
注※3
BLCMASTER.methodに "direct"指定時は必須で,"pool"指定時は無視します。
注※4
BLCMASTER.methodが"pool"指定時は必須で,"direct"指定時は無視します。
注※5
xxxxxxxxは32バイト以内の半角英数字の任意の文字列です。この文字列が,DB接続名になります。
注※6
xxxxxxxx.method が"direct"指定時は必須で,"pool"指定時は無視します。
注※7
xxxxxxxx.method が"pool"指定時は必須で,"direct"指定時は無視します。
注※8
指定書式に誤りがあるとGMTゾーンとして扱われます。書式はJavaのTimeZoneクラスを参照してください。
注※9
実行処理名を表示させるよう設定した場合,DBアクセスが増加します。
注※10
ScreenValidPolicyキーに"cookie"を指定した場合の補足情報および注意事項については,「ScreenValidPolicyキーに"cookie"を指定した場合の補足情報および注意事項」を参照してください。

トレースサイズ,および面数のデフォルト値の見積もりモデル
  • 1メソッド:4レコード
  • 同時アクセススレッド数:50
  • 1スレッド当たりの保存メソッド数:2000
  • デフォルト面数:2
    ↑ 100×4×50×2,000÷2÷1,024÷1,024 ↑×1,024×1,024 = 20,971,520 (20MB)
ScreenValidPolicyキーに"cookie"を指定した場合の補足情報および注意事項
Cookieを使用した認証は,認証クラスと認証ページで処理を実現します。認証処理では,Cookieに対するユーザIDの保持および参照を実行します。BLC実行環境は,CookieにユーザIDがあればログイン済みと判断し,BLCのページを遷移させます。
認証クラスは,次の条件で使用されます。
  • ログイン処理
    ユーザの業務開始ページ(ログインページなど)からBLC認証ページが要求されて,BLC認証ページ内で認証処理をします。
  • ログイン済みチェック処理
    すべてのページから呼ばれて,認証済みチェックをします。
注意事項
  • BLCの各ページからほかのページに遷移する場合,CookieにユーザIDなどの情報がないときは,BLC認証エラーとなり,ブラウザにエラーメッセージが表示されます。
  • Cookieには,BLCにログインしたブラウザを終了するまで,ユーザIDなどの情報が保持されます。
  • BLCにログインしたブラウザを終了すると,Cookieに保持されているユーザIDなどの情報は削除されます。
  • Cookieに保持されるユーザIDなどの情報は,現在ログインしているアプリケーションサーバだけで認証情報として使用されます。アプリケーションサーバ上で,BLCのコンテキストパスが異なる場合,BLC認証情報は無効となります。
  • "cookie"選択時にポータル画面でセッションタイムアウトが発生した場合でも,BLCの画面では動作し続けます。ただし,Portal Frameworkが管理する画面(ポータルホームなど)を操作するとエラーが発生します。この場合は,いったんログアウトしたあとで再ログインしてください。

(5) プロパティファイルのサンプル

BLCプロパティファイルのサンプルについて,ファイル名,格納先,および内容を次に示します。

ファイル名
BLC.BLCproperties.sam
格納先
BLCプロパティファイルのサンプルは,アプリケーションサーバの次のディレクトリに格納されています。
  • Windows版の場合
    <BLC2のインストールディレクトリ>\conf
サンプルの内容
サンプルの内容を次に示します。
#All Rights Reserved. Copyright (C) 2002, 2009, Hitachi, Ltd.
#Licensed Material of Hitachi, Ltd.
#Reproduction, use, modification or disclosure otherwise than
#permitted in the License Agreement is strictly prohibited.
######################################################################
# Hitachi Business Logic - Container 2 sample file
######################################################################
TracePath = C:\\Program Files\\Hitachi\\HBPM2\\logs
TraceFileNum = 16
TraceFileSize = 10485760
TraceLevel = 20
TraceEncoding = Shift_JIS
#yyyyyyyy.ApTracePath = C:\\Program Files\\Hitachi\\HBPM2\\logs\\Ap
#yyyyyyyy.ApTraceFileNum = 16
#yyyyyyyy.ApTraceFileSize = 10485760
#yyyyyyyy.ApTraceLevel = 20
#yyyyyyyy.ApTraceEncoding = Shift_JIS
BLCMASTER.method = pool
#BLCMASTER.drv = JP.co.Hitachi.soft.HiRDB.JDBC.HiRDBDriver
#BLCMASTER.url = jdbc:hitachi:hirdb://DBID=22200,DBHOST=BPMSV,ENCODELANG=MS932
#BLCMASTER.properties = user=BPM,password=BPM
BLCMASTER.name = java:comp/env/BLC
#xxxxxxxx.method = pool
#xxxxxxxx.drv = JP.co.Hitachi.soft.HiRDB.JDBC.HiRDBDriver
#xxxxxxxx.url = jdbc:hitachi:hirdb://DBID=33300,DBHOST=BPMSV,ENCODELANG=MS932
#xxxxxxxx.properties = user=BPM,password=BPM
#xxxxxxxx.name = java:comp/env/BLC
#Directory_Class = jp.co.Hitachi.soft.blc.BLCDirs
#ListForm_UserAddClass = jp.co.Hitachi.soft.blc.BLCListForm
#ListMenu_UserAddClass = jp.co.Hitachi.soft.blc.BLCListMenu
RequestDataEncode = Shift_JIS
#PINamePrefix = BLC
#PINameLength = 7
TimeZone = GMT+09:00
SpaceHtmlEncode = true
DispHistory = false
PIPFrameWork = no
#BLCPIStatusFactoryName = jp.co.Hitachi.soft.blc.BLCPIStatusFactory
PIHistory.outputPIStatus = no
FormDataSeparateSize = 1950
ScreenValidPolicy = session
PortalScreenEnable = true
BLCMaxRequestSize = 11000000
#MailSMTPHost = 
#MailSMTPPort = 25
#PasswordType = sha1
#PasswordMin = 8