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

1. Entwicklungsumgebung:
   • Visual Studio 2019 oder höher.
   • .NET Standard 2.0 als Zielplattform für PlugIns.
2. Abhängigkeiten:
   • `OmniSeller.Common` und `OmniSeller.Enums` aus dem **HTK NuGet Repository**:
3. ```plaintext
4. https://htkpackages/repository/
5. ```
6. Nützliche Schnittstellen und Modelle:
   • `IEntryPointPlugin` (aus `OmniSeller.Common`).
   • `Enums.EntryPoint` und `Enums.ShopTypes`.
7. 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:

```csharp public interface IEntryPointPlugin {

   string Name { get; } // Der Name des PlugIns
   EntryPoint SupportedEntryPoints { get; } // Unterstützte EntryPoints
   string Version { get; } // Version des PlugIns
   int SortOrder { get; } // Reihenfolge des PlugIns
   string Author { get; } // Entwicklername
   string Publisher { get; } // Herausgebername
   ShopTypes SupportedShopTypes { get; } // Unterstützte Shop-Typen
   string Notes { get; } // Notizen/Hinweise

   Product Call(ShopTypes shopType, int portalID, Product productObj, EntryPoint entryPoint); // Hauptlogik

}

=== 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.

csharp

<button class="flex gap-1 items-center select-none py-1">Code kopieren</button>

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 ===

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

plaintext

<button class="flex gap-1 items-center select-none py-1">Code kopieren</button>

OmniSeller.Common

OmniSeller.Enums

=== 2. PlugIn-Logik implementieren ===

• Implementiere die Schnittstelle IEntryPointPlugin.
• Definiere die unterstützten EntryPoints und ShopTypes.
• Implementiere die Logik in der Methode Call.

=== 3. PlugIn erstellen und veröffentlichen ===

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

plaintext

<button class="flex gap-1 items-center select-none py-1">Code kopieren</button>

C:\OmniVersum\Apps\OmniSellerService2\PlugIns

=== 4. PlugIn testen ===

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

== EntryPoints und deren Bedeutung == {| class="wikitable" |- ! EntryPoint

! Beschreibung</thead>
PORTAL_STARTUP
Wird beim Start eines Portals ausgeführt.
-
PRODUCT_BEFORE_UPLOAD
Vor dem Produkt-Upload.
-
PRODUCT_AFTER_UPLOAD
Nach dem Produkt-Upload.
-
PRICE_BEFORE_UPLOAD
Vor dem Preis-Upload.
-
PRICE_AFTER_UPLOAD
Nach dem Preis-Upload.
-
ORDER_AFTER_DOWNLOAD
Nach dem Herunterladen einer Bestellung.
}

== Best Practices für PlugIns ==

Vermeide lange Blockaden:

#* Die Methode Call sollte möglichst schnell ausgeführt werden, um Verzögerungen im DataService zu vermeiden.

Fehlerbehandlung:

#* Verwende try-catch, um Laufzeitfehler zu verhindern, die den gesamten Service beeinflussen könnten.

Testumgebung nutzen:

#* Teste das PlugIn in einer Entwicklungs- oder Staging-Umgebung, bevor es in die Produktion übernommen wird.

Log-Ausgaben:

#* Nutze Console.WriteLine, um wichtige Informationen und Debug-Daten während der PlugIn-Ausführung zu loggen.

== Beispielhafte Ordnerstruktur ==

plaintext

<button class="flex gap-1 items-center select-none py-1">Code kopieren</button>

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üfe, ob die IEntryPointPlugin-Schnittstelle korrekt implementiert wurde. #* Stelle sicher, dass alle Abhängigkeiten (z. B. OmniSeller.Common) verfügbar sind.

Assembly-Version inkompatibel:

#* Stelle sicher, dass die Hauptanwendung und das PlugIn dieselben Versionen von OmniSeller.Common und OmniSeller.Enums verwenden.

Kein EntryPoint aktiviert:

#* Prüfe, ob der EntryPoint des PlugIns (SupportedEntryPoints) mit dem vom Service ausgelösten EntryPoint übereinstimmt.

Falls es weitere Fragen oder Probleme gibt, wende dich an das OmniSeller-Entwicklungsteam.

 

 

 

Disclaimer

Unser Angebot enthält Links zu externen Webseiten Dritter, auf deren Inhalte wir keinen Einfluss haben. Deshalb können wir für diese fremden Inhalte auch keine Gewähr übernehmen. Für die Inhalte der verlinkten Seiten ist stets der jeweilige Anbieter oder Betreiber der Seiten verantwortlich. Die verlinkten Seiten wurden zum Zeitpunkt der Verlinkung auf mögliche Rechtsverstöße überprüft. Rechtswidrige Inhalte waren zum Zeitpunkt der Verlinkung nicht erkennbar. Eine permanente inhaltliche Kontrolle der verlinkten Seiten ist jedoch ohne konkrete Anhaltspunkte einer Rechtsverletzung nicht zumutbar. Bei Bekanntwerden von Rechtsverletzungen werden wir derartige Links umgehend entfernen. Some pages may contain Icons by www.icons8.com.