BPM:GUI Plugins: Unterschied zwischen den Versionen

#Nach öffnen des Visual Studio's, wählen Sie bitte Neues Projekt und erstellen eine .NET Framework 4.0 Klassenbibliothek.<br/> <br/> [[File:GUI Plugins 1.png]]<br/> <br/> Getreu dem Motto [http://de.wikipedia.org/wiki/Konvention_vor_Konfiguration Conversion over Configuration] muss der Name '''HTKServer.GUI.Plugins. ''' gefolgt von ihrem Projektnamen lauten.  

#Nun benötigen wir noch verschiedene Projektverweise. Die Basisvariante eines Plugins muss folgende Verweise enthalten.<br/> <br/> [[File:GUI Plugins 2.png]]<br/> <br/> [[File:GUI Plugins 3.png]]<br/> <br/> '''[https://msdn.microsoft.com/en-us/library/system.componentmodel.composition(v=vs.110).aspx System.ComponentModel.Composition]''', '''[https://msdn.microsoft.com/en-us/library/system.componentmodel.dataannotations(v=vs.110).aspx System.ComponentModel.DataAnnotations]''' und '''[https://msdn.microsoft.com/en-us/library/system.windows.forms(v=vs.110).aspx System.Windows.Forms]''' können aus dem .NET Framework Standardkatalog verwiesen werden. '''HTKLicense''', '''HTKServer.GUI.Plugins.IPlugin''' und '''HTKServer.GUI.Shared''' können aus dem Installationsordner der BusinessProcessManagement GUI im Ordner Plugins verwiesen werden.<br/> <br/> [[File:GUI Plugins 4.png]]  

#Nun sollte die Datei<br/> [[File:GUI Plugins 5.png]]<br/> in<br/> [[File:GUI Plugins 6.png]]<br/> umbenannt werden. Sollte es zu einer Meldung kommen ob alle Projektverweise umbenannt werden sollen, so antworten Sie bitte mit JA.,  

#Jetzt lassen wir die Klasse Plugin von der abstrakten Basisklasse '''PluginBase''' erben, sowie von den Interfaces '''IPlugin.IPlugin, ''' '''[https://msdn.microsoft.com/en-us/library/system.componentmodel.composition.ipartimportssatisfiednotification(v=vs.110).aspx IPartImportsSatisfiedNotification]''' und '''[https://msdn.microsoft.com/en-us/library/system.idisposable(v=vs.110).aspx IDisposable]''' im Anschluss implementieren wir die Interfaces durch anklicken der zugehörigen Microsoft Visual Studio Funktion.<br/> <br/> <u>'''IPlugin.IPlugin​''' </u><br/> [[File:GUI Plugins 7.png]]<br/> <u>'''IPartImportsSatisfiedNotification'''</u>​<br/> [[File:GUI Plugins 8.png]]<br/> <br/> '''<u>IDisposable</u> '''<br/> [[File:GUI Plugins 8.png]]  

#OPTIONAL: Es empfiehlt sich als "Best Practice" die Interface Member von <u>'''[https://msdn.microsoft.com/en-us/library/system.componentmodel.composition.ipartimportssatisfiednotification(v=vs.110).aspx IPartImportsSatisfiedNotification]'''</u>und '''[https://msdn.microsoft.com/en-us/library/system.idisposable(v=vs.110).aspx IDisposable]''' per Region einzuklappen wenn diese ungenutzt sind.<br/> [[File:GUI Plugins 9.png]]  

#Nun '''müssen''' wir noch den [http://mef.codeplex.com/wikipage?title=Exports%20and%20Metadata MEF-Export] der DLL definieren. Hierzu '''muss ''' das '''Export ''' Attribut mit dem Entsprechenden Typ des Interfaces, sowie das '''[https://msdn.microsoft.com/en-us/library/ee155691(v=vs.110).aspx#metadata_and_metadata_views ExportMetaData]''' Attribut mit dem entsprechendenm Pluginnamen hinzugefügt werden. Bitte achten Sie darauf dass Sie dies nicht vergessen, denn ohne diese beiden Attribute kann das Plugin nicht erkannt werden.<br/> [[File:GUI Plugins 10.png]]

