Bottom of Page | Previous Page | Next Page | Contents

Appendix B. HATS Studio files

When you use HATS Studio to build your project, files for each component of the project are created. This appendix tells you where the file is located on your system, how to view and edit the source for the file, and describes the tags that make up each file.

Note:
If you edit these source files, we recommend you use the HATS Studio editors.

All of the files you create with HATS Studio are stored on your system under the drive and directory where you installed your WebSphere Studio program, such as WebSphere Studio Application Developer. In the workspace subdirectory, a folder exists for each project with the name you supply when you create the project. For example, if you create a project and name it Employees, the files are stored in the following path:

drive:/ws*d_dir/workspace/Employees

where drive and ws*d_dir are the drive and directory where you installed the WebSphere Studio program.

All of the file locations in this appendix refer to the relative path from the directory named for your project.

Application files (.hap)

The application file contains XML tags that define the settings you choose when you create the project.

The application (.hap) file is stored in the project_name/source/profiles directory, where project_name is the name you gave the project when you created it. You can view and edit the source of the application file by double-clicking on the Project Settings node of the HATS Project View to open the project editor. The source for the file can be viewed by clicking on the Source tab.

You can modify the application file using any of the tabs in the project editor. HATS Studio updates the affected information on other tabs when you make changes on any tab.

<application> tag

The <application> tag is the enclosing tag for the project.

The attributes of the <application> tag are:

description
Specifies the description you enter when you create a project.
template
Specifies the name of the default template for the project, which you select when you create the project. The default template is Simple1.jsp.

<sessions> tag

The <sessions> tag is the enclosing tag for the session characteristics.

The attributes of the <sessions> tag are:

default
Specifies the session configured for the project. This value should always be main, and main is the default.

<session> tag

The <session> tag specifies the session characteristics for the project.

Note:
If you select a bi-directional (BIDI) code page, refer to Additions to HATS files.

The attributes of the <session> tag are:

