OmniSeller:PlugIn Entwicklung

OmniSeller PlugIn Entwicklung

Überblick

Der OmniSeller DataService bietet die Möglichkeit, externe Logik über PlugIns zu integrieren. PlugIns können entwickelt werden, um spezifische Geschäftsanforderungen zu erfüllen, beispielsweise das Anpassen von Produktdaten vor dem Upload oder das Modifizieren von Preisen basierend auf bestimmten Kriterien.

OmniSeller PlugIns basieren auf .NET Standard 2.0, um sowohl mit alten (.NET Framework 4.7.2) als auch mit neuen (.NET 6.0) Service-Versionen kompatibel zu sein.

Voraussetzungen

• Entwicklungsumgebung:
  • Visual Studio 2019 oder höher
  • .NET Standard 2.0 als Zielplattform für PlugIns
• Abhängigkeiten:
  • OmniSeller.Common und OmniSeller.Enums aus dem HTK NuGet Repository HTKPackages
• Nützliche Schnittstellen und Modelle:
  • IEntryPointPlugin (aus OmniSeller.Common)
  • Enums.EntryPoint und Enums.ShopTypes
• Zugriff auf ein bestehendes OmniSeller-System, um das PlugIn zu testen

Struktur eines OmniSeller PlugIns

Ein OmniSeller PlugIn muss die Schnittstelle IEntryPointPlugin implementieren, die folgende Eigenschaften und Methoden definiert:

public interface IEntryPointPlugin
{
    string Name { get; }
    EntryPoint SupportedEntryPoints { get; }
    string Version { get; }
    int SortOrder { get; }
    string Author { get; }
    string Publisher { get; }
    ShopTypes SupportedShopTypes { get; }
    string Notes { get; }
    Product Call(ShopTypes shopType, int portalID, Product productObj, EntryPoint entryPoint);
}

Beispiel für ein PlugIn: ZeroPricePlugIn

Dieses PlugIn setzt automatisch den niedrigsten Preis für Produkte, die den Preis 0 haben, basierend auf den Preisen der Kind-Produkte.

using OmniSeller.Enums;
using OmniSellerPlugins.Interfaces;
using OmniSellerPlugins.Models;
using System;

namespace OmniSeller.PlugIns
{
    internal class ZeroPricePlugIn : IEntryPointPlugin
    {
        public string Name => "OmniSellerZeroPricePlugIn";
        public EntryPoint SupportedEntryPoints => EntryPoint.PRICE_BEFORE_UPLOAD;
        public string Version => "1.0.0.0";
        public int SortOrder => 1000;
        public string Author => "AS";
        public string Publisher => "HTK GmbH & Co.KG";
        public ShopTypes SupportedShopTypes => ShopTypes.Magento;
        public string Notes => "Kein Hinweistext";

        public ZeroPricePlugIn()
        {
            Console.WriteLine($"Running PlugIn {Name}");
        }

        public Product Call(ShopTypes shopType, int portalID, Product productObj, EntryPoint entryPoint)
        {
            Console.WriteLine($"Running PlugIn {Name} for {shopType} at {entryPoint}");
            if (shopType == ShopTypes.Magento)
            {
                // Logik zur Anpassung von Produktpreisen
            }
            return productObj;
        }
    }
}

Schritt-für-Schritt-Anleitung zur Erstellung eines PlugIns

1. Projekt einrichten

• Erstellen Sie ein neues .NET Standard 2.0 Class Library-Projekt in Visual Studio
• Fügen Sie die folgenden Pakete über das HTK NuGet Repository hinzu:

OmniSeller.Common
OmniSeller.Enums
    

2. PlugIn-Logik implementieren

• Implementieren Sie die Schnittstelle IEntryPointPlugin.
• Definieren Sie die unterstützten EntryPoints und ShopTypes.
• Implementieren Sie die Logik in der Methode Call.

3. PlugIn erstellen und veröffentlichen

• Kompilieren Sie das Projekt.
• Die resultierende .dll-Datei (zusammen mit ihren Abhängigkeiten) wird in das OmniSeller PlugIn-Verzeichnis kopiert:

C:\OmniVersum\Apps\OmniSellerService2\PlugIns

4. PlugIn testen

