Expecco Plugin API/en - Versionsgeschichte

Cg: /* Sample Plugin Creation Session */

2019-09-03T09:31:40Z

Sample Plugin Creation Session

Cg: /* Sample Plugins */

2019-02-13T21:52:54Z

Sample Plugins

← Nächstältere Version		Version vom 13. Februar 2019, 21:52 Uhr
Zeile 116:		Zeile 116:

	== Sample Plugins ==		== Sample Plugins ==
	The expecco installation includes some small example plugins in the "plugin/demoPlugins"-folder. These can be used as templates to develop additional personal plugins.		The expecco installation includes some small example plugins in the "<code>plugin/demoPlugins</code>"-folder. These can be used as templates to develop additional personal plugins.

	* '''DemoPluginWithMenuOnly''' (file: "Expecco__DemoPluginWithMenuOnly") - does exactly what its name implies: it adds additional menu items which open an information notifier when invoked.		* '''DemoPluginWithMenuOnly''' (file: "<code>Expecco__DemoPluginWithMenuOnly</code>") - does exactly what its name implies: it adds additional menu items which open an information notifier when invoked.

	* '''DemoPluginWithSettingsGUI''' (file: "Expecco__DemoPluginWithSettingsGUI") - in addition to the above, this example also adds a settings dialog entry		* '''DemoPluginWithSettingsGUI''' (file: "<code>Expecco__DemoPluginWithSettingsGUI</code>") - in addition to the above, this example also adds a settings dialog entry

	* '''PrePostTestRunShellExecutionPlugin''' (file: "Expecco__PrePostTestRunShellExecutionPlugin") - implements dummy callbacks to monitor test execution.		* '''PrePostTestRunShellExecutionPlugin''' (file: "<code>Expecco__PrePostTestRunShellExecutionPlugin</code>") - implements dummy callbacks to monitor test execution.

	== Sample Plugin Creation Session ==		== Sample Plugin Creation Session ==

Cg: /* Sample Plugin Creation Session */

2019-02-13T21:51:34Z

Sample Plugin Creation Session

← Nächstältere Version		Version vom 13. Februar 2019, 21:51 Uhr
Zeile 157:		Zeile 157:
	** then open the right-button menu and choose "''More''" - "''Misc''" "''Insert new UUID''"		** then open the right-button menu and choose "''More''" - "''Misc''" "''Insert new UUID''"
	** place single quotes around the UUID string		** place single quotes around the UUID string

			The next step is to save the plugin code to a file:
			* select the "''FileOut As...''" menu function in the lass-menu.
			** navigate to the expecco installation folder's "plugins" subfolder and save your code there.

			Restart expecco.

	----		----

Cg: /* Sample Plugin Creation Session */

2019-02-13T21:48:10Z

Sample Plugin Creation Session

Cg: /* Sample Plugin Creation Session */

2019-02-13T21:43:36Z

Sample Plugin Creation Session

← Nächstältere Version		Version vom 13. Februar 2019, 21:43 Uhr
Zeile 145:		Zeile 145:
	category:'Expecco-Plugin-QMRestAnnounce'		category:'Expecco-Plugin-QMRestAnnounce'
	</code></pre>		</code></pre>
	** press "Accept" (the green bar on the left) or choose "Accept" from the codeview's right-button menu (CTRL-s will also do)		** press "Accept" (the green bar on the left) or choose "Accept" from the codeview's right-button menu (<kbd>CTRL-s</kbd> will also do)
	** concratulations: you have created a new class!.		** concratulations: you have created a new class!.
	* create the minimum required code via the class-menus "Generate" - "Required Protocol" menu function.		* create the minimum required code via the class-menus "Generate" - "Required Protocol" menu function.

Cg: /* Expecco Plugin API */

2018-12-17T09:17:33Z

Expecco Plugin API

