インタラクションの集約

Sitecore Experience Platform
加工
インタラクションの集約
チュートリアル: インタラクションバッチパイプラインを使用してレポートデータを集計および保存する

チュートリアル: インタラクションバッチパイプラインを使用してレポートデータを集計および保存する

Version:

日本語翻訳に関する免責事項

このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。

このトピックでは、インタラクションのユーザーエージェントに対するすべての訪問の合計数と合計値をグループ化するバッチインタラクション集約プロセッサを作成する方法を示します。

メモ

プロセッサのロジックと構成は、従来の対話式アグリゲーションプロセッサとは少し異なります。クラシックプロセッサをバッチプロセッサにアップグレードすることをお勧めします。

次のものを作成します。

ディメンションテーブルは、IDを持つ一意のユーザーエージェントのリストを格納する参照テーブルです。
ファクトテーブルは、そのユーザーエージェントによって生成された合計訪問数と値に対するユーザーエージェントIDを保存します。
ファクトクラスとディメンションクラス: ファクトテーブルとディメンションテーブル内のデータをモデル化します。
ファクトクラスとディメンションクラスを使用してレポートデータベース内のテーブルを設定するバッチ相互作用集計プロセッサ。

ディメンションクラスとテーブルの作成

ディメンションテーブルには、ユーザーエージェント文字列の一覧が格納されます。各ユーザーエージェントには一意のIDがあります。ディメンションテーブルは、ユーザーエージェントIDに対する訪問の合計数とすべての訪問の合計値を格納したファクトテーブルによって参照されます。

ディメンション・クラスの作成

