dackdive's blog

新米webエンジニアによる技術ブログ。JavaScript(React), Salesforce, Python など

[Salesforce]Usage Metrics(利用状況総計値)のインストール手順

はじめに

Summer'14 から正式リリースされているものの、日本語の記事がほとんど見当たらない
Usage Metrics(利用状況総計値)についてのメモ。

Summer'14 リリースノートは こちら
その他、参考になりそうなものはリファレンスにて。

とりあえず色々いじり倒すのはこの先やるとして、導入までの流れと基本事項を整理。

手順

環境ハブを設定

Usage Metrics を使うには、事前に環境ハブを有効化する必要がある。
環境ハブを有効化するには、組織で「私のドメイン」を設定した後 Partner Community でケース申請する。

参考: Help And Training Community

また、Usage Metrics の申請時に以下の2つの組織の組織IDが必要なので確認しておく。

  • リリース組織: パッケージのアップロードに使用する Development Edition 組織
  • レポート組織: 利用状況データが毎日配信される組織

Usage Metrics を有効化

Parnter Community から新規ケース申請。

f:id:dackdive:20151207105534p:plain

トピック:
  AppExchange & 関連機能 > 機能有効化/ライセンス追加

件名:
  利用状況総計値の有効化申請

概要:
  以下の3つの情報を記載する。
  1. アプリケーションのパッケージID
  2. リリース組織ID
  3. レポート組織ID
(パッケージIDは License Management Org の Packages タブより該当のアプリケーションの情報を確認する)

MetricsDataFile のフィールド

https://www.salesforce.com/developer/docs/api/Content/sforce_api_objects_metricsdatafile.htm

field type description
MetricsDataFile base64 データが格納されているフィールド
MetricsDataFileContentType string データファイルのフォーマット。現在は text/csv のみ
MetricsDataFileLength int データファイルのサイズ(byte)
MetricsRunDate datetime 利用状況総計値の集計ジョブが開始された日時
MetricsEndDate datetime データ収集が終了した日時
MetricsStartDate datetime データ収集が開始された日時
MetricsType picklist データのタイプ。CustomObject または Visualforce
NamespacePrefix string 名前空間プリフィックス
SendingInstance string データ収集が行われたインスタンス

Usage Metrics Visualization のインストール

https://appexchange.salesforce.com/listingDetail?listingId=a0N3000000B5FMvEAN

https://appexchangejp.salesforce.com/ だと検索しても出てこない。
https://appexchange.salesforce.com/ にアクセスすること。

基本のSOQL

以下は開発者コンソールの Query Editor でも実行できるけど、
肝心のデータ部分が BASE64 エンコードされてるからあんまり意味なし。

SELECT Id, MetricsDataFile, MetricsStartDate, MetricsEndDate FROM MetricsDataFile

(選んだフィールドは適当です)

FAQ

Q. データストレージは消費しないの?

  1. しない(らしい。サポート問い合わせ済み)。
    Usage Metrics Visualization もカスタムオブジェクトを含まないので大丈夫そう

Q. 一度有効化すると、Sandbox 組織にも引き継がれるの?

  1. メタデータは引き継がれる(MetricsDataFile というオブジェクトは Sandbox でも存在する)

※(2015/02/26追記)
ただし、フル Sandbox でデータまでは引き継がれなかった。
ほんとにそうなのか、確認中。

※(2015/03/16追記)
Salesforceにケースで問い合わせたところ、
フル Sandbox であっても MetricsDataFile のデータはコピーされない とのこと。

というわけで2015年3月現在では、Sandbox 組織で色々試してみるのは難しそう。。。

IdeaExchange に投稿してみました
https://success.salesforce.com/ideaView?id=08730000000DlDEAA0

Q. データローダで MetricsDataFile をエクスポートすることは可能?

可能(インポートは不可)

TODO

  • Usage Metrics Visualization でどんな情報が可視化されるのか
  • 自分で Apex + Visualforce で書いたらどうなるか

リファレンス

SDUG で紹介された時の資料

その他

Salesforce Developers

Developer Blog | Salesforce Developers

All about Salesforce Usage Metrics | JSON's Salesforce Blog

How does the Salesforce usage metrics pilot differ from other analytics apps? - Salesforce Stack Exchange