エンドポイントを実装する

エンドポイント設定プラグインを実装する

Version:

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

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

エンドポイントの設定は、エンドポイントテンプレートを使用して構成します。この例では、読み取ることができるファイルのパスや、ファイルの最初の行に列ヘッダーが含まれているかどうかなどの設定を構成できます。

エンドポイントテンプレートは、エンドポイント設定へのデザイン時アクセスを提供します。エンドポイント設定へのランタイムアクセスは、プラグインを通じて提供されます。エンドポイントの特定の設定を処理するには、プラグインを使用する必要があります。

エンドポイント設定プラグインを実装するには:

Visual Studioで、次のクラスを追加します。

using Sitecore.DataExchange;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace Examples.DataExchange.Providers.FileSystem
{
    public class TextFileSettings : IPlugin
    {
        public TextFileSettings() { }
        public bool ColumnHeadersInFirstLine { get; set; }
        public string ColumnSeparator { get; set; }
        public string Path { get; set; }
    }
}

次のクラスを追加します。

using Sitecore.DataExchange.Models;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace Examples.DataExchange.Providers.FileSystem
{
    public static class EndpointExtensions
    {
        public static TextFileSettings GetTextFileSettings(this Endpoint endpoint)
        {
            return endpoint.GetPlugin<TextFileSettings>();
        }
        public static bool HasTextFileSettings(this Endpoint endpoint)
        {
            return (GetTextFileSettings(endpoint) != null);
        }
    }
}

メモ

この拡張方法により、必要なときにプラグインに簡単にアクセスできるようになります。

プラグインにアクセスするための拡張メソッドを提供することは、Data Exchange Frameworkのプロバイダを実装する際に考慮すべきベストプラクティスです。

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