intra-mart Accel Platform IM-Authz(認可)インポート・エクスポート仕様書 第4版 2019-08-01

5. インポート

更新モード

更新モードを使用することで、インポートの目的にあわせたデータの更新を行うことができます。
更新モードには、「merge」、および、「replace」が提供されています。
XML形式の場合、ポリシーを除いて、update-mode 属性を指定することでモードを設定します。
Excel(xlsx)形式の場合、更新モードの指定はありません。

merge

インポートファイルのデータとデータベース上のデータをマージして更新します。
インポートファイルに存在しない項目は既存のデータをそのまま設定します。

replace

インポートファイルのデータに存在しない情報は未設定の値(デフォルト値)で更新します。
インポートファイルに存在しない項目は値無しとして設定されます。

リソースグループ

XML

XML形式では、<authz-resource-group> タグを1レコードとしてインポートします。
ファイルのフォーマットについては「XMLファイル形式 」を参照してください。
インポート時の動作をオプションとして指定が可能です。
インポート時に利用可能なオプションについては、「XMLのオプション 」を参照してください。

更新モード

リソースグループの更新モードには「merge 」、「replace 」が提供されています。
update-mode 属性は、<authz-resource-group> タグに指定します。
特に指定していない場合、「merge」モードで動作します。

merge

未登録ロケールの表示名、または、説明を追加する場合に使用します。
更新対象のリソースグループ配下に子のリソースグループが登録されていた場合、 子のリソースグループには影響しません。
../../_images/import_2.png

図 mergeモードによるインポート結果のイメージ

replace

既存の表示名、または、説明を削除して、新たに登録する場合に使用します。
更新対象のリソースグループ配下に子のリソースグループが登録されていた場合、子のリソースグループはすべて削除されます。
../../_images/import_3.png

図 replaceモードによるインポート結果のイメージ

インポートの依存関係

リソースグループをインポートする際、指定した親となるリソースグループをあらかじめ登録してください。
同じインポートファイル内で親子を定義する場合は、親を子よりもファイルの先頭側に定義してください。
親となるリソースグループが登録されていない場合、エラー E.IWP.AUTHZ.IMPORT.10010 が発生します。

リソース

XML

XML形式では、<authz-resource> タグを1レコードとしてインポートします。
ファイルのフォーマットについては「XMLファイル形式 」を参照してください。
インポート時の動作をオプションとして指定が可能です。
インポート時に利用可能なオプションについては、「XMLのオプション 」を参照してください。

注意

<authz-resource> タグの id 属性に指定されたIDがキーとなり更新処理が行われますが、id 属性が指定されなかった場合は uri 属性に指定されたURIをもとに、URIで一意になるIDが自動的に作成され、IDとして使用されます。
IDと同様に、URIもテナント内で一意になるように指定する必要があります。

更新モード

リソースの更新モードには「merge 」、「replace 」が提供されています。
update-mode 属性は、<authz-resource> タグに指定します。
特に指定していない場合、「merge」モードで動作します。

merge

未登録ロケールの表示名、または、説明を追加する場合に使用します。
../../_images/import_4.png

図 mergeモードによるインポート結果のイメージ

replace

既存の表示名、または、説明を削除して、新たに登録する場合に使用します。
../../_images/import_5.png

図 replaceモードによるインポート結果のイメージ

インポートの依存関係

リソースをインポートする際、指定した親となるリソースグループをあらかじめ登録する必要があります。
同じインポートファイル内で親子を定義する場合は、親を子よりもファイルの先頭側に定義してください。
親となるリソースグループが登録されていない場合、エラー E.IWP.AUTHZ.IMPORT.10007 が発生します。

サブジェクトグループ

XML

XML形式では、<authz-subject-group> タグを1レコードとしてインポートします。
ファイルのフォーマットについては「XMLファイル形式 」を参照してください。
インポート時の動作をオプションとして指定が可能です。
インポート時に利用可能なオプションについては、「XMLのオプション 」を参照してください。

更新モード

サブジェクトグループの更新モードには「merge 」、「replace 」が提供されています。
update-mode 属性は、<authz-subject-group> タグに指定します。
特に指定していない場合、「merge」モードで動作します。

merge

未登録ロケールの表示名、または、説明を追加する場合に使用します。
../../_images/import_6.png

図 mergeモードによるインポート結果のイメージ

replace

既存の表示名、または、説明を削除して、新たに登録する場合に使用します。
../../_images/import_7.png

図 replaceモードによるインポート結果のイメージ

インポートの依存関係

サブジェクトグループをインポートする際、特に依存するデータはありませんが、サブジェクトの条件式に指定する対象者データをあらかじめ登録しておくことをお勧めします。
例えば、S(b_m_role:tenant_manager) を条件式に指定する場合、あらかじめ「tenant_manager」のIDでロールを作成してください。

