ウォークスルー
このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。
アクティビティタイプは 、マーケティングオートメーションエンジンがキャンペーンに連絡を登録する際に取るアクションを定義します。いくつかの組み込みアクティビティタイプがありますが、カスタムアクティビティタイプを作成することも可能です。
アクティビティタイプを作成したら、コンテンツを作成者が使えるようにマーケティングオートメーション(MA)のユーザーインターフェースに追加する必要があります。これはNode Package Manager(NPM) パッケージに含まれるTypeScriptクラスとAngularベースのアクティビティエディタを組み合わせてMAプラグインを形成することで行います。
このウォークスルーでは、以下のタスクの進め方を説明します。
- NPMパッケージを作成する
- アクティビティタイプを作成する
- アクティビティエディターを作成する
- MAプラグインを準備してください
- Angular AOTコンパイラの設定
- アクティビティタイプとアクティビティエディタをコンパイルします
- MAプラグインにアクティビティタイプとアクティビティエディターを追加します
- webpackモジュールの束ねを設定してください
- MAプラグインをビルドしてください
- MAプラグインをデプロイしてください
- アクティビティの種類を確認してください
!重要WorkStation上でTypeScript、JSON、JavaScript、XMLファイル用のプロジェクトフォルダを作成しなければなりません。このフォルダは、あなたがアクティビティタイプを作成したフォルダと同じである必要はありません。このウォークスルーでは、プロジェクトフォルダを
と呼んでいます。
NPMパッケージを作成する
NPMパッケージの基盤はpackage.jsonファイルです。他のNPMパッケージを追加することで、その機能を容易に拡張できます。
NPMパッケージを作成するには:
-
/フォルダ内にsample/フォルダを作成します。 -
sample/フォルダに行き、NPMを使ってpackage.jsonファイルを作成します:
npm init
!注NPMはパッケージフォルダ名の後にパッケージ名を付けており、オプションフィールド(バージョン、説明、エントリポイント、テストコマンド、gitリポジトリ、キーワード、著者、ライセンス)にカスタム設定を選択する必要はありません。
-
package.jsonファイルに欠けている依存関係を追加してください:
sample/package.json (for Sitecore 9.1+)
"dependencies": { "@sitecore/ma-core": "
/ /sitecore/shell/client/Applications/MarketingAutomation/packages/ma-core", "@angular/common": "5.2.11", "@angular/compiler": "5.2.11", "@angular/compiler-cli": "5.2.11", "@angular/core": "5.2.11", "@angular/forms": "5.2.11", "@angular/http": "5.2.11", "@angular/platform-browser": "5.2.11", "@ngx-translate/core": "9.0.2", "rxjs": "5.5.11", "zone.js": "^0.8.4" }, "devDependencies": { "ts-loader": "4.4.2", "typescript": "2.5.3", "webpack": "4.43.0", "webpack-cli": "3.3.11" } -
package.jsonファイルを保存してください。
-
以下のコマンドで欠けている依存関係をインストールします:
npm install
アクティビティタイプを作成する
アクティビティタイプはカスタムビジネスロジックを定義する場所です。 @sitecore/ma-coreパッケージには拡張可能な以下の組み込みアクティビティタイプが含まれています:
アクティビティタイプを作成するには:
/sample/フォルダに行ってください。 - src/フォルダを作成しましょう。
- src/フォルダに行き、sample-single-item-activity-type.tsファイルを作成します。
- SingleItemアクティビティタイプからサンプルのTypeScript実装をコピーしてください。
- オプションのカスタムコードを追加してください。
- sample-single-item-activity-type.tsファイルを保存してください。
アクティビティエディターを作成する
コンテンツ作成者が活動タイプに基づいてキャンペーン活動を定義する際に使用できるアクティビティエディター(グラフィカルユーザーインターフェース)を作成する必要があります。
アクティビティエディターを作成するには:
/sample/src/フォルダに行ってください。 - editor/フォルダを作成しましょう。
- editor/フォルダにsample-single-item-editor.component.tsファイルを作成します。
- アクティビティエディターからサンプルのTypeScriptコンポーネント実装をコピーします。
- オプションのカスタムコードを追加してください。
- sample-single-item-editor.component.tsファイルを保存してください。
- sample-single-item-editor.module.tsファイルを作成します。
- アクティビティエディタからサンプルのTypeScriptモジュール実装をコピーします。
- sample-single-item-editor.module.tsファイルを保存してください。
MAプラグインを準備してください
MAプラグインはアクティビティタイプとアクティビティエディタを組み合わせるものです。
MAプラグインの準備方法:
-
/sample/src/フォルダに行ってください。 -
以下のTypeScriptコードを含むsample.plugin.tsファイルを作成します:
sample/src/sample.plugin.ts
import { Plugin } from '@sitecore/ma-core';
@Plugin({ activityDefinitions:
})export default class SamplePlugin {}
!重要この時点でactivityDefinitionsセクションにアクティビティタイプを追加しないでください。
!注export default文はプラグインを パッケージのデフォルトのエクスポートにします。これはMAアプリケーションがそれを検出するために必要です。
-
sample.plugin.tsファイルを保存してください。
Angular AOTコンパイラの設定
TypeScriptコードをコンパイルするには、Angularの先行(AOT)コンパイラ を設定する必要があります。
Angular AOTコンパイラの設定:
-
/sample/フォルダに行ってください。 -
package.jsonファイル内にAngular AOTコンパイラdevスクリプトを追加します:
sample/package.json
"scripts": { "test": "echo \"Error: no test specified\" && exit 1", "dev": "ngc -p ./src/tsconfig.aot.json" }
!注Angular AOTコンパイラは各MAプラグインごとにファクトリーを生成します。このファクトリーは、プラグインデコレーターにアクティビティエディタモジュールを登録するために必要です。
-
package.jsonファイルを保存してください。
-
以下のJSON構造を含むtsconfig.jsonファイルを作成します。
sample/tsconfig.json
{ "compilerOptions": { "emitDecoratorMetadata": true, "experimentalDecorators": true, "target": "es5", "module": "es2015", "moduleResolution": "node", "removeComments": true, "sourceMap": true, "outDir": "./codegen", "rootDir": "./", "declaration": true, "lib": "es2016", "dom" , "baseUrl": "" } }
-
tsconfig.jsonファイルを保存してください。
-
src/フォルダ内に、以下のJSON構造を含むtsconfig.aot.jsonファイルを作成します。
sample/src/tsconfig.aot.json
{ "compilerOptions": { "emitDecoratorMetadata": true, "experimentalDecorators": true, "target": "es5", "module": "commonjs", "moduleResolution": "node", "removeComments": true, "sourceMap": true, "outDir": "../codegen", "rootDir": "./", "declaration": true, "lib": "es2016", "dom"
}, "angularCompilerOptions": { "genDir": "../codegen", "skipMetadataEmit": true, "generateCodeForLibraries": true } }
-
tsconfig.aot.jsonファイルを保存してください。
アクティビティタイプとアクティビティエディタをコンパイルします
アクティビティタイプのTypeScriptとアクティビティエディターをコンパイルし、それらをMAプラグインに追加する必要があります。
MAプラグインにアクティビティタイプとエディタをコンパイルし、追加するには:
-
/sample/フォルダに行ってください。 -
Angular AOTコンパイラを使ってcodegen/ フォルダを作成し、次のコマンドでTypeScriptをコンパイルします:
npm run dev
MAプラグインにアクティビティタイプとアクティビティエディターを追加します
アクティビティタイプとアクティビティエディターは、MAプラグインのactivityDefinitionsプロパティに追加しなければなりません。
activityDefinitionsプロパティはActivityDefinitionオブジェクトの配列です。各オブジェクトは以下の必要なプロパティを持ちます:
財産
種類
概要
id
string
Sitecoreアクティビティ項目IDマスターデータベースの sitecore/System/Settings/Analytics/Marketing Automation/Activity Types 項目の下に存在します。
activity
ItemBase
SingleItem、FinalItem、ConditionItem、またはDecisionPointItemクラスを拡張しなければならない活動クラス。
editorComponent
EditorBase
codegen/フォルダーから参照しなければならないアクティビティエディタクラスです。
editorModuleFactory
NgModuleFactory
Angular AOTコンパイラによって生成される工場出荷時のアーティファクトです。
MAプラグインにアクティビティタイプとアクティビティエディタを追加するには:
-
/sample/src/フォルダのsample.plugin.tsファイルに、以下のimport文とactivityDefinitionsを追加します: sample/src/sample.plugin.ts
import { Plugin } from '@sitecore/ma-core'; import { SampleSingleItemActivityType } from './sample-single-item-activity-type'; import { SampleSingleItemModuleNgFactory } from '../codegen/editor/sample-single-item-editor.module.ngfactory'; import { SampleSingleItemEditorComponent } from '../codegen/editor/sample-single-item-editor.component';
@Plugin({ activityDefinitions: { // The ID of the sitecore activity item that exists in the Master database under // sitecore/System/Settings/Analytics/Marketing Automation/Activity Types item id: '5908ca79-1089-440b-9af1-a2f47766a783', activity: SampleSingleItemActivityType, editorComponenet: SampleSingleItemEditorComponent, editorModuleFactory: SampleSingleItemModuleNgFactory } })
export default class SamplePlugin {}
-
sample.plugin.tsファイルを保存してください。
webpackモジュールの束ねを設定してください
webpackモジュールの束ね器でプラグインのアーティファクトを1つの出力ファイルにまとめるように設定する必要があります。
!重要MAアプリケーションはプラグインの読み込みにSystemJSを使用します。つまり、プラグインモジュールのフォーマットはSystemJSがサポートする任意のフォーマットで選べます。ここでは、libraryTargetプロパティで定義されたユニバーサルモジュールフォーマット(UMD)を使用しています。
webpackモジュールの束ね取りを設定するには:
-
/sample/フォルダに行ってください。 -
以下のJavaScriptコードでwebpack.config.jsファイルを作成します:
sample/webpack.config.js
var path = require("path");
module.exports = { entry: "./src/sample.plugin.ts", module: { rules: { test: /\.ts$/, use: "ts-loader", exclude: path.resolve(__dirname, "node_modules") }
}, resolve: { extensions: ".ts", ".js" }, output: { path: path.resolve(__dirname, "dist"), filename: "sample.plugin.js", library: "samplePlugin", libraryTarget: "umd" }, externals: "@sitecore/ma-core", "@angular/core", "@ngx-translate/core"
};
!注MAアプリケーションは実行時に @sitecore/ma-core、@angular/core、@ngx-translate/coreのライブラリを提供します。もしexternalsとして設定されていなければ、プラグインアーティファクトとバンドルされ、プラグインは読み込めません。
-
webpack.config.jsファイルを保存してください。
-
package.jsonファイルにwebpackbuildスクリプトを追加します:
sample/package.json
"scripts": { "test": "echo \"Error: no test specified\" && exit 1", "dev": "ngc -p ./src/tsconfig.aot.json", "build": "webpack" }
-
package.jsonファイルを保存してください。
MAプラグインを構築してください。
MAアプリケーションにデプロイするには、シングルファイルのMAプラグインをビルドする必要があります。
MAプラグインを構築するには:
-
/sample/フォルダで、次のコマンドでdist/sample.plugin.js fileのMAプラグインを構築します: npm run build
MAプラグインをデプロイしてください
MAプラグインをSitecoreにデプロイし、MAアプリケーションがそれを検出できるようにします。
プラグインをデプロイするには:
-
/sample/フォルダに行ってください。 -
MAプラグインファイルを次のコマンドでMAアプリケーションに展開します:
cp dist/sample.plugin.js
/sitecore/shell/client/Applications/MarketingAutomation/plugins/ -
以下のXMLでSamplePlugin.config設定ファイルを作成します:
SamplePlugin.config
-
SamplePlugin.config設定ファイルを以下のコマンドでMAアプリケーションに展開します:
cp SamplePlugin.config
/App_Config/Include/
アクティビティの種類を確認してください
MAのユーザーインターフェースでコンテンツ作成者が活動タイプが利用可能かどうかを確認する必要があります。
アクティビティタイプを確認するには:
- Sitecore Launchpadで「 マーケティングオートメーション」をクリックしてください。
- 既存のキャンペーンを開くか、新しいキャンペーンを作成する。
- 画面右側のツールボックスパネルで、アクティビティタイプがあるか確認してください。