#Das Interface '''IPlugin''' implementiert 2 Member. <span style="color:#0000FF">public bool</span> <span style="color:#008080">StartupEntr</span> y(<span style="color:#0000FF">ProcessInformation</span> processInformation) und <span style="color:#0000FF">public bool</span> <span style="color:#008080">JobEntry</span> (<span style="color:#0000FF">ProcessInformation</span> processInformation). Was auffällt ist das beide Funktionen den processInformation parameter übergeben bekommen. Der processInformation parameter wird innerhalb der HauptGUI gebildet und beinhaltet folgende schreibgeschützte Properties.<br/> [[File:GUI Plugins 11.png]]<br/> Die Properties sollten selbstsprechend sein, das LocalisationSystem kann durch die Übergabe im Plugin genutzt werden. Die Property ProcessType beinhaltet die Informationen um was für einen Prozess es sich handelt, also bspw. VKBeleg After Save etc.  

#Der Interface Member '''JobEntry''' wird aufgerufen sobald man innerhalb der Business Process Management GUI auf Erweiterte Konfiguration eines Jobs drückt. Hier öffnet man in der Regel eine Maske welche zur erweiterten Konfiguration genutzt werden kann. Es können zusätzlich auch Prüfungen stattfinden, beispielsweise ob ein Mandant gewählt wurde oder nicht. Wenn diese Funktion False zurückgibt, wird der Job nicht gespeichert und das hinterlegte Delete Script innerhalb der [[/doku.php?id=wiki:guipluginassets|Assets]]-Struktur wird aufgerufen, auf das Thema [[/doku.php?id=wiki:guipluginassets|Assets]] gehen wir später ein. Hier ein Beispiel:<br/> <br/> [[File:GUI Plugins 11.png]]<br/> Die [[/doku.php?id=wiki:pluginbase|Basisklasse]] (base.) beinhaltet verschiedene Basisfunktionen wie beispielsweise GetLogger.<br/> ​Die aufgerufene Form sollte als Best Practise immer die folgenden Konstruktor-Parameter definiert haben:<br/> <br/> [[File:GUI Plugins 12.png]]<br/> Um einen FluentLogger zu verwenden (was Sie wirklich tun sollten!), setzen Sie bitte einen Verweis auf die '''HTKFunctionsLibrary ''' welche Sie auch im Plugins Ordner ihrer Installierten Business Process Management GUI finden.<br/> <br/> [[File:|146x22px]]<br/> <br/> '''Achtung''': sollten Sie wie in obigem Beispiel eine [https://documentation.devexpress.com/#WindowsForms/clsDevExpressXtraEditorsXtraMessageBoxtopic XtraMessageBox] verwenden (was optisch besser in das Gesamtbild passt), so benötigen Sie die [https://www.devexpress.com/Products/NET/Controls/WinForms/ DevExpress Komponenten] in der jeweisl vorrausgesetzten Version (siehe Systemvorrausetzungen). Die nötigen Verweise sind<br/> [[File:|233x42px]]<br/> [[File:|178x24px]]​<br/> sowie<br/> <br/> [[File:|209x42px]]<br/> <br/> Desweiteren empfiehlt es sich wenn Sie [https://www.devexpress.com/Products/NET/Controls/WinForms/ Devexpress Komponenten] verwenden, eine [https://documentation.devexpress.com/#WindowsForms/clsDevExpressXtraEditorsXtraFormtopic XtraForm] statt einer Form zu erstellen und in deren Konstruktor folgenden Codeschnipsel zu übernehmen:<br/> <br/> [[File:|255x125px]]<br/> Für die Bonusskins ist ein weiterer Verweis auf<br/> <br/> [[File:|185x24px]]<br/> <br/> erforderlich.<br/> Nach erfolreicher erweiterten Konfiguration geben Sie bitte true zurück<span style="color:#0000FF"><span style="font-size:14px line-height: 19.6000003814697px">.</span></span>  

#Legen Sie nun folgende Ordnerstruktur in Ihrem Projekt an. Die Dateien können je nach bedarf hinzugefügt werden. DIe Ordnerstruktur sollten Sie allerdings standardmäßig so anlegen. Bitte achten Sie auf Korrekte Benennung der Ordnerstruktur.<br/> <br/> [[File:|285x306px]]<br/> '''Achtung: '''<u>Alle [[/doku.php?id=wiki:guipluginassets|Assets]]'''müssen''' bei Buildvorgang Eingebettete Ressource hinterlegt haben!<br/> [[File:|266x37px]]</u>  

#'''Cleanup: ''' Der Ordner Cleanup beinhaltet Scripte welche benötigt werden um die Tabellenstrukturen "sauber" zu halten. Auch wenn Sie alles korrekt gemacht haben, sollten Sie trotzdem ein solchen Script hinterlegen. Die Scripte werden automatisch ausgeführt. Es empfiehlt sich als Best Practise den Namen der zu "cleanenden" Tabelle als Scriptname zu hinterlegen.<br/> <br/> [[File:|190x22px]]<br/> <br/> Script-Beispiel:<br/>