← Nächstältere Version		Version vom 17. Dezember 2018, 09:17 Uhr
Zeile 10:		Zeile 10:
	The expecco plugin API allows for both graphical and non-graphical extensions to be built for and added to expecco. Plugins are allowed to add items to the top menu, to the toolbar, to popup-menus in the tree or the diagram editor, and to add additional pages (tabs) to the testplan and testcase editors, and to the settings dialog. Plugins can also add custom fields to any artefact, for example to remember links or ids for external program interfacing.		The expecco plugin API allows for both graphical and non-graphical extensions to be built for and added to expecco. Plugins are allowed to add items to the top menu, to the toolbar, to popup-menus in the tree or the diagram editor, and to add additional pages (tabs) to the testplan and testcase editors, and to the settings dialog. Plugins can also add custom fields to any artefact, for example to remember links or ids for external program interfacing.

	Plugins which are placed ~~into~~ the "plugins" directory are automatically loaded and installed when expecco is started. Other plugins can be installed at any later time via the settings dialog. You can slightly speed up the initial startup of expecco, by placing unused plugins into a separate folder.		Plugins which are placed in or under the "<code>plugins</code>" directory are automatically loaded and installed when expecco is started. Other plugins can be installed at any later time via the settings dialog. You can slightly speed up the initial startup of expecco, by placing unused plugins into a separate folder.

	Usually, plugins consist of dlls (dynamic link libraries) which contain binary compiled code.		Usually, plugins consist of dlls (dynamic link libraries) which contain binary compiled code.

Cg: /* Introduction */

2018-12-17T09:15:41Z

Introduction

← Nächstältere Version		Version vom 17. Dezember 2018, 09:15 Uhr
Zeile 2:		Zeile 2:
	== Introduction ==		== Introduction ==

	Expecco is built on an open architecture, which allows for additional functions to be added dynamically. Customers, eXept and third parties can therefore add more functions via plugins.		Expecco is built on an open architecture, which allows for additional functions to be added dynamically. Customers, eXept and third parties can therefore add more functions via plugins.

			This document is for plugin developers and describes the plugin API and required protocol which has to be implemented by a plugin.

	== Expecco Plugin API ==		== Expecco Plugin API ==

Cg: /* Sample Plugin Creation Session */

2018-05-16T17:29:06Z

Sample Plugin Creation Session

@@ Zeile 126: / Zeile 126: @@
 The following simple plugin shall install a post-testplan-execute action, which sends a REST message to an (alien) quality management system.
 [[Datei:Plugin_SystemBrowser1.png|200px|thumb|right|Class Browser & Class Search Menu]]
-* open a Class Browser via "Extras" - "Tools" - "Class Browser", and find the "UserPlugin" class:
+* open a Class Browser via "Extras" - "Tools" - "Class Browser", and find the "AbstractUserPlugin" class:
-* right click into the top-left category-list and select the "Find Class..." menu item,
+** right click into the top-left category-list and select the "Find Class..." menu item,
-* enter: "UserPlugin" into the now appearing class-search dialog
+** enter: "UserPlugin" into the now appearing class-search dialog
-* an entry named "Expecco::AbstractUserPlugin" should be in the list;
+** an entry named "Expecco::AbstractUserPlugin" should be in the list;
-* select it and close the dialog with the "Find" button at the bottom (or double click on the "Expecco::AbstractUserPlugin" entry in the list).
+** select it and close the dialog with the "Find" button at the bottom (or double click on the "Expecco::AbstractUserPlugin" entry in the list).
 ----

Cg: /* Sample Plugin Creation Session */

2018-05-15T09:39:33Z

Sample Plugin Creation Session

← Nächstältere Version		Version vom 15. Mai 2018, 09:39 Uhr
Zeile 125:		Zeile 125:

	The following simple plugin shall install a post-testplan-execute action, which sends a REST message to an (alien) quality management system.		The following simple plugin shall install a post-testplan-execute action, which sends a REST message to an (alien) quality management system.
⚫	* open a Class Browser via "Extras" - "Tools" - "Class Browser", and find the "UserPlugin" class:
	[[Datei:Plugin_SystemBrowser1.png\|200px\|thumb\|right\|Class Browser & Class Search Menu]]		[[Datei:Plugin_SystemBrowser1.png\|200px\|thumb\|right\|Class Browser & Class Search Menu]]
		⚫	* open a Class Browser via "Extras" - "Tools" - "Class Browser", and find the "UserPlugin" class:
	* right click into the top-left category-list and select the "Find Class..." menu item,		* right click into the top-left category-list and select the "Find Class..." menu item,
	* enter: "UserPlugin" into the now appearing class-search dialog		* enter: "UserPlugin" into the now appearing class-search dialog

