IBM WebSphere Multichannel Bank Transformation Toolkit, Version 7.1

Creating a configuration file for a palette object

A palette object is defined in IBM® WebSphere® Multichannel Bank Transformation Toolkit in a .xml file. The .xml file describes how the object is displayed in the Palette view and the editing area of the Processor editor, the properties of the object that can be edited, and how the properties of the object can be edited. This topic provides a description of the tags in the configuration file of an object.

There are two types of Palette objects: state object and transition object. For information on the tags in the configuration file of each type of object, refer to the following sections:

State objects

There are three tags in the configuration file of state objects:
  • <appearance> tag
  • <properties> tag
  • <property> tag
An example of a configuration file for a state object is provided here:
<?xml version="1.0" encoding="UTF-8"?>
<state xmlns="http://btt.ibm.com/StateSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://btt.ibm.com/StateSchema StateSchema.xsd ">
	<appearance backgroundColor="254,46,154" font="Arial-italic-20" fontColor="0,0,0" gradient="true"/>
	<properties>
		<property name="Page" displayName="Page Name" defaultValue="" hidden="false" required="true" 
		description="Page file path" editRule="PageSelection" />
		<property name="Back Allowed" defaultValue="False" hidden="false" required="false" 
		description="Specifies the possibility to use the back button from the navigator" editRule="Boolean" />
		<property name="id" defaultValue="" hidden="true" required="false" description="id" editRule="" />
	</properties>
</state>
The <appearance> tag defines how a state object is displayed in the Palette view in Rational® Application Developer. Table 1 provides a description of the attributes of the <appearance> tag of a state object.
Table 1. The attributes of the <appearance> tag of a state object.
Attribute Description
gradient true or false
fontColor Color in RGB. For example, 255,255,255
backgroundColor Color in RGB. For example, 255,255,255
font The font of the text that is displayed on a state object.

The <properties> tag lists the properties of a state object. The <properties> tag must contain one or more <property> tags.

The <property> tag describes how a state object is displayed in the editing area of the Processor Editor and how a property of the state object can be edited. Table 2 describes the attributes of the <property> tag.
Table 2. The attributes of the <property> tag
Attribute Description
name The property name identifier.
defaultValue It corresponds to the property value by default.
hidden Specifies whether the property is displayed. Possible values are true or false. If it is set to true, the attributes described are not displayed. The default value is false.
editRule It is the property editor that will be used by the user to enter the property value. It should be the same as any rule id in Table 3. If it is not specified, a default editor is assigned.
description Contains the text to be used as tooltip.
required Specifies whether the property is mandatory. If the property is mandatory, then a value must be specified for the property. Possible values are true or false. The default value is false.
Table 3 describes the predefined property edit rules:
Table 3. The predefined property edit rules
Rule ID Description
Boolean For boolean chosen rule
XValidate For XValidate property editor rule
Context For Context chosen rule
ConditionAdjust For Condition adjust rule
OpStepAction For OpStep action chosen rule
OpStepCondition For OpStep condition rule
Operation For Operation chosen rule
EventId For Event Id chosen rule
PageSelection For Page chosen rule

Transition objects

There are three tags in the configuration file of transition objects:
  • <appearance> tag
  • <properties> tag
  • <property> tag
An example of a configuration file for a transition object is provided here:
<transition xmlns="http://btt.ibm.com/TransitionSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://btt.ibm.com/TransitionSchema TransitionSchema.xsd ">
	<appearance lineColor="0,0,0" lineWidth="1" lineStyle="Solid" arrowTypeStyle="SolidArrow" font="Arial-regular-10" fontColor="0,0,0"  />
	<properties>
		<property name="Event" hidden="false" required="true" defaultValue="" editRule="EventTransitionBeta"/>
		<property name="Input Data Format" required="false" description="%InputFormat" editRule="MapperFormat"/>
		<property name="Output Data Format" required="false" description="%OutputFormat"  editRule="MapperFormat"/>
		<property name="Skip Validation" defaultValue="false" description="%TransValidated" editRule="Boolean"/>
		<property name="id" defaultValue="" hidden="true" required="false" />		
	</properties>
</transition>
The <appearance> tag defines how a transition object is displayed in the Palette view in Rational Application Developer and in the editing area of the Processor editor. Table 4 provides a description of the attributes of the <appearance> tag of a transition object.
Table 4. The attributes of the <appearance> tag of a transition object.
Attribute Description
lineColor Color in RGB. For example, 255,255,255. Default value is 0,0,0.
lineWidth Line width in pixel. Default value is 1.
lineStyle Possible values are: ‘Solid', 'Dash', ‘DashDotDot', ‘DashDot', ‘Dot', ‘Double'. Default value is Solid.
arrowTypeStyle Possible values are: ‘None', ‘OpenArrow' and ‘SolidArrow'. Default value is Solid.
font The font of the text that is displayed on a transition object.
font color Color in RGB. For example, 255,255,255

The attributes of the <properties> and the <property> tag of a transition object are the same as the <properties> and the <property> tag of a state object. For descriptions of the <properties> and <property> tags of a transition object see Table 2 and Table 3 in this topic.



Feedback