CRM Analytics ダッシュボード用のコンポーネントの構成

Lightning Web コンポーネントを使用してカスタム機能を実装し、CRM Analytics ダッシュボードのウィジェットやステップと連動させて使用します。

1.設定ファイルに CRM Analytics 対象を追加する

componentName.js-meta.xml ファイルは、CRM Analytics ダッシュボードでの使用を許可する設定も含め、コンポーネントのメタデータ値を定義します。コンポーネントの設定ファイルに analytics__Dashboard 対象を追加します。isExposed 属性を true に設定して、コンポーネントが CRM Analytics のデザイナ UI に表示されるようにします。

1<?xml version="1.0" encoding="UTF-8"?>
2<LightningComponentBundle xmlns="http://soap.sforce.com/2006/04/metadata">
3    <isExposed>true</isExposed>
4    <targets>
5        <target>analytics__Dashboard</target>
6    </targets>
7</LightningComponentBundle>

2.コンポーネント構成オプションの設定

componentName.js-meta.xml ファイルに、analytics__Dashboard 対象用の targetConfig を追加します。コンポーネントが、ダッシュボードのステップから CRM Analytics のクエリデータを使用するように設計されている場合は、hasStep タグを true に設定します。CRM Analytics ダッシュボードで使用するように設計されているコンポーネント属性ごとに、property タグを追加します。

1<?xml version="1.0" encoding="UTF-8"?>
2<LightningComponentBundle xmlns="http://soap.sforce.com/2006/04/metadata">
3    <targetConfig targets="analytics__Dashboard">
4        <hasStep>true</hasStep>
5        <property name="title" type="String" label="Title" description="Component Title" required="true" />
6    </targetConfig>
7</LightningComponentBundle>

共通のデータ型に加えて、analytics__Dashboard 対象は、<hasStep>true</hasStep> が設定されたコンポーネントに対して、Measure と Dimension のデータ型もサポートします。ダッシュボードエディタは、関連付けられたステップの結果から、特定のデータ型の列を選択できます。

1<?xml version="1.0" encoding="UTF-8"?>
2<LightningComponentBundle xmlns="http://soap.sforce.com/2006/04/metadata">
3    <targetConfig targets="analytics__Dashboard">
4        <hasStep>true</hasStep>
5        <property name="labelColumn" type="Dimension" label="Label Column" description="Segment Label" required="true" />
6    </targetConfig>
7</LightningComponentBundle>

これらの手順が完了したら、CRM Analytics Studio のダッシュボードエディタで、Lightning Web コンポーネントをコンポーネントウィジェットとして追加します。詳細は、『Lightning Web Components in CRM Analytics Dashboards (CRM Analytics ダッシュボードの Lightning Web コンポーネント)』開発者ガイドを参照してください。

The Japanese Summer '24 guide is now live

日本語の Summer '24 ガイドが公開されました! 「Component Reference (コンポーネントリファレンス)」は、以前と同様にコンポーネントライブラリにあります。