ポリシー

XML

XML形式では、<authz-policy> タグを1レコードとしてインポートします。
ファイルのフォーマットについては「XMLファイル形式 」を参照してください。
インポート時の動作をオプションとして指定が可能です。
インポート時に利用可能なオプションについては、「XMLのオプション 」を参照してください。

Excel(xlsx)

Excel(xlsx)形式では、シート上のポリシー部分(下図の赤枠部分)の1セルを1レコードとしてインポートします。
インポート時は、左上のセルを開始点として右方向へ走査し、順次下方向へ進みインポートが行われます。
ファイルのフォーマットについては「Excel(xlsx)形式 」を参照してください。
../../_images/import_1.png

図 Excel(xlsx)形式で出力したファイルのポリシー部分

インポート時の動作をオプションとして指定が可能です。
インポート時に利用可能なオプションについては、「Excel(xlsx)のオプション 」を参照してください。
intra-mart Accel Platform で用意されているデフォルトのテンプレートを使用した場合、ポリシー部分に指定可能な文字列は、以下の通りです。
また、「未設定認可ポリシー検証フラグ 」の設定値によってチェック内容が変わります。
設定値 説明 未設定認可ポリシー検証フラグ 」= true 未設定認可ポリシー検証フラグ 」= false
許可 「許可」として更新します。 「許可」として更新します。
× 禁止 「禁止」として更新します。 「禁止」として更新します。
↑レ 未設定(親リソースを継承した結果、許可) 継承結果が「許可」以外の場合、エラー E.IWP.AUTHZ.XLSX.21012 が発生します。 継承結果にかかわらず、「未設定」として更新します。
↑× 未設定(親リソースを継承した結果、禁止) 継承結果が「禁止」以外の場合、エラー E.IWP.AUTHZ.XLSX.21013 が発生します。 継承結果にかかわらず、「未設定」として更新します。
上記以外 不明な指定 必ずエラー E.IWP.AUTHZ.XLSX.21014 が発生します。 更新しません。

更新モード

ポリシーの場合、更新モード指定はできず、常にインポートデータで上書きされます。
リソースグループ・リソース・サブジェクトグループのインポートとは異なり、 エフェクトに「未設定」が定義されている場合は、該当するポリシーが削除されます。
ただし、インポートデータに含まれないキーのポリシーには影響しません。
../../_images/import_8.png

図 インポート結果のイメージ

インポートの依存関係

ポリシーをインポートする際、エフェクトの設定対象となるリソースグループ、リソースをあらかじめ登録する必要があります。
また、存在しないリソースタイプID、アクションIDを指定することはできません。
エフェクトの設定対象となるリソースグループ、または、リソースが登録されていない場合の動作は以下のとおりです。
ファイル形式 動作
XML形式 エラー E.IWP.AUTHZ.IMPORT.10001 が発生します。
Excel(xlsx)形式
エラー E.IWP.AUTHZ.XLSX.21006 が発生します。
リソースグループ・リソース存在検証フラグ 」に false を設定している場合は、無視します。
エフェクトの設定対象となるリソースタイプIDが存在しない場合の動作は以下のとおりです。
ファイル形式 動作
XML形式 エラー E.IWP.AUTHZ.IMPORT.10002 が発生します。
Excel(xlsx)形式
エラー E.IWP.AUTHZ.XLSX.21008 が発生します。
リソースグループ・リソース存在検証フラグ 」に false を設定している場合は、無視します。
エフェクトの設定対象となるアクションIDが存在しない場合の動作は以下のとおりです。
ファイル形式 動作
XML形式 システムエラーが発生します。
Excel(xlsx)形式
エラー E.IWP.AUTHZ.XLSX.21009 が発生します。
リソースグループ・リソース存在検証フラグ 」に false を設定している場合は、無視します。
エフェクトの設定対象となるサブジェクトグループが登録されていない場合の動作は以下のとおりです。
ファイル形式 動作
XML形式 指定されている条件式でサブジェクトグループが作成されますが、名称が設定されません。
Excel(xlsx)形式
エラー E.IWP.AUTHZ.XLSX.21010、または、E.IWP.AUTHZ.XLSX.21011 が発生します。
サブジェクトグループ存在検証フラグ 」に false を設定している場合は、無視します。

ポリシーの置換インポート

XML形式を使用してインポートする場合、明示的に「未設定」をエフェクトに指定した場合に限り、ポリシーの削除処理を行います。
そのため、「未設定」のエフェクトを指定していないXML形式のファイルを使用してシステム全体のポリシーを完全に置き換えるために、「認可(ポリシー)置換インポート」ジョブネットを使用できます。