intra-mart Accel Platform 設定ファイルリファレンス 第22版 2019-04-01

認可設定画面設定

概要

認可設定画面の設定を行います。
モジュール テナント管理機能
フォーマットファイル(xsd) WEB-INF/schema/authz-editor-config.xsd
設定場所 WEB-INF/conf/authz-editor-config.xml

<?xml version="1.0" encoding="UTF-8"?>
<authz-editor-config
    xmlns="http://www.intra-mart.jp/authz/authz-editor-config"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://www.intra-mart.jp/authz/authz-editor-config ../schema/authz-editor-config.xsd ">
  <policy-update>
    <cache-update-error rollback="true" />
  </policy-update>
  <resource-group-update>
    <cache-update-error rollback="true" />
  </resource-group-update>
  <resource-group-backup>
    <path>im_authz/backup</path>
    <max-size>10</max-size>
  </resource-group-backup>
  <xlsx-import>
    <path>im_authz/xlsx_import</path>
    <commit-count>0</commit-count>
    <validate-inherits>false</validate-inherits>
    <validate-resource-exists>true</validate-resource-exists>
    <validate-subject-exists>false</validate-subject-exists>
    <max-size>10</max-size>
  </xlsx-import>
  <xlsx-export>
    <template-file>products/im_authz_xlsx_import_export/authz_template.xlsx</template-file>
    <path>im_authz/xlsx_export</path>
    <file-name>yyyyMMdd_HHmmss</file-name>
    <file-ext>.xlsx</file-ext>
    <max-size>10</max-size>
    <xlsx-password>intramart</xlsx-password>
  </xlsx-export>
</authz-editor-config>

リファレンス

認可ポリシー更新処理設定

タグ名 policy-update
認可ポリシー更新時の処理の設定を行います。

【設定項目】

<authz-editor-config>
  <policy-update>
    ...
  </policy-update>
</authz-editor-config>

必須項目 ×
複数設定 ×
設定値・設定する内容 なし
単位・型 なし
省略時のデフォルト値 なし
親タグ authz-editor-config

キャッシュ更新エラー設定(認可ポリシー)

タグ名 cache-update-error
認可ポリシーのキャッシュ更新によるエラー時の挙動について設定します。

【設定項目】

<authz-editor-config>
  <policy-update>
    <cache-update-error rollback="true" />
  </policy-update>
</authz-editor-config>

必須項目 ×
複数設定 ×
設定値・設定する内容 なし
単位・型 なし
省略時のデフォルト値 なし
親タグ policy-update

【属性】

属性名 説明 必須 デフォルト値
rollback キャッシュ更新失敗し認可ポリシーの更新をロールバックするかどうかを設定します。 × true

認可リソースグループ更新処理設定

タグ名 resource-group-update
認可リソースグループ更新時の処理の設定を行います。

【設定項目】

<authz-editor-config>
  <resource-group-update>
    ...
  </resource-group-update>
</authz-editor-config>

必須項目 ×
複数設定 ×
設定値・設定する内容 なし
単位・型 なし
省略時のデフォルト値 なし
親タグ authz-editor-config

キャッシュ更新エラー設定(認可リソースグループ)

タグ名 cache-update-error
認可リソースグループのキャッシュ更新によるエラー時の挙動について設定します。

【設定項目】

<authz-editor-config>
  <resource-group-update>
    <cache-update-error rollback="true" />
  </resource-group-update>
</authz-editor-config>

必須項目 ×
複数設定 ×
設定値・設定する内容 なし
単位・型 なし
省略時のデフォルト値 なし
親タグ resource-group-update

【属性】

属性名 説明 必須 デフォルト値
rollback キャッシュ更新失敗し認可リソースグループの更新をロールバックするかどうかを設定します。 × true

リソースグループバックアップ設定

タグ名 resource-group-backup
リソースグループと、紐づくリソースを削除した場合に、関係する認可設定を自動でバックアップするための設定です。

【設定項目】

<authz-editor-config>
  <resource-group-backup>
    ...
  </resource-group-backup>
