How to query and start Business Services with Parameters?

How to query and start Business Services with Parameters?

book

Article ID: KB0091167

calendar_today

Updated On:

Products Versions
TIBCO BPM Enterprise (formerly TIBCO ActiveMatrix BPM) -
Not Applicable -

Description

Resolution:
Description:
============
How to query and start Business Services with Parameters
Environment:
============
TIBCO ActiveMatrix BPM 1.3.x

Resolution:
===========
By default these services cannot be seen/started. They are designed to be started by custom GUIs, and therefore can only be started by API (SOAP API calls/Service connector).

In order to see these, you must set includeFormalParams to true when calling the query, and specify the parameters when starting the Business Service.

https://docs.tibco.com/pub/activematrix_bpm/1.3.1_july_2012/doc/pdf/tib_amx_bpm_development.pdf

See chapter 10, chapter 17 of the BPM Developers guide

ProcessPackage.queryBusinessServices

&ltxs:element name="includeFormalParameters" type="xs:boolean" minOccurs="0" maxOccurs="1">
        &ltxs:annotation>
          &ltxs:documentation&gtBoolean value defining whether the query should return business services that have formal parameters.</xs:documentation>
        </xs:annotation>
      </xs:element>

When you use startBusinessService, you also need to specify your formalParams

&ltxs:element name="formalParams" type="df:dataPayload" minOccurs="0">
        &ltxs:annotation>
          &ltxs:documentation&gtData for the formal parameters associated with the business service start event.

Note: You cannot determine the names of these formal parameters programmatically. Instead, you must obtain them by examining the business service in TIBCO Business Studio.</xs:documentation>
        </xs:annotation>
      </xs:element>


References:
===========
https://docs.tibco.com/pub/activematrix_bpm/1.3.1_july_2012/doc/pdf/tib_amx_bpm_development.pdf > chapter 10, chapter 17 of the BPM Developers guide

Issue/Introduction

How to query and start Business Services with Parameters?