Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Difference between revisions of "Stardust/Enhancing and Embedding Stardust/Browser Modeler/Application Overlay"

Line 7: Line 7:
 
The definition of Extensions to the Application Overlay (as well as those for the Event Overlay) need to reside in arbitrary JavaScript files '''integrationOverlay''' of your '''modelerExtensions''' folder. For convenience you may create one '''integrationOverlay.js''' file in that folder.
 
The definition of Extensions to the Application Overlay (as well as those for the Event Overlay) need to reside in arbitrary JavaScript files '''integrationOverlay''' of your '''modelerExtensions''' folder. For convenience you may create one '''integrationOverlay.js''' file in that folder.
  
 +
<source lang="javascript">
 
define(
 
define(
[ "bpm-modeler/js/GenericEndpointOverlay",
+
[ "test/js/SqlOverlay"],
"bpm-modeler/js/MailIntegrationOverlay",
+
function(SqlOverlay) {
"bpm-modeler/js/RestServiceOverlay",
+
"bpm-modeler/js/RulesIntegrationOverlay",
+
"bpm-modeler/js/ScriptingIntegrationOverlay",
+
"bpm-modeler/js/m_manualTriggerIntegrationOverlay",
+
"bpm-modeler/js/m_timerEventIntegrationOverlay",
+
"bpm-modeler/js/m_fileEventIntegrationOverlay",
+
"bpm-modeler/js/m_emailEventIntegrationOverlay",
+
"bpm-modeler/js/m_messageEventIntegrationOverlay",
+
"bpm-modeler/js/m_scanEventIntegrationOverlay",
+
"bpm-modeler/js/m_genericCamelRouteEventIntegrationOverlay" ],
+
function(GenericEndpointOverlay, MailIntegrationOverlay, RestServiceOverlay, RulesIntegrationOverlay, ScriptingIntegrationOverlay, m_manualTriggerIntegrationOverlay,
+
m_timerEventIntegrationOverlay, m_fileEventIntegrationOverlay,
+
m_emailEventIntegrationOverlay,
+
m_messageEventIntegrationOverlay,
+
m_scanEventIntegrationOverlay,
+
m_genericCamelRouteEventIntegrationOverlay) {
+
 
return {
 
return {
 
applicationIntegrationOverlay : [ {
 
applicationIntegrationOverlay : [ {
id : "genericEndpointOverlay",
+
id : "sqlOverlay",
name : "Generic Camel Endpoint",
+
name : "SQL Database Access",
pageHtmlUrl : "genericEndpointOverlay.html",
+
pageHtmlUrl : "sqlOverlay.html",
provider : GenericEndpointOverlay
+
provider : SqlOverlay
}, {
+
id : "mailIntegrationOverlay",
+
name : "E-Mail Send/Receive",
+
pageHtmlUrl : "mailIntegrationOverlay.html",
+
provider : MailIntegrationOverlay,
+
visibility : "preview"
+
}, {
+
id : "restServiceOverlay",
+
name : "REST Service",
+
pageHtmlUrl : "restServiceOverlay.html",
+
provider : RestServiceOverlay
+
},
+
{
+
id : "rulesIntegrationOverlay",
+
name : "Rules Set Invocation",
+
pageHtmlUrl: "rulesIntegrationOverlay.html",
+
provider : RulesIntegrationOverlay,
+
},
+
{
+
id : "scriptingIntegrationOverlay",
+
name : "Script Invocation",
+
pageHtmlUrl: "scriptingIntegrationOverlay.html",
+
provider : ScriptingIntegrationOverlay,
+
visibility : "preview"
+
 
}],
 
}],
eventIntegrationOverlay : [
+
eventIntegrationOverlay : [ ... ]
{
+
id : "manualTrigger",
+
name : "Manual Start by User",
+
eventTypes : [ "startEvent" ],
+
eventClass : "none",
+
pageHtmlUrl : "manualTriggerIntegrationOverlay.html",
+
provider : m_manualTriggerIntegrationOverlay
+
},
+
{
+
id : "timerEvent",
+
name : "Timer Event",
+
eventTypes : [ "startEvent", "intermediateEvent" ],
+
eventClass : "timer",
+
pageHtmlUrl : "timerEventIntegrationOverlay.html",
+
provider : m_timerEventIntegrationOverlay
+
},
+
{
+
id : "fileEvent",
+
name : "File Event",
+
eventTypes : [ "startEvent", "intermediateEvent",
+
"endEvent" ],
+
eventClass : "message",
+
pageHtmlUrl : "fileEventIntegrationOverlay.html",
+
provider : m_fileEventIntegrationOverlay
+
},
+
{
+
id : "emailEvent",
+
name : "EMail Event",
+
eventTypes : [ "startEvent", "intermediateEvent",
+
"endEvent" ],
+
eventClass : "message",
+
pageHtmlUrl : "emailEventIntegrationOverlay.html",
+
provider : m_emailEventIntegrationOverlay
+
},
+
{
+
id : "messageEvent",
+
name : "Message Event",
+
eventTypes : [ "startEvent", "intermediateEvent",
+
"endEvent" ],
+
eventClass : "message",
+
pageHtmlUrl : "messageEventIntegrationOverlay.html",
+
provider : m_messageEventIntegrationOverlay
+
},
+
{
+
id : "scanEvent",
+
name : "Scan Event",
+
eventTypes : [ "startEvent" ],
+
eventClass : "message",
+
pageHtmlUrl : "scanEventIntegrationOverlay.html",
+
provider : m_scanEventIntegrationOverlay
+
},
+
{
+
id : "genericCamelRouteEvent",
+
name : "Generic Camel Route Event",
+
eventTypes : [ "startEvent" ],
+
eventClass : "message",
+
pageHtmlUrl : "genericCamelRouteEventIntegrationOverlay.html",
+
provider : m_genericCamelRouteEventIntegrationOverlay
+
} ]
+
 
};
 
};
 
});
 
});
 +