</authz-editor-config>

必須項目 ×
複数設定 ×
設定値・設定する内容 なし
単位・型 なし
省略時のデフォルト値 なし
親タグ authz-editor-config

バックアップ先パス設定

タグ名 path
バックアップした認可設定のファイルを保存する場所について設定します。
パブリックストレージのルートからの相対パスです。

【設定項目】

<authz-editor-config>
  <resource-group-backup>
    <path>im_authz/backup</path>
  </resource-group-backup>
</authz-editor-config>

必須項目 ×
複数設定 ×
設定値・設定する内容 パブリックストレージのルートからの相対パスを指定します。
単位・型 文字列
省略時のデフォルト値 im_authz/backup
親タグ resource-group-backup

バックアップ最大件数設定

タグ名 max-size
バックアップとして認可設定のファイルを保存する最大件数について設定します。
0 を指定した場合は、保存件数は無制限です。この場合、パブリックストレージの容量不足に注意してください。

【設定項目】

<authz-editor-config>
  <resource-group-backup>
    <max-size>30</max-size>
  </resource-group-backup>
</authz-editor-config>

必須項目 ×
複数設定 ×
設定値・設定する内容 バックアップを残す最大件数を指定します。
単位・型 数値
省略時のデフォルト値 30
親タグ resource-group-backup

Excelインポート設定

タグ名 xlsx-import
認可設定画面上からExcelファイルを用いて認可設定のインポートを行う際に利用する設定です。

【設定項目】

<authz-editor-config>
  <xlsx-import>
    ...
  </xlsx-import>
</authz-editor-config>

必須項目 ×
複数設定 ×
設定値・設定する内容 なし
単位・型 なし
省略時のデフォルト値 なし
親タグ authz-editor-config

Excelインポート処理結果配置パス設定

タグ名 path
Excelインポート処理の処理結果が保存されているJSON形式のファイルを配置する場所を設定します。
ファイルはパブリックストレージに配置されるため、パブリックストレージのルートからの相対パスを設定してください。
認可設定画面にてExcelインポートを行う際にアップロードを行ったExcelファイルもこのパス配下に配置されます。(ただし、インポート後に自動的に削除されます。)

【設定項目】

<authz-editor-config>
  <xlsx-import>
    <path>im_authz/xlsx_import</path>
  </xlsx-import>
</authz-editor-config>

必須項目 ×
複数設定 ×
設定値・設定する内容 Excelインポート処理結果ファイルを格納する場所を、パブリックストレージのルートからの相対パスで指定します。
単位・型 文字列
省略時のデフォルト値 im_authz/xlsx_import
親タグ xlsx-import

Excelインポートコミット間隔設定

タグ名 commit-count
インポート処理で、認可ポリシー変更(追加・更新・削除を指します)を行った後にデータベース・トランザクションのコミットを行うまでの件数を設定します。
例えば、10 を指定した場合は 10 件の認可ポリシーを変更する度にデータベース・トランザクションのコミットを行います。
0 以下を指定した場合、インポート処理が完了するまでコミットが行われません。
インポート処理にてコミットを行う順序については、「IM-Authz(認可)インポート・エクスポート仕様書」-「Excel(xlsx)」を参照してください。

【設定項目】

<authz-editor-config>
  <xlsx-import>
    <commit-count>0</commit-count>
  </xlsx-import>
</authz-editor-config>

必須項目 ×
複数設定 ×
設定値・設定する内容 コミットを行うまでのポリシー変更件数
単位・型 数値
省略時のデフォルト値 0
親タグ xlsx-import

未設定認可ポリシー検証設定

タグ名 validate-inherits
インポートファイルにて明示的に「許可」/「禁止」を設定されていない認可ポリシーに対して検証を行うかどうかを設定します。
検証は、インポートファイルの編集者のミスなどにより意図しない認可ポリシーが反映されないようにするために行います。
検証を行う場合、「許可」/「禁止」以外が設定されている認可ポリシーのセルに対して、以下の条件に当てはまらない場合はインポートエラーとします。
  • セルの内容が「未設定(継承した結果、許可)」であり、セルの上位リソースグループが「許可」または「未設定(継承した結果、許可)」である。
  • セルの内容が「未設定(継承した結果、禁止)」であり、セルの上位リソースグループが「禁止」または「未設定(継承した結果、禁止)」である。