codePage
Specifies the numeric code page number for the codepage used in the project. The default value is 037. You select the codePage value when you create the project. A code page number might be used for more than one location or usage. See the description of the codePageKey attribute for the code page numbers.
codePageKey
Specifies the usage key that corresponds to the numeric codepage. The default value is KEY_US. Valid values for codePage and the location or usage key are:
Table 5. Code pages and usage keys
Code page Usage key
037
KEY_BELGIUM
KEY_BRAZIL
KEY_CANADA
KEY_NETHERLANDS
KEY_PORTUGAL
KEY_US
273
KEY_AUSTRIA
KEY_GERMANY
274
KEY_BELGIUM_OLD
275
KEY_BRAZIL_OLD
277
KEY_DENMARK
KEY_NORWAY
278
KEY_FINLAND
KEY_SWEDEN
280
KEY_ITALY
284
KEY_SPAIN
KEY_LATIN_AMERICA
285
KEY_UNITED_KINGDOM
290
KEY_JAPAN_KATAKANA_EX
297
KEY_FRANCE
420
KEY_ARABIC
424
KEY_HEBREW
500
KEY_MULTILINGUAL
803
KEY_HEBREW_OLD
838
KEY_THAI
870
KEY_BOSNIA_HERZEGOVINA
KEY_CROATIA
KEY_CZECH
KEY_HUNGARY
KEY_POLAND
KEY_ROMANIA
KEY_SLOVAKIA
KEY_SLOVENIA
871
KEY_ICELAND
875
KEY_GREECE
924
KEY_MULTILINGUAL_ISO_EURO
930
KEY_JAPAN_KATAKANA
933
KEY_KOREA_EX
937
KEY_ROC_EX
939
KEY_JAPAN_ENGLISH_EX
1025
KEY_BELARUS
KEY_BULGARIA
KEY_MACEDONIA
KEY_RUSSIA
KEY_SERBIA_MONTEGRO
1026
KEY_TURKEY
1047
KEY_OPEN_EDITION
1112
KEY_LATVIA
KEY_LITHUANIA
1122
KEY_ESTONIA
1123
KEY_UKRAINE
1137
KEY_HINDI
1140
KEY_BELGIUM_EURO
KEY_BRAZIL_EURO
KEY_CANADA_EURO
KEY_NETHERLANDS_EURO
KEY_PORTUGAL_EURO
KEY_US_EURO
1141
KEY_AUSTRIA_EURO
KEY_GERMANY_EURO
1142
KEY_DENMARK_EURO
KEY_NORWAY_EURO
1143
KEY_FINLAND_EURO
KEY_SWEDEN_EURO
1144
KEY_ITALY_EURO
1145
KEY_LATIN_AMERICA_EURO
KEY_SPAIN_EURO
1146
KEY_UNITED_KINGDOM_EURO
1147
KEY_FRANCE_EURO
1148
KEY_MULTILINGUAL_EURO
1149
KEY_ICELAND_EURO
1153
KEY_BOSNIA_HERZEGOVINA_EURO
KEY_CROATIA_EURO
KEY_CZECH_EURO
KEY_HUNGARY_EURO
KEY_POLAND_EURO
KEY_ROMANIA_EURO
KEY_SLOVAKIA_EURO
KEY_SLOVENIA_EURO
1154
KEY_BELARUS_EURO
KEY_BULGARIA_EURO
KEY_MACEDONIA_EURO
KEY_RUSSIA_EURO
KEY_SERBIA_MONTEGRO_EURO
1155
KEY_TURKEY_EURO
1156
KEY_LATVIA_EURO
KEY_LITHUANIA_EURO
1157
KEY_ESTONIA_EURO
1158
KEY_UKRAINE_EURO
1160
KEY_THAI_EURO
1364
KEY_KOREA_EURO
1371
KEY_ROC_EURO
1388
KEY_PRC_EX_GBK
1390
KEY_JAPAN_KATAKANA_EX_EURO
1399
KEY_JAPAN_ENGLISH_EX_EURO
delayInterval
Specifies the time (in milliseconds) that the server waits until a full host screen that is not the first host screen has arrived. The initial default value is 1500 milliseconds.
delayStart
Specifies the time (in milliseconds) that the server waits until the first full host screen has arrived. The initial default value is 1500 milliseconds.
description
Specifies a description for the session configured for the project. This value is always empty.
enableSSL
Specifies whether SSL is enabled. Valid values are:
true
SSL is enabled for the project.
false
SSL is not enabled for the project.
host
Specifies the name of the host to which the project connects.
name
Specifies the session configured for the project. This value should always be main, and main is the initial default.
port
Specifies the number of the port through which the connection to the host is made. The valid range for ports is 0-65535. The initial default is 23.
printFontName
Specifies the font in which you want your output printed. Valid values depend on the value of the codePage attribute.
printOrientation
Specifies how your printed output is positioned on the page. Valid values for printOrientation are:
PDF_ORIENTATION_PORTRAIT
Orients the paper vertically.
PDF_ORIENTATION_LANDSCAPE
Rotates the paper 90 degrees clockwise.
printPaperSize
Specifies the size of the paper on which to print your output. Valid values for printPaperSize are:
ISO_A3
ISO/DN & JIS A4, 297 x 420 mm
ISO_A4
ISO/DN & JIS A4, 210 x 297 mm
ISO_A5
ISO/DN & JIS A4, 148 x 210 mm
ISO_B4
ISO/DN B4, 250 x 353 mm
ISO_B5
ISO/DN B5, 176 x 250 mm
JIS_B4
JIS B4, 257 x 364 mm
JIS_B5
JIS B5, 182 x 257 mm
ISO_C5
ISO/DN C5, 162 x 229 mm
ISO_DESIGNATED_LONG
ISO/DN Designated Long, 110 x 220 mm
EXECUTIVE
Executive, 7 1/4 x 10 1/2 in
LEDGER
Ledger, 11 x 17 in
NA_LETTER
North American Letter, 8 1/2 x 11 in
NA_LEGAL
North American Legal, 8 1/2 x 14 in
NA_NUMBER_9_ENVELOPE
North American #9 Business Envelope, 3 7/8 x 8 7/8 in
NA_NUMBER_10_ENVELOPE
North American #10 Business Envelope, 4 1/8 x 9 1/2 in
MONARCH_ENVELOPE
Monarch Envelope, 3 7/8 x 7 1/2 in
CONTINUOUS_80_COLUMNS
Data Processing 80 Columns Continuous Sheet, 8 x 11 in
CONTINUOUS_132_COLUMNS
Data Processing 132 Columns Continuous Sheet, 13 1/5 x 11 in
printSupport
Specifies whether your project includes print capability. Valid values for printSupport are true and false. The initial default is false.
printURL
Specifies the URL for an iSeries for Web Access (IWA) Printer Output window on a 5250 server. The default URL is http://hostname/webaccess/iWASpool, where hostname is the name of the 5250 server.
screenSize
Specifies the number of rows and columns that the host terminal displays. Valid values for screenSize are: The initial default screen size is 24 x 80.
sessionType
Specifies the type of terminal the host terminal displays. Valid values for type are: The initial default is 3270.
TNEnhanced
Specifies whether the connection is a TN3270E connection. Valid values are true and false. The initial default is true.

