チュートリアル: マーケティングオートメーションUIにアクティビティの種類を追加する
このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。
アクティビティの種類 は、Marketing Automation Engineが連絡先をキャンペーンに登録するときに実行するアクションを定義します。組み込みのアクティビティ タイプはいくつかありますが、カスタム アクティビティ タイプを作成することもできます。
アクティビティタイプを作成したら、コンテンツ作成者が使用できるように、そのアクティビティタイプをマーケティングオートメーション (MA) ユーザーインターフェースに追加する必要があります。これを行うには、Node Package Manager(NPM) パッケージに含まれるTypeScriptクラスとAngularベースのアクティビティエディタを組み合わせてMAプラグインを形成します。
このチュートリアルでは、次のタスクを実行する方法について説明します。
ワークステーション上にTypeScript、JSON、JavaScript、およびXMLファイル用のプロジェクトフォルダを作成する必要があります。このフォルダは、アクティビティタイプを作成したフォルダと同じである必要はありません。このチュートリアルでは、プロジェクト フォルダーを <project folder>と呼びます。
NPMパッケージを作成する
NPMパッケージを作成する
NPMパッケージの基本はpackage.jsonファイルです。他のNPMパッケージをパッケージに追加して、その機能を簡単に拡張できます。
NPMパッケージを作成するには:
-
<project folder>/ フォルダーに、sample/ フォルダーを作成します。
-
sample/フォルダに移動し、NPMを使用してpackage.jsonファイルを作成します。
メモNPMはパッケージ フォルダー名にちなんでパッケージに名前を付け、オプションのフィールド (バージョン、説明、エントリ ポイント、テスト コマンド、gitリポジトリ、キーワード、作成者、ライセンス) のいずれにもカスタム値を選択する必要はありません。
-
package.jsonファイルに、不足している依存関係を追加します。
-
package.jsonファイルを保存します。
-
不足している依存関係を次のコマンドでインストールします。
アクティビティの種類を作成する
アクティビティの種類を作成する
アクティビティの種類は、カスタムビジネスロジックを定義する場所です。 @sitecore/ma-coreパッケージには、拡張できる次の組み込みアクティビティの種類が含まれています。
アクティビティタイプを作成するには:
-
<project folder>/sample/フォルダに移動します。
-
src/フォルダを作成します。
-
src/フォルダに移動し、sample-single-item-activity-type.tsファイルを作成します。
-
サンプルのTypeScript実装をSingleItemアクティビティの種類からコピーします。
-
オプションのカスタムコードを追加します。
-
sample-single-item-activity-type.tsファイルを保存します。
アクティビティ エディターを作成する
アクティビティ エディターを作成する
コンテンツ作成者がアクティビティタイプに基づいてキャンペーンアクティビティを定義するときに使用するアクティビティエディター (グラフィカルユーザーインターフェイス) を作成する必要があります。
アクティビティエディターを作成するには:
-
<project folder>/sample/src/フォルダに移動します。
-
editor/フォルダを作成します。
-
editor/ フォルダにsample-single-item-editor.component.tsファイルを作成します。
-
アクティビティ エディターからサンプルのTypeScript component実装をコピーします。
-
オプションのカスタムコードを追加します。
-
sample-single-item-editor.component.tsファイルを保存します。
-
sample-single-item-editor.module.tsファイルを作成します。
-
アクティビティ エディターからサンプルのTypeScript module実装をコピーします。
-
sample-single-item-editor.module.tsファイルを保存します。
MAプラグインを準備する
MAプラグインを準備する
MAプラグインは、アクティビティ タイプとアクティビティ エディターが組み合わされる場所です。
MAプラグインを準備するには:
-
<project folder>/sample/src/フォルダに移動します。
-
次のTypeScriptコードを含むsample.plugin.tsファイルを作成します。
大事なこの時点では、アクティビティの種類をactivityDefinitionsセクションに追加しないでください。
手記export defaultステートメントは、プラグインをパッケージのデフォルトエクスポートにします。これは、MAアプリケーションがそれを検出するために必要です。
-
sample.plugin.tsファイルを保存します。
Angular AOTコンパイラを構成する
Angular AOTコンパイラを構成する
TypeScriptコードをコンパイルするには、Angular Ahead-of-Time (AOT) コンパイラ を構成する必要があります。
Angular AOTコンパイラを構成するには:
-
<project folder>/sample/フォルダに移動します。
-
package.jsonファイルに、Angular AOTコンパイラdevスクリプトを追加します。
手記Angular AOTコンパイラは、各MAプラグインのファクトリを生成します。このファクトリは、アクティビティエディターモジュールをプラグインデコレータに登録するために必要です。
-
package.jsonファイルを保存します。
-
次のJSON構造を含むtsconfig.jsonファイルを作成します。
-
tsconfig.jsonファイルを保存します。
-
src/ フォルダーに、次のJSON構造を含むtsconfig.aot.jsonファイルを作成します。
-
tsconfig.aot.jsonファイルを保存します。
アクティビティの種類とアクティビティ エディターをコンパイルする
アクティビティの種類とアクティビティ エディターをコンパイルする
アクティビティの種類とアクティビティ エディターのTypeScriptをコンパイルし、それらをMAプラグインに追加する必要があります。
アクティビティタイプとエディタをコンパイルしてMAプラグインに追加するには:
-
<project folder>/sample/フォルダに移動します。
-
Angular AOTコンパイラを使用してcodegen/ フォルダーを作成し、次のコマンドでTypeScriptをコンパイルします。
アクティビティタイプとアクティビティエディタをMAプラグインに追加する
アクティビティタイプとアクティビティエディタをMAプラグインに追加する
アクティビティタイプとアクティビティエディタをMAプラグインのactivityDefinitionsプロパティに追加する必要があります。
activityDefinitionsプロパティは、ActivityDefinitionオブジェクトの配列です。各オブジェクトには、次の必須プロパティがあります。
|
財産 |
種類 |
形容 |
|---|---|---|
|
id |
string |
sitecore/System/Settings/Analytics/Marketing Automation/Activity Typesアイテムの下のMasterデータベースに存在するSitecoreアクティビティ アイテムID。 |
|
activity |
ItemBase |
SingleItem、FinalItem、ConditionItem、またはDecisionPointItemクラスを拡張する必要があるアクティビティ クラス。 |
|
editorComponent |
EditorBase |
codegen/ フォルダーから参照する必要があるアクティビティ エディター クラス。 |
|
editorModuleFactory |
NgModuleFactory<any> |
Angular AOTコンパイラによって生成されるファクトリ アーティファクト。 |
アクティビティタイプとアクティビティエディタをMAプラグインに追加するには:
-
<project folder>/sample/src/ フォルダのsample.plugin.tsファイルに、次のimportステートメントとactivityDefinitionsを追加します。
-
sample.plugin.tsファイルを保存します。
webpackモジュール バンドラーを構成する
webpackモジュール バンドラーを構成する
webpackモジュールバンドラーを設定して、プラグインアーティファクトを1つの出力ファイルに結合する必要があります。
MAアプリケーションはSystemJSを使用してプラグインをロードします。つまり、プラグインモジュールの形式は、SystemJSでサポートされている任意の形式にすることができます。ここでは、libraryTargetプロパティで定義されているユニバーサル モジュール フォーマット (UMD) を使用します。
webpackモジュール バンドラーを設定するには:
-
<project folder>/sample/フォルダに移動します。
-
次のJavaScriptコードを使用してwebpack.config.jsファイルを作成します。
手記MAアプリケーションは、実行時に @sitecore/ma-core、@angular/core、および @ngx-translate/coreライブラリを提供します。 externalsとして設定されていない場合、プラグインアーティファクトにバンドルされ、プラグインはロードできません。
-
webpack.config.jsファイルを保存します。
-
package.jsonファイルにwebpack buildスクリプトを追加します。
-
package.jsonファイルを保存します。
MAプラグインをビルドします。
MAプラグインをビルドします。
単一ファイルのMAプラグインをMAアプリケーションにデプロイするには、それをビルドする必要があります。
MAプラグインをビルドするには:
-
<project folder>/sample/フォルダで、次のコマンドを使用してMAプラグインをdist/sample.plugin.js fileにビルドします。
MAプラグインをデプロイする
MAプラグインをデプロイする
MAプラグインをSitecoreにデプロイして、MAアプリケーションが検出できるようにする必要があります。
プラグインをデプロイするには:
-
<project folder>/sample/フォルダに移動します。
-
次のコマンドを使用して、MAプラグインファイルをMAアプリケーションにデプロイします。
-
次のXMLを使用してSamplePlugin.config構成ファイルを作成します。
-
次のコマンドを使用して、SamplePlugin.config設定ファイルをMAアプリケーションにデプロイします。
アクティビティの種類を確認する
アクティビティの種類を確認する
コンテンツ作成者がアクティビティタイプを使用できるかどうかは、MAユーザーインターフェースで確認する必要があります。
アクティビティタイプを確認するには:
-
Sitecoreスタート画面で、Marketing Automationをクリックします。
-
既存のキャンペーンを開くか、新しいキャンペーンを作成します。
-
画面の右側にある ツールボックス ウィンドウで、アクティビティの種類が存在するかどうかを確認します。