メタデータ API 開発者ガイド
jAnalyticsSettings
ファイルのサフィックスおよびディレクトリの場所
AnalyticsSettings の値は、settings フォルダの Analytics.settings ファイルに保存されます。.settings ファイルは、各設定コンポーネントに設定ファイルが 1 つしかないため、他の名前つきのコンポーネントとは異なります。
バージョン
AnalyticsSettings コンポーネントは、API バージョン 46.0 以降で使用できます。
特別なアクセスルール
AnalyticsSettings メタデータ型は、すべての Salesforce 組織でアクセスできます。レポートおよびダッシュボードに関連する項目はすべての組織で使用できますが、Einstein Analytics に関連する項目は Einstein Analytics が有効になっている組織でのみ使用できます。
項目
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| alwaysGenPreviews | boolean |
Analytics アセットのプレビューが作成されるか (true)、否か (false) を示します。API バージョン 47.0 以降で利用できます。 |
| analyticsAdoptionMetadata | boolean |
Adoption Analytics のメタデータのコレクションをこの組織のデータフローでインストール可能か (true)、否か (false) を示します。API バージョン 47.0 以降で利用できます。 |
| analyticsCalendarApp | boolean |
この組織で、Analytic Calendar App for Industry 連動テンプレートをインストールできるか (true)、否か (false) を示します。API バージョン 49.0 で使用可能。API バージョン 50.0 で削除されました。 |
| canAccessAnalyticsViaAPI | boolean |
この組織の Analytics REST API を使用して Analytics アセットにアクセスできるか (true)、否か (false) を示します。API バージョン 47.0 以降で利用できます。 |
| canAnnotateDashboards | boolean |
この組織で、Analytics ダッシュボードの Chatter アノテーション機能を使用できるか (true)、否か (false) を示します。API バージョン 47.0 以降で利用できます。 |
| canEnableLiveMetrics | boolean |
この組織で、Data Discovery ライブモデル評価指標の計算を使用できるか (true)、否か (false) を示します。API バージョン 48.0 および 49.0 で使用できます。API バージョン 50.0 で削除されました。 |
| canEnableSavedView | boolean |
この組織で、Analytics ダッシュボード用の保存済みビュー機能を使用できるか (true)、否か (false) を示します。API バージョン 47.0 以降で利用できます。 |
| canExploreDataConversationally | boolean |
Analytics データの探索に自然言語クエリ (NLQ) を使用できるか (true)、厳密な SAQL ステートメントを使用しなければならないか (false) を示します。たとえば、「商談成立したすべての取引先を表示」などです。API バージョン 47.0 以降で利用できます。 |
| canShareAppsWithCommunities | boolean |
標準の Analytics Studio エクスペリエンス以外で、Analytics アプリケーションを Experience Builder サイトおよびそのユーザと共有できるか (true)、否か (false) を示します。API バージョン 47.0 以降で利用できます。 |
| canSubscribeDashboardWidgets | boolean |
この組織で、ユーザが Analytics ダッシュボードウィジェットに登録できるか (true)、否か (false) を示します。API バージョン 47.0 ～ 50.0 で使用可能です。API バージョン 51.0 で削除されました。 |
| canViewThumbnailAssets | boolean |
Analytics レンズとダッシュボードのサムネイル表示が表示できるか (true)、否か (false) を示します。API バージョン 47.0 以降で利用できます。 |
| enableAnalyticsEncryption | boolean |
この組織で、暗号化が Analytics に対応するか (true)、否か (false) を示します。API バージョン 48.0 以降で利用できます。 |
| enableAnalyticsSharingEnable | boolean |
この組織で、Analytics 共有を使用できるか (true)、否か (false) を示します。API バージョン 48.0 以降で利用できます。 |
| enableAutoCompleteCombo | boolean |
この組織で、レポートとダッシュボードを選択しているときにオートコンプリートを使用できるか (true)、否か (false) を示します。API バージョン 47.0 以降で利用できます。 |
| enableC360GlobalProfileData | boolean |
この組織で、Customer 360 データ検証ダッシュボードコネクタを使用できるか (true)、否か (false) を示します。API バージョン 48.0 以降で使用できます。 |
| enableDashboardComponentSnapshot | boolean |
この組織で、すべてのユーザに表示されるフィードへ、ダッシュボードコンポーネントスナップショットを投稿できるか (true)、否か (false) を示します。API バージョン 47.0 以降で利用できます。 |
| enableDashboardFlexiTable | boolean |
この組織で、すべてのユーザが柔軟なダッシュボードテーブルにアクセスできるか (true)、否か (false) を示します。API バージョン 47.0 以降で利用できます。 |
| enableDashboardToPDFEnable | boolean |
この組織で、ダッシュボードを PDF にエクスポートできるか (true)、否か (false) を示します。API バージョン 48.0 以降で利用できます。 |
| enableDataBlending | boolean |
この組織で、Analytics エクスプローラのデータブレンド機能を使用できるか (true)、否か (false) を示します。API バージョン 48.0 および 49.0 で使用できます。API バージョン 50.0 で削除されました。 |
| enableEmailReportsToPortalUsers | boolean |
この組織で、Classic のレポートとダッシュボードをポータルユーザに送信できるか (true)、否か (false) を示します。API バージョン 47.0 以降で利用できます。 |
| enableFirebirdEditor | boolean |
この組織で、Firebird エディタを使用できるか (true)、否か (false) を示します。API バージョン 48.0 以降で利用できます。 |
| enableFloatingReportHeaders | boolean |
レポートの結果で、スクロール時にフロート表示のヘッダーが表示されるか (true)、否か (false) を示します。API バージョン 47.0 以降で利用できます。 |
| enableSecureImageSharing | boolean |
この組織で、安全な画像共有およびダウンロードが有効化されているか (true)、否か (false) を示します。API バージョン 50.0 以降で利用できます。 |
| enableInsights | boolean |
この組織で、Einstein Analytics が有効化されているか (true)、否か (false) を示します。 |
| enableLightningReportBuilder | boolean |
この組織で、[設定] ページから Lightning レポートビルダー機能を有効化または無効化できるか (true)、否か (false) を示します。API バージョン 47.0 以降で利用できます。 |
| enableLotusNotesImages | boolean |
この組織で、Lotus Notes 対応の画像をダッシュボードやレポートで使用できるか (true)、否か (false) を示します。API バージョン 47.0 以降で利用できます。 |
| enableMassEnableReportBuilder | boolean |
プロファイルレベルの設定を上書きして、レポートビルダーを組織全体で有効化できるか (true)、否か (false) を示します。API バージョン 47.0 以降で利用できます。 |
| enableNewChartsEngine | boolean |
この組織で、レポートとダッシュボード用に新しいグラフエンジンを使用できるか (true)、否か (false) を示します。API バージョン 47.0 以降で利用できます。 |
| enableNullDimension | boolean |
この組織で、null 値が SAQL クエリのグルーピングキー値としてサポートされているか (true)、否か (false) を示します。API バージョン 48.0 以降で利用できます。 |
| enableOrgHasMobileOfflineEnabled | boolean |
この組織で、システム管理者がモバイルオフラインアクセスを有効化できるか (true)、否か (false) を示します。API バージョン 51.0 以降で利用できます。 |
| enableOrgHasWatchlistEnabled | boolean |
この組織で、システム管理者がアセットのウォッチリストを有効化できるか (true)、否か (false) を示します。API バージョン 50.0 以降で利用できます。 |
| enablePowerInsights | boolean |
この組織で、システム管理者が Power Insights を有効化できるか (true)、否か (false) を示します。API バージョン 51.0 で削除されました。 |
| enableQueryLiveConnectors | boolean |
この組織で、ライブコネクタのクエリが可能か (true)、否か (false) を示します。API バージョン 48.0 以降で利用できます。 |
| enableRemoveFooterForRepDisplay | boolean |
この組織で、レポート実行ページと印刷用表示ページのデフォルトの免責事項は削除されるか (true)、否か (false) を示します組織。API バージョン 47.0 以降で利用できます。 |
| enableRemoveFooterFromRepExp | boolean |
この組織で、エクスポートされた (csv/excel) レポートのデフォルトのフッターが削除されるか (true)、否か (false) を示します。API バージョン 47.0 以降で利用できます。 |
| enableReportFieldToFieldPref | boolean |
この組織で、Lightning Experience のレポートに項目間の検索条件を使用できるか (true)、否か (false) を示します。API バージョン 47.0 で使用可能。API バージョン 48.0 で削除されました。 |
| enableReportCrtAutoAddPref | boolean |
この組織で、新規項目の作成時に関連するカスタム Lightning Experience レポートタイプにその項目を自動的に追加する機能を使用できるか (true)、否か (false) を示します。API バージョン 50.0 以降で利用できます。 |
| enableReportHideXlsExportPref | boolean |
この組織で、Lightning Experience レポートの XLS エクスポート機能が表示されるか (true)、否か (false) を示します。API バージョン 51.0 以降で利用できます。 |
| enableReportNotificationsEnable | boolean |
この組織で、Lightning Experience レポートの通知機能を使用できるか (true)、否か (false) を示します。API バージョン 48.0 以降で利用できます。 |
| enableReportUniqueRowCountPref | boolean |
この組織で、Lightning Experience レポートのユニーク行数集計機能を使用できるか (true)、否か (false) を示します。API バージョン 47.0 で使用可能。API バージョン 48.0 で削除されました。 |
| enableRequestPrioritySchdl | boolean |
この組織で、優先度ベースのデータフロー要求スケジュールを使用できるか (true)、否か (false) を示します。API バージョン v50.0 以降で利用できます。 |
| enableS1AnalyticsEclairEnable | boolean |
この組織で、S1 Mobile Analytics の EclairNG グラフを有効にできるか (true)、否か (false) を示します。API バージョン 48.0 以降で利用できます。 |
| enableS3OutputConnector | boolean |
この組織で、S3 出力データコネクタを使用できるか (true)、否か (false) を示します。API バージョン 49.0 以降で利用できます。 |
| enableSFXJoinedReportsEnable | boolean |
この組織で、[設定] ページで Lightning 結合レポート機能を有効化または無効化できるか (true)、否か (false) を示します。API バージョン 47.0 以降で利用できます。 |
| enableSalesforceOutputConnector | boolean |
この組織で、Salesforce 出力データコネクタを使用できるか (true)、否か (false) を示します。API バージョン 51.0 以降で利用できます。 |
| enableSmartDataDiscovery | boolean |
この組織で、組織のシステム管理者が Einstein Discovery を有効化できるか (true)、否か (false) を示します。API バージョン 49.0 および 50.0 で使用できます。API バージョン 51.0 で削除されました。 |
| enableSnowflakeOutputConnector | boolean |
この組織で、Snowflake 出力データコネクタを使用できるか (true)、否か (false) を示します。API バージョン 49.0 以降で利用できます。 |
| enableSqlLiveDataset | boolean |
この組織で、SQL ライブデータセットを使用できるか (true)、否か (false) を示します。API バージョン 51.0 以降で利用できます。 |
| enableTableauHyperOutputConnector | boolean |
この組織で、Tableau Hyper 出力データコネクタを使用できるか (true)、否か (false) を示します。API バージョン 51.0 以降で利用できます。 |
| enableUseOldChartsLookAndFeel | boolean |
この組織で、レポートとダッシュボードに旧デザインを使用できるか (true)、否か (false) を示します。API バージョン 47.0 以降で利用できます。 |
| enableWaveAssetsNewDateVersion | boolean |
この組織で、Analytics アセットのタイムゾーンサポートの新しい日付バージョンが有効化されているか (true)、否か (false) を示します。API バージョン 51.0 以降で利用できます。 |
| enableWaveCustomFiscal | boolean |
この組織の Analytics でカスタム会計年度が有効化されているか (true)、否か (false) を示します。カスタム会計年度が有効化されている場合、システム管理者は Salesforce から Analytics にカスタム会計年度の定義をインポートできます。API バージョン 50.0 以降で利用できます。 |
| enableWaveIndexMVDim | boolean |
この組織で、複数-値ディメンションインデックス付けが有効化されているか (true)、否か (false) を示します。API バージョン 50.0 以降で利用できます。 |
| enableWaveRecordNavigation | boolean |
この組織で、Analytics からレコードアクションのブラウザタブナビゲーションを使用できるか (true)、否か (false) を示します。API バージョン 48.0 以降で利用できます。 |
| enableWaveReplication | boolean |
この組織で Salesforce オブジェクトの複製 (抽出) が可能であるか (true)、または SFDC ダイジェスト (false) しか使用できないかを示します。 |
| enableWaveSharingInheritance | boolean |
この組織で、Analytics データが元の Salesforce オブジェクトの共有およびセキュリティ設定を継承できるか (true)、否か (false) を示します。 |
| enableWaveTemplate | boolean |
この組織で、Analytics テンプレートが有効化されているか (true)、否か (false) を示します。API バージョン 51.0 で削除されました。 |
| enableWaveTrendedDatasetCleanup | boolean |
この組織で、使用されていないトレンド分析データセットを自動的に削除できるか (true)、否か (false) を示します。API バージョン 47.0 以降で利用できます。 |
| inheritSharingForNonOpptyObjects | boolean |
この組織で、商談オブジェクト以外のすべての Salesforce オブジェクトについて Analytics 共有継承のメディア表示がサポートされているか (true)、否か (false) を示します。API バージョン 48.0 および 49.0 で使用できます。API バージョン 50.0 で削除されました。 |
| inheritSharingForOpptyObject | boolean |
この組織で、商談オブジェクトについて Analytics 共有継承のメディア表示がサポートされているか (true)、否か (false) を示します。API バージョン 48.0 および 49.0 で使用できます。API バージョン 50.0 で削除されました。 |
| maxHoursAppInProgress | integer |
組み込みアプリケーションがキャンセルされるまで InProgress の状況でいられる最大時間。API バージョン 50.0 以降で利用できます。 |
| replaceBlankMeasuresWithNulls | boolean |
基準の null 値がサポートされているか (true)、否か (false) を示します。有効な場合 (true)、空白の基準の暗黙的なデフォルト値は null です。API バージョン 48.0 以降で利用できます。 |
| setWaveIsYearEndFiscalYear | boolean |
Analytics の 1 年の終わりが決算期であるか (true)、否か (false) を示します。この設定は、enableWaveCustomFiscal が true に設定されている場合にのみ適用されます。false の場合、決算期は年末になります。API バージョン 50.0 以降で利用できます。 |
| sonicEnabled | boolean |
この組織で、音響機能を使用できるか (true)、否か (false) を示します。API バージョン 51.0 以降で利用できます。 |
| turnOnTimeZones | boolean |
この組織で、タイムゾーン機能を使用できるか (true)、否か (false) を示します。API バージョン 48.0 以降で利用できます。 |
宣言的なメタデータの定義のサンプル
次に、Analytics.settings ファイルの例を示します。
1<?xml version="1.0" encoding="UTF-8"?>
2<AnalyticsSettings xmlns="http://soap.sforce.com/2006/04/metadata">
3 <enableWaveTemplate>true</enableWaveTemplate>
4 <enableInsights>true</enableInsights>
5 <canAccessAnalyticsViaAPI>true</canAccessAnalyticsViaAPI>
6</AnalyticsSettings>パッケージマニフェストの例
Analytics 設定メタデータをリリースまたは取得するために使用される、パッケージマニフェストの例を次に示します。
1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3 <types>
4 <members>Analytics</members>
5 <name>Settings</name>
6 </types>
7 <version>47.0</version>
8</Package>マニフェストファイル内のワイルドカードのサポート
package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) は、機能設定のメタデータ型には適用されません。ワイルドカードは、個々の設定ではなくすべての設定を取得するときにのみ適用されます。詳細は、「設定」を参照してください。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。