OpenWorkItem Application

TIBCO BPM Enterprise provides the openworkitem application that allows a user to open a work item directly without accessing the UI. You can open a work item using a link by passing specific parameters in the URL, instead of accessing the UI and selecting the relevant options from a list.

TIBCO BPM Enterprise uses the openworkitem application when a work item is assigned/allocated to a user via an email. When you click the link, the login screen opens. On authentication, the work item assigned/allocated to you opens.

Configuring the openworkitem application

protocol://host:port/apps/openworkitem/#/workItemId
?username=BPM username
&auth0=plain text BPM password
&auth1=Base64 BPM password
&displayConfirmation=true|false

The parameters are described in the following table:

Parameters

Parameter Name Description
protocol (required) The communications protocol used by TIBCO BPM Enterprise that is defined during installation. You can set it to http or https.
host (required) This is the DNS name or IP address of the server that hosts TIBCO BPM Enterprise.
port (required) The port that is used by TIBCO BPM Enterprise. By default, it is 8080.
workItemId (required) The numerical ID assigned to the work item that should be opened (for example, 15). Workitemid is passed as the URL path parameter.
username The TIBCO BPM Enterprise login name.
auth0 The TIBCO BPM Enterprise login password, as plain text.
auth1 The TIBCO BPM Enterprise runtime login password, as a Base64-encoded string. You need a Base64 encoder to encode the password.
displayConfirmation A boolean value, that has been configured as true or false. If set to true, a confirmation message is shown on completion of the work item.
Note: If a parameter contains spaces, it must be URL encoded.
Note: You can configure the openworkitem application to close the browser, or leave it open, after the work item is submitted, cancelled, or closed.

Examples

Example of opening a work item with the openworkitem application: 

http://Host:Port/apps/openworkitem/#/15
Example of opening a work item with the openworkitem application with login credentials and display confirmation defined: 
http://Host:Port/apps/openworkitem/#/15?username=tibco-admin&auth0=secret&displayConfirmation=true

Events

The openworkitems application will generate load, cancel, close and submit events using window.postMessage. The properties of event message are explained in the following table:

Event Event message Event description
Load

eventName: FORM_LOAD

data: workitem data

formUrl: URL for the form

This event is triggered when work item form is loaded.
Cancel

eventName: FORM_CANCEL

data: workitem data

This event is triggered when form is cancelled by clicking on the cancel button on the form.
Close

eventName: FORM_CLOSE

data: workitem data

This event is triggered when form is closed by clicking on the close button on the form.
Submit

eventName: FORM_SUBMIT

completed: true|false. The value is set to true if the work item is completed.

data: workitem data

This event is triggered when form is submitted by clicking on the submit button on the form.