Open topic with navigation

TIBCO BusinessEvents® Enterprise Edition 6.3.1

# Payload (Advanced Tab)

An event can have a payload. The payload often corresponds to a message body. Payloads can be defined using an XML schema. In the left panel, you add groups (elements) and parameters (attributes). You can add groups as children of a selected group, or at the same level, to define a hierarchy as desired. In the right panel, you define the type of each element or parameter. The table below describes the payload parameters available for each content type. The content types appear in the dropdown list for the Content field in the Payload section:

Simple Event Payload Element Parameters (Sheet of)
Content/Parameter | Description
--- | ---
Complex Element | An element that contains other elements. This is like a structure in a programming language. The complex element can contain zero or more elements of other types, including other complex elements.
| Name | The name of the element.
| Cardinality | Values for Cardinality: Required: The payload must include an instance of this element. Optional (?); The element is not required. Repeating (*); The element is a list that has zero or more instances. At least one (+): The element is a list that has one or more instances.
Element of Type | An element with a specified data type. You can specify a scalar data type (string, integer, and so on), you can reference an XML type, or you can specify the `TIBCO ActiveEnterprise Any` data type.
| Name | The name of the element.
| Cardinality | See Cardinality under Complex Element.
| Type | The generic data type. For example, decimal or date/time.
| Type | The specific data type. For example, float or month. Refer to the TIBCO ActiveMatrix BusinessWorks Palette Reference for a complete list.
XML Element Reference | A reference to an element in a stored XML schema. See TIBCO Designer documentation for more information about XML schemas.
| Cardinality | See Cardinality under Complex Element.
| Schema | Stored XML schema that contains the element or type you want to reference.
| Element | The element within the stored XML schema that you want to reference.
Attribute of Type | An attribute with a specified data type. You can specify a scalar data type (string, integer, and so on), you can reference an XML type, or specify the `TIBCO ActiveEnterprise Any` data type.
| Name | The name of the element.
| Cardinality | See Cardinality under Complex Element.
| Type | The generic data type. For example, decimal or date/time.
| Type | The specific data type. For example, float or month. Refer to the TIBCO ActiveMatrix BusinessWorks Palette Reference for a complete list.
Sequence | A sequence of elements. Each item in the sequence is a structure of the sub-elements of this element.
| Cardinality | See Cardinality under Complex Element.
Choice | A choice of elements. The data type of this element can be one of the sub-elements defined.
| Cardinality | See Cardinality under Complex Element.
All | The data type of this element can be all the data types of the sub-elements defined.
| Cardinality | See Cardinality under Complex Element.
XML Group Reference | A reference to an XML group in a stored XML schema. See TIBCO Designer documentation for more information about the XML schema.
| Cardinality | See Cardinality under Complex Element.
| Schema | Stored XML schema that contains the element or type you want to reference.
| Model Group | Select the appropriate model group from the pull-down list.
Any Element | A reference to any XML Element. You can use the Coercions button to supply a reference to the XML Element for this item when it appears in the input or process data.
| Cardinality | See Cardinality under Complex Element.
| Validation | Select the level of validation to be performed on the XML Element: Strict: Must validate by locating a declaration for the element. Skip: Do not validate. Lax: Validate if a declaration for the element is available.

Note: The CDD property `be.serialization.inline.namespaces` defines the location of namespace references in the payload.
`be.serialization.inline.namespaces = false` (default) declares the namespace at the top of the document.
`be.serialization.inline.namespaces = true` (same as in BE version 5.6.x) declares the namespace at the level where it is first referenced.

Did you find this helpful?

YesNo
Great!
Thanks for taking the time to give us some feedback.
Sorry about that

Why wasn't this helpful? (check all that apply)

Could not find what I was looking for
Instructions confusing or unclear
Instructions did not work

Want to tell us more?

Please select at least one option or provide details about the issue!!

Error occurred while submitting feedback.

Error2 occurred while submitting feedback.

TIBCO BusinessEvents® Enterprise Edition

Copyright © 2004-2024. Cloud Software Group, Inc. All Rights Reserved.