<otherParameters> tag

The <otherParameters> tag specifies additional Host On-Demand session parameters.

Host On-Demand session parameters supported by HATS are:

Lamalef
Sets the LamAlef property, which determines whether LamAlef should be expanded or compressed. This property applies to Arabic sessions only. Values are in string format. Valid values are: The default is LAMALEF_OFF .
LUName
Sets the LUName property, which is the LU name used during enhanced negotiation. This property is only valid when the TNEnhanced property is true. This property is valid for 3270 sessions only. Values are in string format. Maximum length of LUName is 17 characters. There is no default. To configure print support for your 3270 HATS project, you must specify that the host type is 3270E. When you add the LUName parameter to the list of connection settings, do not use the printer LU name; use the name of your display LU or a pool of display LUs.
numeralShape
Sets the numeralShape property. This property applies to bi-directional sessions only. Values are in string format. The default is NOMINAL.
numericSwapEnabled
Sets the Numeric swapping property. This property applies to Arabic 3270 sessions only. Valid values are true and false. The default is true.
roundTrip
Sets the roundTrip property. This property applies to bi-directional sessions only. Values are in string format. Valid values are: The default is ROUNDTRIP_ON.
SecurityProtocol
Sets the SecurityProtocol property, which indicates whether to use the TLS v1.0 protocol or the SSL protocol for providing security. Values are in string format. The default is TLS.
SSLServerAuthentication
Sets the SSLServerAuthentication property, which indicates whether SSL server authentication is enabled. Valid values are true and false. The default is false.
symmetricSwapEnabled
Sets the Symetric swapping property. This property applies to Arabic 3270 sessions only. Valid values are true and false. The default is true.
textOrientation
Sets the textOrientation property. This property applies to bi-directional sessions only. Values are in string format. Valid values are: The default is LEFT_TO_RIGHT.
ThaiDisplayMode
Sets Thai display mode property. This property applies to Thai sessions only. Values are in string format. The default is THAI_MODE_5.
workstationID
Sets the workstationID property, which is used during enhanced negotiation for 5250. Values are in string format. All lowercase characters will be converted to uppercase. There is no default.

To have more control over 3270 PDF print output format, you can add the following IBM WebSphere Host On-Demand connection session parameters to the list of connection settings:

CPI
Characters per inch. Specifies the number of characters printed per inch. On a Windows platform, three choices (10, 12, and 17) are available. The default value is 10.
LPI
Lines per inch. Specifies the number of lines per inch. On a Windows platform, five choices (2, 3, 4, 6, and 8) are available. The default value is 6.
MCPL
Maximum characters per line. Specifies the maximum number of characters per line, also called the Maximum Print Position or the Maximum Presentation Position (MPP). Enter a value from 1 to 255. The default value is 132.
MLPP
Maximum lines per page. Specifies the maximum number of lines per page, including the top and bottom margins. This value is also called Maximum Page Length (MPL). Enter a value from 1 to 255. The default value is 66.
RTLfile
Printing Right-to-left files. Specify "true" to print a file as it appears on a RTL screen. The default is "false."

<eventPriority> tag

The <eventPriority> tag is the enclosing tag for the screen customization events you defined for the project. The order of the event tags within the <eventPriority> tag defines which events have higher priority. The highest priority event should be the first event in the list.

<event> tag

The <event> tag specifies an event you defined for the project.

The attributes of the <event> tag are:

enabled
Specifies whether the event can occur within the project. Valid values for enabled are true and false. The default is true.
name
Specifies the name you gave the screen customization event when you defined it. If you store a screen customization file under a folder (or group), the name of the folder is prepended to the name of the file.

<classSettings> tag

The <classSettings>tag is the enclosing tag for the Java classes you include in the project.

<class> tag

The <class>tag specifies the Java classes that can be included in an project.

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.
showPrintJobs
If value=true, shows a key in the application keypad for showing print jobs.
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.
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.
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 project.
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.

<textReplacement> tag

The <textReplacement> tag is the enclosing tag for any text replacement values you define in the project.

<replace> tag

The <replace> tag specifies the text replacement values in a project.

Note:
If you are using a bi-directional (BIDI) code page, refer to Additions to HATS files.

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.

Template and transformation files (.jsp)

