You can promote a node property to the message flow level to simplify the maintenance of the message flow and its nodes, and to provide common values for multiple nodes within the flow by converging promoted properties.
Before you start
To complete this task, you must have completed the following task:
To promote message flow node properties to the message flow level:
If this is the first message flow that you have opened, the message flow control window and the list of available built-in message flow nodes are also displayed, to the left of the editor view.
You can access all node properties from this dialog, regardless of the node that you selected when you first opened the dialog, by expanding the properties for all the other nodes in the flow (these are initially collapsed).
The right side lists all the properties that are currently promoted to the message flow. If you have not yet promoted any properties, only the message flow name as the root of the promoted property tree is displayed on the right.
The majority of message flow node properties are available for promotion, but you cannot promote:
When you create a new promoted property, the name that you enter is the name by which the property is known within the system, and must meet certain Java and XML naming restrictions. These are enforced by the dialog, and a message is displayed if you enter a name that includes a non-valid character. For example, you cannot include a space or the double quote symbol.
The name field is highlighted; type over it to rename the group when it is created. You can also rename the group at any later time by double-clicking the name.
The name field is highlighted; type over it to rename the property when it is created. You can also rename the property at any time by double-clicking the name.
The list on the left also includes the remaining nodes in this message flow. You can expand the properties listed under each node and work with all these properties at the same time. You do not have to close the dialog and select another node from the editor view to continue promoting properties.
The new group is given a name that defaults to Group1. If the group Group1 already exists, the next default name is Group2, and so on. Rename the group by double-clicking it and entering new text.
When you have promoted a property, you can no longer make any changes to that property through the node properties dialog. You can only update its value at the message flow level.
The message flow node properties are now promoted to the message flow. If you want to confirm this, right-click the message flow in the Navigator view, or right-click the editor view, and select Properties.
The Properties dialog of the message flow is displayed, showing the message flow node properties that you have promoted, organized in the groups that you have created. If you now set a value for one of these properties, that value appears as the default value for the property whenever the message flow is itself included in other message flows.
When you select an embedded message flow within another message flow (a subflow) and view its properties, you see the promoted property values. If you look inside the embedded flow (that is, if you select Open Subflow), you see the original values for the properties. The value of a promoted property does not replace the original property, but it takes precedence when you deploy the message flow.
If you promote a property that is mandatory (that is, an asterisk appears beside the name in the properties dialog of the message flow node), the mandatory characteristic of the property is preserved. You must always set a value for every mandatory property at the node level, even if you intend to promote that property to the message flow level and thereby override it.
You can repeat the process of promoting message flow node properties through several levels of message flow. You can promote properties from any level in the hierarchy to the next level above, and so on through the hierarchy to the top level. The value of a property is propagated from the highest point in the hierarchy at which it is set down to the original message flow node when the message flow is deployed to a broker. The value of that property on the original message flow node is overridden.
Related concepts
Promoted properties
Message flow application deployment
Related tasks
Defining promoted properties
Renaming a promoted property
Converging multiple properties
Removing a promoted property
Editing configurable properties
Related reference
Built-in nodes
Notices |
Trademarks |
Downloads |
Library |
Support |
Feedback
![]() ![]() |
ac02380_ |