メタデータ API 開発者ガイド
jFolderShare
拡張分析フォルダーの共有設定を表します。レポートまたはダッシュボードを含むフォルダーへの閲覧者、エディターまたはマネージャーアクセス権を他のユーザーに付与することにより、レポートまたはダッシュボードへのアクセスを制御できます。
ファイルのサフィックスおよびディレクトリの場所
FolderShare オブジェクトは、reports ディレクトリと dashboards ディレクトリに保存されます。ディレクトリに含まれるレポートフォルダーまたはダッシュボードフォルダーごとに、FolderName-meta.xml という名前のメタデータファイルがあります。FolderName-meta.xml メタデータファイルには、accessLevel など、そのフォルダーのメタデータ情報が含まれます。たとえば、reports ディレクトリに myReportsFolder というレポートフォルダーがある場合、myReportsFolder と同じレベルに myReportsFolder-meta.xml ファイルもあります。
バージョン
FolderShare コンポーネントは、API バージョン 28 以降で使用できます。
項目
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| accessLevel | FolderShareAccessLevel (string 型の列挙) | 必須。フォルダーで実行できるアクションの組み合わせを指定します。有効な値は、次のとおりです。
|
| sharedTo | string | 必須。フォルダーに対して指定されたアクセス権を持つユーザー、グループ、またはロールを指定します。 |
| sharedToType | FolderSharedToType (string 型の列挙) | 必須。フォルダーを共有するエンティティの種別を指定します。有効な値は、次のとおりです。
|
宣言的なメタデータの定義のサンプル
次に、ダッシュボードフォルダーの FolderShare コンポーネントの例を示します。
1<?xml version="1.0" encoding="UTF-8"?>
2<DashboardFolder xmlns="http://soap.sforce.com/2006/04/metadata">
3 <folderShares>
4 <accessLevel>View</accessLevel>
5 <sharedTo>R1</sharedTo>
6 <sharedToType>Role</sharedToType>
7 </folderShares>
8</DashboardFolder>次に、レポートフォルダーの FolderShare コンポーネントの例を示します。
1<?xml version="1.0" encoding="UTF-8"?>
2<ReportFolder xmlns="http://soap.sforce.com/2006/04/metadata">
3 <folderShares>
4 <accessLevel>View</accessLevel>
5 <sharedTo>R1</sharedTo>
6 <sharedToType>Role</sharedToType>
7 </folderShares>
8</ReportFolder>マニフェストファイル内のワイルドカードのサポート
このメタデータ型では、package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) はサポートされません。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。