Business Service App (BizApp)

The Business Service App (BizApp) is available as part of Openspace. It enables you to start business services or inject events into business services that have already started, by providing the appropriate URL. It can render TIBCO Forms and also supports the complete functionality of static and dynamic sub-processes.

BizApp is accessed via a URL (for clarity, the URL is shown with each parameter on a separate line):

protocol://host:port/openspace/bizapp/bizapp.html
?module=module name
&process=process name
&version=version number
&channel=channel name
&payLoad=payload
&managedIframe=true|false
&eventWithData=true|false
&tibco_jsonp=true|false
&event=event name
&processid=process ID
&username=BPM username
&auth0=plain text BPM password
&auth1=Base64 BPM password

The URL parameters are explained in the following table:

Parameter Name Description
protocol (required) The communications protocol that is used by Openspace: either http or https. This was determined at installation.
host (required) The DNS name or IP address of the server that hosts the BPM runtime.
port (required) The port that is used by Openspace. The default is 8080.
module (required) The module that defines the business service. It can be found in Openspace under the BUSINESS SERVICE SUMMARY that is displayed for a selected Business Service. The value must be URI-encoded.
process (required) The name of the business service process.
version (required) The version number of the business service, in the format of major.minor.micro .[qualifier]. If you do not specify a qualifier, then the latest deployed version of the application is used.
channel The channel that is used to open the business service. The default is openspaceGWTPull_DefaultChannel.
payload The JSON payload that is passed to the business service.
managedIframe If this is set to true, the business service is opened in a Managed Frame.
eventWithData If this is set to true, the BusinessServiceDataEvent is triggered in addition to the BusinessServiceEvent.
tibco_jsonp If this is set to true, cross-domain access to the business service form definitions is enabled.
event The name of the event to inject into a business service. You should use this parameter only if you are injecting an event into a business service.
processid The process ID of the business service that is being injected into. You should use this parameter only if you are injecting an event into a business service.
username The BPM runtime login name.
auth0 The BPM runtime login password, as plain text.
auth1 The BPM runtime login password, as a Base64-encoded string. You need a Base64 encoder to encode the password.
Important: If a parameter contains spaces, it must be URL-encoded.

Examples

Example URL for starting a business service:

http://machinename:8080/openspace/bizapp/bizapp.html?module=%2FCMISSample%2FProcess%2FCMISSample.xpdl&process=CMISSampleCatchMessageEvent&version=3.0.0
Example URL that includes payload as a business service:
http://machinename:8080/openspace/bizapp/bizapp.html?module=%2FORDER%2FProcess%20Packages%2FOrderProc.xpdl&process=StartOrderForCustomer&version=1.0&channel=openspaceGWTPull_DefaultChannel&tibco_channel=desktop&payLoad={"items":[
{"$param":"customerId","$value":"123456789","type":"Integer","mode":"IN"}
]}