Cg: /* Sample Plugin Creation Session */

2018-05-15T09:39:16Z

Sample Plugin Creation Session

← Nächstältere Version		Version vom 15. Mai 2018, 09:39 Uhr
Zeile 125:		Zeile 125:

	The following simple plugin shall install a post-testplan-execute action, which sends a REST message to an (alien) quality management system.		The following simple plugin shall install a post-testplan-execute action, which sends a REST message to an (alien) quality management system.
	~~First~~ open a Class Browser via "Extras" - "Tools" - "Class Browser", and find the "UserPlugin" class:		* open a Class Browser via "Extras" - "Tools" - "Class Browser", and find the "UserPlugin" class:
	[[Datei:Plugin_SystemBrowser1.png\|200px\|thumb\|right\|Class Browser & Class Search Menu]]		[[Datei:Plugin_SystemBrowser1.png\|200px\|thumb\|right\|Class Browser & Class Search Menu]]
			* right click into the top-left category-list and select the "Find Class..." menu item,
			* enter: "UserPlugin" into the now appearing class-search dialog
			* an entry named "Expecco::AbstractUserPlugin" should be in the list;
			* select it and close the dialog with the "Find" button at the bottom (or double click on the "Expecco::AbstractUserPlugin" entry in the list).


	----		----
	Back to [[Plugins]]<br>		Back to [[Plugins]]<br>

← Nächstältere Version		Version vom 3. September 2019, 09:31 Uhr
Zeile 128:		Zeile 128:
	The following simple plugin shall install a post-testplan-execute action, which sends a REST message to an (alien) quality management system.		The following simple plugin shall install a post-testplan-execute action, which sends a REST message to an (alien) quality management system.
	[[Datei:Plugin_SystemBrowser1.png\|200px\|thumb\|right\|Class Browser & Class Search Menu]]		[[Datei:Plugin_SystemBrowser1.png\|200px\|thumb\|right\|Class Browser & Class Search Menu]]
	* open a Class Browser via "''Extras''" - "''Tools''" - "''Class Browser''", and find the "<code>AbstractUserPlugin</code>" class:		* open a Class Browser via "''Extras''" → "''Tools''" → "''Class Browser''", and find the "<code>AbstractUserPlugin</code>" class:
	** right click into the top-left category-list and select the "''Find Class...''" menu item,		** right click into the top-left category-list and select the "''Find Class...''" menu item,
	** enter: "<code>UserPlugin</code>" into the now appearing class-search dialog		** enter: "<code>UserPlugin</code>" into the now appearing class-search dialog
Zeile 147:		Zeile 147:
	** press "''Accept''" (the green bar on the left) or choose "''Accept''" from the codeview's right-button menu (<kbd>CTRL-s</kbd> will also do)		** press "''Accept''" (the green bar on the left) or choose "''Accept''" from the codeview's right-button menu (<kbd>CTRL-s</kbd> will also do)
	** concratulations: you have created a new class!.		** concratulations: you have created a new class!.
	* create the minimum required code via the class-menus "''Generate''" - "''Required Protocol''" menu function.		* create the minimum required code via the class-menus "''Generate''" → "''Required Protocol''" menu function.
	** right click into the second-top-left class list and select the "''Generate''" menu item,		** right click into the second-top-left class list and select the "''Generate''" menu item,
	** a submenu appears; select the last item named "''Required Protocol''"		** a submenu appears; select the last item named "''Required Protocol''"
Zeile 155:		Zeile 155:
	** select the "<code>pluginUUID</code>" method in the top-right list.		** select the "<code>pluginUUID</code>" method in the top-right list.
	** in the codeview: select the "<code>self shouldImplement</code>" piece of code (left click and move),		** in the codeview: select the "<code>self shouldImplement</code>" piece of code (left click and move),
	** then open the ~~right-button~~ menu and choose "''More''" - "''Misc''" "''Insert new UUID''"		** then open the context menu (right button) and choose "''More''" → "''Misc''" → "''Insert new UUID''"
	** place single quotes around the UUID string		** place single quotes around the UUID string