These JavaServer Pages (JSP) files contain HTML and JSP tagging to define how your project appears in the end user's browser.

The template .jsp files are stored in the project_name/webApplication/templates directory. The transformation .jsp files are stored in the project_name/webApplication/transformations directory.You can view and edit the source of the .jsp files by double-clicking on the name of the template or transformation in the HATS Project View to open the JSP editor. The source for the file can be viewed by clicking on the Source tab.

You can modify the template and transformation files using the Design or the Source tabs in the JSP editor. HATS Studio updates the affected information on other tab when you make changes on either tab.

A template .jsp file contains HTML tagging to define links and images for the project page. The template .jsp file also contains a <HATS:Transform> tag that defines the transformation to be used with the template to present the page of your project.

A transformation .jsp file contains HTML tags to describe the layout of the information presented to the user of the project in a Web browser. The transformation .jsp file may also contain <HATS:Component> tags that define HATS components and widgets used to present the page of your project. For more information on the HATS:Component tag, see Creating custom host components and widgets.

Screen customization files (.evnt)

The screen customization files define how a host screen is recognized, and also defines the actions HATS performs when a screen is recognized.

The screen customization (.evnt) files are stored in the project_name/source/profiles/events/screencustomizations directory. You can view and edit the source of the screen customization files by double-clicking on the name of the screen customization in the HATS Project View to open the screen customization editor. The source for the file can be viewed by clicking on the Source tab.

You can modify screen customization files using the Screen Recognition Criteria, Actions, or Source tabs in the editor. HATS Studio updates the affected information on other tabs when you make changes on any tab.

The screen customization event files contain tags to define how a host screen is recognized and the actions to occur when the host screen is recognized. The tags are:

event
Begins the definition of the screen customization. The event tag has the following attributes:
description
If you supplied a description of the screen customization when you created it, that description is defined in this attribute.
type
For a screen customization, type is always screenRecognize.
actions
Encompasses the actions defined in the screen customization. The possible actions and their attributes are:
apply
Defines the action for applying a transformation. The attributes of the apply tag are:
immediateKeyset
Defines the host keys sent to the host immediately when pressed by the end user of your project. If you did not define any host keys to be sent to the host immediately, this attribute has an empty value.
template
Names the template file that surrounds the transformation being applied. If the default template is being used to surround the transformation, this attribute has an empty value.
transformation
Names the transformation file that is to be applied for this action.
insert
Defines the action for inserting a global variable or a string. The attributes of the insert tag are:
row
Defines the starting row on the host screen where the value is to be inserted.
col
Defines the starting column on the host screen where the value is to be inserted.
source
Specifies whether the value to be inserted is a string or the value of a global variable. Valid values are string and variable.
value
Specifies either the string to be inserted onto the host screen or the name of a global variable from which the value is taken.
fill
If the source of the value to be inserted is an indexed global variable, fill specifies whether the indices of the global variable are to be concatenated and inserted at the specified position, or inserted into a rectangular region of the host screen. Valid values are concatenate and rectangular.
index
If the source of the value to be inserted is an indexed global variable, index specifies the number of the index that is to be used as the value to be inserted onto the host screen.
extract
Defines the action for extracting a global variable. The attributes of the extract tag are:
srow
Defines the starting row on the host screen of the text being extracted.
erow
Defines the ending row on the host screen of the text being extracted.
scol
Defines the starting column on the host screen of the text being extracted.
ecol
Defines the ending column on the host screen of the text being extracted.
name
Specifies the name of the global variable to which the text is extracted. This can be an existing global variable or a new global variable.
overwrite
Specifies whether the text extracted is to overwrite the value of an existing global variable. Valid values are true and false.
indexed
Specifies whether the text extracted is a single string or a list of strings, where each string in the list corresponds to a single row of text from the extracted region. Valid values are true and false.
index
If an existing global variable is indexed, this attribute specifies the index number to which the extracted value is to be written. The effect of this attribute is dependent on the value of the overwrite attribute. If overwrite=true, the extracted value overwrites the existing variable, starting at the specified index. If overwrite=false, the extracted value is inserted into the existing variable, beginning at the specified index.
set
Defines the action for setting a global variable. The attributes of the set tag are:
name
Specifies the name of the global variable being set. This can be an existing global variable or a new global variable.
type
Specifies whether the value of the global variable being set comes from a fixed constant or a calculated value. Valid values are string and calculate.
overwrite
Specifies whether the value being set is to overwrite the value of an existing global variable. Valid values are true and false.
index
If the value being set is being written to an existing indexed global variable, this attribute specifies the index number to which the value being set is written. The effect of this attribute is dependent on the value of the overwrite attribute. If overwrite=true, the value being set overwrites the existing variable, beginning at the specified index. If overwrite=false, the value being set is inserted into the existing variable, beginning at the specified index.
op1
Specifies whether the first operand of a calculated value is a fixed constant or the value of an existing global variable. Valid values are a fixed constant or the name of a global variable.
op1_type
Specifies whether the value of the first operand of a calculated value is set as a fixed constant or from an existing global variable. Valid values are string and variable.
op1_index
If the source of the value of the first operand of a calculated value is an indexed global variable, op1_index specifies the number of the index used as the value for the calculation.
op
Specifies the type of operation to occur between the first and second operands of a calculated value. Valid values are + (add), - (subtract), * (multiply), / (divide), and % (percentage).
op2
Specifies whether the second operand of a calculated value is a fixed constant or the value of an existing global variable. Valid values are a fixed constant or the name of a global variable.
op2_type
Specifies whether the value of the first operand of a calculated value is set as a fixed constant or from an existing global variable. Valid values are string and variable.
op2_index
If the source of the value of the second operand of a calculated value is an indexed global variable, op2_index specifies the number of the index used as the value for the calculation.
dec
Specifies the number of decimal places to which a calculated value is rounded. Valid values are 0-999.
execute
Defines the action for executing business logic. The attributes of the execute tag are:
class
Names the Java class that contains your business logic. The class value is required.
method
Names the method inside the class that executes the business logic. The method value is required.
package
Names the package that the Java class resides in on your file system. The package value is optional.
show
Defines the action for showing a URL. The show tag has the following attribute:
url
Identifies the Uniform Resource Locator (URL) of the Web page to show. This attribute is required.
play
Defines the action for playing a macro. The play tag has the following attribute:
macro
Names the macro to be played. This attribute is required.
associatedScreens
The associatedScreens tag encompasses the screen tag that follows.
screen
Defines a screen associated with the screen customization. The screen tag has the following attribute:
name
Specifies the name of a captured screen, for which the screen recognition criteria and actions have been defined.
description
The description tag is the enclosing tag for the description associated with the screen customization, which is comprised of the oia tag and the string tag. There are no attributes for the description tag.
oia
The oia tag specifies an operator information area (OIA) condition to match. This tag is optional. The default is to wait for inhibit status.

