文書情報と操作ボタンに関するシステム設定(properties-definition.xml)
バインダやプロセスで利用する文書に関する情報と操作ボタンの制御をキャビネットまたはバインダ単位で指定可能にしました。設定パターンをシステム設定ファイルに定義し、対象範囲をキャビネットIDまたはバインダIDで指定します。システム全体や複数のバインダに対して対象の機能を一括で定義したい場合や、バインダの定義画面からは指定できない設定を利用することができます。
- 設定の範囲はキャビネットIDまたはバインダIDを指定します。バインダキーは指定できません。
- 親キャビネットの設定は、そのキャビネットに含まれる全ての子キャビネットとバインダに反映されます。
- 親キャビネットと子キャビネットで同一の設定項目に異なる定義をした場合は、親キャビネットの設定が優先されます。
- 本設定は同様の設定が画面にある場合でも、画面には反映されません。
- 本設定は既存のバインダ属性、フォーム属性、システム設定(default.xml)の上位設定になります。 同様の設定がある場合は、本設定で上書きされます。
- 設定はetc/hibikiのシステム設定ファイルproperties-definition.xmlに記述します。
- 設定を反映するにはtomcatの再起動が必要です。
■ 対象の機能
表示制御
下記項目に関して、本機能で表示・非表示が設定可能となります。
対象画面 | 表示/非表示 | 図 |
---|---|---|
文書詳細画面 | 文書基本情報(文書タイトル、文書番号) | ① |
業務開始画面 | 見出し入力用のポップアップ | - |
アクティビティ実施画面 | アクティビティ基本情報 (業務名、見出し、アクティビティ名、受信日時、担当者(代行者)、業務責任者(業務開始者)、業務開始日時) |
② |
実施立場及び実施コメント入力欄 (アクティビティ名、受信日時、コメント、実施立場の候補) |
③ | |
再計算ボタン | ④ | |
アクティビティ実施完了画面 | アクティビティ基本情報 (アクティビティ名、種別、説明) |
⑤ |
イベントハンドラ | ⑥ | |
最新文書 | ⑦ | |
実際の担当者 | ⑧ | |
実施立場及び実施コメント入力欄 (実施者、実施日時、実施アクション、履歴文書、コメント) |
⑨ |
文書詳細画面 表示設定
実施画面 表示設定
実施完了画面 表示設定
■ 機能制御
下記項目に関して、本機能で機能設定が可能となります。
- 印刷の許可、印刷許可ユーザー
- 文書一覧からのCSV出力時に表示されるポップアップの表示制御
- 実施画面、実施完了画面の操作ボタンの表示位置
機能の詳細は、各設定項目を参照してください。
定義方法について説明します。
■ 設定ファイル
/etc/hibiki/properties-definition.xml
■ 定義構成
① パターン名とその対象範囲を定義します。
② パターン名に対して、パターン内容を定義します。
<properties-definition-config>
<binder-properties-pattern name="PatternA" target="10001"/> ・・・①
<binder-properties-pattern name="PatternB" target="root"/> ・・・①
<binder-properties-def name="PatternA"> ・・・②
--パターンAの内容を定義--
</binder-properties-def>
<binder-properties-def name="PatternB"> ・・・②
--パターンBの内容を定義--
</binder-properties-def>
</properties-definition-config>
※ 同じパターン名で同じパラメータが定義されている場合は、後の記述が有効になります。
※ 複数の定義で同じtargetが指定された場合で、同じパラメータが定義されている場合は、後の記述が有効になります。
※ 定義が不正な場合はログにエラーを出力しますが、記述を無効にして起動します。
■ キャビネットIDの取得方法
定義の適用範囲はバインダID、またはキャビネットIDで指定します。IDは以下の方法で参照します。
■ 適用対象の範囲
全システムに対して設定したい場合
システム全体にパターン設定を適用したい場合は target="system" とします。
systemはルートキャビネットへの指定となり、全てのキャビネット、バインダに対してその設定が適用されます。
記述例
<binder-properties-pattern name="PatternA" target="system"/>
■ キャビネットの階層構造と設定の有効範囲について
キャビネットが階層構造の場合、子キャビネットすべてに対し設定が継承されます。
親キャビネットと子キャビネットで同一の設定項目に対して、異なる値が設定されている場合は、親キャビネットの設定が有効になります。
キャビネット内のバインダに共通の設定は、親キャビネットに定義し、複数バインダに対して独自に設定をしたい場合は、新たにキャビネットを作成し、定義してください。
親キャビネットで未設定の定義が子キャビネットに設定されている場合は、子キャビネットの範囲で設定が有効になります。
■ 表示制御と機能制御の各種設定
バインダの文書アクセス権限を無効にする設定 (Ver.3.2.0の追加機能)
バインダの文書アクセス権限を無効にするユーザ・グループを設定ファイルで指定可能にしました。設定によって権限が無効になったユーザが対象の文書にアクセスした場合、「権限がありません。」というメッセージの画面が表示されます。
- 無効になる文書アクセス権は、文書の登録、閲覧、編集、削除、一括操作です。
- properties-definition.xmlに文書アクセス権限を無効にしたいユーザのMID、またはグループのGIDをカンマ区切りで記載します。
- グループのGIDを指定した場合は、そのグループにプライマリ所属するユーザとセカンダリ所属するユーザともに、文書アクセス権限が無効となります。
- 設定の対象範囲はキャビネットIDまたはバインダIDで指定します。
- 親キャビネットの設定は、そのキャビネットに含まれる全ての子キャビネットとバインダに反映されます。
- 親キャビネットと子キャビネットで異なる定義をした場合は、親キャビネットの設定が優先されます。
- 本設定は既存のバインダ属性の上位設定になります。
- 設定を反映するにはtomcatの再起動が必要です。
表 バインダの文書アクセス権限を無効にする設定
親要素 | permission-restrict | ||
---|---|---|---|
要素 | 名称 | 既定値 | 説明 |
document-operation-restrict-account | なし | GIDまたはMIDを指定。複数の場合はカンマ区切りで指定。 |
記述例:
PatternAが適用されるバインダID 10001のバインダに登録された文書のアクセスをMIDが1000126のユーザとGIDが2000012のグループに所属するユーザに対して無効にする設定例です。
<binder-properties-def name="PatternA">
<binder-properties-def name="PatternA">
<permission-restrict>
<document-operation-restrict-account>
1000126,2000012
</document-operation-restrict-account>
</permission-restrict>
</binder-properties-def>
文書詳細画面
表 文書詳細画面 文書基本情報 表示設定
親要素 | binder-properties-def | ||
---|---|---|---|
要素 | 名称 | 初期値 | 説明 |
display-detail-info-top | true | 文書詳細画面の文書基本情報の表示制御。 | |
※非表示(false)の場合も、削除完了画面、文書更新履歴画面には表示されます。 |
記述例:
<binder-properties-def name="PatternA">
<display-detail-info-top>false</display-detail-info-top>
</binder-properties-def>
印刷制限(文書一覧、文書詳細)
表 印刷許可設定
親要素 | print-feature | ||
---|---|---|---|
要素 | 名称 | 初期値 | 説明 |
enable-printer | true | 印刷許可設定 | |
enable-printer-restrict-account | false | 印刷許可設定 ユーザー制御設定 trueの場合印刷のユーザー制御を行う |
|
printer-restrict-account-list | なし | [enable-printer-restrict-account]がtrueの場合に有効。 印刷を許可するユーザのアカウントIDをカンマ区切りで記述する。未設定の場合は、どのユーザにも許可されない。 記述例:20000,10026,…. |
記述例:
<binder-properties-def name="PatternA">
<print-feature>
<enable-printer>false</enable-printer>
<enable-printer-restrict-account>true</enable-printer-restrict-account>
<printer-restrict-account-list>2000000,2000100,1000000
</printer-restrict-account-list>
</print-feature>
</binder-properties-def>
CSV出力
CSV簡易出力設定は、この機能を有効にすると、文書一覧画面からのCSV出力で、ダウンロードファイル選択画面を表示せずに、CSV出力を行います。この機能は、CSV出力バックグラウンド化機能、関連ファイル出力機能、パスワード保護機能との併用はできません。
CSV出力のカスタムボタン設定は、任意のボタンを表示してアドオン処理を追加することができます。本設定に関しては『SmartDB Ver.3.2.0 リリースノート』の『2-5-1 CSV出力拡張ExtensionPointsの追加』も併せてご参照ください。
表 CSV簡易出力設定
親要素 | csv.export | ||
---|---|---|---|
要素 | 名称 | 初期値 | 説明 |
enable-direct-csv-download | false | CSV簡易出力設定 trueの場合、文書一覧からCSVの簡易出力を行う |
|
charset | Shift_JIS | CSV簡易出力設定時の文字コード Shift_JISもしくはUTF-8 を設定する |
|
custom-csv-button-factory | order | カスタムボタンの並び順。任意の数値(int)を指定。 指定した値の昇順に左から順に配置される。 |
|
path | カスタムボタンファクトリーパス ※本設定に関しては『SmartDB Ver.3.2.0 リリースノート』の『2-5-1 CSV出力拡張ExtensionPointsの追加』も併せてご参照ください |
記述例:
<binder-properties-def name="PatternA">
<csv>
<export>
<enable-direct-csv-download>true</enable-direct-csv-download>
<charset>Shift_JIS</charset>
<custom-csv-button-factory order="1" path="jp.co.dreamarts.hibiki.smartdb.sample.csv2excel.CSV2ExcelButtonFactory"/>
</export>
</csv>
</binder-properties-def>
プロセスに関する設定
表 業務開始ダイアログの表示設定
業務開始画面 | |||
---|---|---|---|
親要素 | workflow | ||
要素 | 名称 | 初期値 | 説明 |
display-workflow-start-dialog | true | 業務開始ダイアログの表示設定。 非表示(false)にした場合も、確認メッセージ画面と複数のプロセスが定義された場合の業務開始画面は表示されます。 |
|
操作ボタン位置 | |||
親要素 | workflow.operate-button-position | ||
要素 | enable-use-form-setting | true | 実施画面、実施完了画面の操作ボタン位置は フォーム属性の操作ボタンの位置の設定を反映する。 ※display-positionの設定を反映させるためには、"false"にする必要があります。 |
display-position | bottom | 上のみ(top)、下のみ(bottom)、両方(both)のいずれかを設定する。 ※display-positionの設定を反映させるためには、enable-use-form-settingを"false"にする必要があります。 |
|
実施画面 | |||
親要素 | workflow.activity-execute | ||
要素 | display-basic-info | true | アクティビティ基本情報 |
display-activity-basic-info | true | アクティビティ名、実施日時、実施コメント、実施立場の候補 | |
display-recalc-button | true | 再計算ボタン | |
実施完了画面 | |||
親要素 | workflow.activity-receipt | ||
要素 | display-basic-info | true | アクティビティ基本情報 |
display-event-handler-info | false | イベントハンドラ | |
display-doc-link | true | 最新文書欄 | |
display-principal | true | 実際の担当者 | |
display-activity-basic-info | true | 実施者、実施日時、実施アクション、履歴文書、コメント |
記述例:
<workflow>
<!-- 業務開始ダイアログ 表示設定 --> <display-workflow-start-dialog>false</display-workflow-start-dialog>
<!-- 操作ボタン連動設定 -->
<operate-button-position>
<enable-use-form-setting>false</enable-use-form-setting>
</operate-button-position>
<!-- 実施画面の項目表示設定 -->
<activity-execute>
<display-basic-info>false</display-basic-info>
<display-activity-basic-info>false</display-activity-basic-info>
<display-recalc-button>false</display-recalc-button>
</activity-execute>
<!-- 実施完了画面の項目表示設定 -->
<activity-receipt>
<display-basic-info> false </display-basic-info>
<display-event-handler-info> false </display-event-handler-info>
<display-doc-link> false </display-doc-link>
<display-principal>false</display-principal>
<display-activity-basic-info>false</display-activity-basic-info>
</activity-receipt>
</workflow>