Try OpenEdge Now
skip to main content
Web Services Developer's Guide
Deploying Progress Apama widgets

Deploying Progress Apama widgets

You can deploy the Progress® Apama® widgets using Business Process Portal’s web service. Business Process Portal exposes the widget deployment API as a web service that registers dashboard widgets.
Business Process Portal’s web service takes a complex type of object containing the following information as an input parameter.
Table 6. Information contained in a complex type of object of a Web Service
Parameter name
This is the name of the widget that appear in the Add Widget dialog box.
This represents the type of widget. Widget type "compositeui" supports Apama widgets.
This is the name of an application from which the widget is deployed. In case of ‘Common Resource Project’, the widgets are listed below ‘ALL’ application.
You can specify a category for a widget. For Apama widgets, the category must be ‘Apama’. This is a mandatory attribute.
This is the description of a widget.
This is the title for a widget. This appears in the header of the widget.
This is the height of the graph. For iframe based widgets, the height is set to iframe.
For graphical widgets, this is the width of a graph.
This can be set to NULL. To use this parameter, you need to add the renderer jsp and make the URL available. Typically, this is used for customization. If you set this to NULL, then the default renderer for Apama is used.
This is the URL for Apama widgets. You can specify this URL in one of the following ways.Absolute URLUsing server alias
These are the parameters (name-value) pairs for the target URL.
You need to write the widget rendering JSP in the <WEBAPP_DIR>/bpmportal/widget/ext folder, where WEBAPP_DIR is the folder where your application server is installed. The configuration parameter, param name="OEBPS.WebAppDir", is located in the oebps.conf file at OEBPS_HOME/conf folder. The configuration parameter provides the location of the WEBAPP_DIR.
Business Process Portal generates a name for this JSP based on the category you specify. For example, if you set ‘Apama’ as the widget category, then Business Process Portal generates an ApamaWidget.jsp file for displaying the Apama widget. The implementation of this JSP is to call the Apama widget URL (Target URL). The registered widgets are added in the list of components in the Business Process Portal that users can add in their dashboards.