未設定認可ポリシー検証設定によるインポート時の挙動の違いについての詳細は、「IM-Authz(認可)インポート・エクスポート仕様書」-「Excel(xlsx)」を参照してください。

【設定項目】

<authz-editor-config>
  <xlsx-import>
    <validate-inherits>false</validate-inherits>
  </xlsx-import>
</authz-editor-config>

必須項目 ×
複数設定 ×
設定値・設定する内容 未設定である認可ポリシーセルの検証を行うかどうかを設定します。
単位・型 真偽値(true/false)
省略時のデフォルト値 false
親タグ xlsx-import

リソースグループ・リソース存在検証設定

タグ名 validate-resource-exists
インポートするExcel(xlsx)ファイルに定義されたリソースグループ・リソースに関するデータが登録されているかどうか検証します。
検証を行う場合、存在しないリソースグループ・リソースが定義されていた場合、エラー扱いとしてインポート処理を中断します。

【設定項目】

<authz-editor-config>
  <xlsx-import>
    <validate-resource-exists>true</validate-resource-exists>
  </xlsx-import>
</authz-editor-config>

必須項目 ×
複数設定 ×
設定値・設定する内容 リソースグループ・リソース存在検証を行うかどうかを設定します。
単位・型 真偽値(true/false)
省略時のデフォルト値 true
親タグ xlsx-import

サブジェクトグループ存在検証設定

タグ名 validate-subject-exists
インポートするExcel(xlsx)ファイルに定義されたサブジェクトグループに関するデータが登録されているかどうか検証します。
存在しないサブジェクトグループが定義されていた場合、エラー扱いとしてインポート処理を中断します。

【設定項目】

<authz-editor-config>
  <xlsx-import>
    <validate-subject-exists>false</validate-subject-exists>
  </xlsx-import>
</authz-editor-config>

必須項目 ×
複数設定 ×
設定値・設定する内容 サブジェクトグループを行うかどうかを設定します。
単位・型 真偽値(true/false)
省略時のデフォルト値 false
親タグ xlsx-import

Excelインポート処理の処理結果ファイル数設定

タグ名 max-size
Excelインポート処理の処理結果ファイルを保存するファイル数を設定します。
Excelインポート処理の処理結果ファイルの数が設定値を超えた場合、古い順にファイルの削除を行います。
「認可設定」画面のインポート結果一覧に表示される結果数はこの設定で指定した値が表示されます。
0 以下を指定した場合は、保存件数は無制限です。この場合、パブリックストレージの容量不足に注意してください。

【設定項目】

<authz-editor-config>
  <xlsx-import>
    <max-size>10</max-size>
  </xlsx-import>
</authz-editor-config>

必須項目 ×
複数設定 ×
設定値・設定する内容 Excelインポート処理の処理結果のファイル数
単位・型 数値
省略時のデフォルト値 10
親タグ xlsx-import

Excelエクスポート設定

タグ名 xlsx-export
認可設定画面上からExcelファイルを用いて認可設定のエクスポートを行う際に利用する設定です。

【設定項目】

<authz-editor-config>
  <xlsx-export>
    ...
  </xlsx-export>
</authz-editor-config>

必須項目 ×
複数設定 ×
設定値・設定する内容 なし
単位・型 なし
省略時のデフォルト値 なし
親タグ authz-editor-config

テンプレートファイル設定

タグ名 template-file
エクスポートするExcel(xlsx)ファイルを作成するための、テンプレートファイルのパス(パブリックストレージのルートからの相対パス)を指定します。

【設定項目】

<authz-editor-config>
  <xlsx-export>
    <template-file>products/im_authz_xlsx_import_export/authz_template.xlsx</template-file>
  </xlsx-export>
</authz-editor-config>

