Using the openworkitem Application in Your Application

The openworkitem application is a browser-based application that provides the ability to open a work item from a URL with a given set of parameters.

The HTML document to which you want to add the openworkitem application must add an HTML element to access the openworkitem application. The HTML element needs to define and set the query parameter information to be passed to the openworkitem application. It is up to you how you obtain the information that populates the query parameters.

The HTML element is an <a> tag with an href attribute that accesses the openworkitem application and specifies the ID of the work item that you want to open. The format is: 
app_path?ID=workItemID[&version=versionNumber][&displayConfirmation=boolean][&username=userName][&authType=password]
where:
Parameter Description
appPath This is the relative path to the openworkitem application. For example, /apps/openworkitem/index.html
workItemID Unique ID of the work item.
versionNumber (optional) Version of the work item. For example, 1.0.1
displayConfirmation (optional) Boolean defining whether the end user receives confirmation after the work item is completed. If displayConfirmation is false, a work item is opened in it's own window and when the work item is completed, the window is closed.
userName (optional) A valid BPM runtime login. For example, tibco-admin
authType (optional) Must be either:
  • auth0 - the password of the BPM runtime login must be supplied in plain text.
  • auth1 - the password of the BPM runtime login must be supplied as a Base64 encoded string. You must use a Base64 encoder to encode the password of the BPM runtime login.
password Password of the BPM runtime login in either plain text or as a Base64 encoded string, depending on the specified authType.

Example

Your HTML page defines the <a> tag that accesses the openworkitem application and provides the query parameter information to be passed to the URL. 
<a href="/apps/openworkitem/index.html?id=1&version=1.0.1&displayConfirmation=true&username=tibco-admin&auth1=cGFzc3dvcmQ"></a>