すべてのディメンションには、そのディメンションに固有のキーと値クラスがあります (この場合、それらはUserAgentNameKey (キーの例: -1743424285) とUserAgentNameValue (値の例: Chrome) です。

ディメンション・キー・クラスを作成します。

namespace Documentation.Examples
{
    using Sitecore;
    using Sitecore.Analytics.Aggregation.Data.Model;
    using Sitecore.Analytics.Core;

    public class UserAgentNameKey : DictionaryKey
    {
        private readonly Hash32 userAgentNameId;

        public Hash32 UserAgentNameId
        {
            get
            {
                return this.userAgentNameId;
            }
        }
        public UserAgentNameKey(Hash32 userAgentNameId)
        {
            this.userAgentNameId = userAgentNameId;
        }
    }
}

ディメンション値クラスを作成します。

namespace Documentation.Examples
{
    using Sitecore;
    using Sitecore.Analytics.Aggregation.Data.Model;
    using Sitecore.Analytics.Core;

    public class UserAgentNameValue : DictionaryValue
    {
        private readonly string userAgentName;

        [CanBeNull]
        public string UserAgentName
        {
            get
            {
                return this.userAgentName;
            }
        }

        public UserAgentNameValue([CanBeNull] string userAgentName)
        {
            this.userAgentName = userAgentName;
        }
    }
}

UserAgentNameKeyクラスとUserAgentNameValueクラスを使用するディメンションクラスを作成します。

namespace Documentation.Examples
{
    using Sitecore;
    using Sitecore.Analytics.Aggregation.Data.Model;
    using Sitecore.Analytics.Core;

    public class UserAgentName : Dimension<UserAgentNameKey, UserAgentNameValue>
    {
        public UserAgentName()
        {
        }

        public Hash32 Add([CanBeNull] string userAgentName)
        {
            string userAgentNameValue = (userAgentName ?? string.Empty);
            Hash32 result = Hash32.Compute(userAgentNameValue);

            UserAgentNameKey key = new UserAgentNameKey(result);
            UserAgentNameValue value = new UserAgentNameValue(userAgentNameValue);

            this.Add(key, value);

            return result;
        }
    }
}

ディメンションテーブルの作成

大事な

ディメンションテーブルには、クラスと同じ名前を付ける必要があります。たとえば、UserAgentNameクラスには、クラスのプロパティに一致する列を持つ一致するdbo.UserAgentNameテーブルが必要です。

レポートデータベースで、次の表を作成します。

CREATE TABLE [dbo].[UserAgentName] (
        [UserAgentNameId] INT            NOT NULL,
        [UserAgentName]   NVARCHAR (1000) NOT NULL,
        CONSTRAINT [PK_UserAgentNames] PRIMARY KEY CLUSTERED ([UserAgentNameId] ASC)
);

GO

ファクトクラスとテーブルの作成

ディメンションテーブルには、そのユーザーエージェントによって生成された訪問の合計数と訪問の合計値に対するユーザーエージェントIDのリストが格納されます。

ファクトクラスの作成

ファクト値クラスを作成します。

namespace Documentation.Examples
{
    using System;
    using Sitecore;
    using Sitecore.Analytics.Aggregation.Data.Model;
    using Sitecore.Analytics.Core;
    using Sitecore.Diagnostics;

    public class UserAgentValue : DictionaryValue
    {
        public long Visits { get; set; }
        public long Value { get; set; }

        //
        //   Reduces two <see cref="UserAgentValue"/> objects into one by
        //   adding corresponding members together.
        //
        [NotNull]
        internal static UserAgentValue Reduce([NotNull] UserAgentValue left, [NotNull] UserAgentValue right)
        {
            Debug.ArgumentNotNull(left, "left");
            Debug.ArgumentNotNull(right, "right");
            UserAgentValue result = new UserAgentValue();
            result.Visits = (left.Visits + right.Visits);
            result.Value = (left.Value + right.Value);
            return result;
        }
    }
}

手記

Reduce() メソッドは、2つのファクト値を加算できるように実装する必要があります。

ファクトキークラスを作成します。

namespace Documentation.Examples
{
    using System;
    using Sitecore;
    using Sitecore.Analytics.Aggregation.Data.Model;
    using Sitecore.Analytics.Core;
    using Sitecore.Diagnostics;

    public class UserAgentFactKey : DictionaryKey
    {
        public DateTime Date { get; set; }
        public Hash32 Checksum { get; set; }
        public Hash32 UserAgentNameId { get; private set; }

        public UserAgentFactKey(Hash32 userAgentHash32)
        {
            UserAgentNameId = userAgentHash32;
        }
    }
}

UserAgentFactKeyクラスとUserAgentValueクラスを使用するファクトクラスを作成します。

namespace Documentation.Examples
{
    using System;
    using Sitecore;
    using Sitecore.Analytics.Aggregation.Data.Model;
    using Sitecore.Analytics.Core;
    using Sitecore.Diagnostics;

    public class UserAgentFact : Fact<UserAgentFactKey, UserAgentValue>
    {
        public UserAgentFact() : base(UserAgentValue.Reduce)
        {
        }
    }
}

ファクトテーブルの作成

ファクトテーブルには、クラスと同じ名前を付け、プレフィックスにFact_を付ける必要があります。たとえば、UserAgentFactファクトクラスには、クラスのプロパティに一致する列を持つ一致するdbo.Fact_UserAgentFactテーブルがあります。

レポートデータベースで、次の表を作成します。

CREATE TABLE [dbo].[Fact_UserAgentFact] (
        [Date]            SMALLDATETIME    NOT NULL,
        [Checksum]        INT              NOT NULL,
        [UserAgentNameId] INT              NOT NULL,
        [Visits]          BIGINT           NOT NULL,
        [Value]           BIGINT           NOT NULL,
        CONSTRAINT [FK_Fact_UserAgentFact_UserAgentName] FOREIGN KEY ([UserAgentNameId]) REFERENCES [dbo].[UserAgentName] ([UserAgentNameId]),
);


GO
ALTER TABLE [dbo].[Fact_UserAgentFact] NOCHECK CONSTRAINT [FK_Fact_UserAgentFact_UserAgentName];


GO
CREATE NONCLUSTERED INDEX [IX_ByDateAndUserAgent]
        ON [dbo].[Fact_UserAgentFact]([Date] ASC, [UserAgentNameId] ASC)
        INCLUDE([Visits], [Value]);


GO
CREATE CLUSTERED INDEX [IX_ByDate]
        ON [dbo].[Fact_UserAgentFact]([Date] ASC, [Checksum] ASC);


GO
CREATE NONCLUSTERED INDEX [IX_Fact_UserAgentFact_UserAgent]
        ON [dbo].[Fact_UserAgentFact]([UserAgentNameId] ASC);

バッチ相互作用集計プロセッサクラスを作成する

次の方法でクラスを作成します。

public void Process(InteractionBatchAggregationPipelineArgs args) { }

手記

バッチプロセッサには基本クラスは必要ありません。クラシックプロセッサには基本クラスが必要です。

次の例では、前の手順で作成したファクトクラスとディメンションクラスを使用します。プロセッサは、ファクトテーブルとディメンションテーブルを自動的に取り込みます。

namespace Documentation.Examples
{
    using System;
    using Sitecore;
    using Sitecore.Analytics.Aggregation;
    using Sitecore.Analytics.Aggregation.Data.Model;
    using Sitecore.Analytics.Aggregation.Pipeline;
    using Sitecore.Analytics.Core;
    using Sitecore.Diagnostics;

    public class UserAgentProcessor
    {
        public void Process(InteractionBatchAggregationPipelineArgs args)
        {
            foreach (var context in args.Contexts)
            {
                var useragent = context.Interaction.UserAgent;

                if (string.IsNullOrEmpty(useragent))
                {
                    return;
                }

                //
                // Create the fact key
                //
                Hash32 userAgentId = UpdateUserAgentDimension(useragent, context.Results);
                UserAgentFactKey key = new UserAgentFactKey(userAgentId);
                key.Date = args.DateTimeStrategy.Translate(context.Interaction.StartDateTime);
                key.Checksum = Hash32.Compute(userAgentId);

                //
                // Create the fact value.
                //
                UserAgentValue value = new UserAgentValue();
                value.Visits = 1;
                value.Value = context.Interaction.EngagementValue;

                //
                // Emit fact.
                //
                UserAgentFact facts = context.Results.GetFact<UserAgentFact>();
                facts.Emit(key, value);
            }
        }
    }
}

手記

xConnect Client APIなどのファセットやサービスには、インタラクションアグリゲーションプロセッサのコンテキストでアクセスできます。

構成にプロセッサを追加

プロセッサを次のように構成にパッチします。

<?xml version="1.0" encoding="utf-8" ?>
<configuration xmlns:patch="http://www.sitecore.net/xmlconfig/" xmlns:role="http://www.sitecore.net/xmlconfig/role/">
<sitecore role:require="Standalone or Processing">
    <pipelines>
        <group groupName="analytics.aggregation">
            <pipelines>
                <interactionsBatch>
                    <processor type="Documentation.Examples.UserAgentProcessor, Documentation.Examples" />
                </interactionsBatch>
            </pipelines>
        </group>
    </pipelines>
</sitecore>
</configuration>

この記事を改善するための提案がある場合は、お知らせください!