1.381
Bearbeitungen
BPM:GUI Plugins: Unterschied zwischen den Versionen
Zur Navigation springen
Zur Suche springen
keine Bearbeitungszusammenfassung
Admin (Diskussion | Beiträge) Keine Bearbeitungszusammenfassung |
Admin (Diskussion | Beiträge) Keine Bearbeitungszusammenfassung |
||
| Zeile 38: | Zeile 38: | ||
#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|RTENOTITLE]] | #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|RTENOTITLE]] | ||
#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/> | #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/> | ||
#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/> <span style="color:#FF0000">[[File:Variablen.png]]</span><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. | #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/> <span style="color:#FF0000">[[File:Variablen.png|RTENOTITLE]]</span><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 '''StartupEntry''' wird bei allen Plugins nach dem Druck auf Login / Anmelden ausgeführt. Dies kann also dazu genutzt werden, um bspw. einmalig etwas beim ersten Aufruf auszuführen, egal ob der Prozess definiert wurde oder nicht. Bspw. "Achtung, die Grundlagen für das Plugin XYZ werden nun automatisch eingerichtet, bitte haben Sie einen moment Geduld". Wichtig ist hierbei nur, dass diese Methoden '''immer ''' ausgeführt werden, d.H. Sie müssen bei Verwendung des StartupEntry Einstiegspunktes aufjedenfall dafür sorgen, dass Sie per Markierung in der DB oder in einer Datei ein erneutes Aufrufen verhindern, sonst würde man in dem genannten Beispiel bei jedem Start der GUI wieder nach der Grundlageninstallation gefragt werden. '''Achtung''' Dies betrifft nur dinge welche beim aufruf der Gui gestartet werden müssen und nicht mit der Standardinstallationsroutine für Pluginvorrausetzungen abbilden werden können. Die funktion sollte true zurückgeben wenn Sie nicht genutzt wird, oder wenn es keine Probleme gab, ansonsten natürlich False. | #Der Interface Member '''StartupEntry''' wird bei allen Plugins nach dem Druck auf Login / Anmelden ausgeführt. Dies kann also dazu genutzt werden, um bspw. einmalig etwas beim ersten Aufruf auszuführen, egal ob der Prozess definiert wurde oder nicht. Bspw. "Achtung, die Grundlagen für das Plugin XYZ werden nun automatisch eingerichtet, bitte haben Sie einen moment Geduld". Wichtig ist hierbei nur, dass diese Methoden '''immer ''' ausgeführt werden, d.H. Sie müssen bei Verwendung des StartupEntry Einstiegspunktes aufjedenfall dafür sorgen, dass Sie per Markierung in der DB oder in einer Datei ein erneutes Aufrufen verhindern, sonst würde man in dem genannten Beispiel bei jedem Start der GUI wieder nach der Grundlageninstallation gefragt werden. '''Achtung''' Dies betrifft nur dinge welche beim aufruf der Gui gestartet werden müssen und nicht mit der Standardinstallationsroutine für Pluginvorrausetzungen abbilden werden können. Die funktion sollte true zurückgeben wenn Sie nicht genutzt wird, oder wenn es keine Probleme gab, ansonsten natürlich False. | ||
#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|RTENOTITLE]]<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|RTENOTITLE]]<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/> <span style="color:#FF0000">[[File:FunktionsLibrary.png]]</span><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/> <span style="color:#FF0000">[[File:Verweise DevExpress.png]]</span> | #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|RTENOTITLE]]<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|RTENOTITLE]]<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/> <span style="color:#FF0000">[[File:FunktionsLibrary.png|RTENOTITLE]]</span><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/> <span style="color:#FF0000">[[File:Verweise DevExpress.png|RTENOTITLE]]</span> | ||
#[[File:DevExpress.png]] | #[[File:DevExpress.png|RTENOTITLE]] | ||
#sowie<br/> <br/> <span style="color:#FF0000">[[File:Devexpress2.png]]</span><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/> <span style="color:#FF0000"> | #sowie<br/> <br/> <span style="color:#FF0000">[[File:Devexpress2.png|RTENOTITLE]]</span><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/> <span style="color:#FF0000">[[File:Express methoden.png]]</span><br/> Für die Bonusskins ist ein weiterer Verweis auf<br/> <br/> <span style="color:#FF0000">[[File:Bonus Skin.png]]</span><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/> <span style="color:#FF0000">Assetbaum</span><br/> '''Achtung: '''<u>Alle [[/doku.php?id=wiki:guipluginassets|Assets]]'''müssen''' bei Buildvorgang Eingebettete Ressource hinterlegt haben!<br/> <span style="color:#FF0000">Bildvorgang</span></u> | #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/> <span style="color:#FF0000">[[File:Assetbaum.png]]</span><br/> '''Achtung: '''<u>Alle [[/doku.php?id=wiki:guipluginassets|Assets]]'''müssen''' bei Buildvorgang Eingebettete Ressource hinterlegt haben!<br/> <span style="color:#FF0000">[[File:Bildvorgang.png]]</span></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: | #'''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:Plugin beispiel.png]]<br/> <br/> Script-Beispiel: | ||
#'''Delete: ''' Der Ordner Delete beinhaltet Scripte, welche ausgeführt werden wenn die Methode '''JobEntry ''' false zurückgibt. Auch hier empfiehlt sich als Namensgebung der Tabellenname.<br/> <br/> [[File: | #[[File:Scriptbeispiel1.png]] | ||
#'''Graphics → Icons: ''' In diesen Ordner können Grafikdateien hinterlegt werden, welche als Grundlage für die RibbonButtons dienen. Es empfiehlt sich *.ico Dateien zu verwenden. Beispiel:<br/> <br/> [[File: | #'''Delete: ''' Der Ordner Delete beinhaltet Scripte, welche ausgeführt werden wenn die Methode '''JobEntry ''' false zurückgibt. Auch hier empfiehlt sich als Namensgebung der Tabellenname.<br/> <br/> [[File:Plugin beispiel.png]]<br/> Script-Beispiel:<br/> [[File:Scriptbeispiel2.png]]<br/> Im speziellen Fall des Delete-Scriptes stehen folgende [[/doku.php?id=wiki:guiplatzhalter|Platzhalter]] zur Verfügung. @Mandant und @JobId, bitte achten Sie bei Verwendung der Variablen auf die korrekte Bennenung. | ||
#'''Info: ''' Der Ordner Info beinhaltet die '''[[/doku.php?id=wiki:productxml|Product.xml]]''' welche folgenden Aufbau hat.<br/> [[File:]]<br/> * '''ValidationKey:''' Der ValidationKey der HTK Lizensierung. * | #'''Graphics → Icons: ''' In diesen Ordner können Grafikdateien hinterlegt werden, welche als Grundlage für die RibbonButtons dienen. Es empfiehlt sich *.ico Dateien zu verwenden. Beispiel:<br/> <br/> [[File:Grafiks.png]] | ||
#'''Info: ''' Der Ordner Info beinhaltet die '''[[/doku.php?id=wiki:productxml|Product.xml]]''' welche folgenden Aufbau hat.<br/> [[File:Product.png]]<br/> * '''ValidationKey:''' Der ValidationKey der HTK Lizensierung. * | |||
#*'''DemoSerial:''' Hier kann eine Standard Demoseriennummer. * | #*'''DemoSerial:''' Hier kann eine Standard Demoseriennummer. * | ||
#*'''SettingsXml:''' Hier kann die zu verwendende SettingsXML. * | #*'''SettingsXml:''' Hier kann die zu verwendende SettingsXML. * | ||