← Nächstältere Version		Version vom 13. Februar 2019, 21:48 Uhr
Zeile 128:		Zeile 128:
	The following simple plugin shall install a post-testplan-execute action, which sends a REST message to an (alien) quality management system.		The following simple plugin shall install a post-testplan-execute action, which sends a REST message to an (alien) quality management system.
	[[Datei:Plugin_SystemBrowser1.png\|200px\|thumb\|right\|Class Browser & Class Search Menu]]		[[Datei:Plugin_SystemBrowser1.png\|200px\|thumb\|right\|Class Browser & Class Search Menu]]
	* open a Class Browser via "Extras" - "Tools" - "Class Browser", and find the "AbstractUserPlugin" class:		* open a Class Browser via "''Extras''" - "''Tools''" - "''Class Browser''", and find the "<code>AbstractUserPlugin</code>" class:
	** right click into the top-left category-list and select the "Find Class..." menu item,		** right click into the top-left category-list and select the "''Find Class...''" menu item,
	** enter: "UserPlugin" into the now appearing class-search dialog		** enter: "<code>UserPlugin</code>" into the now appearing class-search dialog
	** an entry named "Expecco::AbstractUserPlugin" should be in the list;		** an entry named "<code>Expecco::AbstractUserPlugin</code>" should be in the list;
	** select it and close the dialog with the "Find" button at the bottom (or double click on the "Expecco::AbstractUserPlugin" entry in the list).		** select it and close the dialog with the "''Find''" button at the bottom (or double click on the "<code>Expecco::AbstractUserPlugin</code>" entry in the list).
	* create a new subclass of "AbstractUserPlugin":		* create a new subclass of "<code>AbstractUserPlugin</code>":
	** right click into the second-top-left class list and select the "New - Subclass" menu item,		** right click into the second-top-left class list and select the "''New - Subclass''" menu item,
	** a definition template will appear; replace "NewClass" by "QMRestAnnouncePlugin" and the category by "'Expecco-Plugin-QMRestAnnounce'" (notice the quotes)		** a definition template will appear; replace "<code>NewClass</code>" by "<code>QMRestAnnouncePlugin</code>" and the category by "<code>'Expecco-Plugin-QMRestAnnounce'</code>" (notice the quotes)
	** you should now have the folowing code on your screen:		** you should now have the folowing code on your screen:
	"{ NameSpace: Expecco }"		"{ NameSpace: Expecco }"
Zeile 145:		Zeile 145:
	category:'Expecco-Plugin-QMRestAnnounce'		category:'Expecco-Plugin-QMRestAnnounce'
	</code></pre>		</code></pre>
	** press "Accept" (the green bar on the left) or choose "Accept" from the codeview's right-button menu (<kbd>CTRL-s</kbd> will also do)		** press "''Accept''" (the green bar on the left) or choose "''Accept''" from the codeview's right-button menu (<kbd>CTRL-s</kbd> will also do)
	** concratulations: you have created a new class!.		** concratulations: you have created a new class!.
	* create the minimum required code via the class-menus "Generate" - "Required Protocol" menu function.		* create the minimum required code via the class-menus "''Generate''" - "''Required Protocol''" menu function.
	** right click into the second-top-left class list and select the "Generate" menu item,		** right click into the second-top-left class list and select the "''Generate''" menu item,
	** a submenu appears; select the last item named "Required Protocol"		** a submenu appears; select the last item named "''Required Protocol''"
	** this created a bunch of methods which are the minimum required methods for plugin classes.		** this created a bunch of methods which are the minimum required methods for plugin classes.
	* change the pluginUUID class method to provide a unique UUID		* change the pluginUUID class method to provide a unique UUID
	** select the "Class" radio control (in the Instance/Class radio group)		** select the "''Class''" radio control (in the Instance/Class radio group)
	** select the "pluginUUID" method in the top-right list.		** select the "<code>pluginUUID</code>" method in the top-right list.
	** in the codeview: select the "self shouldImplement" piece of code (left click and move),		** in the codeview: select the "<code>self shouldImplement</code>" piece of code (left click and move),
	** then open the right-button menu and choose "More" - "Misc" "Insert new UUID"		** then open the right-button menu and choose "''More''" - "''Misc''" "''Insert new UUID''"
	** place single quotes around the UUID string		** place single quotes around the UUID string