The attributes of the <oia> tag are:

status
If NOTINHIBITED, the OIA must be uninhibited for a match to occur. If DONTCARE, the OIA inhibit status is ignored. This has the same effect as not specifying OIA at all. Valid values are NOTINHIBITED and DONTCARE. This is a required attribute.
optional
If false, this descriptor is considered non-optional during screen recognition. If the descriptors are comprised of more than one non-optional descriptor, and more than one optional descriptor, the non-optional descriptors are checked first. If all of the non-optional descriptors match, the screen matches. If at least one of the non-optional descriptors does not match, the optional descriptors are checked. One of the optional descriptors must match for the screen to match. Otherwise, the screen fails to match. The value must be true or false. This attribute is optional. The default is false.
invertmatch
If true, recognition matching passes only if the screen does not match this description element (boolean not operation). The value must be true or false. This attribute is optional. The default is false.
string
The string tag describes the screen based on a string. The attributes of the <string> tag are:
value
The string value. This value can contain any valid Unicode character. This is a required attribute.
row
The starting row position for a string at an absolute position or in a rectangle. The value must be a number or an expression that evaluates to a number. This value is optional. If not specified, Macro logic searches the entire screen for the string. If specified, col position is required. <erow> and <ecol> attributes can also be specified to specify a string in a rectangular area.
Note:
Negative values are valid and are used to indicate relative position for the bottom of the screen (for example, -1 is the last row).
col
The starting column position for the string at an absolute position or in a rectangle. The value must be a number or an expression that evaluates to a number. This attribute is optional.
erow
The ending row position for string in a rectangle. The value must be a number or an expression that evaluates to a number. This attribute is optional. If both erow and ecol are specified, string is in a rectangle.
ecol
The ending column position for string in a rectangle. The value must be a number or an expression that evaluates to a number. This attribute is optional. If both erow and ecol are specified, string is in a rectangle.
casesense
If true, string comparison is case sensitive. The value must be true or false or an expression that evaluates to true or false. This attribute is optional. The default is false.
optional
If false, this descriptor is considered non-optional during screen recognition. If the descriptors are comprised of more than one non-optional descriptor, and more than one optional descriptor, the non-optional descriptors are checked first. If all of the non-optional descriptors match, the screen matches. If at least one of the non-optional descriptors does not match, the optional descriptors are checked. One of the optional descriptors must match for the screen to match. Otherwise, the screen fails to match. The value must be true or false or an expression that evaluates to true or false. This attribute is optional. The default is false.
invertmatch
If true, recognition matching passes only if the screen does not match this description element (boolean not operation). The value must be true or false or an expression that evaluates to true or false. This attribute is optional. The default is false.

