SOAP API - setAvailableProcessInstanceVariables

The table summarizes the SOAP API - setAvailableProcessInstanceVariables.

Request Uses the setAvailableProcessInstanceVariablesInput element (from the ProcessManagement schema)
Parameter notes
  • processID can be obtained from queryHaltedProcessInstances.

    The specified process instance must be in a HALTED state for the request to be valid. An illegalStateFault is returned if the process instance is in any other state.

  • variableMap is a set of name/value pairs for the variables to be set. This can include arrays. The available variables can be obtained from getAvailableProcessInstanceVariables.
Note: You can set a new value of the delimiter between array elements using the arrayDelimiter property in the bx.properties file. The default value is a comma followed by a space (, ).

For more information about properties files, see BPM Properties Files.

Response Returns a success element (from the ProcessManagement schema)
Example Request: 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:proc="http://www.tibco.com/bx/2009/management/processManagerType">
   <soapenv:Header/>
   <soapenv:Body>
      <proc:setAvailableProcessInstanceVariablesInput>
         <proc:processID>pvm:0a124</proc:processID>
         <proc:variableMap>
            <proc:variable>
               <proc:name>CustID</proc:name>
               <proc:value>REF1234</proc:value>
            </proc:variable>
            <proc:variable>
               <proc:name>CustName</proc:name>
               <proc:value>Heston</proc:value>
            </proc:variable></proc:variableMap>
      </proc:setAvailableProcessInstanceVariablesInput>
   </soapenv:Body>
</soapenv:Envelope>
Response: 
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
   <SOAP-ENV:Header/>
   <SOAP-ENV:Body>
      <proc:success xmlns:proc="http://www.tibco.com/bx/2009/management/processManagerType">OK</proc:success>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Example for array of integers Request: 
<soapenv:Envelope xmlns:proc="http://www.tibco.com/bx/2009/management/processManagerType" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Header>
      <wsse:Security soapenv:mustUnderstand="1" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
         <wsse:UsernameToken wsu:Id="UsernameToken-34">
            <wsse:Username>tibco-admin</wsse:Username>
            <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">secret</wsse:Password>
            <wsse:Nonce EncodingType="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-soap-message-security-1.0#Base64Binary">8Ua3tMNKnDkMNFxuCkONIg==</wsse:Nonce>
            <wsu:Created>2014-10-07T21:36:26.153Z</wsu:Created>
         </wsse:UsernameToken>
      </wsse:Security>
   </soapenv:Header>
   <soapenv:Body>
      <proc:setAvailableProcessInstanceVariablesInput>
         <proc:processID>pvm:0a12ga</proc:processID>
         <proc:variableMap>
            <proc:variable>
               <proc:name>IntArray</proc:name>
            <proc:value>[5, 6]</proc:value>
            </proc:variable>
         </proc:variableMap>
      </proc:setAvailableProcessInstanceVariablesInput>
   </soapenv:Body>
</soapenv:Envelope>
Example of array of BOMs Request: 
<soapenv:Envelope xmlns:proc="http://www.tibco.com/bx/2009/management/processManagerType" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Header>
      <wsse:Security soapenv:mustUnderstand="1" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
         <wsse:UsernameToken wsu:Id="UsernameToken-34">
            <wsse:Username>tibco-admin</wsse:Username>
            <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">secret</wsse:Password>
            <wsse:Nonce EncodingType="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-soap-message-security-1.0#Base64Binary">8Ua3tMNKnDkMNFxuCkONIg==</wsse:Nonce>
            <wsu:Created>2014-10-07T21:36:26.153Z</wsu:Created>
         </wsse:UsernameToken>
      </wsse:Security>
   </soapenv:Header>
   <soapenv:Body>
      <proc:setAvailableProcessInstanceVariablesInput>
         <proc:processID>pvm:0a12gb</proc:processID>
         <proc:variableMap>
            <proc:variable>
               <proc:name>CarArray</proc:name>
            <proc:value><![CDATA[[<?xml version="1.0" encoding="UTF-8"?>
<testpmbomvariable:CarElement xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:testpmbomvariable="http://example.com/testpmbomvariable" xsi:type="testpmbomvariable:Car">
  <model>Corolla</model>
  <make>Toyotas</make>
</testpmbomvariable:CarElement>, <?xml version="1.0" encoding="UTF-8"?>
<testpmbomvariable:CarElement xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:testpmbomvariable="http://example.com/testpmbomvariable" xsi:type="testpmbomvariable:Car">
  <model>Camry</model>
  <make>Toyota</make>
</testpmbomvariable:CarElement>]]]></proc:value>
            </proc:variable>
         </proc:variableMap>
      </proc:setAvailableProcessInstanceVariablesInput>
   </soapenv:Body>
</soapenv:Envelope>