Using the startbizaction Application in Your Application

The startbizaction application is a browser-based application that provides the ability to start a business service from a URL.

The HTML document to which you want to add the startbizaction application must add an HTML element to access the startbizaction application. The HTML element needs to define and set the query parameter information to be passed to the startbizaction 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 startbizaction application and specifies the business service that you want to start. The format is: 

appPath?module=moduleName&process=processName&version=versionNumber[&payload=payload][&displayConfirmation=boolean][&username=username][&authType=password]
where:
Parameter Description
appPath This is the relative path to the startbizaction application.
moduleName Name of the parent module that contains the business service.
processName Name of the business service to be started.
version Version number of the business service.
payload (optional) Page data for the formal parameters associated with the business service. You cannot determine the names of these formal parameters programmatically. Instead, you must obtain them by examining the business service in TIBCO Business Studio.
displayConfirmation Boolean defining whether the end user receives confirmation after the business service is completed. If displayConfirmation is false, a business service is opened in its own window and when the business service is completed, the window is closed.
userName (optional) a valid BPM runtime login.
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 the 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 startbizaction application and provides the query parameter information of the business services you want to start. 
<a href=/apps/startbizaction/index.html?module=/XYZInsurance_Process/Process Packages/XYZInsurance_Process.xpdl&process=InitiateClaimReportIncident&version=1.0.1&displayConfirmation=true&username=tibco-admin&auth1=cGFzc3dvcmQ</a>