Entwicklung eigener Module

Einführung

In contentXXL können Sie auf sehr einfache Weise mit minimalem Zeitaufwand eigene Module entwickeln. Hierfür stellen wir Ihnen den Webservice CosyFactory zur Verfügung.

Dieser besteht einerseits aus einem AddIn für Ihre Visual Studio-Entwicklumgsumgebung, das Ihnen eine assistentengestützte Erstellung von Modulpaketen ermöglicht, andererseits aus einem automatischen Installationssystem, das eine einfache Bereitstellung neuer sowie Aktualisierung bestehender Modulpakete ermöglicht. Modulpakete sind eine Kombination von mehreren Modulen, die in einem logischen Zusammenhang stehen (z. B. Produktkatalog, Warenkorb und Bestellung in einem Shopsystem).  Der Sourcecode wird hierfür von einem Webservice der CosyFactory generiert.

Aktuell können damit content-Module (wie News, Kontakte etc), die jeweiligen verknüpften Module (Related Module) sowie Funktionsmodule ("simple modules") generiert werden.

Voraussetzungen

• Visual Studio 2015 oder Visual Studio 2019 Entwicklungsumgebung (Die kostenlose Community-Editon ist bereits ausreichend)
• contentXXL 5.4 oder neuer
• Funktionierende Internetverbindung

Installation des Add-Ins

1. Laden Sie das AddIn 2015 oder 2019 herunter
2. Installieren Sie das AddIn mit einem Doppelklick auf die Datei und bestätigen Sie die Lizenzbedingungen
3. Vor Nutzung des AddIns ist ein Neustart bereits laufender Visual Studio-Instanzen erforderlich
4. Beim AddIn 2019 ist für das ordnungsgemäße Funktionieren im Visual Studio folgende Einstellung notwendig: Tools > Options > Extensions > Allow synchronous autoload of extensions (Synchrones automatisches Laden zulassen)

Projekterstellung

1. Öffnen Sie den Dialog zur Erstellung eines neuen Visual Studio Projekts
2. Wählen Sie das .NET Framework 4.5 als aktives Framework aus
3. Selektieren Sie die Projektvorlage "Vorlagen > Visual C# > contentXXL > v5.5"
   
   
    
4. Geben Sie dem Projekt einen Namen und bestätigen Sie mit "OK"
5. Wählen Sie in dem Projektassistenten die Option "Einfach" und klicken Sie auf "Weiter"
   
   
    
6. Bei erstmaliger Ausführung des Assistenten werden Sie aufgefordert, Ihre contentXXL-Lizenz auszuwählen.(dieser Schritt wird bei zukünftigen Projekten übersprungen).
   
   
    
7. Konfigurieren Sie Ihr Modul nach Ihren Wünschen
   
   
   
   1) Geben Sie den Namen des Autors an (z. B. den Namen Ihrer Firma). Durch einen Klick auf das Diskettensymbol können Sie Ihre Eingabe als Standardwert für zukünftige Projekte speichern.
   2) Vergeben Sie einen Namen für Ihr neues oder ein bestehendes Modulpaket.
   3) Vergeben Sie einen Namen für ihr Modul.
   4) Wählen Sie den Modultyp "Content" für Module mit Objekten oder "Simple" für Funktionsmodule. Im Fall des Modultyps "Content"
        können Sie auch anklicken, falls ein Related-Modul hierzu mit erzeugt werden soll.
   5) Legen Sie Namen und Datentypen Ihrer Felder fest (dies beinhaltet auch contentXXL-spezifische Typen wie z. B. Ressource oder Image).
        Folgende Felder werden von jedem contentXXL-Objekt benötigt und daher automatisch angelegt:
        - Title nvarchar(1000)               Der Titel des Objekts
        - Description nvarchar(max)   Der Detailtext mit WYSIWYG-Editor
        - Keywords nvarchar(max)      Die Schlagwörter unter dem SEO-Reiter
        - Type nvarchar(256)                Der Objekttyp unter dem SEO-Reiter
        - Author nvarchar(256)            Der Name des Autors
        - AuthorID int                            Die ID des initialen Bearbeiters
        - CreatedDate datetime           Das Erstellungsdatum des Objekts
        - LastModified datetime          Datum der letzten Änderung
        - LastModifier int                      Die ID des letzten Bearbeiters
        Weiterhin werden noch die Felder GlobalID, ItemID, Version, PublishedVersion, LanguageID und PortalID vom System vergeben.
        Bitte stellen Sie sicher, dass Sie keines dieser Felder selbst verwenden.
   6) Bestätigen Sie Ihre Eingaben mit einem Klick auf "Weiter".
8. Warten Sie, bis der Sourcecode Ihres Projekts von der CosyFactory erzeugt wurde
   
   

Bereitstellung

1. Rechtsklicken Sie auf den Projektknoten in Ihrem Projektmappen-Explorer und wählen Sie "Als contentXXL-Modulpaket in Verzeichnis veröffentlichen.
   
   
    
2. Geben Sie den Pfad zu Ihrem contentXXL 5.4+ Installationsverzeichnis an
   
   
    
3. Starten Sie den Sitemanager. Ihr neues Modulpaket wird automatisch von contentXXL erkannt und installiert bzw. die vorherige Modulversion auf den neuen Stand migriert.