</source>
 +
 +
= Implementation =
 +
 +
The implementation of the Overlay requires an HTML file, e.g.
 +
 +
<source lang="html">
 +
</source>
 +
 +
and a JavaScript controller
 +
 +
<source lang="javascript">
 +
</source>
  
 
= Runtime =
 
= Runtime =

Revision as of 08:36, 13 June 2013

Purpose

The Application Overlay Extension Point allows you to create a pluggable user interface for arbitrary applications invoked from the Browser Modeler.

Definition

The definition of Extensions to the Application Overlay (as well as those for the Event Overlay) need to reside in arbitrary JavaScript files integrationOverlay of your modelerExtensions folder. For convenience you may create one integrationOverlay.js file in that folder.

define(
		[ "test/js/SqlOverlay"],
		function(SqlOverlay) {
			return {
				applicationIntegrationOverlay : [ {
					id : "sqlOverlay",
					name : "SQL Database Access",
					pageHtmlUrl : "sqlOverlay.html",
					provider : SqlOverlay
				}],
				eventIntegrationOverlay : [ ... ]
			};
		});

Implementation

The implementation of the Overlay requires an HTML file, e.g.

Invalid language.

You need to specify a language like this: <source lang="html4strict">...</source>

Supported languages for syntax highlighting:

4cs, 6502acme, 6502kickass, 6502tasm, 68000devpac, abap, actionscript, actionscript3, ada, algol68, apache, applescript, apt_sources, arm, asm, asp, asymptote, autoconf, autohotkey, autoit, avisynth, awk, bascomavr, bash, basic4gl, bf, bibtex, blitzbasic, bnf, boo, c, c_loadrunner, c_mac, caddcl, cadlisp, cfdg, cfm, chaiscript, cil, clojure, cmake, cobol, coffeescript, cpp, cpp-qt, csharp, css, cuesheet, d, dcl, dcpu16, dcs, delphi, diff, div, dos, dot, e, ecmascript, eiffel, email, epc, erlang, euphoria, f1, falcon, fo, fortran, freebasic, freeswitch, fsharp, gambas, gdb, genero, genie, gettext, glsl, gml, gnuplot, go, groovy, gwbasic, haskell, haxe, hicest, hq9plus, html4strict, html5, icon, idl, ini, inno, intercal, io, j, java, java5, javascript, jquery, kixtart, klonec, klonecpp, latex, lb, ldif, lisp, llvm, locobasic, logtalk, lolcode, lotusformulas, lotusscript, lscript, lsl2, lua, m68k, magiksf, make, mapbasic, matlab, mirc, mmix, modula2, modula3, mpasm, mxml, mysql, nagios, netrexx, newlisp, nsis, oberon2, objc, objeck, ocaml, ocaml-brief, octave, oobas, oorexx, oracle11, oracle8, otj, oxygene, oz, parasail, parigp, pascal, pcre, per, perl, perl6, pf, php, php-brief, pic16, pike, pixelbender, pli, plsql, postgresql, povray, powerbuilder, powershell, proftpd, progress, prolog, properties, providex, purebasic, pycon, pys60, python, q, qbasic, rails, rebol, reg, rexx, robots, rpmspec, rsplus, ruby, sas, scala, scheme, scilab, sdlbasic, smalltalk, smarty, spark, sparql, sql, stonescript, systemverilog, tcl, teraterm, text, thinbasic, tsql, typoscript, unicon, upc, urbi, uscript, vala, vb, vbnet, vedit, verilog, vhdl, vim, visualfoxpro, visualprolog, whitespace, whois, winbatch, xbasic, xml, xorg_conf, xpp, yaml, z80, zxbasic



and a JavaScript controller

 

Runtime

Back to the top