• Starten Sie den OmniSeller DataService und beobachten Sie die Logs.
• Das PlugIn wird automatisch geladen und ausgeführt, wenn der entsprechende EntryPoint erreicht wird.

EntryPoints und deren Bedeutung

EntryPoint	Beschreibung
PORTAL_STARTUP	Wird beim Start einer Portalwarteschlange ausgeführt (einmalig).
PRODUCT_BEFORE_UPLOAD	Vor dem Produkt-Upload.
PRODUCT_AFTER_UPLOAD	Nach dem Produkt-Upload.
STOCK_BEFORE_UPLOAD	Vor dem Preis-Upload.
STOCK_AFTER_UPLOAD	Nach dem Preis-Upload.
ORDER_AFTER_DOWNLOAD	Nach dem Herunterladen einer Bestellung.

Best Practices für PlugIns

• Vermeiden Sie lange Blockaden:
  • Die Methode Call sollte möglichst schnell ausgeführt werden, um Verzögerungen im DataService zu vermeiden.
• Fehlerbehandlung:
  • Verwenden Sie try-catch, um Laufzeitfehler zu verhindern, die den gesamten Service beeinflussen könnten.
• Testumgebung nutzen:
  • Testen Sie das PlugIn in einer Entwicklungs- oder Staging-Umgebung, bevor es in die Produktion übernommen wird.
• Log-Ausgaben:
  • Nutzen Sie Console.WriteLine, um wichtige Informationen und Debug-Daten während der PlugIn-Ausführung zu loggen.

Beispielhafte Ordnerstruktur

C:\OmniVersum\Apps\OmniSellerService2\
├── PlugIns\
│   ├── OmniSellerZeroPricePlugIn.dll
│   ├── OmniSeller.Common.dll
│   ├── OmniSeller.Enums.dll
├── OmniSellerService.exe

Häufige Fehler und Lösungen

• PlugIn wird nicht geladen:
  • Überprüfen Sie, ob die IEntryPointPlugin-Schnittstelle korrekt implementiert wurde.
  • Stellen Sie sicher, dass alle Abhängigkeiten (z. B. OmniSeller.Common) verfügbar sind.
• Assembly-Version inkompatibel:
  • Stellen Sie sicher, dass die Hauptanwendung und das PlugIn dieselben Versionen von OmniSeller.Common verwenden.
• Kein EntryPoint aktiviert:
  • Prüfen Sie, ob der EntryPoint des PlugIns (SupportedEntryPoints) mit dem vom Service ausgelösten EntryPoint übereinstimmt.
    
    
    

Hinweis zur PlugIn-Entwicklung

Die Möglichkeit, individuelle PlugIns für den OmniSeller DataService zu erstellen, bietet eine flexible und maßgeschneiderte Lösung für spezifische Kundenanforderungen. Bitte beachten Sie jedoch:

• Die Entwicklung von PlugIns ist nicht Bestandteil unserer regulären Pakete, einschließlich des Enterprise-Pakets.
• Eine PlugIn-Entwicklung erfordert immer eine gesonderte Absprache mit HTK.

PlugIns ermöglichen Anpassungen, die über den Standardumfang hinausgehen. Sie sind ideal, um individuelle Geschäftsprozesse oder spezielle Anforderungen abzubilden, erfordern jedoch eine präzise Abstimmung zwischen Ihnen und unserem Entwicklungsteam.

Was bedeutet das für Sie?

• Keine Standardfunktion: Die PlugIn-Entwicklung ist eine Zusatzleistung und nicht automatisch im Lieferumfang unserer OmniSeller-Pakete enthalten (auch nicht im Enterprise Paket).
• Gesonderte Kosten: Jede PlugIn-Entwicklung wird individuell kalkuliert und als separate Leistung abgerechnet.
• Kundenspezifische Lösung: PlugIns werden speziell für Ihre Anforderungen erstellt und sind nicht universell einsetzbar.

Wenn Sie Interesse an der Entwicklung eines PlugIns haben, kontaktieren Sie bitte Ihren Ansprechpartner bei HTK. Wir freuen uns darauf, Ihre Anforderungen zu besprechen und Ihnen eine passende Lösung anzubieten.

HTK behält sich das Recht vor, PlugIn-Anfragen zu prüfen und gegebenenfalls abzulehnen, falls diese nicht mit den technischen oder geschäftlichen Rahmenbedingungen vereinbar sind.