Macro files (.hma)

Macro files are stored in the project_name/source/profiles/events/macros directory. You can view and edit the source of the macro files by double-clicking on the name of the macro in the HATS Project View to open the macro editor. The source for the file can be viewed by clicking on the Source tab.

You can modify macro files using the Prompts and Extracts or Source tabs in the editor. HATS Studio updates the affected information on the other tab when you make changes on either tab.

Macro files contains tags that define a set of screens. The tags are:

macro
Begins the definition of the macro. The macro tag has no attributes.
extracts
The associatedScreens tag encompasses the extract tag that follows. The extracts tag has no attributes.
extract
The extract tag defines the extraction to occur. The attributes of the extract tag are:
name
Specifies the name of the extraction.
handler
You can select a .jsp file to display the extracted information to the end user. A default macro handler is shipped with HATS, and it is named default.jsp. You can find this file by clicking the HATS Project View tab of the HATS Studio and expanding the project name, and expanding Macros > Macro Event Handlers. If you want to create your own handler, ensure that you return control to the HATS runtime.
showHandler
Specifies whether the extracted information should be shown to the end user. Valid values are true and false.
save
Specifies whether the extracted information is saved to a global variable. Valid values are true and false.
variableName
If the extracted information is being saved to a global variable, variableName specifies the name of a new or existing global variable.
overwrite
If the extracted information is being saved to an existing global variable, overwrite specifies whether the extracted information is to overwrite the current value of the existing global variable, or whether the extracted information is to be appended to the current value. Valid values are true and false. True specifies that the value of the existing global variable is overwritten.
indexed
Specifies whether the extracted information is a single string or a list of strings. Valid values are true and false. True specifies that the extracted information is a list of strings.
prompts
The prompts tag encompasses the prompt tag that follows. The prompts tag has no attributes.
prompt
The prompt tag defines the prompt to occur. The attributes of the prompt tag are:
name
Specifies the name of the prompt.
handler
You can select a .jsp file to prompt the end user for the necessary information, and include a button for the user to submit the information. A default macro handler is shipped with HATS, and it is named default.jsp. You can find this file by clicking the HATS Project View tab of the HATS Studio and expanding the project name, and expanding Macros > Macro Event Handlers. If you want to create your own handler, ensure that you return control to the HATS runtime.
source
Specifies whether the value of the prompt is set to a string or the value of a global variable. Valid values are string and variable.
variableName
If the value of the prompt is being saved to a global variable, variableName specifies the name of a new or existing global variable.
variableIndex
If the value of the prompt is being saved to an indexed global variable, variableIndex specifies to which index the value should be assigned. This value is always 0.
value
Specifies either the string to be used for the prompt or the name of a global variable from which the value is taken.
HAScript
The HAScript tag is the main enclosing tag for the other macro tags and attributes.

For descriptions of the HAScript tag, its attributes, and other tags used with the HAScript tag in macros, see Appendix C. Macro script syntax.

Screen capture files (.hsc)

Screen capture files are XML representations of host screens, used to create or customize screen customizations or transformations.

Screen capture files are stored in the project_name/screens directory. You can view these files by double-clicking on the name of the screen capture in the HATS Project View. You cannot edit screen capture files.

Image files (.gif or .jpg)

Image files are used in HATS Studio within template files to create the Web page displayed to the user of your project.

Image files are stored in the project_name/webApplication/common/images directory. You can view and edit the image files by double-clicking on the name of the image in the HATS Project View to open the WebSphere Studio WebArt Designer.

Stylesheet files (.css)

Stylesheet files are used in HATS Studio within template files to specify appearance items such as color, font, font size, whitespace, and spacing between letters.

Stylesheet files are stored in the project_name/webApplication/common/stylesheets directory. You can edit the stylesheet files by double-clicking on the name of the stylesheet in the HATS Project View to open the stylesheet editor.

[ Top of Page | Previous Page | Next Page ]