Data Format and Structures

You should use XML instead of JSON as the data payload format. (The JSON returned by the BPM runtime is tailored for use with the Forms Runtime Adapter.)

Your application must interpret and render the XML data payloads returned by the BPM runtime, which will require knowledge of their underlying data structures. You cannot obtain this information programmatically. Instead, you must obtain it from TIBCO Business Studio:

  • Export a Work Data Model for every project that the client application will need to handle. This model contains a number of artifacts, including:
    • a work type definition file (wt.xml), which defines the data structures of all work types used in the project. (Each user activity in a business process has a work type associated with it.)
    • a pageflow activity definition file (pfActivityType.xml), which defines the data structure for each user activity in a pageflow process in the project.
      Note: For more information about how to generate a Work Data Model, see "Exporting Projects to a Work Data Model" in TIBCO Business Studio Process Modeling.
  • Note any formal parameters required by business processes or pageflow processes. When you start or inject data into a pageflow process or business service that requires formal parameters, you must specify the data for those formal parameters. (See the following element definitions: startPageFlow, injectPageFlowEvent, startBusinessService, injectBusinessServiceEvent.)