メタデータ API 開発者ガイド
jFieldRestrictionRule
項目セットに項目が含まれているかどうかで、その項目をユーザーに表示するかどうかを制御する項目の表示ルールを表します。拡張個人情報管理の設定が Spring ’22 より前から有効になっている場合、項目の表示は項目のコンプライアンス分類に基づきます。Metadata メタデータ型を拡張し、その fullName 項目を継承します。
ファイルのサフィックスおよびディレクトリの場所
FieldRestrictionRule コンポーネントにはサフィックス .rule が付けられ、fieldRestrictionRules フォルダーに保存されます。
バージョン
FieldRestrictionRule コンポーネントは、API バージョン 52.0 以降で使用できます。
特別なアクセスルール
- この種別にアクセスするには、「共有を管理」権限が必要です。
- 従業員項目の表示ルールを作成して管理するには、Workplace Command Center 権限セットライセンスと「Workplace Command Center 機能へのアクセス権の付与」システム権限が割り当てられている必要があります。
- ユーザー項目の表示ルールを作成して管理するには、[デジタルエクスペリエンス] および [拡張個人情報管理] 機能を有効にする必要があります。
項目
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| active | boolean | ルールが有効であるか (true)、否か (false) を示します。デフォルト値は false です。 |
| classification | string[] | 必須。ルールの対象であるデータ分類のコンプライアンス分類または項目セット。ルールは、この分類でマークされている項目、またはこの項目セットに含まれている項目に適用されます。Spring '22 (API バージョン 54.0) より前に [拡張個人情報管理] を有効にしている場合は、Salesforce のデフォルトのコンプライアンス分類値を使用することも、自分で追加した値を使用することもできます。Spring '22 (API バージョン 54.0) より後に [拡張個人情報管理] を有効にした場合は、PersonalInfo_EPIM 項目セットか、独自に追加した項目セットを使用します。 |
| classificationType | ClassificationType (string 型の列挙) | 組織使用される分類方法の種別。Spring '22 より前に [拡張個人情報管理] を有効にしている場合は (API バージョン 54.0)、ComplianceCategory を使用します。Spring '22 より後に [拡張個人情報管理] を有効にした場合は、FieldSet を使用します。
|
| description | string | 必須。ルールの説明。 |
| enforcementType | EnforcementType (string 型の列挙) | 必須。ルールの種別。可能な値は次のとおりです。
|
| masterLabel | string | 必須。ルールの名前。 |
| recordFilter | string | 必須。指定されたユーザーに表示する項目を決定する条件。たとえば、この項目では、ログインユーザーが従業員 ID に一致するかどうかを検査できます。 |
| targetEntity | string | 必須。ルールを作成するオブジェクト。従業員オブジェクトとユーザーオブジェクトのみがサポートされています。 |
| userCriteria | string | 必須。このルールが適用されるユーザー。たとえば、すべての有効ユーザーや、指定されたロールやプロファイルを持つユーザーなどです。 |
| version | int | 必須。ルールのバージョン番号。 |
宣言的なメタデータの定義のサンプル
ComplianceCategory 分類種別を使用する FieldRestrictionRule コンポーネントの例を次に示します。分類値は、Salesforce のデフォルトのコンプライアンス分類の値の 1 つですが、代わりにカスタムコンプライアンス分類値を作成して、使用することもできます。
1<?xml version="1.0" encoding="UTF-8"?>
2<FieldRestrictionRule xmlns="http://soap.sforce.com/2006/04/metadata">
3 <active>true</active>
4 <classification>PII</classification>
5 <classificationType>ComplianceCategory</classificationType>
6 <description>Is Owner of Employee</description>
7 <enforcementType>FieldRestrict</enforcementType>
8 <masterLabel>Is Owner Field Restriction Rule</masterLabel>
9 <recordFilter>OwnerId = $User.Id</recordFilter>
10 <targetEntity>Employee</targetEntity>
11 <userCriteria>$User.IsActive = true</userCriteria>
12 <version>1</version>
13</FieldRestrictionRule>FieldSet 分類種別を使用する FieldRestrictionRule コンポーネントの例を次に示します。分類値は、個人情報に対する Salesforce のデフォルトの項目セットですが、代わりに項目セットを作成して、使用することもできます。
1<?xml version="1.0" encoding="UTF-8"?>
2<FieldRestrictionRule xmlns="http://soap.sforce.com/2006/04/metadata">
3 <active>true</active>
4 <classification>PersonalInfo_EPIM</classification>
5 <classificationType>FieldSet</classificationType>
6 <description>Is Owner of Employee</description>
7 <enforcementType>FieldRestrict</enforcementType>
8 <masterLabel>Is Owner Field Restriction Rule</masterLabel>
9 <recordFilter>OwnerId = $User.Id</recordFilter>
10 <targetEntity>Employee</targetEntity>
11 <userCriteria>$User.IsActive = true</userCriteria>
12 <version>1</version>
13</FieldRestrictionRule>前の定義を参照する package.xml の例を次に示します。
1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3 <types>
4 <members>*</members>
5 <name>FieldRestrictionRule</name>
6 </types>
7 <version>52.0</version>
8</Package>