Try OpenEdge Now
skip to main content
Application Developer's Guide
Developing an application : Using BPM Workflow JSP tags
 

Using BPM Workflow JSP tags

At run time, BPM Workflow facilitates the generation of JSP-based interfaces by using XML-like tags and scripts to generate an interface page. These tags are maintained in the JSP Tag Library, allowing developers to introduce additional complexity into their JSP pages without discarding the general "look and feel" of the JSP pages or the user’s ability to customize these types of pages. The following table presents a list of the JSP tags defined in BPMWebFlow.
Attributes in bold and italic (example, name) are required fields. The default in a group of options (example, STRING) is underlined.
Table 6. Defined JSP 1.1 tags
Name
Attributes
Description
bizsolo:initApp
<name="name"/mode="mode">
Creates context at application’s initialization. Includes the generateID functionality, which creates a String representation of a unique ID and makes it available to the page context, under the specified name.
bizsolo:initDS
< name="STRING,
LONG, DOUBLE, ..."
[type="TYPE"]
[label="label"]
[value="value"]
[param="param"]
[hexval={"TRUE|FALSE"}]
[choices="choices"]/>
Creates a new BPMWebFlow dataslot, with the given name, type, value and choices. If the type is not specified, then the default type is CHARACTER. Allowed values for type are: CHARACTER, INTEGER, INT64, DECIMAL, BOOLEAN, OBJECT, LIST, DATETIME-TZ, RADIO, CHECKBOX, SELECT, MSELECT, and TEXTAREA.
The label for the dataslot can be specified using label = "label".The value used for initialization can be specified directly, using value="value", or it can be taken from the HTTP request object, by searching for a request parameter with the same name. If the parameter name is different, then it can be specified by using param="param".If the value, either specified directly or taken from the request object, is hexencoded, then this has to be specified by setting hexval="TRUE".
bizsolo:setDS
< name="name"[type="TYPE"]
[value="value"]
[hexval={"TRUE|FALSE"}]/>
Updates the named BPMWebFlow dataslot. If the value is specified as hexencoded (default is False), then hexencoding is performed prior to updating. If value is set, then the update is performed by using "value" instead of the value retrieved from the Request object.
bizsolo:getDS
<name="name"[type="TYPE"]
[writePerm={"TRUE|FALSE"}]
[required={"TRUE|FALSE"}]
[password={"TRUE|FALSE"}]
[size="40"] [maxlength="100"]
[rows="5"][cols="40"]
[docInterface=
{"JavaApplet|JavaScript"}]
[mode=["StandAlone"]]
[multiline={"TRUE|FALSE"}]
[appendWith=["..."]]
[precision=["..."]]
[scale=["..."]]>
Gets HTML interface for named dataslot. If writePerm="TRUE", then this dataslot is presented as output, that is, it may return a value as part of the request.Precision and scale parameters are used to define numerical data in DECIMAL type dataslots.
bizsolo:executeAction
<epClassName="..."
[dsClassName=["..."]]
perfMethod="..."
[query="..."][filter="..."]
[dsi="..."][dso="..."]
[mode={"WebApp|"}]/>
[res="..."]
Creates an EP instance and executes the method specified as a parameter.As a result, an action could be performed (process creation, send mail, etc.) or a new dataslot is created and initialized, if dsClassName is specified and: epClassName="DsPrototypeFactory".
dsClassName is made obsolete by className in DSPrototypeFactory.The Mode parameter sets the type of exception report. If you select ‘ ‘, then exception is reported; if WEBAPP, then no exception is reported within the JSP page.
bizsolo:invokeWS
<epClassName="epClassName"
perfMethod="perfMethod"
serviceName=["..."]
wsdl="..."
operation="..."
[port=["..."]]/>
Invokes a Web service, with a JSP form.
bizsolo:OpParam
<name="..."
value="..."
[msg="[..."]]
[part=["..."]]
[type=["..."]]/>
Provides a Web service operation parameter.
bizsolo:redirectURL
< [page="page"]
[application="application"]/>
Redirects to the specified page or application and insulates the user from any details of session handling (URL rewriting)
bizsolo:transferDS
<bizsolo:transferDS/>
Used in an End workstep to transfer dataslots back to the BP Server.
bizsolo:getLabel
< name="..."
type=
{"DATASLOT|LINK|RESOURCE"}
[wsName="..."]
[resClass=["..."]]
/[mode={"WebApp|BPM CustomUI API"}]>
Gets the localized label associated with a dataslot (in a specific workstep), a link (connection), or a resource (system or user-defined).
For more information, see Using the getLabel tag.
bizsolo:pageInstruction
<[value=["..."]]/>
Creates a tag that handles instructions for worksteps from BPM Designer.
bizsolo:getHttpPath
<id="id" pageName="..."
appName="..."/>
Returns the HTTP URL of a given page for a particular application. Use it to allow dynamic choices of CSS pages, images or *.conf files used when generating an application. Normally, it is not required if you plan to have only static references in the JSP source.
bizsolo:getBSParameter
< name="param_name"/>
Reads the value of a BPMWebFlow parameter (specified in bpmwebflow.conf) during run-time.
bizsolo:setCallerData
<[parentApp="parentApp"]
childApp="..." [dsList="..."]
[returnPage="..."]/>
Stores parent process data in the HTTP session.
bizsolo:getCallerData
<[parentApp="parentApp"]
childApp="..."
[dsList="..."]/>
Retrieves parent process data from the HTTP session.
bizsolo:setParentData
<[dsList="..."]/>
Tells subprocess to retrieve parent process data in the HTTP session.
bizsolo:getParentData
<[dsList="..."] />
Sends retrieved subprocess data back to parent process.
bizsolo:checkPermission
<application="..."
component="..."
permission="..."/>
Provides user authorization for a Web application. Establishes access to a specific component, application or user permission.
bizsolo:choose
<bizsolo:choose/>
Executes only one JSP section out of available multiple options. Equivalent to a switch statement.
bizsolo:when
<est="..."/>
Identifies a JSP section (tag body) to be executed when test condition (run time condition) is evaluated as True. Used only within a <bizsolo:choose/> tag. Equivalent to a case statement.
bizsolo:otherwise
<bizsolo:otherwise/>
This default is executed when none of the preceding four tags are evaluated as True. Used only within a <bizsolo:choose/> tag.
bizsolo:if
<test="..."/>
Executes the JSP section (tag body) when test condition (run time condition) is evaluated as True.
bizsolo:ifCrtWS
<name="..."
[param="param"]
[isDefault="..."]/>
Executes the JSP section (tag body) when test condition matches the current workstep name. Used only within the controller page.
bizsolo:value
<name="..." indiex="0"]/>
Returns the value of the specified dataslot. If the dataslot has multiple values, for example, combo box, then use the index attribute.
bizsolo:label
<name="..."
workstepName="..."
type="..." ["dataslot"|workstep"|"link"]/>
Returns the label of the specified resource.
bizsolo:getResourceLabel
<name="..."
[resClass=["..."]]/
[mode=
{"WebApp|BPM CustomUI API"}]>
bizsolo:getResource
<name="name"
[wsName="..."]
[writePerm={"TRUE|FALSE"}]
[required={"TRUE|FALSE"}]
[size="40"] [maxlength="100"]
[mode=["StandAlone"]]
Note: BPMWebFlow does not run on servlet/JSP containers that are not Servlet 2.2/JSP 1.1 compliant. Business Process Server no longer supports jserv/gnujsp for the servlet engine. BPM Workflow is therefore incompatible with applications written and run on GNUJSP 1.0.
* Using the getLabel tag