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.
Difference between revisions of "Stardust/Enhancing and Embedding Stardust/Browser Modeler/Application Overlay"
Line 4: | Line 4: | ||
= Definition = | = 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( | ||
+ | [ "bpm-modeler/js/GenericEndpointOverlay", | ||
+ | "bpm-modeler/js/MailIntegrationOverlay", | ||
+ | "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 { | ||
+ | applicationIntegrationOverlay : [ { | ||
+ | id : "genericEndpointOverlay", | ||
+ | name : "Generic Camel Endpoint", | ||
+ | pageHtmlUrl : "genericEndpointOverlay.html", | ||
+ | provider : GenericEndpointOverlay | ||
+ | }, { | ||
+ | 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 : [ | ||
+ | { | ||
+ | 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 | ||
+ | } ] | ||
+ | }; | ||
+ | }); | ||
= Runtime = | = Runtime = |
Revision as of 08:29, 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( [ "bpm-modeler/js/GenericEndpointOverlay", "bpm-modeler/js/MailIntegrationOverlay", "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 { applicationIntegrationOverlay : [ { id : "genericEndpointOverlay", name : "Generic Camel Endpoint", pageHtmlUrl : "genericEndpointOverlay.html", provider : GenericEndpointOverlay }, { 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 : [ { 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 } ] }; });