Modifying your application file
The application file contains XML tags that define the settings you select
when you configure your HATS LE application. You can perform advanced configuration
by editing the application file. To edit the file, start the HATS LE Administrative
Console and click Advanced. This section describes some
of the important tags which can be used in the application file along with
their settings and classes.
<application> tag
The <application> tag is the enclosing tag for the application.
The attributes of the <application> tag are:
- description
- Contains an optional description for the application.
- template
- Specifies the name of the template for the application, which you select
when you configure the application.
<connections> tag
The <connections> tag is the enclosing tag for the connection characteristics.
The attributes of the <connections> tag are:
- default
- Specifies the connection configured for the application. This value
should always be main, and main is the default.
<connection> tag
The <connection> tag is the enclosing tag for the individual connection
names.
The attributes of the <connection> tag are:
- name
- Specifies the name of your connection.
Example:
<connections default="main">
<connection name="main"/>
</connection>
<defaultRendering> tag
The <defaultRendering> tag is the enclosing tag for any default rendering
settings you define in the project. This tag has no attributes.
<renderingSet> tag
The <renderingSet> tag is in rendering this the <defaultRendering>
tag. Default is "main". HATS LE V5 only supports "main" as a valid value.
<renderingItem> tag
The <renderingItem> tag is the enclosing tag for a specific rendering
item.
The attributes of the <renderingItem> tag are:
- description
- The description entered when the rendering item was created.
- enabled
- Indicates whether this rendering item is enabled. Reflects the state
of the check box on the Rendering page of Project Settings.
- endCol
- The last column of the host screen to which this rendering item should
be applied. -1 means the rightmost column of the host screen.
- endRow
- The last row of the host screen to which this rendering item should
be applied. -1 means the bottom row of the host screen.
- startCol
- The first column of the host screen to which this rendering item should
be applied.
- startRow
- The first row of the host screen to which this rendering item should
be applied.
- type
- The host component whose contents will be transformed.
- widget
- The widget into which the host component will be transformed.
<classSettings> tag
The <classSettings> tag is the enclosing tag for the Java(TM) classes
you include in the application.
<class> tag
The <class> tag specifies the Java classes that can be included in an
application.
The attributes of the <class> tag are:
- name
- Specifies one of the following Java classes:
The class names on the name attribute must be enclosed in quotes.
<setting> tag
The <setting> tag specifies the methods included in the Java class.
The attributes of the <setting> tag are:
- name
- Specifies the name of the Java method or a customized setting for a
component, a widget or the locale. The names listed depend on the Java class
in which the methods reside or the name of a component or widget setting.
For the com.ibm.hats.common.ApplicationKeypadTag class, the methods are:
- show
- If value=true, shows a keypad in the application.
- style
- Depending on the value attribute, shows the keys defined with value=true
as either a button or a link in the application keypad.
- showKeyboardToggle
- If value=true, shows a key in the application keypad for toggling display
of a host keyboard.
- showReset
- If value=true, shows a Reset key in the application keypad to clear
all the fields on the browser page of any entries made by the end user.
- showReverse
- If value=true, shows a Reverse key in the application keypad for bi-directional
support.
- showRefresh
- If value=true, shows a Refresh key in the application keypad to refresh
the browser window contents using the original transformation, and restore
the input fields to their original value.
- showDisconnect
- If value=true, shows a Disconnect key in the application keypad to disconnect
from the host.
- showDefault
- If value=true, shows a Default key in the application keypad to change
the presentation to the default transformation.
For the com.ibm.hats.common.HostKeypadTag class, the methods are:
- show
- If value=true, shows a host keypad in the application.
- style
- Depending on the value attribute, shows the keys defined with value=true
as either a button or a link in the host keypad.
- showAttention
- If value=true, shows an ATTN key in the host keypad.
- showPrint
- If value=true, shows a PRINT key in the host keypad for printing output.
- showSystemRequest
- If value=true, shows a SYSREQ key in the host keypad.
- showClear
- If value=true, shows a CLEAR key in the host keypad.
- showFieldExit
- If value=true, shows a Field exit key in the host keypad
- showFieldPlus
- If value=true, shows a Field+ key in the host keypad
- showFieldMinus
- If value=true, shows a Field- key in the host keypad
- showPageUp
- If value=true, shows a Page Up key in the host keypad.
- showPageDown
- If value=true, shows a Page Down key in the host keypad.
- showPA1
- If value=true, shows a PA1 key in the host keypad.
- showPA2
- If value=true, shows a PA2 key in the host keypad.
- showPA3
- If value=true, shows a PA3 key in the host keypad.
- showReset
- If value=true, shows a Reset key in the host keypad.
- showEnter
- If value=true, shows an Enter key in the host keypad.
- showAltView
- If value=true, shows an AltView key in the host keypad.
- showHelp
- If value=true, shows a Help key in the host keypad.
- showF1 - showF24
- If value=true, shows a Function key with a number in the host keypad.
For the com.ibm.hats.common.KeyboardSupport class, the methods
are:
- enable
- Depending on the value attribute, enable specifies whether keyboard
support is available in the application.
- initialState
- If value=true, the initial state of the host keyboard is on (the physical
keys on the keyboard are active).
For the com.ibm.hats.component.* class or com.ibm.hats.widget.*
class, name specifies a customized component or widget setting.
For
the com.ibm.hats.common.ClientLocale class, name is always locale.
- value
- For definitions of keypad keys, specifies whether to show the key in
the keypad. Valid values are true and false.
For name=style, specifies
how keys defined with value=true are displayed in the in the host keypad.
Valid values are the following:
For component or widget settings, value specifies what you specified
for the customized setting.
For the com.ibm.hats.common.ClientLocale
class, value specifies characters that identify the country code of the locale.
<replace> tag
The <replace> tag specifies the text replacement values in a application.
The attributes of the <replace> tag are:
- caseSensitive
- Specifies whether the case of text replacement values must match before
text replacement occurs. Valid values are true and false.
- from
- Specifies the text you want to replace. The text on the from attribute
must be enclosed in quotes.
- to
- Specifies the text you want to insert in place of the value specified
on the from attribute. The text on the to attribute must be enclosed in quotes.
Note:
Care should be taken when using text replacement. Text
replacement with a disparate number of characters in the strings can cause
changes in the HTML representation of the screen. Depending on the widget
used for presenting a region of a screen, text on a line of the screen could
be contracted, expanded, or forced to a new line.