カスタム モデルのデプロイ

xConnect モデルをシリアル化するコンソール アプリケーションを作成します。

モデルを JSON に、次の例のようにシリアル化します。この例では、Sitecore のデフォルトのコレクション モデルを使用しています。

using Sitecore.XConnect.Serialization;

namespace Documentation
{
    public class DeployModel
    {
        public void Serialize()
        {
            // File name will be Sitecore.XConnect.Collection.Model, 9.0.json
            var json = XdbModelWriter.Serialize(Sitecore.XConnect.Collection.Model.CollectionModel.Model);
        }
    }
}

モデルの JSON ファイルを、xConnect Collection Search および xConnect Collection のロールのすべてのインスタンスに対して、次のパスにコピーします。

C:\<Path to xConnect>\root\App_Data\Models

モデルの JSON ファイルを、xConnect Search Indexer で次のパスにコピーします。

C:\<Path to indexer>\root\App_data\Models

Sitecore 9.0 Update 2 以降では、Marketing Automation Operations ロールのすべてのインスタンスで、モデルの JSON ファイルを次のパスにコピーする必要があります。このモデルは、ライブ イベントを処理するために必要です。

C:\<Path to marketing automation operations>\root\App_Data\Models

モデルの DLL を Marketing Automation Engine のすべてのインスタンスのルートにコピーします。

C:\<Path to xConnect>\App_data\jobs\continuous\AutomationEngine\AppData\config\sitecore で、構成ファイルを sc.Sample.CustomModel.xml という名前で作成します。ファイル名は、sc で始まり、.xml で終わる必要があります。次のモデル構成を貼り付けて、以下のように変更します。

<Settings>
    <Sitecore>
        <XConnect>
            <Services>
                <XConnect.Client.Configuration>
                    <Options>
                        <Models>
                            <CustomModel1>
                                <TypeName>Sitecore.Xdb.MarketingAutomation.Stub.Model.StubModel, Sitecore.Xdb.MarketingAutomation.Stub</TypeName>
                            </CustomModel1>
                        </Models>
                    </Options>
                </XConnect.Client.Configuration>
            </Services>
        </XConnect>
    </Sitecore>
</Settings>

モデル DLL を core Sitecore インスタンスの bin ディレクトリにコピーします。

独自のモデル クラスを次のように \App_Config\Sitecore\XConnect.Client.Configuration\Sitecore.XConnect.Client.config に適用します。

<?xml version="1.0" encoding="utf-8" ?>
<configuration xmlns:patch="http://www.sitecore.net/xmlconfig/">
<sitecore>
    <xconnect>
    <runtime type="Sitecore.XConnect.Client.Configuration.RuntimeModelConfiguration,Sitecore.XConnect.Client.Configuration">
        <schemas hint="list:AddModelConfiguration">
            <!-- value of 'name' property must be unique -->
            <schema name="documentationmodel" type="Sitecore.XConnect.Client.Configuration.StaticModelConfiguration,Sitecore.XConnect.Client.Configuration" patch:after="schema[@name='collectionmodel']">
                <param desc="modeltype">Documentation.Model.CollectionModel, Documentation.Model</param>
            </schema>
        </schemas>
    </runtime>
    </xconnect>
</sitecore>
</configuration>

コードで、モデルの DLL を参照します。

xConnect Client API を使用してイベントをトリガーするか、またはコンタクト ファセットにデータを入力します。