必須項目 ×
複数設定 ×
設定値・設定する内容 エクスポートするExcel(xlsx)ファイルを作成するための、テンプレートファイルのパスをパブリックストレージのルートからの相対パスで指定します。
単位・型 文字列
省略時のデフォルト値 products/im_authz_xlsx_import_export/authz_template.xlsx
親タグ xlsx-export

Excelエクスポートファイル配置パス設定

タグ名 path
Excelエクスポートを行い出力されるファイルを配置する場所を設定します。
ファイルはパブリックストレージに配置されるため、パブリックストレージのルートからの相対パスを設定してください。

【設定項目】

<authz-editor-config>
  <xlsx-export>
    <path>im_authz/xlsx_export</path>
  </xlsx-export>
</authz-editor-config>

必須項目 ×
複数設定 ×
設定値・設定する内容 Excelエクスポートされたファイルを格納する場所を、パブリックストレージのルートからの相対パスで指定します。
単位・型 文字列
省略時のデフォルト値 im_auhtz/xlsx
親タグ xlsx-export

Excelエクスポートファイル名設定

タグ名 file-name
Excelエクスポートされたファイルのファイル名を設定します。
ファイル名には、日付と時刻のフォーマットパターンを利用することが可能です。利用可能なフォーマットは java.text.SimpleDateFormat で利用可能なパターンです。詳細は、SimpleDateFormat のJavaDocを参照してください。

【設定項目】

<authz-editor-config>
  <xlsx-export>
    <file-name>yyyyMMdd_HHmmss</file-name>
  </xlsx-export>
</authz-editor-config>

必須項目 ×
複数設定 ×
設定値・設定する内容 エクスポートするExcelファイルのファイル名を設定します。
単位・型 文字列
省略時のデフォルト値 yyyyMMdd_HHmmss
親タグ xlsx-export

Excelエクスポートファイル拡張子設定

タグ名 file-ext
Excelエクスポートされたファイルの拡張子を設定します。
設定値に置換文字列が利用可能です。利用可能な置換文字列は以下の通りです。
  • {^userCd^} : 出力操作を行ったユーザコード
  • {^partId^} : 出力した part-id

【設定項目】

<authz-editor-config>
  <xlsx-export>
    <file-ext>.xlsx</file-ext>
  </xlsx-export>
</authz-editor-config>

必須項目 ×
複数設定 ×
設定値・設定する内容 エクスポートするExcelファイルの拡張子を設定します。
単位・型 文字列
省略時のデフォルト値 .xlsx
親タグ xlsx-export

Excelエクスポート保存ファイル数設定

タグ名 max-size
Excelエクスポートを行い出力されるファイルを保存するファイル数を設定します。
Excelエクスポートを行い出力されるファイルの数が設定値を超えた場合、古い順にファイルの削除を行います。
「認可設定」画面のエクスポート済みファイル一覧に表示される結果数はこの設定で指定した値が表示されます。
0 以下を指定した場合、保存件数は無制限です。この場合、パブリックストレージの容量不足に注意してください。

【設定項目】

<authz-editor-config>
  <xlsx-export>
    <max-size>10</max-size>
  </xlsx-export>
</authz-editor-config>

必須項目 ×
複数設定 ×
設定値・設定する内容 Excelエクスポートを行い出力されるファイルの数が
単位・型 数値
省略時のデフォルト値 10
親タグ xlsx-export

保護パスワード設定

タグ名 xlsx-password
エクスポートするExcel(xlsx)ファイルの変更不可部分を保護するパスワードを指定します。
指定しない場合、保護パスワードはかからず行・列の追加・更新・削除が可能になりますが、実際に行うとインポート時にエラーが発生する原因となります。

【設定項目】

<authz-editor-config>
  <xlsx-export>
    <xlsx-password>intramart</xlsx-password>
  </xlsx-export>
</authz-editor-config>

必須項目 ×
複数設定 ×
設定値・設定する内容 保護するパスワードの値を設定します。
単位・型 文字列
省略時のデフォルト値 intramart
親タグ xlsx-export